#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
int | GetIndex () const |
char const * | GetName () const |
char alter * | GetName () alter |
TK_Status | Read (BStreamFileToolkit &tk) alter |
TK_Status | ReadAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
void | Reset () alter |
void | SetIndex (int i) alter |
void | SetName (char const *name) alter |
void | SetName (int length) alter |
TK_Named (unsigned char opcode) | |
TK_Status | Write (BStreamFileToolkit &tk) alter |
TK_Status | WriteAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
Protected Attributes | |
int | m_index |
internal use: simple value for recognised old forms | |
char * | m_name |
internal use: name | |
int | m_name_length |
internal use: length of name |
TK_Named provides support for writing/reading opcode objects which represent a simple string. For compatibility, it also incorporates forms for certain recognised values. This currently includes the opcodes: TKE_Marker_Symbol, TKE_Line_Pattern, TKE_Edge_Pattern
TK_Named::TK_Named | ( | unsigned char | opcode | ) | [inline] |
constructor
TK_Status TK_Named::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.
Reimplemented in HTK_Named.
int TK_Named::GetIndex | ( | ) | const [inline] |
Returns the index value
char const* TK_Named::GetName | ( | ) | const [inline] |
Returns the name
char alter* TK_Named::GetName | ( | ) | [inline] |
Returns the name buffer, which can be modified directly
TK_Status TK_Named::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_Named::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_Named::SetIndex | ( | int | i | ) | [inline] |
Sets the index value
void TK_Named::SetName | ( | char const * | name | ) |
Sets the name. Allocates the buffer and copies the name string
void TK_Named::SetName | ( | int | length | ) |
Sets the name buffer. Allocates a buffer large enough to hold a string of 'length' characters
TK_Status TK_Named::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.