TK_Reference Class Reference

Inheritance diagram for TK_Reference:

Inheritance graph
[legend]
Collaboration diagram for TK_Reference:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 1340 of file BOpcodeHandler.h.

Public Member Functions

 TK_Reference ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void Reset (void) alter
void SetIndex (int index) alter
ID_Key GetIndex (void) alter
void SetCondition (char const *condition) alter
void SetCondition (int length) alter
char const * GetCondition (void) const
char alter * GetCondition (void) alter
void SetFollow (bool f) alter
bool GetFollow (void) alter

Protected Attributes

int m_index
int m_cond_length
int m_cond_allocated
char * m_condition
ID_Key m_this_key
 for internal use only
ID_Key m_key
 for internal use only
BBaseOpcodeHandlerm_referee
 for internal use only
bool m_follow
 for internal use only


Constructor & Destructor Documentation

TK_Reference::TK_Reference  ) 
 

constructor


Member Function Documentation

TK_Status TK_Reference::Clone BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler
const [virtual]
 

Copies the opcode handler

Parameters:
tk A reference to the BStreamFileToolkit object.
handler A pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

char alter* TK_Reference::GetCondition void   )  [inline]
 

Get the condition string buffer. Returns a pointer to the current condition buffer which may then be modified directly

Definition at line 1392 of file BOpcodeHandler.h.

char const* TK_Reference::GetCondition void   )  const [inline]
 

Get the condition string. Returns a pointer to the current condition

Definition at line 1387 of file BOpcodeHandler.h.

bool TK_Reference::GetFollow void   )  [inline]
 

Returns the flag indicating whether the referenced item should be processed itself

Definition at line 1398 of file BOpcodeHandler.h.

ID_Key TK_Reference::GetIndex void   )  [inline]
 

Returns the id of the referenced item

Definition at line 1372 of file BOpcodeHandler.h.

TK_Status TK_Reference::Read BStreamFileToolkit tk  )  [virtual]
 

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Reference::Reset void   )  [virtual]
 

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

Reimplemented from BBaseOpcodeHandler.

void TK_Reference::SetCondition int  length  ) 
 

Set the condition string. Makes sure the buffer is big enough to hold a string of 'length' characters

void TK_Reference::SetCondition char const *  condition  ) 
 

Set the condition string. Makes sure the buffer is big enough to hold the condition, and copies it in

void TK_Reference::SetFollow bool  f  )  [inline]
 

Sets the flag indicating whether the referenced item should be processed itself

Definition at line 1396 of file BOpcodeHandler.h.

void TK_Reference::SetIndex int  index  )  [inline]
 

Sets the id of the referenced item

Definition at line 1370 of file BOpcodeHandler.h.

TK_Status TK_Reference::Write BStreamFileToolkit tk  )  [virtual]
 

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


Member Data Documentation

int TK_Reference::m_cond_allocated [protected]
 

Size of currently available condition buffer. for internal use only

Definition at line 1348 of file BOpcodeHandler.h.

int TK_Reference::m_cond_length [protected]
 

Length of condition. for internal use only

Definition at line 1347 of file BOpcodeHandler.h.

char* TK_Reference::m_condition [protected]
 

Condition. for internal use only

Definition at line 1349 of file BOpcodeHandler.h.

int TK_Reference::m_index [protected]
 

tag index of referenced item. for internal use only

Definition at line 1346 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:45 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5