TK_File_Info

Detailed Description

class TK_File_Info : public BBaseOpcodeHandler

Handles the TKE_File_Info opcode.

TK_File_Info provides support for writing/reading the TKE_File_Info opcode object to/from an HSF file.

The TKE_File_Info opcode object contains information about how the file was written.

Public Functions

inline TK_File_Info()

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 Execute(BStreamFileToolkit &tk)

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.
virtual TK_Status Interpret(BStreamFileToolkit &tk, long key, int variant)

Extracts graphics data (typically from the application’s scene-graph) and maps it to the opcode handler’s data members in preparation for writing out an object to the file.

Parameters:
  • tk – A reference to the BStreamFileToolkit object.
  • key – An identifier to the object (for example, the HOOPS key of a geometry item)
  • variant – optional specification of an alternate form, such as a Level-of-Detail representation
Returns:

The result of the function call.

inline virtual TK_Status Interpret(BStreamFileToolkit &tk, long key, char const *special)

Extracts graphics data (typically from the application’s scene-graph) and maps it to the opcode handler’s data members in preparation for writing out an object to the file.

Parameters:
  • tk – A reference to the BStreamFileToolkit object.
  • key – An identifier to the object (for example, the HOOPS key of a geometry item)
  • special – A string value of particular data
Returns:

The result of the function call.

TK_Status ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status WriteAscii(BStreamFileToolkit &tk)

Deprecated.

inline void SetFlags(int f)

Sets the flag indicating whether the reference segment should be processed itself

inline int GetFlags()

Returns the flag indicating whether the reference segment should be processed itself