Handles the TKE_External_Reference opcodes. More...
#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
TK_Status | Execute (BStreamFileToolkit &tk) |
char const * | GetString () const |
char * | GetString () |
TK_Status | Read (BStreamFileToolkit &tk) |
TK_Status | ReadAscii (BStreamFileToolkit &tk) |
Deprecated. | |
void | Reset () |
void | SetString (char const *string) |
void | SetString (int length) |
TK_Status | Write (BStreamFileToolkit &tk) |
TK_Status | WriteAscii (BStreamFileToolkit &tk) |
Deprecated. | |
Protected Attributes | |
int | m_allocated |
int | m_length |
char * | m_string |
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).
TK_Status TK_External_Reference::Clone | ( | BStreamFileToolkit & | tk, |
BBaseOpcodeHandler ** | handler | ||
) | const [virtual] |
Copies the opcode handler
tk | A reference to the BStreamFileToolkit object. |
handler | A pointer to the opcode handler object. Passed by reference. |
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.
tk | A reference to the BStreamFileToolkit object. |
Reimplemented from BBaseOpcodeHandler.
char const* TK_External_Reference::GetString | ( | ) | const [inline] |
Returns the reference string
char* TK_External_Reference::GetString | ( | ) | [inline] |
Returns the reference string buffer, which may be modified directly
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.
tk | A reference to the BStreamFileToolkit object. |
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 | ( | char const * | string | ) |
Sets the reference string. Allocates the buffer and copies the string
void TK_External_Reference::SetString | ( | int | length | ) |
Sets the reference string buffer. Allocates a buffer large enough to hold a string of 'length' bytes
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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
int TK_External_Reference::m_allocated [protected] |
internal use; Size of allocated string buffer
int TK_External_Reference::m_length [protected] |
internal use; Length of text string
char* TK_External_Reference::m_string [protected] |
internal use; Text string