TK_External_Reference

class TK_External_Reference

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).

Inherits from: BBaseOpcodeHandler

Methods

TK_External_Reference::TK_External_Reference()
TK_External_Reference::~TK_External_Reference()
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.
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.
TK_Status TK_External_Reference::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_External_Reference::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_External_Reference::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

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

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

char const *TK_External_Reference::GetString() const

const

Returns the reference string

char *TK_External_Reference::GetString()

Returns the reference string buffer, which may be modified directly

Variables

int TK_External_Reference::m_length

protected

int

internal use; Length of text string

int TK_External_Reference::m_allocated

protected

int

internal use; Size of allocated string buffer

char *TK_External_Reference::m_string

protected

char

internal use; Text string