DtVrfUnderwaterAcoustics Class Reference

Public Member Functions
	DtVrfUnderwaterAcoustics (DtVrfObject *)
	CTOR.
virtual	~DtVrfUnderwaterAcoustics ()
	DTOR.
virtual void	tick ()
	Tick publishers.
std::map< DtU8, DtActiveSonarPublisher * > &	activeSonars ()
	{@ Accessors.
DtUnderwaterAcousticsPublisher *	underwaterAcoustics ()
DtPropulsionNoisePublisher *	propulsionNoise ()
virtual void	setUsePropulsionNoisePublisher (bool)
	Important – these need to be set before first access to any of the methods below.
virtual void	setUseActiveSonarPublisher (bool)
	Important – these need to be set before first access to any of the methods below.
virtual void	addActiveSonar (DtU8 id)
	Active sonar methodsAdd new sonar system.
virtual void	removeActiveSonar (DtU8 id)
	Removes active sonar.
virtual DtActiveSonarStateRepository *	activeSonarSR (DtU8)
	Returns active sonar by id, or 0 if no sonar by that id exits.
virtual void	setSystemName (DtU8, DtUnderwaterAcousticSystemName nameEnum)
	Sets system name by id.
virtual DtUnderwaterAcousticSystemName	systemName (DtU8)
	Returns system name by id.
virtual void	setSystemFunction (DtU8, DtUnderwaterAcousticFunction)
	Sets system function code.
virtual DtUnderwaterAcousticFunction	systemFunction (DtU8)
	Returns system function.
virtual void	setMountLocation (DtU8, const DtVector &location)
	Where the system is located.
virtual DtVector	mountLocation (DtU8)
	Active sonar methodsAdd new sonar system.
virtual DtActiveSonarBeamRepository *	addBeam (DtU8 systemId, DtU8 id)
	Adds a new beam to the system.
virtual void	removeBeam (DtU8 systemId, DtU8 id)
	Remove beam from system.
virtual void	removeAllBeams (DtU8 systemId)
	Remove all beams.
virtual DtActiveSonarBeamRepository *	beam (DtU8 systemId, DtU8 id)
	Returns a beam by id.
virtual int	numBeams (DtU8)
	Returns number of beams.
virtual DtList *	beamList (DtU8 systemId)
	Returns list of beams.
virtual void	setShaftData (const std::vector< DtUnderwaterAcousticShaftSpeed > &)
	Propulsion noise data.
virtual std::vector < DtUnderwaterAcousticShaftSpeed >	shaftData ()
	Propulsion noise data.

Protected Member Functions
virtual DtUnderwaterAcousticsPublisher *	getOrCreateAndInitUnifiedPublisher ()
	Creates and initializes unified publisher.
virtual DtPropulsionNoisePublisher *	getOrCreateAndInitPropulsionNoisePublisher ()
	Creates and initializes propulsion noise publisher.
virtual DtActiveSonarPublisher *	createAndInitActiveSonarPublisher (DtU8 id)
	Creates and initializes active sonar publisher.
virtual bool	publishersCanBeCreated ()
	If publishers can be created returns true, else false and warns.
virtual bool	unified () const
	Returns true if in unified mode.

Protected Attributes
DtVrfObject *	myOwner
std::map< DtU8, DtActiveSonarPublisher * >	myActiveSonars
	If only using sonar these are the list of sonar publishers by system id.
DtUnderwaterAcousticsPublisher *	myUnderwaterAcoustics
	If publishing both sonar and propulsion noise, use this publisher.
DtPropulsionNoisePublisher *	myPropulsionNoise
	If only publishing propulsion noise.
bool	myUsePropulsionNoisePublisher
bool	myUseActiveSonarPublisher
bool	myWarned
bool	myChecked

Constructor & Destructor Documentation

DtVrfUnderwaterAcoustics::DtVrfUnderwaterAcoustics

(

DtVrfObject *

)

CTOR.

virtual DtVrfUnderwaterAcoustics::~DtVrfUnderwaterAcoustics ( )

virtual

DTOR.

Member Function Documentation

virtual void DtVrfUnderwaterAcoustics::tick ( )

virtual

Tick publishers.

virtual void DtVrfUnderwaterAcoustics::setUsePropulsionNoisePublisher ( bool  )

virtual

Important – these need to be set before first access to any of the methods below.

Once a method is selected, if these flags are not set, only the publisher for that particular acoustic will be created. Set both flags to true to create a unified publisher. Do not set (or set only one) to create a publisher of that choice

virtual void DtVrfUnderwaterAcoustics::setUseActiveSonarPublisher ( bool  )

virtual

Important – these need to be set before first access to any of the methods below.

Once a method is selected, if these flags are not set, only the publisher for that particular acoustic will be created. Set both flags to true to create a unified publisher. Do not set (or set only one) to create a publisher of that choice

virtual void DtVrfUnderwaterAcoustics::addActiveSonar ( DtU8  id )

virtual

Active sonar methodsAdd new sonar system.

virtual void DtVrfUnderwaterAcoustics::removeActiveSonar ( DtU8  id )

virtual

Removes active sonar.

virtual DtActiveSonarStateRepository* DtVrfUnderwaterAcoustics::activeSonarSR ( DtU8  )

virtual

Returns active sonar by id, or 0 if no sonar by that id exits.

virtual void DtVrfUnderwaterAcoustics::setSystemName ( DtU8  , DtUnderwaterAcousticSystemName  nameEnum  )

virtual

Sets system name by id.

virtual DtUnderwaterAcousticSystemName DtVrfUnderwaterAcoustics::systemName ( DtU8  )

virtual

Returns system name by id.

virtual void DtVrfUnderwaterAcoustics::setSystemFunction ( DtU8  , DtUnderwaterAcousticFunction    )

virtual

Sets system function code.

virtual DtUnderwaterAcousticFunction DtVrfUnderwaterAcoustics::systemFunction ( DtU8  )

virtual

Returns system function.

virtual void DtVrfUnderwaterAcoustics::setMountLocation ( DtU8  , const DtVector &  location  )

virtual

Where the system is located.

virtual DtVector DtVrfUnderwaterAcoustics::mountLocation ( DtU8  )

virtual

Active sonar methodsAdd new sonar system.

virtual DtActiveSonarBeamRepository* DtVrfUnderwaterAcoustics::addBeam ( DtU8  systemId, DtU8  id  )

virtual

Adds a new beam to the system.

virtual void DtVrfUnderwaterAcoustics::removeBeam ( DtU8  systemId, DtU8  id  )

virtual

Remove beam from system.

virtual void DtVrfUnderwaterAcoustics::removeAllBeams ( DtU8  systemId )

virtual

Remove all beams.

virtual DtActiveSonarBeamRepository* DtVrfUnderwaterAcoustics::beam ( DtU8  systemId, DtU8  id  )

virtual

Returns a beam by id.

virtual int DtVrfUnderwaterAcoustics::numBeams ( DtU8  )

virtual

Returns number of beams.

virtual DtList* DtVrfUnderwaterAcoustics::beamList ( DtU8  systemId )

virtual

Returns list of beams.

virtual void DtVrfUnderwaterAcoustics::setShaftData ( const std::vector< DtUnderwaterAcousticShaftSpeed > &  )

virtual

Propulsion noise data.

virtual std::vector<DtUnderwaterAcousticShaftSpeed> DtVrfUnderwaterAcoustics::shaftData ( )

virtual

Propulsion noise data.

std::map<DtU8, DtActiveSonarPublisher*>& DtVrfUnderwaterAcoustics::activeSonars ( )

inline

{@ Accessors.

Do not use unless you know which publisher is active. Use methods to set/get information if not

DtUnderwaterAcousticsPublisher* DtVrfUnderwaterAcoustics::underwaterAcoustics ( )

inline

DtPropulsionNoisePublisher* DtVrfUnderwaterAcoustics::propulsionNoise ( )

inline

virtual DtUnderwaterAcousticsPublisher* DtVrfUnderwaterAcoustics::getOrCreateAndInitUnifiedPublisher ( )

protectedvirtual

Creates and initializes unified publisher.

virtual DtPropulsionNoisePublisher* DtVrfUnderwaterAcoustics::getOrCreateAndInitPropulsionNoisePublisher ( )

protectedvirtual

Creates and initializes propulsion noise publisher.

virtual DtActiveSonarPublisher* DtVrfUnderwaterAcoustics::createAndInitActiveSonarPublisher ( DtU8  id )

protectedvirtual

Creates and initializes active sonar publisher.

virtual bool DtVrfUnderwaterAcoustics::publishersCanBeCreated ( )

protectedvirtual

If publishers can be created returns true, else false and warns.

Publishers cannot be created for HLA 13 RPR 1.0.

virtual bool DtVrfUnderwaterAcoustics::unified ( ) const

protectedvirtual

Returns true if in unified mode.

Member Data Documentation

DtVrfObject* DtVrfUnderwaterAcoustics::myOwner

protected

std::map<DtU8, DtActiveSonarPublisher*> DtVrfUnderwaterAcoustics::myActiveSonars

protected

If only using sonar these are the list of sonar publishers by system id.

DtUnderwaterAcousticsPublisher* DtVrfUnderwaterAcoustics::myUnderwaterAcoustics

protected

If publishing both sonar and propulsion noise, use this publisher.

DtPropulsionNoisePublisher* DtVrfUnderwaterAcoustics::myPropulsionNoise

protected

If only publishing propulsion noise.

bool DtVrfUnderwaterAcoustics::myUsePropulsionNoisePublisher

protected

bool DtVrfUnderwaterAcoustics::myUseActiveSonarPublisher

protected

bool DtVrfUnderwaterAcoustics::myWarned

protected

bool DtVrfUnderwaterAcoustics::myChecked

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/vrfUnderwaterAcoustics.h