TK_Named

class TK_Named

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

Inherits from: BBaseOpcodeHandler

Methods

TK_Named::TK_Named(unsigned char opcode)

constructor

TK_Named::~TK_Named()
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 the BStreamFileToolkit object.

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 the BStreamFileToolkit object.

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 BStreamFileToolkit object.

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

char const *TK_Named::GetName() const

const

Returns the name

char *TK_Named::GetName()

Returns the name buffer, which can be modified directly

void TK_Named::SetIndex(int i)

Sets the index value

int TK_Named::GetIndex() const

const

Returns the index value

Variables

int TK_Named::m_name_length

protected

int

internal use: length of name

char *TK_Named::m_name

protected

char

internal use: name

int TK_Named::m_index

protected

int

internal use: simple value for recognised old forms