TK_Delete_Object
Functions
void |
|
int |
Detailed Description
-
class TK_Delete_Object : public BBaseOpcodeHandler
Handles the TKE_Delete_Object opcode.
As its name implies, the TKE_Delete_Object is an instruction to remove a previously given object.
Public Functions
-
inline TK_Delete_Object()
constructor
-
virtual TK_Status Read(BStreamFileToolkit &tk)
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.
-
virtual TK_Status Write(BStreamFileToolkit &tk)
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.
-
virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
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 ReadAscii(BStreamFileToolkit &tk)
Deprecated.
-
TK_Status WriteAscii(BStreamFileToolkit &tk)
Deprecated.
-
inline void SetIndex(int i)
Sets the index of the item to be deleted
-
inline int GetIndex()
Returns the index of the item to be deleted
-
inline TK_Delete_Object()
