DtUnderwaterAcousticsStateRepository Class Reference

Instances of DtUnderwaterAcousticsStateRepository are used to store state data for all underwater acoustics objects for a given entity. More...

Inheritance diagram for DtUnderwaterAcousticsStateRepository:

Collaboration diagram for DtUnderwaterAcousticsStateRepository:

Public Types
typedef DtAdditionalPassiveActivitiesRepository *(*	DtApaStateRepCreator )()
	Function prototype for functions that create APA State Repositories. More...
typedef DtActiveSonarStateRepository *(*	DtActiveSonarStateRepCreator )()
	Function prototype for functions that create Active Sonar State Repositories. More...
Public Types inherited from DtStateRepository
typedef std::map< DtString, DtStateRepositoryExtension * >	DtStateRepositoryExtensionMap

Public Member Functions
	DtUnderwaterAcousticsStateRepository ()
	Constructor. More...
	DtUnderwaterAcousticsStateRepository (const DtUnderwaterAcousticsStateRepository &orig)
	Copy Constructor. More...
virtual	~DtUnderwaterAcousticsStateRepository ()
	Destructor. More...
DtUnderwaterAcousticsStateRepository &	operator= (const DtUnderwaterAcousticsStateRepository &orig)
	Assignment Operator. More...
virtual DtStateRepository *	clone (bool copy) const
	Return a copy/empty object of the same type as this. More...
virtual void	printData () const
	Print data to the DtInfo stream. More...
virtual void	printDataToStream (std::ostream &stream) const
	Print data to the specified stream. More...
General attribute mutators (overridden).
virtual void	setEntityId (const DtEntityIdentifier &id)
	Entity id setter (overridden to update subobjects too). More...
virtual void	setHostId (const DtGlobalObjectDesignator &id)
	Entity id setter (overridden to update subobjects too). More...
virtual void	setEventIdentifier (const DtEventId &id)
	Entity id setter (overridden to update subobjects too). More...
Shaft Propulsion Noise accessors & mutators
virtual void	setHullMaskerOn (bool val)
	Set the HullMaskerOn. More...
virtual bool	hullMaskerOn () const
	Get the HullMaskerOn. More...
virtual void	setPassiveParameterIndex (DtU16 val)
	Set the PassiveParameterIndex. More...
virtual DtU16	passiveParameterIndex () const
	Get the PassiveParameterIndex. More...
virtual void	setPropulsionPlantConfiguration (DtUnderwaterAcousticPropulsionPlantConfig val)
	Set the PropulsionPlantConfiguration. More...
virtual DtUnderwaterAcousticPropulsionPlantConfig	propulsionPlantConfiguration () const
	Get the PropulsionPlantConfiguration. More...
virtual void	setShaftRateData (const std::vector< DtUnderwaterAcousticShaftSpeed > &val)
	Set the ShaftRateData. More...
virtual const std::vector < DtUnderwaterAcousticShaftSpeed > &	shaftRateData () const
	Get the ShaftRateData. More...
virtual const DtPropulsionNoiseStateRepository &	propNoiseStateRep () const
	Accessors for the prop noise state rep (for direct read/write). More...
virtual DtPropulsionNoiseStateRepository &	propNoiseStateRep ()
	Set the HullMaskerOn. More...
Additional Passive Activities accessors & mutators.
virtual DtAdditionalPassiveActivitiesRepository *	apaSRById (DtU16 activityCode, DtApaRetCode *retcode=NULL)
	Return a pointer to the first APA with the specified activity code. More...
virtual DtAdditionalPassiveActivitiesRepository *	addApa (DtU16 activityCode=0, DtApaRetCode *retcode=NULL)
	Add/remove a new APA within this underwater acoustic object. More...
virtual DtApaRetCode	removeApa (DtU16 activityCode)
	Removes an APA, if there are duplicate APAs, it will remove the first APA with the given activity code. More...
virtual DtApaRetCode	removeApa (const DtGlobalObjectDesignator &id)
	Return a pointer to the first APA with the specified activity code. More...
virtual int	numAPAs () const
	Returns number of APAs. More...
virtual const DtList *	apaList () const
	Returns DtList of DtAdditionalPassiveActivitiesRepositories. More...
virtual DtList *	apaList ()
	Return a pointer to the first APA with the specified activity code. More...
bool	isMember (DtAdditionalPassiveActivitiesRepository *ssr) const
	Returns true if the given APA SR is in the list of APA SRs. More...
Active Sonar accessors & mutators.
virtual DtActiveSonarStateRepository *	activeSonarSRById (DtU8 acousticId, DtSonarSysRetCode *retcode=NULL)
	Return a pointer to the first active sonar with the specified id. More...
virtual DtActiveSonarStateRepository *	addActiveSonar (DtU8 acousticId=0, DtSonarSysRetCode *retcode=NULL)
	Add/remove a new active sonar within this underwater acoustic object. More...
virtual DtSonarSysRetCode	removeActiveSonar (DtU8 acousticId)
	Removes an active sonar, if there are duplicate sonars it will remove the first sonar with the given acoustic ID. More...
virtual DtSonarSysRetCode	removeActiveSonar (const DtGlobalObjectDesignator &id)
	Return a pointer to the first active sonar with the specified id. More...
virtual int	numActiveSonars () const
	Returns number of active sonars. More...
virtual const DtList *	activeSonarList () const
	Returns DtList of DtActiveSonarStateRepositories. More...
virtual DtList *	activeSonarList ()
	Return a pointer to the first active sonar with the specified id. More...
bool	isMember (DtActiveSonarStateRepository *ssr) const
	Returns true if the given active sonar SR is in the list of sonar SRs. More...
Public Member Functions inherited from DtUnderwaterAcousticsEmissionRepository
	DtUnderwaterAcousticsEmissionRepository ()
	Constructor. More...
virtual	~DtUnderwaterAcousticsEmissionRepository ()
	Destructor. More...
	DtUnderwaterAcousticsEmissionRepository (const DtUnderwaterAcousticsEmissionRepository &orig)
	Copy Constructor. More...
DtUnderwaterAcousticsEmissionRepository &	operator= (const DtUnderwaterAcousticsEmissionRepository &orig)
	Assignment Operator. More...
virtual const DtEventId &	eventIdentifier () const
	Get the EventIdentifier. More...
Public Member Functions inherited from DtEmbeddedSystemRepository
	DtEmbeddedSystemRepository ()
	default constructor More...
	DtEmbeddedSystemRepository (const DtEmbeddedSystemRepository &orig)
	copy constructor More...
virtual	~DtEmbeddedSystemRepository ()
	destructor More...
DtEmbeddedSystemRepository &	operator= (const DtEmbeddedSystemRepository &orig)
	assignment operator More...
virtual const DtEntityIdentifier &	entityId () const
	Get the entity identifier. More...
virtual const DtGlobalObjectDesignator &	hostId () const
	Get the host identifier. More...
virtual void	setRelativePosition (const DtVector32 &position)
	Set the position of the object relative to the entity. More...
virtual const DtVector32 &	relativePosition () const
	Get the position of the object relative to the entity. More...
Public Member Functions inherited from DtStateRepository
	DtStateRepository ()
	default constructor More...
	DtStateRepository (const DtStateRepository &orig)
	copy constructor More...
virtual	~DtStateRepository ()
	destructor More...
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator More...
virtual void	setGlobalId (const DtString &id)
	Get/Set global identifier, or name. More...
virtual const DtString &	globalId () const
virtual void	setLocalId (const DtObjectId &id)
	Get/Set local identifier, or handle. More...
virtual const DtObjectId &	localId () const
virtual bool	publishesAttribute (const RTI::AttributeHandle &val) const
	Returns true if the attribute is published. More...
virtual void	setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
	Set the attribute with the given handle. More...
virtual const char *	getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle. More...
virtual void	setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size, DtHlaObject *hlaObj)
	Set the attribute with the given name. Note that in order to do this you must provide a DtHlaObject. More...
virtual const char *	getAttributeByName (const DtString &attrName, unsigned &size, DtHlaObject *hlaObj) const
	Get a pointer to attribute value for the attribute with the given name. More...
virtual const char *	getAttributeByHandleIfUpdated (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle, but only if it's been updated since the last time we read it. More...
virtual DtStateRepositoryExtension *	stateRepositoryExtension (DtString srExtName) const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
virtual std::vector< DtString >	stateRepositoryExtensionNames () const
	Returns a set of the registered state repository extension names. More...
virtual void	setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...
virtual const std::map < DtString, DtStateRepositoryExtension * >	stateRepositoryExtensions () const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found. More...

Static Public Member Functions
static DtUnderwaterAcousticsStateRepository *	create ()
	Create a DtUnderwaterAcousticsStateRepository. More...
static DtActiveSonarStateRepCreator	setActiveSonarStateRepCreator (DtActiveSonarStateRepCreator creator)
	Give us a function to be used for creating active sonar SRs. More...
Static Public Member Functions inherited from DtUnderwaterAcousticsEmissionRepository
static DtUnderwaterAcousticsEmissionRepository *	create ()
	Create a DtUnderwaterAcousticsEmissionStateRepository. More...
Static Public Member Functions inherited from DtEmbeddedSystemRepository
static DtEmbeddedSystemRepository *	create ()
Static Public Member Functions inherited from DtStateRepository
static bool	addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
	The following functions are for extending state repositories through State Repository Extension classes. More...

Protected Member Functions
virtual void	purgeApaList ()
virtual void	purgeActiveSonarList ()

Protected Attributes
DtPropulsionNoiseStateRepository	myPropulsionNoiseState
	Propulsion noise state rep. More...
DtList	myAdditionalPassiveActivitiesList
	APA state rep. More...
DtList	myActiveSonarList
	List of active sonars in this system. More...
Protected Attributes inherited from DtUnderwaterAcousticsEmissionRepository
DtEventId	myEventIdentifier
Protected Attributes inherited from DtEmbeddedSystemRepository
DtEntityIdentifier	myEntityId
DtGlobalObjectDesignator	myHostId
DtVector32	myRelativePosition

Static Protected Attributes
static DtApaStateRepCreator	theApaStateRepCreator
static DtActiveSonarStateRepCreator	theActiveSonarStateRepCreator

Additional Inherited Members
Public Attributes inherited from DtStateRepository
DtString	myGlobalId
DtObjectId	myLocalId
std::map< RTI::AttributeHandle, DtGenericAttributeInfo * >	myAttributesByHandle
	Attributes by handle. More...
DtStateRepositoryExtensionMap	myStateRepositoryExtensionMap
Static Public Attributes inherited from DtStateRepository
static std::map< DtString, DtSrExtCreatorFnc >	theStateRepositoryExtensionCreatorMap

Detailed Description

Instances of DtUnderwaterAcousticsStateRepository are used to store state data for all underwater acoustics objects for a given entity.

Member Typedef Documentation

typedef DtActiveSonarStateRepository*(* DtUnderwaterAcousticsStateRepository::DtActiveSonarStateRepCreator)()

Function prototype for functions that create Active Sonar State Repositories.

typedef DtAdditionalPassiveActivitiesRepository*(* DtUnderwaterAcousticsStateRepository::DtApaStateRepCreator)()

Function prototype for functions that create APA State Repositories.

Constructor & Destructor Documentation

DtUnderwaterAcousticsStateRepository::DtUnderwaterAcousticsStateRepository

(

)

Constructor.

DtUnderwaterAcousticsStateRepository::DtUnderwaterAcousticsStateRepository

(

const DtUnderwaterAcousticsStateRepository &

orig

)

Copy Constructor.

virtual DtUnderwaterAcousticsStateRepository::~DtUnderwaterAcousticsStateRepository ( )

virtual

Destructor.

Member Function Documentation

virtual const DtList* DtUnderwaterAcousticsStateRepository::activeSonarList ( ) const

virtual

Returns DtList of DtActiveSonarStateRepositories.

virtual DtList* DtUnderwaterAcousticsStateRepository::activeSonarList ( )

virtual

Return a pointer to the first active sonar with the specified id.

virtual DtActiveSonarStateRepository* DtUnderwaterAcousticsStateRepository::activeSonarSRById ( DtU8  acousticId, DtSonarSysRetCode *  retcode = NULL  )

virtual

Return a pointer to the first active sonar with the specified id.

virtual DtActiveSonarStateRepository* DtUnderwaterAcousticsStateRepository::addActiveSonar ( DtU8  acousticId = 0, DtSonarSysRetCode *  retcode = NULL  )

virtual

Add/remove a new active sonar within this underwater acoustic object.

If you add an active sonar with a duplicate ID, retcode will be set to DtDuplicateSonar, and activeSonarSRById will return the first active sonar SR with the given ID.

virtual DtAdditionalPassiveActivitiesRepository* DtUnderwaterAcousticsStateRepository::addApa ( DtU16  activityCode = 0, DtApaRetCode *  retcode = NULL  )

virtual

Add/remove a new APA within this underwater acoustic object.

If you add an APA with a duplicate ID, retcode will be set to DtDuplicateApa, and addPassActSRById will return the first APA SR with the given ID.

virtual const DtList* DtUnderwaterAcousticsStateRepository::apaList ( ) const

virtual

Returns DtList of DtAdditionalPassiveActivitiesRepositories.

virtual DtList* DtUnderwaterAcousticsStateRepository::apaList ( )

virtual

Return a pointer to the first APA with the specified activity code.

virtual DtAdditionalPassiveActivitiesRepository* DtUnderwaterAcousticsStateRepository::apaSRById ( DtU16  activityCode, DtApaRetCode *  retcode = NULL  )

virtual

Return a pointer to the first APA with the specified activity code.

virtual DtStateRepository* DtUnderwaterAcousticsStateRepository::clone ( bool  copy ) const

virtual

Return a copy/empty object of the same type as this.

Reimplemented from DtUnderwaterAcousticsEmissionRepository.

static DtUnderwaterAcousticsStateRepository* DtUnderwaterAcousticsStateRepository::create ( )

static

Create a DtUnderwaterAcousticsStateRepository.

virtual bool DtUnderwaterAcousticsStateRepository::hullMaskerOn ( ) const

virtual

Get the HullMaskerOn.

bool DtUnderwaterAcousticsStateRepository::isMember

(

DtAdditionalPassiveActivitiesRepository *

ssr

)

const

Returns true if the given APA SR is in the list of APA SRs.

bool DtUnderwaterAcousticsStateRepository::isMember

(

DtActiveSonarStateRepository *

ssr

)

const

Returns true if the given active sonar SR is in the list of sonar SRs.

virtual int DtUnderwaterAcousticsStateRepository::numActiveSonars ( ) const

virtual

Returns number of active sonars.

virtual int DtUnderwaterAcousticsStateRepository::numAPAs ( ) const

virtual

Returns number of APAs.

DtUnderwaterAcousticsStateRepository& DtUnderwaterAcousticsStateRepository::operator=

(

const DtUnderwaterAcousticsStateRepository &

orig

)

Assignment Operator.

virtual DtU16 DtUnderwaterAcousticsStateRepository::passiveParameterIndex ( ) const

virtual

Get the PassiveParameterIndex.

virtual void DtUnderwaterAcousticsStateRepository::printData ( ) const

virtual

Print data to the DtInfo stream.

Reimplemented from DtUnderwaterAcousticsEmissionRepository.

virtual void DtUnderwaterAcousticsStateRepository::printDataToStream ( std::ostream &  stream ) const

virtual

Print data to the specified stream.

Reimplemented from DtUnderwaterAcousticsEmissionRepository.

virtual const DtPropulsionNoiseStateRepository& DtUnderwaterAcousticsStateRepository::propNoiseStateRep ( ) const

virtual

Accessors for the prop noise state rep (for direct read/write).

virtual DtPropulsionNoiseStateRepository& DtUnderwaterAcousticsStateRepository::propNoiseStateRep ( )

virtual

Set the HullMaskerOn.

virtual DtUnderwaterAcousticPropulsionPlantConfig DtUnderwaterAcousticsStateRepository::propulsionPlantConfiguration ( ) const

virtual

Get the PropulsionPlantConfiguration.

virtual void DtUnderwaterAcousticsStateRepository::purgeActiveSonarList ( )

protectedvirtual

virtual void DtUnderwaterAcousticsStateRepository::purgeApaList ( )

protectedvirtual

virtual DtSonarSysRetCode DtUnderwaterAcousticsStateRepository::removeActiveSonar ( DtU8  acousticId )

virtual

Removes an active sonar, if there are duplicate sonars it will remove the first sonar with the given acoustic ID.

This can cause crashes in HLA as this may not be the HLA object which was actually removed. It is safer in HLA to call removeActiveSonar which takes a GlobalId.

virtual DtSonarSysRetCode DtUnderwaterAcousticsStateRepository::removeActiveSonar ( const DtGlobalObjectDesignator &  id )

virtual

Return a pointer to the first active sonar with the specified id.

virtual DtApaRetCode DtUnderwaterAcousticsStateRepository::removeApa ( DtU16  activityCode )

virtual

Removes an APA, if there are duplicate APAs, it will remove the first APA with the given activity code.

This can cause crashes in HLA as this may not be the HLA object which was actually removed. It is safer in HLA to call removeApa which takes a GlobalId.

virtual DtApaRetCode DtUnderwaterAcousticsStateRepository::removeApa ( const DtGlobalObjectDesignator &  id )

virtual

Return a pointer to the first APA with the specified activity code.

static DtActiveSonarStateRepCreator DtUnderwaterAcousticsStateRepository::setActiveSonarStateRepCreator ( DtActiveSonarStateRepCreator  creator )

static

Give us a function to be used for creating active sonar SRs.

virtual void DtUnderwaterAcousticsStateRepository::setEntityId ( const DtEntityIdentifier &  id )

virtual

Entity id setter (overridden to update subobjects too).

Reimplemented from DtEmbeddedSystemRepository.

virtual void DtUnderwaterAcousticsStateRepository::setEventIdentifier ( const DtEventId &  id )

virtual

Entity id setter (overridden to update subobjects too).

Reimplemented from DtUnderwaterAcousticsEmissionRepository.

virtual void DtUnderwaterAcousticsStateRepository::setHostId ( const DtGlobalObjectDesignator &  id )

virtual

Entity id setter (overridden to update subobjects too).

Reimplemented from DtEmbeddedSystemRepository.

virtual void DtUnderwaterAcousticsStateRepository::setHullMaskerOn ( bool  val )

virtual

Set the HullMaskerOn.

virtual void DtUnderwaterAcousticsStateRepository::setPassiveParameterIndex ( DtU16  val )

virtual

Set the PassiveParameterIndex.

virtual void DtUnderwaterAcousticsStateRepository::setPropulsionPlantConfiguration ( DtUnderwaterAcousticPropulsionPlantConfig  val )

virtual

Set the PropulsionPlantConfiguration.

virtual void DtUnderwaterAcousticsStateRepository::setShaftRateData ( const std::vector< DtUnderwaterAcousticShaftSpeed > &  val )

virtual

Set the ShaftRateData.

virtual const std::vector<DtUnderwaterAcousticShaftSpeed>& DtUnderwaterAcousticsStateRepository::shaftRateData ( ) const

virtual

Get the ShaftRateData.

Member Data Documentation

DtList DtUnderwaterAcousticsStateRepository::myActiveSonarList

protected

List of active sonars in this system.

DtList DtUnderwaterAcousticsStateRepository::myAdditionalPassiveActivitiesList

protected

APA state rep.

DtPropulsionNoiseStateRepository DtUnderwaterAcousticsStateRepository::myPropulsionNoiseState

protected

Propulsion noise state rep.

DtActiveSonarStateRepCreator DtUnderwaterAcousticsStateRepository::theActiveSonarStateRepCreator

staticprotected

DtApaStateRepCreator DtUnderwaterAcousticsStateRepository::theApaStateRepCreator

staticprotected

---

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

• underwaterAcousticsStateRepository.h