DtActiveSonarEncoder Class Reference

class DtActiveSonarEncoder More...

Inheritance diagram for DtActiveSonarEncoder:

Collaboration diagram for DtActiveSonarEncoder:

Public Member Functions
	DtActiveSonarEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Default constructor.
virtual	~DtActiveSonarEncoder ()
	Destructor.
	DtActiveSonarEncoder (const DtActiveSonarEncoder &orig)
	Copy constructor.
DtActiveSonarEncoder &	operator= (const DtActiveSonarEncoder &orig)
	Assignment operator.
Public Member Functions inherited from DtUnderwaterAcousticsEmissionEncoder
	DtUnderwaterAcousticsEmissionEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Default constructor.
virtual	~DtUnderwaterAcousticsEmissionEncoder ()
	Destructor.
	DtUnderwaterAcousticsEmissionEncoder (const DtUnderwaterAcousticsEmissionEncoder &orig)
	Copy constructor.
DtUnderwaterAcousticsEmissionEncoder &	operator= (const DtUnderwaterAcousticsEmissionEncoder &orig)
	Assignment operator.
Public Member Functions inherited from DtBaseEmbeddedSystemEncoder
	DtBaseEmbeddedSystemEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	default constructor
virtual	~DtBaseEmbeddedSystemEncoder ()
	destructor
	DtBaseEmbeddedSystemEncoder (const DtBaseEmbeddedSystemEncoder &orig)
	copy constructor
DtBaseEmbeddedSystemEncoder &	operator= (const DtBaseEmbeddedSystemEncoder &orig)
	assignment operator
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)

Static Public Member Functions
static DtHlaStateEncoder *	create (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Function that creates a DtActiveSonarEncoder.

Static Protected Member Functions
static bool	needAcousticName (const DtActiveSonarStateRepository &stateRep, const DtActiveSonarStateRepository &asSeenByRemote)
	Return true if AcousticName needs to be sent to the network, false otherwise.
static bool	needFunctionCode (const DtActiveSonarStateRepository &stateRep, const DtActiveSonarStateRepository &asSeenByRemote)
	Return true if FunctionCode needs to be sent to the network, false otherwise.
static bool	needAcousticsIdentifier (const DtActiveSonarStateRepository &stateRep, const DtActiveSonarStateRepository &asSeenByRemote)
	Return true if AcousticsIdentifier needs to be sent to the network, false otherwise.
static void	encodeAcousticName (const DtActiveSonarStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes AcousticName from rep into attrs.
static void	encodeFunctionCode (const DtActiveSonarStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes FunctionCode from rep into attrs.
static void	encodeAcousticsIdentifier (const DtActiveSonarStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes AcousticsIdentifier from rep into attrs.
Static Protected Member Functions inherited from DtUnderwaterAcousticsEmissionEncoder
static bool	needEventIdentifier (const DtUnderwaterAcousticsEmissionRepository &stateRep, const DtUnderwaterAcousticsEmissionRepository &asSeenByRemote)
	Return true if EventIdentifier needs to be sent to the network, false otherwise.
static void	encodeEventIdentifier (const DtUnderwaterAcousticsEmissionRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes EventIdentifier from rep into attrs.

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.
Protected Member Functions inherited from DtBaseEmbeddedSystemEncoder
	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (RelativePosition)
	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (EntityID)
	for version <= 0.8
	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (HostObjectID)
	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (EntityIdentifier)
	for version > 0.8
	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (HostObjectIdentifier)
	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (RelativePosition)
	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (EntityID)
	for version <= 0.8
	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (HostObjectID)
	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (EntityIdentifier)
	for version > 0.8
	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (HostObjectIdentifier)
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

class DtActiveSonarEncoder

Instances of DtActiveSonarEncoder encode data from DtActiveSonarStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

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

Default constructor.

virtual DtActiveSonarEncoder::~DtActiveSonarEncoder ( )

virtual

Destructor.

DtActiveSonarEncoder::DtActiveSonarEncoder

(

const DtActiveSonarEncoder &

orig

)

Copy constructor.

Member Function Documentation

static DtHlaStateEncoder* DtActiveSonarEncoder::create ( DtExerciseConn *  exConn, DtObjClassDesc *  classDesc  )

static

Function that creates a DtActiveSonarEncoder.

Reimplemented from DtUnderwaterAcousticsEmissionEncoder.

static void DtActiveSonarEncoder::encodeAcousticName ( const DtActiveSonarStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes AcousticName from rep into attrs.

static void DtActiveSonarEncoder::encodeAcousticsIdentifier ( const DtActiveSonarStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes AcousticsIdentifier from rep into attrs.

static void DtActiveSonarEncoder::encodeFunctionCode ( const DtActiveSonarStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes FunctionCode from rep into attrs.

static bool DtActiveSonarEncoder::needAcousticName ( const DtActiveSonarStateRepository &  stateRep, const DtActiveSonarStateRepository &  asSeenByRemote  )

staticprotected

Return true if AcousticName needs to be sent to the network, false otherwise.

static bool DtActiveSonarEncoder::needAcousticsIdentifier ( const DtActiveSonarStateRepository &  stateRep, const DtActiveSonarStateRepository &  asSeenByRemote  )

staticprotected

Return true if AcousticsIdentifier needs to be sent to the network, false otherwise.

static bool DtActiveSonarEncoder::needFunctionCode ( const DtActiveSonarStateRepository &  stateRep, const DtActiveSonarStateRepository &  asSeenByRemote  )

staticprotected

Return true if FunctionCode needs to be sent to the network, false otherwise.

DtActiveSonarEncoder& DtActiveSonarEncoder::operator=

(

const DtActiveSonarEncoder &

orig

)

Assignment operator.

---

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

• activeSonarEncoderHLA.h