#include <BOpcodeHandler.h>
Public Member Functions | |
void | AppendXML (int size, char const *data=0) alter |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
TK_Status | Execute (BStreamFileToolkit &tk) alter |
int | GetSize () const |
char alter * | GetXML () alter |
char const * | GetXML () const |
TK_Status | Read (BStreamFileToolkit &tk) alter |
TK_Status | ReadAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
void | Reset () alter |
void | SetXML (int size, char const *data=0) alter |
TK_XML () | |
TK_Status | Write (BStreamFileToolkit &tk) alter |
TK_Status | WriteAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
Protected Attributes | |
char * | m_data |
int | m_size |
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.
TK_XML::TK_XML | ( | ) | [inline] |
constructor
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
tk | A reference to the BStreamFileToolkit object. | |
handler | A pointer to the opcode handler object. Passed by reference. |
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.
tk | A reference to the BStreamFileToolkit object. |
Reimplemented from BBaseOpcodeHandler.
int TK_XML::GetSize | ( | ) | const [inline] |
Returns the size of the data buffer
char alter* 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.
tk | A reference to the BStreamFileToolkit object. |
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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
char* TK_XML::m_data [protected] |
internal use; XML data
int TK_XML::m_size [protected] |
internal use; Number of bytes of XML data