TK_XML

class TK_XML

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.

Inherits from: BBaseOpcodeHandler

Methods

TK_XML::TK_XML()

constructor

TK_XML::~TK_XML()
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.
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.
TK_Status TK_XML::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.
TK_Status TK_XML::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_XML::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

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.
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.

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

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

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

char const *TK_XML::GetXML() const

const

Returns the address of the data buffer

char *TK_XML::GetXML()

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

int TK_XML::GetSize() const

const

Returns the size of the data buffer

Variables

int TK_XML::m_size

protected

int

internal use; Number of bytes of XML data

char *TK_XML::m_data

protected

char

internal use; XML data