TK_Named Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Named:

Inheritance graph
[legend]
Collaboration diagram for TK_Named:

Collaboration graph
[legend]
List of all members.

Detailed Description

TK_Named provides support for writing/reading opcode objects which represent a simple string. For compatibility, it also incorporates forms for certain recognised values. This currently includes the opcodes: TKE_Marker_Symbol, TKE_Line_Pattern, TKE_Edge_Pattern

Definition at line 4662 of file BOpcodeHandler.h.

Public Member Functions

 TK_Named (unsigned char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void Reset (void) alter
void SetName (char const *name) alter
void SetName (int length) alter
char const * GetName (void) const
char alter * GetName (void) alter
void SetIndex (int i) alter
int GetIndex (void) const

Protected Attributes

int m_name_length
 internal use: length of name
char * m_name
 internal use: name
int m_index
 internal use: simple value for recognised old forms


Constructor & Destructor Documentation

TK_Named::TK_Named unsigned char  opcode  )  [inline]
 

constructor

Definition at line 4674 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Named::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_Named::GetIndex void   )  const [inline]
 

Returns the index value

Definition at line 4699 of file BOpcodeHandler.h.

char alter* TK_Named::GetName void   )  [inline]
 

Returns the name buffer, which can be modified directly

Definition at line 4694 of file BOpcodeHandler.h.

char const* TK_Named::GetName void   )  const [inline]
 

Returns the name

Definition at line 4692 of file BOpcodeHandler.h.

TK_Status TK_Named::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_Named::Reset void   )  [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_Named::SetIndex int  i  )  [inline]
 

Sets the index value

Definition at line 4697 of file BOpcodeHandler.h.

void TK_Named::SetName int  length  ) 
 

Sets the name buffer. Allocates a buffer large enough to hold a string of 'length' characters

void TK_Named::SetName char const *  name  ) 
 

Sets the name. Allocates the buffer and copies the name string

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