TK_Delete_Object

class TK_Delete_Object

Handles the TKE_Delete_Object opcode.

As its name implies, the TKE_Delete_Object is an instruction to remove a previously given object.

Inherits from: BBaseOpcodeHandler

Methods

TK_Delete_Object::TK_Delete_Object()

constructor

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

Deprecated.

TK_Status TK_Delete_Object::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Delete_Object::SetIndex(int i)

Sets the index of the item to be deleted

int TK_Delete_Object::GetIndex()

Returns the index of the item to be deleted

Variables

int TK_Delete_Object::m_index

protected

int

internal use