Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Delete_Object Class Reference

Handles the TKE_Delete_Object opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Delete_Object:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetIndex ()
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetIndex (int i)
 TK_Delete_Object ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

int m_index
 internal use


Detailed Description

Handles the TKE_Delete_Object opcode.

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


Constructor & Destructor Documentation

TK_Delete_Object::TK_Delete_Object (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_Delete_Object::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.

int TK_Delete_Object::GetIndex (  )  [inline]

Returns the index of the item to be deleted

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.

Implements BBaseOpcodeHandler.

void TK_Delete_Object::SetIndex ( int  i  )  [inline]

Sets the index of the item to be deleted

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.

Implements BBaseOpcodeHandler.


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