Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Header Class Reference

Utility class for managing HSF header information. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Header:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void Reset () alter
 TK_Header ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

BBaseOpcodeHandlerm_current_object
 internal use


Detailed Description

Utility class for managing HSF header information.

TK_Header does not explicitly handle any opcodes, but rather serves as a utility class for writing header information to an HSF file. It will dynamically create TK_Comment and TK_File_Info opcode handlers (which in turn export TKE_Comment and TKE_File_Info opcode objects)


Constructor & Destructor Documentation

TK_Header::TK_Header (  )  [inline]

constructor


Member Function Documentation

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

void TK_Header::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.

Reimplemented from BBaseOpcodeHandler.

TK_Status TK_Header::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: