TK_Named

Functions

	`TK_Named`
	`~TK_Named`
`TK_Status`	`Read`
`TK_Status`	`Write`
`TK_Status`	`Clone`
`TK_Status`	`ReadAscii`
`TK_Status`	`WriteAscii`
void	`Reset`
void	`SetName`
void	`SetName`
char const *	`GetName`
char *	`GetName`
void	`SetIndex`
int	`GetIndex`

Detailed Description

class TK_Named : public BBaseOpcodeHandler

TK_Named provides support for writing/reading opcode objects which represent a simple string. For compatibility, it also incorporates forms for certain recognised values. This currently includes the opcodes: TKE_Marker_Symbol, TKE_Line_Pattern, TKE_Edge_Pattern

Public Functions

inline TK_Named(unsigned char opcode): constructor

~TK_Named()

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.

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

void SetName(char const *name): Sets the name. Allocates the buffer and copies the name string

void SetName(int length): Sets the name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters

inline char const *GetName() const: Returns the name

inline char *GetName(): Returns the name buffer, which can be modified directly

inline void SetIndex(int i): Sets the index value

inline int GetIndex() const: Returns the index value