DtHlaStateDecoder Class Reference

DtHlaStateDecoder is used to provide decoding of a state message into a state repository in an HLA (as opposed to DIS) environment. More...

Inheritance diagram for DtHlaStateDecoder:

Collaboration diagram for DtHlaStateDecoder:

Public Types
typedef void(*	DtAttributeDecoder )(DtStateRepository *stateRep, const RTI::AttributeHandleValuePairSet &avlist, unsigned long pairSetIndex)
	Attribute decoding function declaration. More...

Public Member Functions
	DtHlaStateDecoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	constructor More...
virtual	~DtHlaStateDecoder ()
	destructor More...
	DtHlaStateDecoder (const DtHlaStateDecoder &orig)
	copy constructor More...
DtHlaStateDecoder &	operator= (const DtHlaStateDecoder &orig)
	assignment operator More...
DtAttributeDecoder	addDecoder (RTI::AttributeHandle h, DtAttributeDecoder func)
	Add/Remove a decoding function for the attribute specified by handle. More...
DtAttributeDecoder	removeDecoder (RTI::AttributeHandle h)
DtAttributeDecoder	addDecoder (char *attrName, DtAttributeDecoder func, bool complain=true)
	Add/Remove a decoding function for the attribute specified by name. More...
DtAttributeDecoder	removeDecoder (char *attrName, bool complain=true)
virtual DtAttributeDecoder	decoder (const RTI::AttributeHandle &handle) const
	Get the attribute decoder for the specified handle. More...
virtual void	decode (const DtStateMsg &msg, DtStateRepository *stateRep) const
	Decode the state message into the state repository. More...
virtual RTI::ObjectClassHandle	objectClassHandle () const
	Get the object's class handle. More...
virtual DtHlaStateDecoder *	clone () const
	Returns a new-ed clone of this object. More...
virtual DtHlaStateDecoder *	clone (DtObjClassDesc *classDesc) const
	Returns a new-ed clone of this object which corresponds to the class description classDesc. More...

Static Public Member Functions
static char *	decodingBuffer (int length)
	Returns a pointer to a buffer that can be used to copy data obtained from a phvps. More...
static char *	attributeData (const RTI::AttributeHandleValuePairSet &attrs, int index, RTI::ULong &length)
	Returns a pointer to the attribute data. More...
static char *	attributeData (const RTI::AttributeHandleValuePairSet &attrs, int index, RTI::ULong &length, unsigned int expectedDataSize, char *attrName)
	Gets the attribute data and checks the expected size. More...
static DtNetEventId *	eventIdAttributeData (const RTI::AttributeHandleValuePairSet &attrs, int index)
	Get the attribute data as a DtNetEventId (adds defensive null terminator) Returns a pointer to the attribute data. More...
static std::wstring	wideStringFromHlaUnicodeString (char *buffer, int size, bool *error=nullptr)
	Gets data from an incoming buffer as a HlaUnicodeString and decodes it as a wide string. More...
static bool	getVectorFromArrayOfUuid (char *buffer, int size, std::vector< DtVrlUuid > &uuids)
	Gets data from an incoming buffer as an ArrayOfUuid and decodes it as a vector of type DtVrlUuid. More...

Static Public Attributes
static bool	theUseGetValuePointer

Protected Types
typedef std::map < RTI::AttributeHandle, DtAttributeDecoder >	AttributeHandleDecoderMap
typedef std::map < RTI::AttributeHandle, bool >	AttributeHandleBoolMap

Protected Member Functions
virtual void	decodeAttribute (DtStateRepository *stateRep, const RTI::AttributeHandleValuePairSet &attrs, unsigned long pairSetIndex) const
	Decode the attribute at the specified index in the attribute handle pair set. More...
virtual void	copyDecFuncs (const DtHlaStateDecoder &orig)

Protected Attributes
DtExerciseConn *	myExConn
DtObjClassDesc *	myClassDesc
RTI::ObjectClassHandle	myHandle
AttributeHandleDecoderMap	myDecoderList
	myDecoderList is a map of decoders for each attribute registered to this state. More...

Private Attributes
AttributeHandleBoolMap	myMutableReportedWarning
	myReportedWarnings is an array for keeping track of which warnings have been already issued. More...

Detailed Description

DtHlaStateDecoder is used to provide decoding of a state message into a state repository in an HLA (as opposed to DIS) environment.

Member Typedef Documentation

typedef std::map<RTI::AttributeHandle, bool> DtHlaStateDecoder::AttributeHandleBoolMap

protected

typedef std::map<RTI::AttributeHandle, DtAttributeDecoder> DtHlaStateDecoder::AttributeHandleDecoderMap

protected

typedef void(* DtHlaStateDecoder::DtAttributeDecoder)(DtStateRepository *stateRep, const RTI::AttributeHandleValuePairSet &avlist, unsigned long pairSetIndex)

Attribute decoding function declaration.

Constructor & Destructor Documentation

DtHlaStateDecoder::DtHlaStateDecoder	(	DtExerciseConn *	exConn,
		DtObjClassDesc *	classDesc
	)

constructor

virtual DtHlaStateDecoder::~DtHlaStateDecoder ( )

virtual

destructor

DtHlaStateDecoder::DtHlaStateDecoder

(

const DtHlaStateDecoder &

orig

)

copy constructor

Member Function Documentation

DtAttributeDecoder DtHlaStateDecoder::addDecoder	(	RTI::AttributeHandle	h,
		DtAttributeDecoder	func
	)

Add/Remove a decoding function for the attribute specified by handle.

Returns the decoding function which is replaced by the add/remove. Note: This is non-virtual, since it is typically called by constructors.

Referenced by DtF18EntityDecoder::DtF18EntityDecoder().

DtAttributeDecoder DtHlaStateDecoder::addDecoder	(	char *	attrName,
		DtAttributeDecoder	func,
		bool	complain = true
	)

Add/Remove a decoding function for the attribute specified by name.

Complain flag determines whether to print a warning if the attribute does not exist in the FOM. Returns the decoding function which is replaced by the add/remove. Note: This is non-virtual, since it is typically called by constructors.

char * DtHlaStateDecoder::attributeData ( const RTI::AttributeHandleValuePairSet &  attrs, int  index, RTI::ULong &  length  )

inlinestatic

Returns a pointer to the attribute data.

References decodingBuffer(), and theUseGetValuePointer.

char * DtHlaStateDecoder::attributeData ( const RTI::AttributeHandleValuePairSet &  attrs, int  index, RTI::ULong &  length, unsigned int  expectedDataSize, char *  attrName  )

inlinestatic

Gets the attribute data and checks the expected size.

If the data length is too small, no data is collected (0 returned and length set to 0) and a warning is printed. A message is printed if the data length is too large. Returns a pointer to the attribute data (or 0 if length < expected size).

References decodingBuffer(), DtNlVerbose, DtNotifyLevel, DtVerbose, DtWarn, and theUseGetValuePointer.

virtual DtHlaStateDecoder* DtHlaStateDecoder::clone ( ) const

virtual

Returns a new-ed clone of this object.

Reimplemented in DtBaseEntityDecoder.

virtual DtHlaStateDecoder* DtHlaStateDecoder::clone ( DtObjClassDesc *  classDesc ) const

virtual

Returns a new-ed clone of this object which corresponds to the class description classDesc.

Use this function if you want a subclass in the FOM to use the same decoder as its parent

Reimplemented in DtBaseEntityDecoder.

virtual void DtHlaStateDecoder::copyDecFuncs ( const DtHlaStateDecoder &  orig )

protectedvirtual

virtual void DtHlaStateDecoder::decode ( const DtStateMsg &  msg, DtStateRepository *  stateRep  ) const

virtual

Decode the state message into the state repository.

Reimplemented in DtBaseEntityDecoder, and DtPhysicalEntityDecoder.

virtual void DtHlaStateDecoder::decodeAttribute ( DtStateRepository *  stateRep, const RTI::AttributeHandleValuePairSet &  attrs, unsigned long  pairSetIndex  ) const

protectedvirtual

Decode the attribute at the specified index in the attribute handle pair set.

DtHlaStateDecoder::DtAttributeDecoder DtHlaStateDecoder::decoder ( const RTI::AttributeHandle &  handle ) const

inlinevirtual

Get the attribute decoder for the specified handle.

References myDecoderList.

char * DtHlaStateDecoder::decodingBuffer ( int  length )

inlinestatic

Returns a pointer to a buffer that can be used to copy data obtained from a phvps.

If the buffer isn't large enough to contain the data, more space will be allocated to it.

References DtDecodingBuffer().

Referenced by attributeData(), and eventIdAttributeData().

DtNetEventId * DtHlaStateDecoder::eventIdAttributeData ( const RTI::AttributeHandleValuePairSet &  attrs, int  index  )

inlinestatic

Get the attribute data as a DtNetEventId (adds defensive null terminator) Returns a pointer to the attribute data.

References decodingBuffer().

static bool DtHlaStateDecoder::getVectorFromArrayOfUuid ( char *  buffer, int  size, std::vector< DtVrlUuid > &  uuids  )

static

Gets data from an incoming buffer as an ArrayOfUuid and decodes it as a vector of type DtVrlUuid.

If it's a bad decoding, an error is printed and an empty vector is returned, and if provided, the error code is set to true.

RTI::ObjectClassHandle DtHlaStateDecoder::objectClassHandle ( ) const

inlinevirtual

Get the object's class handle.

References myHandle.

DtHlaStateDecoder& DtHlaStateDecoder::operator=

(

const DtHlaStateDecoder &

orig

)

assignment operator

DtAttributeDecoder DtHlaStateDecoder::removeDecoder

(

RTI::AttributeHandle

h

)

DtAttributeDecoder DtHlaStateDecoder::removeDecoder	(	char *	attrName,
		bool	complain = true
	)

static std::wstring DtHlaStateDecoder::wideStringFromHlaUnicodeString ( char *  buffer, int  size, bool *  error = nullptr  )

static

Gets data from an incoming buffer as a HlaUnicodeString and decodes it as a wide string.

If it's a bad decoding, an error is printed and an empty string is returned, and if provided, the error code is set to true.

Member Data Documentation

DtObjClassDesc* DtHlaStateDecoder::myClassDesc

protected

AttributeHandleDecoderMap DtHlaStateDecoder::myDecoderList

protected

myDecoderList is a map of decoders for each attribute registered to this state.

Referenced by decoder().

DtExerciseConn* DtHlaStateDecoder::myExConn

protected

RTI::ObjectClassHandle DtHlaStateDecoder::myHandle

protected

Referenced by objectClassHandle().

AttributeHandleBoolMap DtHlaStateDecoder::myMutableReportedWarning

mutableprivate

myReportedWarnings is an array for keeping track of which warnings have been already issued.

This variable is set in const functions. The Decoders need to be const, but we would like to warn people only once.

bool DtHlaStateDecoder::theUseGetValuePointer

static

Referenced by attributeData().

---

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

• hlaStateDecoder.h