TK_Unavailable

Functions

TK_Unavailable

TK_Status

Read

TK_Status

Write

Detailed Description

class TK_Unavailable : public BBaseOpcodeHandler

TK_Unavailable is a placeholder handler for undefined opcodes. It will generate an error return if used, primarily as a means to catch data corruption or flag errors due to incorrect behaviour of other handlers.

Public Functions

inline TK_Unavailable(char opcode)

constructor

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.