TK_Header
-
class
TK_Header Utility class for managing HSF header information.
TK_Headerdoes not explicitly handle any opcodes, but rather serves as a utility class for writing header information to an HSF file. It will dynamically createTK_CommentandTK_File_Infoopcode handlers (which in turn export TKE_Comment and TKE_File_Info opcode objects)Inherits from:
BBaseOpcodeHandler
Methods
-
TK_Status
TK_Header::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Header::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Header::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Header::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_Header::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.
Variables
-
BBaseOpcodeHandler *
TK_Header::m_current_object protected
internal use