WsfL16::Messages::FieldAccessor Class Reference

#include <MessageAccessor.hpp>

Public Types
enum	DataType {   cBOOLEAN , cINTEGER , cSTRING , cDOUBLE ,   cENUMERATION }

Public Member Functions
	FieldAccessor (void *aFieldPtr, FieldAccessorType *aAccessorType, const std::string *aNamePtr)
DataType	GetType () const
int	GetId () const
void	Set (bool aValue)
void	Set (int aValue)
void	Set (const std::string &aValue)
void	Set (double aValue)
bool	GetBool () const
int	GetInt () const
std::string	GetString () const
double	GetDouble () const
bool	GetEnumeration (std::string &aEnum) const
bool	GetUnits (std::string &aUnitsType) const
bool	IsNoStatement () const
bool	IsSpare () const
	Returns 'true' if this is a spare field.
bool	IsDisused () const
	Returns 'true' if this is a disused field.
void	SetRawData (int aValue)
int	GetRawData () const
void	SetNoStatement ()
	If this field has a no statement value, it is set to no statement.
const std::string &	GetName () const

Member Enumeration Documentation

DataType

enum WsfL16::Messages::FieldAccessor::DataType

Enumerator
cBOOLEAN
cINTEGER
cSTRING
cDOUBLE
cENUMERATION

Constructor & Destructor Documentation

FieldAccessor()

WsfL16::Messages::FieldAccessor::FieldAccessor	(	void *	aFieldPtr,
		FieldAccessorType *	aAccessorType,
		const std::string *	aNamePtr )

Member Function Documentation

GetBool()

bool WsfL16::Messages::FieldAccessor::GetBool

(

)

const

References WsfL16::Messages::FieldAccessorType::Variant::mBoolean.

Referenced by WsfL16::Messages::Base::PrintWord().

GetDouble()

double WsfL16::Messages::FieldAccessor::GetDouble

(

)

const

References WsfL16::Messages::FieldAccessorType::Variant::mDouble.

Referenced by WsfL16::Messages::Base::PrintWord().

GetEnumeration()

bool WsfL16::Messages::FieldAccessor::GetEnumeration

(

std::string &

aEnum

)

const

Gets the string value of an enumeration. Returns 'true' if the value is mapped to an enumeration Returns 'false' if an enumeration cannot be found

References GetRawData().

Referenced by WsfL16::Messages::Base::PrintWord().

GetId()

int WsfL16::Messages::FieldAccessor::GetId ( ) const

inline

GetInt()

int WsfL16::Messages::FieldAccessor::GetInt

(

)

const

References WsfL16::Messages::FieldAccessorType::Variant::mInteger.

Referenced by WsfL16::Messages::Base::PrintWord().

GetName()

const std::string & WsfL16::Messages::FieldAccessor::GetName ( ) const

inline

Referenced by WsfL16::Messages::Base::PrintWord().

GetRawData()

int WsfL16::Messages::FieldAccessor::GetRawData

(

)

const

Referenced by GetEnumeration(), IsNoStatement(), and WsfL16::Messages::Base::PrintWord().

GetString()

std::string WsfL16::Messages::FieldAccessor::GetString

(

)

const

References WsfL16::Messages::FieldAccessorType::Variant::mString.

Referenced by WsfL16::Messages::Base::PrintWord().

GetType()

FieldAccessor::DataType WsfL16::Messages::FieldAccessor::GetType

(

)

const

Referenced by WsfL16::Messages::Base::PrintWord().

GetUnits()

bool WsfL16::Messages::FieldAccessor::GetUnits

(

std::string &

aUnitsType

)

const

Returns a string specifying the human-readable units type used in this field by default.

Referenced by WsfL16::Messages::Base::PrintWord().

IsDisused()

bool WsfL16::Messages::FieldAccessor::IsDisused

(

)

const

Returns 'true' if this is a disused field.

Referenced by WsfL16::Messages::Base::PrintWord().

IsNoStatement()

bool WsfL16::Messages::FieldAccessor::IsNoStatement

(

)

const

Returns 'true' if the field contains a value meaning 'no statement' Returns 'false' otherwise

References GetRawData().

Referenced by WsfL16::Messages::Base::PrintWord().

IsSpare()

bool WsfL16::Messages::FieldAccessor::IsSpare

(

)

const

Returns 'true' if this is a spare field.

Referenced by WsfL16::Messages::Base::PrintWord().

Set() [1/4]

void WsfL16::Messages::FieldAccessor::Set

(

bool

aValue

)

References WsfL16::Messages::FieldAccessorType::Variant::mBoolean.

Set() [2/4]

void WsfL16::Messages::FieldAccessor::Set

(

const std::string &

aValue

)

References WsfL16::Messages::FieldAccessorType::Variant::mString.

Set() [3/4]

void WsfL16::Messages::FieldAccessor::Set

(

double

aValue

)

References WsfL16::Messages::FieldAccessorType::Variant::mDouble.

Set() [4/4]

void WsfL16::Messages::FieldAccessor::Set

(

int

aValue

)

References WsfL16::Messages::FieldAccessorType::Variant::mInteger.

SetNoStatement()

void WsfL16::Messages::FieldAccessor::SetNoStatement

(

)

If this field has a no statement value, it is set to no statement.

References SetRawData().

SetRawData()

void WsfL16::Messages::FieldAccessor::SetRawData

(

int

aValue

)

Referenced by SetNoStatement().

---

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

• MessageAccessor.hpp
• MessageAccessor.cpp