DtActiveSonarStateRepository Class Reference

class DtActiveSonarStateRepository More...

Inheritance diagram for DtActiveSonarStateRepository:

Collaboration diagram for DtActiveSonarStateRepository:

Public Types
typedef DtActiveSonarBeamRepository *(*	DtBeamStateRepCreator )()
	Function prototype for functions that create Beam State Repositories.

Public Member Functions
	DtActiveSonarStateRepository ()
	Constructor.
virtual	~DtActiveSonarStateRepository ()
	Destructor.
	DtActiveSonarStateRepository (const DtActiveSonarStateRepository &orig)
	Copy Constructor.
DtActiveSonarStateRepository &	operator= (const DtActiveSonarStateRepository &orig)
	Assignment Operator.
virtual DtStateRepository *	clone (bool copy) const
	Return a copy/empty object of the same type as this.
virtual void	printData () const
	Print data to the DtInfo stream.
virtual void	printDataToStream (std::ostream &stream) const
	Print data to the specified stream.
virtual void	setAcousticName (DtUnderwaterAcousticSystemName val)
	Set the AcousticName.
virtual DtUnderwaterAcousticSystemName	acousticName () const
	Get the AcousticName.
virtual void	setFunctionCode (DtUnderwaterAcousticFunction val)
	Set the FunctionCode.
virtual DtUnderwaterAcousticFunction	functionCode () const
	Get the FunctionCode.
virtual void	setAcousticsIdentifier (DtU8 val)
	Set the AcousticsIdentifier.
virtual DtU8	acousticsIdentifier () const
	Get the AcousticsIdentifier.
virtual DtActiveSonarBeamRepository *	beamSRById (DtU8 beamId, DtSonarBeamRetCode *retcode=NULL)
	Return a pointer to the first BeamSR with specified beamID.
virtual DtActiveSonarBeamRepository *	addBeam (DtU8 beamId=0, DtSonarBeamRetCode *retcode=NULL)
	Add/remove a new emitter beam within this system.
virtual DtSonarBeamRetCode	removeBeam (DtU8 beamId)
	removes an emitter beam, if there are duplicate beams it will remove the first beam with the given beamID.
virtual DtSonarBeamRetCode	removeBeam (const DtGlobalObjectDesignator &id)
virtual int	numBeams () const
	Returns number of beams.
virtual const DtList *	beamList () const
	Returns DtList of DtEmitterBeamStateRepositories.
virtual DtList *	beamList ()
bool	isMember (DtActiveSonarBeamRepository *bsr) const
	Returns true if the give BSR is in this ESR's list of BSRs.
Public Member Functions inherited from DtUnderwaterAcousticsEmissionRepository
	DtUnderwaterAcousticsEmissionRepository ()
	Constructor.
virtual	~DtUnderwaterAcousticsEmissionRepository ()
	Destructor.
	DtUnderwaterAcousticsEmissionRepository (const DtUnderwaterAcousticsEmissionRepository &orig)
	Copy Constructor.
DtUnderwaterAcousticsEmissionRepository &	operator= (const DtUnderwaterAcousticsEmissionRepository &orig)
	Assignment Operator.
virtual void	setEventIdentifier (const DtEventId &val)
	Set the EventIdentifier.
virtual const DtEventId &	eventIdentifier () const
	Get the EventIdentifier.
Public Member Functions inherited from DtEmbeddedSystemRepository
	DtEmbeddedSystemRepository ()
	default constructor
	DtEmbeddedSystemRepository (const DtEmbeddedSystemRepository &orig)
	copy constructor
virtual	~DtEmbeddedSystemRepository ()
	destructor
DtEmbeddedSystemRepository &	operator= (const DtEmbeddedSystemRepository &orig)
	assignment operator
virtual void	setEntityId (const DtEntityIdentifier &id)
	Set the entity identifier.
virtual const DtEntityIdentifier &	entityId () const
	Get the entity identifier.
virtual void	setHostId (const DtGlobalObjectDesignator &id)
	Set the host identifier.
virtual const DtGlobalObjectDesignator &	hostId () const
	Get the host identifier.
virtual void	setRelativePosition (const DtVector &position)
	Set the position of the object relative to the entity.
virtual const DtVector &	relativePosition () const
	Get the position of the object relative to the entity.
Public Member Functions inherited from DtStateRepository
	DtStateRepository ()
	default constructor
	DtStateRepository (const DtStateRepository &orig)
	copy constructor
virtual	~DtStateRepository ()
	destructor
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator
virtual void	setGlobalId (const DtString &id)
	Get/Set global identifier, or name.
virtual const DtString &	globalId () const
virtual void	setLocalId (const DtObjectId &id)
	Get/Set local identifier, or handle.
virtual const DtObjectId &	localId () const
virtual bool	publishesAttribute (const RTI::AttributeHandle &val) const
	Returns true if the attribute is published.
virtual void	setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
	Set the attribute with the given handle.
virtual const char *	getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle.
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.
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.
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.

Static Public Member Functions
static DtActiveSonarStateRepository *	create ()
	Create a DtActiveSonarStateRepository.
static DtBeamStateRepCreator	setStateRepCreator (DtBeamStateRepCreator creator)
	Give us a function to be used for creating Beam SRs.

Protected Member Functions
virtual void	purgeBeamList ()

Protected Attributes
DtUnderwaterAcousticSystemName	myAcousticName
DtUnderwaterAcousticFunction	myFunctionCode
DtU8	myAcousticsIdentifier
DtList	myBeamList
	List of beams in this system.
Protected Attributes inherited from DtUnderwaterAcousticsEmissionRepository
DtEventId	myEventIdentifier
Protected Attributes inherited from DtEmbeddedSystemRepository
DtEntityIdentifier	myEntityId
DtGlobalObjectDesignator	myHostId
DtVector	myRelativePosition

Static Protected Attributes
static DtBeamStateRepCreator	theBeamStateRepCreator

Additional Inherited Members
Public Attributes inherited from DtStateRepository
DtString	myGlobalId
DtObjectId	myLocalId
std::map< RTI::AttributeHandle, DtGenericAttributeInfo * >	myAttributesByHandle
	Attributes by handle.

Detailed Description

class DtActiveSonarStateRepository

Instances of DtActiveSonarStateRepository are used to store state data for EmbeddedSystem.UnderwaterAcousticsEmission.ActiveSonar objects.

Member Typedef Documentation

typedef DtActiveSonarBeamRepository*(* DtActiveSonarStateRepository::DtBeamStateRepCreator)()

Function prototype for functions that create Beam State Repositories.

Constructor & Destructor Documentation

DtActiveSonarStateRepository::DtActiveSonarStateRepository

(

)

Constructor.

virtual DtActiveSonarStateRepository::~DtActiveSonarStateRepository ( )

virtual

Destructor.

DtActiveSonarStateRepository::DtActiveSonarStateRepository

(

const DtActiveSonarStateRepository &

orig

)

Copy Constructor.

Member Function Documentation

virtual DtUnderwaterAcousticSystemName DtActiveSonarStateRepository::acousticName ( ) const

virtual

Get the AcousticName.

virtual DtU8 DtActiveSonarStateRepository::acousticsIdentifier ( ) const

virtual

Get the AcousticsIdentifier.

virtual DtActiveSonarBeamRepository* DtActiveSonarStateRepository::addBeam ( DtU8  beamId = 0, DtSonarBeamRetCode *  retcode = NULL  )

virtual

Add/remove a new emitter beam within this system.

If you add a beam with duplicate ID, retcode will be set to DtDuplicateSonarBeamId, and beamSRById will return the first beamSR with the given ID.

virtual const DtList* DtActiveSonarStateRepository::beamList ( ) const

virtual

Returns DtList of DtEmitterBeamStateRepositories.

virtual DtList* DtActiveSonarStateRepository::beamList ( )

virtual

virtual DtActiveSonarBeamRepository* DtActiveSonarStateRepository::beamSRById ( DtU8  beamId, DtSonarBeamRetCode *  retcode = NULL  )

virtual

Return a pointer to the first BeamSR with specified beamID.

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

virtual

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

Reimplemented from DtUnderwaterAcousticsEmissionRepository.

static DtActiveSonarStateRepository* DtActiveSonarStateRepository::create ( )

static

Create a DtActiveSonarStateRepository.

Reimplemented from DtUnderwaterAcousticsEmissionRepository.

virtual DtUnderwaterAcousticFunction DtActiveSonarStateRepository::functionCode ( ) const

virtual

Get the FunctionCode.

bool DtActiveSonarStateRepository::isMember

(

DtActiveSonarBeamRepository *

bsr

)

const

Returns true if the give BSR is in this ESR's list of BSRs.

virtual int DtActiveSonarStateRepository::numBeams ( ) const

virtual

Returns number of beams.

DtActiveSonarStateRepository& DtActiveSonarStateRepository::operator=

(

const DtActiveSonarStateRepository &

orig

)

Assignment Operator.

virtual void DtActiveSonarStateRepository::printData ( ) const

virtual

Print data to the DtInfo stream.

Reimplemented from DtUnderwaterAcousticsEmissionRepository.

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

virtual

Print data to the specified stream.

Reimplemented from DtUnderwaterAcousticsEmissionRepository.

virtual void DtActiveSonarStateRepository::purgeBeamList ( )

protectedvirtual

virtual DtSonarBeamRetCode DtActiveSonarStateRepository::removeBeam ( DtU8  beamId )

virtual

removes an emitter beam, if there are duplicate beams it will remove the first beam with the given beamID.

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 removeBeam which takes a GlobalId

virtual DtSonarBeamRetCode DtActiveSonarStateRepository::removeBeam ( const DtGlobalObjectDesignator &  id )

virtual

virtual void DtActiveSonarStateRepository::setAcousticName ( DtUnderwaterAcousticSystemName  val )

virtual

Set the AcousticName.

virtual void DtActiveSonarStateRepository::setAcousticsIdentifier ( DtU8  val )

virtual

Set the AcousticsIdentifier.

virtual void DtActiveSonarStateRepository::setFunctionCode ( DtUnderwaterAcousticFunction  val )

virtual

Set the FunctionCode.

static DtBeamStateRepCreator DtActiveSonarStateRepository::setStateRepCreator ( DtBeamStateRepCreator  creator )

static

Give us a function to be used for creating Beam SRs.

Member Data Documentation

DtUnderwaterAcousticSystemName DtActiveSonarStateRepository::myAcousticName

protected

DtU8 DtActiveSonarStateRepository::myAcousticsIdentifier

protected

DtList DtActiveSonarStateRepository::myBeamList

protected

List of beams in this system.

DtUnderwaterAcousticFunction DtActiveSonarStateRepository::myFunctionCode

protected

DtBeamStateRepCreator DtActiveSonarStateRepository::theBeamStateRepCreator

staticprotected

---

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

• activeSonarStateRepository.h