KDIS  2-8-x
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
VariableParameter Class Reference

#include <VariableParameter.h>

Inheritance diagram for VariableParameter:
Inheritance graph
[legend]
Collaboration diagram for VariableParameter:
Collaboration graph
[legend]

Public Member Functions

virtual void Decode (KDataStream &stream) throw ( KException )
 Description: Convert From Network Data. More...
 
virtual KDataStream Encode () const
 Description: Convert To Network Data. More...
 
virtual void Encode (KDataStream &stream) const
 
virtual KString GetAsString () const
 Description: Returns a string representation. More...
 
const KUINT8 * GetData () const
 
KUINT8 * GetData ()
 
VariableParameterType GetVariableParameterType () const
 
KBOOL operator!= (const VariableParameter &Value) const
 
KBOOL operator== (const VariableParameter &Value) const
 
void SetData (const KUINT8 *D, KUINT8 DataSize) throw ( KException )
 Description: Raw VP data. 15 byte array. More...
 
void SetVariableParameterType (VariableParameterType VPT)
 Description: VP record type. More...
 
 VariableParameter ()
 
 VariableParameter (VariableParameterType VPT, KUINT8 *Data, KUINT8 DataSize) throw ( KException )
 
 VariableParameter (KDataStream &stream) throw ( KException )
 
virtual ~VariableParameter ()
 
- Public Member Functions inherited from DataTypeBase
 DataTypeBase ()
 
virtual ~DataTypeBase ()
 

Static Public Attributes

static const KUINT16 VARIABLE_PARAMETER_SIZE = 16
 

Protected Attributes

KUINT8 m_Data [15]
 
KUINT8 m_ui8VarParamType
 

Additional Inherited Members

- Public Types inherited from FactoryDecoderUser< VariableParameter >
typedef KDIS::UTILS::KRef_Ptr
< FactoryDecoder
< VariableParameter > > 		FacDecPtr
 
- Static Public Member Functions inherited from FactoryDecoderUser< VariableParameter >
static void ClearFactoryDecoders ()
 Description: Removes all factory decoders. More...
 
static VariableParameter * FactoryDecode (KINT32 EnumVal, KDataStream &stream) throw ( KException )
 Note: An exception may be thrown by a decoder. More...
 
static void RegisterFactoryDecoder (KINT32 EnumVal, FacDecPtr Decoder) throw ( KException )
 
- Static Protected Attributes inherited from FactoryDecoderUser< VariableParameter >
static std::map< KINT32,
FacDecPtr > 		m_mDecoders
 

Constructor & Destructor Documentation

VariableParameter ( )
VariableParameter ( VariableParameterType  VPT,
KUINT8 *  Data,
KUINT8  DataSize 
)
throw (KException
)
VariableParameter ( KDataStream &  stream)
throw (KException
)
virtual ~VariableParameter ( )
virtual

Member Function Documentation

void SetVariableParameterType ( VariableParameterType  VPT)

Description: VP record type.

VariableParameterType GetVariableParameterType ( ) const
void SetData ( const KUINT8 *  D,
KUINT8  DataSize 
)
throw (KException
)

Description: Raw VP data. 15 byte array.

const KUINT8* GetData ( ) const
KUINT8* GetData ( )
virtual KString GetAsString ( ) const
virtual

Description: Returns a string representation.

Implements DataTypeBase.

Reimplemented in ArticulatedPart, and AttachedPart.

virtual void Decode ( KDataStream &  stream)
throw (KException
)
virtual

Description: Convert From Network Data.

Implements DataTypeBase.

Reimplemented in ArticulatedPart, and AttachedPart.

virtual KDataStream Encode ( ) const
virtual

Description: Convert To Network Data.

Implements DataTypeBase.

Reimplemented in ArticulatedPart, and AttachedPart.

virtual void Encode ( KDataStream &  stream) const
virtual

Implements DataTypeBase.

Reimplemented in ArticulatedPart, and AttachedPart.

KBOOL operator== ( const VariableParameter &  Value) const
KBOOL operator!= ( const VariableParameter &  Value) const

Member Data Documentation

KUINT8 m_ui8VarParamType
protected
KUINT8 m_Data[15]
protected
const KUINT16 VARIABLE_PARAMETER_SIZE = 16
static
The documentation for this class was generated from the following file: