TK_XML Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_XML:

Inheritance graph
[legend]
Collaboration diagram for TK_XML:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_XML opcode.

The HOOPS Stream File can contain XML code, which is denoted by TKE_XML. TK_XML will handle the TKE_XML opcode by simply reading the data, and not doing anything with it. Therefore, this class must be overloaded in order to both import (and handle), as well as export XML.

Definition at line 7690 of file BOpcodeHandler.h.

Public Member Functions

 TK_XML ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
TK_Status Execute (BStreamFileToolkit &tk) alter
void Reset (void) alter
void SetXML (int size, char const *data=0) alter
void AppendXML (int size, char const *data=0) alter
char const * GetXML (void) const
char alter * GetXML (void) alter
int GetSize (void) const

Protected Attributes

int m_size
char * m_data


Constructor & Destructor Documentation

TK_XML::TK_XML  )  [inline]
 

constructor

Definition at line 7701 of file BOpcodeHandler.h.


Member Function Documentation

void TK_XML::AppendXML int  size,
char const *  data = 0
 

Expands the buffer by 'size' bytes and, if specified, copies 'bytes' into the buffer

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

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

Reimplemented from BBaseOpcodeHandler.

int TK_XML::GetSize void   )  const [inline]
 

Returns the size of the data buffer

Definition at line 7728 of file BOpcodeHandler.h.

char alter* TK_XML::GetXML void   )  [inline]
 

Returns the address of the data buffer, which may be modified directly

Definition at line 7726 of file BOpcodeHandler.h.

char const* TK_XML::GetXML void   )  const [inline]
 

Returns the address of the data buffer

Definition at line 7724 of file BOpcodeHandler.h.

TK_Status TK_XML::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_XML::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_XML::SetXML int  size,
char const *  data = 0
 

Sets the data buffer. Allocates a buffer which can hold 'size' bytes and if, specified, copies 'bytes' into the buffer

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


Member Data Documentation

char* TK_XML::m_data [protected]
 

internal use; XML data

Definition at line 7697 of file BOpcodeHandler.h.

int TK_XML::m_size [protected]
 

internal use; Number of bytes of XML data

Definition at line 7696 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:48 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5