TK_Image_XRef

Detailed Description

class TK_Image_XRef : public BBaseOpcodeHandler

Handles the TKE_Image_XRef opcodes.

TK_Image_XRef provides support for writing/reading the TKE_Image_XRef opcode object to/from an HSF file.

An Image XRef is a common referral to an external image, implemented here to prevent it being replicated in many other components.

Public Functions

inline TK_Image_XRef()
~TK_Image_XRef()
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.

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 void Reset(void)

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.

inline void SetName(char const *string)

Sets the name of the image. Allocates the buffer and copies the string

inline void SetName(int length)

Sets the name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters

inline char const *GetName(void) const

Returns the image name string

inline char *GetName(void)

Returns the image name string buffer, which may be modified directly

inline void SetSize(int x, int y)
inline int const *GetSize(void) const
inline int *GetSize(void)
inline void SetBitDepth(char bpp)
inline char GetBitDepth(void) const
inline char GetBitDepth(void)