TK_External_Reference Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_External_Reference:

Inheritance graph
[legend]
Collaboration diagram for TK_External_Reference:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_External_Reference opcodes.

TK_External_Reference provides support for writing/reading the TKE_External_Reference opcode object to/from an HSF file.

An External Reference represents another data stream which whould be further interpreted as a sub-part of the current data stream (similar to an "include" directive in a programming language).

Definition at line 7783 of file BOpcodeHandler.h.

Public Member Functions

 TK_External_Reference ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
TK_Status Execute (BStreamFileToolkit &tk) alter
void Reset (void) alter
void SetString (char const *string) alter
void SetString (int length) alter
char const * GetString (void) const
char alter * GetString (void) alter

Protected Attributes

int m_length
int m_allocated
char * m_string


Member Function Documentation

TK_Status TK_External_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.

TK_Status TK_External_Reference::Execute BStreamFileToolkit tk  )  [virtual]
 

Processes the binary data that has been read for the current object, which involves passing the data to application-specific data structures.

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

Reimplemented from BBaseOpcodeHandler.

char alter* TK_External_Reference::GetString void   )  [inline]
 

Returns the reference string buffer, which may be modified directly

Definition at line 7815 of file BOpcodeHandler.h.

char const* TK_External_Reference::GetString void   )  const [inline]
 

Returns the reference string

Definition at line 7813 of file BOpcodeHandler.h.

TK_Status TK_External_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_External_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_External_Reference::SetString int  length  ) 
 

Sets the reference string buffer. Allocates a buffer large enough to hold a string of 'length' bytes

void TK_External_Reference::SetString char const *  string  ) 
 

Sets the reference string. Allocates the buffer and copies the string

TK_Status TK_External_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_External_Reference::m_allocated [protected]
 

internal use; Size of allocated string buffer

Definition at line 7790 of file BOpcodeHandler.h.

int TK_External_Reference::m_length [protected]
 

internal use; Length of text string

Definition at line 7789 of file BOpcodeHandler.h.

char* TK_External_Reference::m_string [protected]
 

internal use; Text string

Definition at line 7791 of file BOpcodeHandler.h.


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