VehicleEncoder Class Reference

A simple FOM encoder class. More...

Inheritance diagram for VehicleEncoder:

Collaboration diagram for VehicleEncoder:

Public Member Functions
	VehicleEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
virtual	~VehicleEncoder ()
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)
DtAttributeEncoder	encoder (const RTI::AttributeHandle &handle)
	Get the attribute encoder for the specified handle.
DtAttributeChecker	checker (const RTI::AttributeHandle &handle)
	Get the attribute checker for the specified handle.
virtual void	encode (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, const RTI::AttributeHandleSet &neededAttrs, const RTI::AttributeHandleSet &includeThese, DtStateMsg *msg)
	Encode necessary values from the state repository.
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.
virtual void	preCalculateEligible (const RTI::AttributeHandleSet &neededAttrs)

Protected Member Functions
	DtDECLARE_TEST_ATTR_ENCODER (VehicleType)
	DtDECLARE_TEST_ATTR_ENCODER (GeocLoc)
	DtDECLARE_TEST_ATTR_CHECKER (VehicleType)
	DtDECLARE_TEST_ATTR_CHECKER (GeocLoc)

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.
typedef bool(*	DtAttributeCheckerWithHandle )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote, RTI::AttributeHandle handle)
	Attribute checking function declaration that takes a handle and checks the specific attribute pointed to by that handle.
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::vector< DtAttributeChecker >	myCheckerCache
	This is a helper varaible that pre-lookups decoder functions in order to avoid making map calls on every update.
const RTI::AttributeHandleSet *	myCachedSet
std::map< RTI::AttributeHandle, bool >	myReportedWarning
	myReportedWarning is an array for keeping track of which warnings have already been reported

Detailed Description

A simple FOM encoder class.

This class is part of the myFomMap Example.

Constructor & Destructor Documentation

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

virtual VehicleEncoder::~VehicleEncoder ( )

virtual

Member Function Documentation

VehicleEncoder::DtDECLARE_TEST_ATTR_CHECKER ( VehicleType  )

protected

VehicleEncoder::DtDECLARE_TEST_ATTR_CHECKER ( GeocLoc  )

protected

VehicleEncoder::DtDECLARE_TEST_ATTR_ENCODER ( VehicleType  )

protected

VehicleEncoder::DtDECLARE_TEST_ATTR_ENCODER ( GeocLoc  )

protected

---

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

• vehicleEnc.h