DtVrfActiveSonarSystem Class Reference

DtVrfActiveSonarSystem manages a VR-Link active sonar system publisher, and sets all the values associated with an active sonar system and its beams.

The active sonar system can be initialized from a DtActiveSonarSystemEntry RW class.

Public Member Functions
	DtVrfActiveSonarSystem (DtLocalObject *hostEntity)
virtual	~DtVrfActiveSonarSystem ()
virtual void	tick ()
virtual bool	init (bool publishSonar=false)
virtual void	setDataFromActiveSonarSystemEntry (const DtActiveSonarSystemEntry &entry)
virtual DtU8	systemId () const
virtual void	setSystemName (DtUnderwaterAcousticSystemName nameEnum)
virtual DtUnderwaterAcousticSystemName	systemName ()
virtual void	setSystemFunction (DtUnderwaterAcousticFunction functionEnum)
virtual DtUnderwaterAcousticFunction	systemFunction ()
virtual void	setMountLocation (const DtVector &location)
virtual DtVector	mountLocation ()
virtual makVrf::DtActiveSonarBeamStateData *	addBeam ()
virtual void	removeBeam (DtU8 id)
virtual void	removeAllBeams ()
virtual void	clearActiveSonarMode ()
virtual makVrf::DtActiveSonarBeamStateData *	beam (DtU8 id=0)
virtual int	numBeams ()
virtual void	setSystemId (DtU8)
virtual std::vector < makVrf::DtActiveSonarBeamStateData > &	beamList ()
virtual DtString	activeSonarMode () const
virtual void	setActiveSonarMode (DtString mode, const DtActiveSonarSystemEntry &entry)
virtual const DtList *	activeSonarModeList (const DtActiveSonarSystemEntry &entry)
virtual void	setEmitterName (const DtString &)
virtual const DtString &	emitterName () const

Protected Attributes
DtLocalObject *	myHostEntity
DtString	myActiveSonarMode
DtString	myEmitterName
makVrf::DtActiveSonarStateComponent *	myActiveSonarComponent
DtU8	mySystemId

Private Member Functions
	DtVrfActiveSonarSystem (const DtVrfActiveSonarSystem &orig)
DtVrfActiveSonarSystem &	operator= (const DtVrfActiveSonarSystem &orig)
	DtVrfActiveSonarSystem ()

Constructor & Destructor Documentation

DtVrfActiveSonarSystem::DtVrfActiveSonarSystem ( const DtVrfActiveSonarSystem &  orig )

private

Not implemented.

DtVrfActiveSonarSystem::DtVrfActiveSonarSystem ( )

private

Not implemented.

DtVrfActiveSonarSystem::DtVrfActiveSonarSystem

(

DtLocalObject *

hostEntity

)

virtual DtVrfActiveSonarSystem::~DtVrfActiveSonarSystem ( )

virtual

Member Function Documentation

DtVrfActiveSonarSystem& DtVrfActiveSonarSystem::operator= ( const DtVrfActiveSonarSystem &  orig )

private

Not implemented.

virtual void DtVrfActiveSonarSystem::tick ( )

virtual

No-op. Here for future use.

virtual bool DtVrfActiveSonarSystem::init ( bool  publishSonar = false )

virtual

virtual void DtVrfActiveSonarSystem::setDataFromActiveSonarSystemEntry ( const DtActiveSonarSystemEntry &  entry )

virtual

sets all active sonar system attributes based on the data in the supplied DtActiveSonarSytemEntry.

virtual DtU8 DtVrfActiveSonarSystem::systemId ( ) const

virtual

Sets/gets the system ID of the active sonar system. Each active sonar system on a given entity should have a different ID.

virtual void DtVrfActiveSonarSystem::setSystemName ( DtUnderwaterAcousticSystemName  nameEnum )

virtual

Accessors and mutators for properties of the beam and active sonar system.

virtual DtUnderwaterAcousticSystemName DtVrfActiveSonarSystem::systemName ( )

virtual

virtual void DtVrfActiveSonarSystem::setSystemFunction ( DtUnderwaterAcousticFunction  functionEnum )

virtual

virtual DtUnderwaterAcousticFunction DtVrfActiveSonarSystem::systemFunction ( )

virtual

virtual void DtVrfActiveSonarSystem::setMountLocation ( const DtVector &  location )

virtual

virtual DtVector DtVrfActiveSonarSystem::mountLocation ( )

virtual

virtual makVrf::DtActiveSonarBeamStateData* DtVrfActiveSonarSystem::addBeam ( )

virtual

Adds a new beam if the ID does not already exist and returns a pointer to the beam repository.

virtual void DtVrfActiveSonarSystem::removeBeam ( DtU8  id )

virtual

Removes a beam from this system.

virtual void DtVrfActiveSonarSystem::removeAllBeams ( )

virtual

Removes all beams from the system.

virtual void DtVrfActiveSonarSystem::clearActiveSonarMode ( )

virtual

Clears the current active sonar mode and removes all beams.

virtual makVrf::DtActiveSonarBeamStateData* DtVrfActiveSonarSystem::beam ( DtU8  id = 0 )

virtual

Returns a pointer to the beam repository of this beam, of NULL if there is no beam of this id in the system.

virtual int DtVrfActiveSonarSystem::numBeams ( )

virtual

Returns total number of beams in this system.

virtual void DtVrfActiveSonarSystem::setSystemId ( DtU8  )

virtual

virtual std::vector<makVrf::DtActiveSonarBeamStateData>& DtVrfActiveSonarSystem::beamList ( )

virtual

Returns list to the beam repositories.

virtual DtString DtVrfActiveSonarSystem::activeSonarMode ( ) const

virtual

virtual void DtVrfActiveSonarSystem::setActiveSonarMode ( DtString  mode, const DtActiveSonarSystemEntry &  entry  )

virtual

Sets the radar mode and also calls setDataFromActiveSonarSystemEntry() to initialize.

virtual const DtList* DtVrfActiveSonarSystem::activeSonarModeList ( const DtActiveSonarSystemEntry &  entry )

virtual

virtual void DtVrfActiveSonarSystem::setEmitterName ( const DtString &  )

virtual

The name of this emitter (descriptive)

virtual const DtString& DtVrfActiveSonarSystem::emitterName ( ) const

virtual

Member Data Documentation

DtLocalObject* DtVrfActiveSonarSystem::myHostEntity

protected

DtString DtVrfActiveSonarSystem::myActiveSonarMode

protected

DtString DtVrfActiveSonarSystem::myEmitterName

protected

makVrf::DtActiveSonarStateComponent* DtVrfActiveSonarSystem::myActiveSonarComponent

protected

DtU8 DtVrfActiveSonarSystem::mySystemId

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmodel/vrfActiveSonarSystem.h