Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_XML Class Reference

Handles the TKE_XML opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_XML:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

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

Protected Attributes

char * m_data
int m_size


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.


Constructor & Destructor Documentation

TK_XML::TK_XML (  )  [inline]

constructor


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 (  )  const [inline]

Returns the size of the data buffer

char* TK_XML::GetXML (  )  [inline]

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

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

Returns the address of the data buffer

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 (  )  [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

int TK_XML::m_size [protected]

internal use; Number of bytes of XML data


The documentation for this class was generated from the following file: