TK_Enumerated Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Enumerated:

Inheritance graph
[legend]
Collaboration diagram for TK_Enumerated:

Collaboration graph
[legend]
List of all members.

Detailed Description

TK_Enumerated provides support for writing/reading opcode objects which represent a simple choice from an enumerated set (TKO_Enumerations). This currently includes the opcodes: TKE_Face_Pattern, TKE_Window_Pattern, TKE_Text_Alignment, TKE_Window_Frame, TKE_Handedness

Definition at line 4552 of file BOpcodeHandler.h.

Public Member Functions

 TK_Enumerated (unsigned char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetIndex (int i) alter
int GetIndex (void) const

Protected Attributes

char m_index
 internal use


Constructor & Destructor Documentation

TK_Enumerated::TK_Enumerated unsigned char  opcode  )  [inline]
 

constructor

Definition at line 4562 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Enumerated::Clone BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler
const [virtual]
 

Copies the opcode handler

Parameters:
tk A reference to the BStreamFileToolkit object.
handler A pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

int TK_Enumerated::GetIndex void   )  const [inline]
 

Returns the index value

Definition at line 4574 of file BOpcodeHandler.h.

TK_Status TK_Enumerated::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_Enumerated::SetIndex int  i  )  [inline]
 

Sets the index value

Definition at line 4572 of file BOpcodeHandler.h.

TK_Status TK_Enumerated::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:43 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5