DtPropulsionNoiseEncoder Class Reference

class DtPropulsionNoiseEncoder More...

Inheritance diagram for DtPropulsionNoiseEncoder:

Collaboration diagram for DtPropulsionNoiseEncoder:

Public Member Functions
	DtPropulsionNoiseEncoder (DtExerciseConn *exConn, DtObjClassDesc *classDesc)
	Default constructor.
virtual	~DtPropulsionNoiseEncoder ()
	Destructor.
	DtPropulsionNoiseEncoder (const DtPropulsionNoiseEncoder &orig)
	Copy constructor.
DtPropulsionNoiseEncoder &	operator= (const DtPropulsionNoiseEncoder &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)
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 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.

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

Static Protected Member Functions
static bool	needHullMaskerOn (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
	Return true if HullMaskerOn needs to be sent to the network, false otherwise.
static bool	needPassiveParameterIndex (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
	Return true if PassiveParameterIndex needs to be sent to the network, false otherwise.
static bool	needPropulsionPlantConfiguration (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
	Return true if PropulsionPlantConfiguration needs to be sent to the network, false otherwise.
static bool	needShaftRateData (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
	Return true if ShaftRateData needs to be sent to the network, false otherwise.
static void	encodeHullMaskerOn (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes HullMaskerOn from rep into attrs.
static void	encodePassiveParameterIndex (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes PassiveParameterIndex from rep into attrs.
static void	encodePropulsionPlantConfiguration (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes PropulsionPlantConfiguration from rep into attrs.
static void	encodeShaftRateData (const DtPropulsionNoiseStateRepository &rep, RTI::AttributeHandleValuePairSet *attrs, RTI::AttributeHandle attrHandle)
	Encodes ShaftRateData 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.
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::map< RTI::AttributeHandle, bool >	myReportedWarning
	myReportedWarning is an array for keeping track of which warnings have already been reported

Detailed Description

class DtPropulsionNoiseEncoder

Instances of DtPropulsionNoiseEncoder encode data from DtPropulsionNoiseStateRepository objects to the net structures to be sent to the network.

Constructor & Destructor Documentation

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

Default constructor.

virtual DtPropulsionNoiseEncoder::~DtPropulsionNoiseEncoder ( )

virtual

Destructor.

DtPropulsionNoiseEncoder::DtPropulsionNoiseEncoder

(

const DtPropulsionNoiseEncoder &

orig

)

Copy constructor.

Member Function Documentation

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

static

Function that creates a DtPropulsionNoiseEncoder.

Reimplemented from DtUnderwaterAcousticsEmissionEncoder.

static void DtPropulsionNoiseEncoder::encodeHullMaskerOn ( const DtPropulsionNoiseStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes HullMaskerOn from rep into attrs.

static void DtPropulsionNoiseEncoder::encodePassiveParameterIndex ( const DtPropulsionNoiseStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes PassiveParameterIndex from rep into attrs.

static void DtPropulsionNoiseEncoder::encodePropulsionPlantConfiguration ( const DtPropulsionNoiseStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes PropulsionPlantConfiguration from rep into attrs.

static void DtPropulsionNoiseEncoder::encodeShaftRateData ( const DtPropulsionNoiseStateRepository &  rep, RTI::AttributeHandleValuePairSet *  attrs, RTI::AttributeHandle  attrHandle  )

staticprotected

Encodes ShaftRateData from rep into attrs.

static bool DtPropulsionNoiseEncoder::needHullMaskerOn ( const DtPropulsionNoiseStateRepository &  stateRep, const DtPropulsionNoiseStateRepository &  asSeenByRemote  )

staticprotected

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

static bool DtPropulsionNoiseEncoder::needPassiveParameterIndex ( const DtPropulsionNoiseStateRepository &  stateRep, const DtPropulsionNoiseStateRepository &  asSeenByRemote  )

staticprotected

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

static bool DtPropulsionNoiseEncoder::needPropulsionPlantConfiguration ( const DtPropulsionNoiseStateRepository &  stateRep, const DtPropulsionNoiseStateRepository &  asSeenByRemote  )

staticprotected

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

static bool DtPropulsionNoiseEncoder::needShaftRateData ( const DtPropulsionNoiseStateRepository &  stateRep, const DtPropulsionNoiseStateRepository &  asSeenByRemote  )

staticprotected

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

DtPropulsionNoiseEncoder& DtPropulsionNoiseEncoder::operator=

(

const DtPropulsionNoiseEncoder &

orig

)

Assignment operator.

---

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

• hPropNoiseEnc.h