DtGenericObjectEncoder Class Reference

The DtGenericObjectEncoder class - the encoder used by DtGenericObjectPublisher. More...

Inheritance diagram for DtGenericObjectEncoder:

Collaboration diagram for DtGenericObjectEncoder:

Public Member Functions
	DtGenericObjectEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	default constructor
virtual	~DtGenericObjectEncoder ()
	destructor
virtual void	encode (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, const RTI::AttributeHandleSet &eligibleAttrs, const RTI::AttributeHandleSet &requiredAttrs, DtStateMsg *msg)
	Encode necessary values from the state repository.
Public Member Functions inherited from DtHlaStateEncoder
	DtHlaStateEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	constructor
virtual	~DtHlaStateEncoder ()
	destructor
	DtHlaStateEncoder (const DtHlaStateEncoder &orig)
	copy constructor
DtHlaStateEncoder &	operator= (const DtHlaStateEncoder &orig)
	assignment operator
DtAttributeEncoder	addEncoder (RTI::AttributeHandle hand, DtAttributeEncoder func)
	Add/Remove an encoding function for the attribute specified by handle.
DtAttributeEncoder	removeEncoder (RTI::AttributeHandle hand)
DtAttributeEncoder	addEncoder (char *name, DtAttributeEncoder func, bool complain=true)
	Add/Remove an encoding function for the attribute specified by name.
DtAttributeEncoder	removeEncoder (char *name, bool complain=true)
DtAttributeChecker	addChecker (RTI::AttributeHandle hand, DtAttributeChecker func)
	Add/Remove a checker function for the attribute specified by handle.
DtAttributeChecker	removeChecker (RTI::AttributeHandle hand)
DtAttributeChecker	addChecker (char *name, DtAttributeChecker func, bool complain=true)
	Add/Remove a checker function for the attribute specified by name.
DtAttributeChecker	removeChecker (char *name, bool complain=true)
virtual DtAttributeEncoder	encoder (const RTI::AttributeHandle &handle)
	Get the attribute encoder for the specified handle.
virtual DtAttributeChecker	checker (const RTI::AttributeHandle &handle)
	Get the attribute checker for the specified handle.
virtual RTI::ObjectClassHandle	objectClassHandle ()
	Get the object's class handle.
virtual DtHlaStateEncoder *	clone (DtObjClassDesc *classDesc) const
	Returns a new-ed clone of this object which corresponds to the class description classDesc.
virtual DtHlaStateEncoder *	clone () const
	Returns a new-ed clone of this object.

Protected Member Functions
virtual bool	valueDiffers (const DtGenericStateRepository &stateRep, const DtGenericStateRepository &asSeenByRemote, RTI::AttributeHandle handle)

Additional Inherited Members
Public Types inherited from DtHlaStateEncoder
typedef void(*	DtAttributeEncoder )(const DtStateRepository &stateRep, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle handle)
	Attribute encoding function declaration.
typedef bool(*	DtAttributeChecker )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
	Attribute checking function declaration.
Static Public Member Functions inherited from DtHlaStateEncoder
static bool	trueChecker (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
	A checker function that always returns 1, meaning that the attribute for which it is being used will be deemed necessary to send on every tick.
static bool	falseChecker (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
	A checker function that always returns 0, meaning that the attribute for which it is being used will never be deemed necessary to send.
Protected Attributes inherited from DtHlaStateEncoder
DtExerciseConn *	myExConn
DtObjClassDesc *	myClassDesc
RTI::ObjectClassHandle	myHandle
std::map< RTI::AttributeHandle, DtAttributeEncoder >	myEncoderList
	myEncoderList and myCheckerList are arrays of classDesc->maxAttrHandle() items.
std::map< RTI::AttributeHandle, DtAttributeChecker >	myCheckerList
std::map< RTI::AttributeHandle, bool >	myReportedWarning
	myReportedWarning is an array for keeping track of which warnings have already been reported

Detailed Description

The DtGenericObjectEncoder class - the encoder used by DtGenericObjectPublisher.

Constructor & Destructor Documentation

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

default constructor

virtual DtGenericObjectEncoder::~DtGenericObjectEncoder ( )

virtual

destructor

Member Function Documentation

virtual void DtGenericObjectEncoder::encode ( const DtStateRepository &  stateRep, const DtStateRepository &  asSeenByRemote, const RTI::AttributeHandleSet &  eligibleAttrs, const RTI::AttributeHandleSet &  requiredAttrs, DtStateMsg *  msg  )

virtual

Encode necessary values from the state repository.

The second state repository represents what is seen by remote simulators and is used to determine when things need to be sent in the state message. includeThese is a set of attributes that should be included even if their thresholds have not been exceeded. This DtGenericObjectEncoder assumes an update condition of "OnChange" for all attributes.

Reimplemented from DtHlaStateEncoder.

virtual bool DtGenericObjectEncoder::valueDiffers ( const DtGenericStateRepository &  stateRep, const DtGenericStateRepository &  asSeenByRemote, RTI::AttributeHandle  handle  )

protectedvirtual

---

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

• genericEnc.h