Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Default Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Default:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
 TK_Default ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

int m_buffer_count
char * m_opcode_buffer


Detailed Description

TK_Default provides a simple dispatcher used when reading/parsing HSF data. Its only purpose is to read a single opcode value and call out to the appropriate handler.

Constructor & Destructor Documentation

TK_Default::TK_Default (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_Default::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.

Implements BBaseOpcodeHandler.

TK_Status TK_Default::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.

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file: