Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Linear_Pattern Class Reference

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetPattern () const
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void SetPattern (int p) alter
 TK_Linear_Pattern (unsigned char opcode)
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

unsigned short m_pattern
 internal use

Detailed Description

TK_Linear_Pattern provided support for writing/reading the TKE_Line_Pattern and TKE_Edge_Pattern opcode objects, which represent a composite of the dashing pattern, cap style, and join style. This has been superceded by TK_Named.


Constructor & Destructor Documentation

TK_Linear_Pattern::TK_Linear_Pattern ( unsigned char  opcode) [inline]

constructor


Member Function Documentation

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

Copies the opcode handler

Parameters:
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

Reimplemented in HTK_Linear_Pattern.

int TK_Linear_Pattern::GetPattern ( ) const [inline]

Returns the pattern value

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

Implements BBaseOpcodeHandler.

void TK_Linear_Pattern::SetPattern ( int  p) [inline]

Sets the pattern value

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

Implements BBaseOpcodeHandler.


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