Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_URL Class Reference

Handles the TKE_URL opcodes. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_URL:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
char * GetString ()
char const * GetString () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset ()
void SetString (int length)
void SetString (char const *string)
 TK_URL ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

int m_allocated
int m_length
char * m_string


Detailed Description

Handles the TKE_URL opcodes.

TK_URL provides support for writing/reading the TKE_URL opcode object to/from an HSF file.

An URL in a stream file is another form of user/application data. Its intent is to provide informational links corresponding to data (as opposed to External_Reference which provides additional content).


Constructor & Destructor Documentation

TK_URL::TK_URL (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_URL::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

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.

Reimplemented from BBaseOpcodeHandler.

char* TK_URL::GetString (  )  [inline]

Returns the reference string buffer, which may be modified directly

char const* TK_URL::GetString (  )  const [inline]

Returns the reference string

TK_Status TK_URL::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 the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_URL::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.

Reimplemented from BBaseOpcodeHandler.

void TK_URL::SetString ( int  length  ) 

Sets the reference string buffer. Allocates a buffer large enough to hold a string of 'length' bytes

void TK_URL::SetString ( char const *  string  ) 

Sets the reference string. Allocates the buffer and copies the string

TK_Status TK_URL::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 the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


Member Data Documentation

int TK_URL::m_allocated [protected]

internal use; Size of allocated string buffer

int TK_URL::m_length [protected]

internal use; Lengths of text string

char* TK_URL::m_string [protected]

internal use; Text string


The documentation for this class was generated from the following file: