WsfL16::Messages::Base Class Reference

#include <Messages.hpp>

Inheritance diagram for WsfL16::Messages::Base:

Public Types
enum	WordType { cINITIAL , cCONTINUATION , cEXTENSION , cUNDEFINED }

Public Member Functions
	Base (char *aData)
	Base ()
virtual WordType	GetWordType () const =0
	Returns the base type of the word.
virtual	~Base ()
virtual int	GetUID () const =0
	Returns the unique identifier of a message word type.
virtual void	TransferI (MessageBitInput &aMR)=0
	Reads the message from a MessageBitInput.
virtual void	TransferO (MessageBitOutput &aMW)=0
	Reads the message from a MessageBitOutput.
virtual void	CreateAccessor (MessageAccessorFiller &aMP)=0
	Used once to provide generic access to messages and fields.
virtual const char *	GetFieldName (int i)=0
	Returns the name of the field with a given index.
virtual std::string	GetClassName () const =0
	Returns the class name of a field (used in scripting and debug output).
void	PrintWord (ut::log::MessageStream &aStream) const

Member Enumeration Documentation

WordType

enum WsfL16::Messages::Base::WordType

Enumerator
cINITIAL
cCONTINUATION
cEXTENSION
cUNDEFINED

Constructor & Destructor Documentation

Base() [1/2]

WsfL16::Messages::Base::Base

(

char *

aData

)

References Base().

Referenced by Base(), WsfL16::Messages::InitialBase::GetSubWord(), and GetWordType().

Base() [2/2]

WsfL16::Messages::Base::Base

(

)

~Base()

WsfL16::Messages::Base::~Base ( )

virtual

Member Function Documentation

CreateAccessor()

virtual void WsfL16::Messages::Base::CreateAccessor ( MessageAccessorFiller & aMP )

pure virtual

Used once to provide generic access to messages and fields.

GetClassName()

virtual std::string WsfL16::Messages::Base::GetClassName ( ) const

pure virtual

Returns the class name of a field (used in scripting and debug output).

Implemented in WsfL16::Messages::ContinuationBase, WsfL16::Messages::ExtensionBase, and WsfL16::Messages::InitialBase.

References PrintWord().

Referenced by PrintWord().

GetFieldName()

virtual const char * WsfL16::Messages::Base::GetFieldName ( int i )

pure virtual

Returns the name of the field with a given index.

GetUID()

virtual int WsfL16::Messages::Base::GetUID ( ) const

pure virtual

Returns the unique identifier of a message word type.

Referenced by WsfL16::Messages::ContinuationBase::GetClassName(), and WsfL16::Messages::ExtensionBase::GetClassName().

GetWordType()

virtual WordType WsfL16::Messages::Base::GetWordType ( ) const

pure virtual

Returns the base type of the word.

Implemented in WsfL16::Messages::ContinuationBase, WsfL16::Messages::ExtensionBase, and WsfL16::Messages::InitialBase.

References Base().

PrintWord()

void WsfL16::Messages::Base::PrintWord

(

ut::log::MessageStream &

aStream

)

const

References WsfL16::Messages::FieldAccessor::cBOOLEAN, WsfL16::Messages::FieldAccessor::cDOUBLE, WsfL16::Messages::FieldAccessor::cENUMERATION, WsfL16::Messages::FieldAccessor::cINTEGER, WsfL16::Messages::FieldAccessor::cSTRING, WsfL16::Messages::MessageAccessor::FieldCount(), WsfL16::Messages::FieldAccessor::GetBool(), GetClassName(), WsfL16::Messages::FieldAccessor::GetDouble(), WsfL16::Messages::FieldAccessor::GetEnumeration(), WsfL16::Messages::MessageAccessor::GetField(), WsfL16::Messages::FieldAccessor::GetInt(), WsfL16::Messages::FieldAccessor::GetName(), WsfL16::Messages::FieldAccessor::GetRawData(), WsfL16::Messages::FieldAccessor::GetString(), WsfL16::Messages::FieldAccessor::GetType(), WsfL16::Messages::FieldAccessor::GetUnits(), WsfL16::Messages::FieldAccessor::IsDisused(), WsfL16::Messages::FieldAccessor::IsNoStatement(), and WsfL16::Messages::FieldAccessor::IsSpare().

Referenced by GetClassName(), and WsfL16::Messages::InitialBase::PrintMessage().

TransferI()

virtual void WsfL16::Messages::Base::TransferI ( MessageBitInput & aMR )

pure virtual

Reads the message from a MessageBitInput.

Referenced by WsfL16::Messages::Factory::ReadMessage().

TransferO()

virtual void WsfL16::Messages::Base::TransferO ( MessageBitOutput & aMW )

pure virtual

Reads the message from a MessageBitOutput.

Referenced by WsfL16::Messages::ContinuationBase::WriteMessage(), WsfL16::Messages::ExtensionBase::WriteMessage(), and WsfL16::Messages::InitialBase::WriteMessage().

---

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

• Messages.hpp
• Messages.cpp