MinePaintScheme Class Reference

#include <MinePaintScheme.h>

Inheritance diagram for MinePaintScheme:

Collaboration diagram for MinePaintScheme:

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
KDIS::DATA_TYPE::ENUMS::MineAlgae	GetAlgae () const
virtual KString	GetAsString () const
	Description: Returns a string representation. More...
KDIS::DATA_TYPE::ENUMS::PaintScheme	GetPaintScheme () const
	MinePaintScheme ()
	MinePaintScheme (KDIS::DATA_TYPE::ENUMS::MineAlgae A, KDIS::DATA_TYPE::ENUMS::PaintScheme PS)
	MinePaintScheme (KDataStream &stream) throw ( KException )
KBOOL	operator!= (const MinePaintScheme &Value) const
KBOOL	operator== (const MinePaintScheme &Value) const
void	SetAlgae (KDIS::DATA_TYPE::ENUMS::MineAlgae A)
	Description: The algae build-up on the mine. More...
void	SetPaintScheme (KDIS::DATA_TYPE::ENUMS::PaintScheme PS)
	Description: The paint scheme of the mine. More...
virtual	~MinePaintScheme ()
Public Member Functions inherited from DataTypeBase
	DataTypeBase ()
virtual	~DataTypeBase ()

Static Public Attributes
static const KUINT16	MINE_PAINT_SCHEME_SIZE = 1

Protected Attributes
union {
struct {
KUINT8   m_ui8Alg: 2
KUINT8   m_ui8Scm: 6
}
KUINT8   m_ui8PntSchm
}	m_PntScmUnion

Constructor & Destructor Documentation

MinePaintScheme

(

)

MinePaintScheme	(	KDIS::DATA_TYPE::ENUMS::MineAlgae	A,
		KDIS::DATA_TYPE::ENUMS::PaintScheme	PS
	)

MinePaintScheme	(	KDataStream &	stream	)
throw	(	KException
	)

virtual ~MinePaintScheme ( )

virtual

Member Function Documentation

void SetAlgae

(

KDIS::DATA_TYPE::ENUMS::MineAlgae

A

)

Description: The algae build-up on the mine.

KDIS::DATA_TYPE::ENUMS::MineAlgae GetAlgae

(

)

const

void SetPaintScheme

(

KDIS::DATA_TYPE::ENUMS::PaintScheme

PS

)

Description: The paint scheme of the mine.

KDIS::DATA_TYPE::ENUMS::PaintScheme GetPaintScheme

(

)

const

virtual KString GetAsString ( ) const

virtual

Description: Returns a string representation.

Implements DataTypeBase.

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

virtual

Description: Convert From Network Data.

Implements DataTypeBase.

virtual KDataStream Encode ( ) const

virtual

Description: Convert To Network Data.

Implements DataTypeBase.

virtual void Encode ( KDataStream &  stream ) const

virtual

Implements DataTypeBase.

KBOOL operator==

(

const MinePaintScheme &

Value

)

const

KBOOL operator!=

(

const MinePaintScheme &

Value

)

const

Member Data Documentation

KUINT8 m_ui8Alg

KUINT8 m_ui8Scm

KUINT8 m_ui8PntSchm

union { ... } m_PntScmUnion

const KUINT16 MINE_PAINT_SCHEME_SIZE = 1

static

---

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

• DataTypes/MinePaintScheme.h