TK_Named
-
class
TK_Named TK_Namedprovides 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_PatternInherits from:
BBaseOpcodeHandlerIndex
Methods
Clone()GetIndex()GetName()GetName()Read()ReadAscii()Reset()SetIndex()SetName()SetName()TK_Named()Write()WriteAscii()~TK_Named()
Variables
Methods
-
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.Parameters
tk: A reference to theBStreamFileToolkitobject.Returns
The result of the function call.
-
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.Parameters
tk: A reference to theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Named::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_Named::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Named::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
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.
-
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
Variables