TK_User_Data

class TK_User_Data

Handles the TKE_Start_User_Data opcode.

The HOOPS Stream File can contain user-data, which is denoted by TKE_Start_User_Data. TK_User_Data will handle the TKE_Start_User_Data 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 user-data.

To ensure that user data will be gracefully handled (skipped-over) by non-custom handlers (meaning, an application that is using the default toolkit and doesn’t understand the custom user data), custom user data must be written out by exporting the following elements in order:

1.  the TKE_Start_User_Data opcode
2.  the number of bytes of user data that will follow
3.  the user data itself
4.  the TKE_Stop_User_Data_Opcode

See the HOOPS/Stream Programming Guide for more detailed information about how to handle user data and create custom files.

Inherits from: BBaseOpcodeHandler

Methods

void TK_User_Data::set_data(int size, unsigned char const *bytes = 0)

protected

internal use

for internal use only

TK_User_Data::TK_User_Data()

constructor

TK_User_Data::~TK_User_Data()
TK_Status TK_User_Data::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_User_Data::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_User_Data::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_User_Data::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_User_Data::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_User_Data::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_User_Data::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_User_Data::SetUserData(int size, unsigned char const *bytes = 0)

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

unsigned char const *TK_User_Data::GetUserData() const

const

Returns the address of the data buffer

unsigned char *TK_User_Data::GetUserData()

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

int TK_User_Data::GetSize() const

const

Returns the size of the data buffer

void TK_User_Data::Resize(int size)

Change the size of the data buffer

void TK_User_Data::SetSize(int size)

Sets the size of the data buffer.

Variables

int TK_User_Data::m_size

protected

int

internal use; Number of bytes of user data

unsigned char *TK_User_Data::m_data

protected

unsigned char

internal use; User data

int TK_User_Data::m_buffer_size

protected

int

internal use; Real m_data size