Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

Public Member Functions | Protected Attributes
TK_Dictionary_Locater Class Reference

Handles the TKE_Dictionary_Locater opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Execute (BStreamFileToolkit &tk) alter
int GetOffset () const
int GetSize () const
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant=0) alter
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) alter
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void Reset () alter
void SetOffset (int offset) alter
void SetSize (int size) alter
 TK_Dictionary_Locater ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

int m_offset
 internal use
int m_size
 internal use

Detailed Description

Handles the TKE_Dictionary_Locater opcode.

TK_Dictionary_Locater provides support for writing/reading the TKE_Dictionary_Locater opcode object to/from an HSF file.

The dictionary provides a mean for locating specific entities in the file, the locater will be placed at the end of the file if the dictionary itself isn't. See the Programming Guide for more detailed information.


Constructor & Destructor Documentation

TK_Dictionary_Locater::TK_Dictionary_Locater ( ) [inline]

constructor


Member Function Documentation

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

int TK_Dictionary_Locater::GetOffset ( ) const [inline]

Returns the offset value

int TK_Dictionary_Locater::GetSize ( ) const [inline]

Returns the size value

TK_Status TK_Dictionary_Locater::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_Locater::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_Locater::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_Locater::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.

void TK_Dictionary_Locater::SetOffset ( int  offset) [inline]

Sets the offset value

void TK_Dictionary_Locater::SetSize ( int  size) [inline]

Sets the size value

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