TK_Unavailable Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Unavailable:

Inheritance graph
[legend]
Collaboration diagram for TK_Unavailable:

Collaboration graph
[legend]
List of all members.

Detailed Description

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.

Definition at line 897 of file BOpcodeHandler.h.

Public Member Functions

 TK_Unavailable (char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter


Constructor & Destructor Documentation

TK_Unavailable::TK_Unavailable char  opcode  )  [inline]
 

constructor

Definition at line 900 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Unavailable::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_Unavailable::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:
Generated on Tue Jan 6 22:41:47 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5