Inheritance diagram for DtActiveSonarEncoder:

Collaboration diagram for DtActiveSonarEncoder:

Public Member Functions
	DtActiveSonarEncoder (DtExerciseConn exConn, DtObjClassDesc classDesc)
	Default constructor. More...

virtual	~DtActiveSonarEncoder ()
	Destructor. More...

	DtActiveSonarEncoder (const DtActiveSonarEncoder &orig)
	Copy constructor. More...

DtActiveSonarEncoder &	operator= (const DtActiveSonarEncoder &orig)
	Assignment operator. More...

Public Member Functions inherited from DtUnderwaterAcousticsEmissionEncoder
	DtUnderwaterAcousticsEmissionEncoder (DtExerciseConn exConn, DtObjClassDesc classDesc)
	Default constructor. More...

virtual	~DtUnderwaterAcousticsEmissionEncoder ()
	Destructor. More...

	DtUnderwaterAcousticsEmissionEncoder (const DtUnderwaterAcousticsEmissionEncoder &orig)
	Copy constructor. More...

DtUnderwaterAcousticsEmissionEncoder &	operator= (const DtUnderwaterAcousticsEmissionEncoder &orig)
	Assignment operator. More...

Public Member Functions inherited from DtBaseEmbeddedSystemEncoder
	DtBaseEmbeddedSystemEncoder (DtExerciseConn exConn, DtObjClassDesc classDesc)
	default constructor More...

virtual	~DtBaseEmbeddedSystemEncoder ()
	destructor More...

	DtBaseEmbeddedSystemEncoder (const DtBaseEmbeddedSystemEncoder &orig)
	copy constructor More...

DtBaseEmbeddedSystemEncoder &	operator= (const DtBaseEmbeddedSystemEncoder &orig)
	assignment operator More...

Public Member Functions inherited from DtHlaStateEncoder
	DtHlaStateEncoder (DtExerciseConn exConn, DtObjClassDesc classDesc)
	constructor More...

virtual	~DtHlaStateEncoder ()
	destructor More...

	DtHlaStateEncoder (const DtHlaStateEncoder &orig)
	copy constructor More...

DtHlaStateEncoder &	operator= (const DtHlaStateEncoder &orig)
	assignment operator More...

DtAttributeEncoder	addEncoder (RTI::AttributeHandle hand, DtAttributeEncoder func)
	Add/Remove an encoding function for the attribute specified by handle. More...

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. More...

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. More...

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. More...

DtAttributeChecker	removeChecker (char *name, bool complain=true)

DtAttributeEncoder	encoder (const RTI::AttributeHandle &handle)
	Get the attribute encoder for the specified handle. More...

DtAttributeChecker	checker (const RTI::AttributeHandle &handle)
	Get the attribute checker for the specified handle. More...

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. More...

virtual RTI::ObjectClassHandle	objectClassHandle ()
	Get the object's class handle. More...

virtual DtHlaStateEncoder *	clone (DtObjClassDesc *classDesc) const
	Returns a new-ed clone of this object which corresponds to the class description classDesc. More...

virtual DtHlaStateEncoder *	clone () const
	Returns a new-ed clone of this object. More...

virtual void	preCalculateEligible (const RTI::AttributeHandleSet &neededAttrs)

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

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

Static Public Member Functions inherited from DtBaseEmbeddedSystemEncoder
static DtHlaStateEncoder *	create (DtExerciseConn exConn, DtObjClassDesc classDesc)
	Create a DtBaseEntityEncoder. Caller is responsible for deletion. More...

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. More...

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. More...

static void	wideStringToHlaUnicodeString (const std::wstring &wideString, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle attrHandle)
	Puts a unicode widestring into a buffer of the appropriate size and adds it to the attribute value list with it's attribute handle. More...

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. More...

static bool	needFunctionCode (const DtActiveSonarStateRepository &stateRep, const DtActiveSonarStateRepository &asSeenByRemote)
	Return true if FunctionCode needs to be sent to the network, false otherwise. More...

static bool	needAcousticsIdentifier (const DtActiveSonarStateRepository &stateRep, const DtActiveSonarStateRepository &asSeenByRemote)
	Return true if AcousticsIdentifier needs to be sent to the network, false otherwise. More...

static void	encodeAcousticName (const DtActiveSonarStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes AcousticName from rep into attrs. More...

static void	encodeFunctionCode (const DtActiveSonarStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes FunctionCode from rep into attrs. More...

static void	encodeAcousticsIdentifier (const DtActiveSonarStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes AcousticsIdentifier from rep into attrs. More...

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. More...

static void	encodeEventIdentifier (const DtUnderwaterAcousticsEmissionRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes EventIdentifier from rep into attrs. More...

Additional Inherited Members
Public Types inherited from DtHlaStateEncoder
typedef void(*	DtAttributeEncoder )(const DtStateRepository &stateRep, RTI::AttributeHandleValuePairSet *avList, RTI::AttributeHandle handle)
	Attribute encoding function declaration. More...

typedef bool(*	DtAttributeChecker )(const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
	Attribute checking function declaration. More...

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. More...

Protected Member Functions inherited from DtBaseEmbeddedSystemEncoder
	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (RelativePosition)

	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (EntityID)
	for version <= 0.8 More...

	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (HostObjectID)

	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (EntityIdentifier)
	for version > 0.8 More...

	DtDECLARE_BASE_EMBEDSYS_ATTR_CHECKER (HostObjectIdentifier)

	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (RelativePosition)

	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (EntityID)
	for version <= 0.8 More...

	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (HostObjectID)

	DtDECLARE_BASE_EMBEDSYS_ATTR_ENCODER (EntityIdentifier)
	for version > 0.8 More...

	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. More...

std::map< RTI::AttributeHandle, DtAttributeChecker >	myCheckerList

std::vector< DtAttributeChecker >	myCheckerCache
	This is a helper variable that pre-lookups decoder functions in order to avoid making map calls on every update. More...

const RTI::AttributeHandleSet *	myCachedSet

std::map< RTI::AttributeHandle, bool >	myReportedWarning
	myReportedWarning is an array for keeping track of which warnings have already been reported More...

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.

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

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation