TK_External_Reference

Functions

TK_External_Reference

~TK_External_Reference

TK_Status

Read

TK_Status

Write

TK_Status

Clone

TK_Status

ReadAscii

TK_Status

WriteAscii

TK_Status

Execute

void

Reset

void

SetString

void

SetString

char const *

GetString

char *

GetString

Detailed Description

class TK_External_Reference : public BBaseOpcodeHandler

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

Public Functions

inline TK_External_Reference()
~TK_External_Reference()
virtual TK_Status Read(BStreamFileToolkit &tk)

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.

virtual TK_Status Write(BStreamFileToolkit &tk)

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.

virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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 ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status WriteAscii(BStreamFileToolkit &tk)

Deprecated.

virtual TK_Status Execute(BStreamFileToolkit &tk)

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.

virtual void Reset()

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 SetString(char const *string)

Sets the reference string. Allocates the buffer and copies the string

void SetString(int length)

Sets the reference string buffer. Allocates a buffer large enough to hold a string of ‘length’ bytes

inline char const *GetString() const

Returns the reference string

inline char *GetString()

Returns the reference string buffer, which may be modified directly