Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Dictionary Class Reference

Handles the TKE_Dictionary opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Execute (BStreamFileToolkit &tk)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant=0)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special)
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset ()
 TK_Dictionary ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

unsigned char m_format
 internal use
Internal_Translator::Index_Key_Pair * m_item
 internal use; cache lookup in Pending cases
int m_number_of_items
 internal use
int m_placeholder
 internal use
unsigned char m_present
 internal use

Detailed Description

Handles the TKE_Dictionary opcode.

TK_Dictionary provides support for writing/reading the TKE_Dictionary opcode object to/from an HSF file.

The dictionary provides a mean for locating specific entities in the file. See the Programming Guide for more detailed information.


Constructor & Destructor Documentation

TK_Dictionary::TK_Dictionary ( ) [inline]

constructor


Member Function Documentation

TK_Status TK_Dictionary::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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status TK_Dictionary::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
int  variant = 0 
) [virtual]

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters:
tkA reference to the BStreamFileToolkit object.
keyAn identifier to the object (for example, the HOOPS key of a geometry item)
variantoptional specification of an alternate form, such as a Level-of-Detail representation
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status TK_Dictionary::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
char const *  special 
) [inline, virtual]

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters:
tkA reference to the BStreamFileToolkit object.
keyAn identifier to the object (for example, the HOOPS key of a geometry item)
specialA string value of particular data
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

References BBaseOpcodeHandler::Interpret().

TK_Status TK_Dictionary::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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Dictionary::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_Dictionary::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:
tkA 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: