Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_External_Reference Class Reference

Handles the TKE_External_Reference opcodes. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_External_Reference:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

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

Protected Attributes

int m_allocated
int m_length
char * m_string


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 would be further interpreted as a sub-part of the current data stream (similar to an "include" directive in a programming language).


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 (  )  [inline]

Returns the reference string buffer, which may be modified directly

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

Returns the reference string

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 (  )  [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

internal use; Size of allocated string buffer

internal use; Length of text string

internal use; Text string


The documentation for this class was generated from the following file: