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. More...

Public Member Functions
	DtVrfActiveSonarSystem (DtVrfObject *hostEntity)
virtual	~DtVrfActiveSonarSystem ()
virtual void	tick ()
	No-op. Here for future use.
virtual bool	init ()
virtual void	setDataFromActiveSonarSystemEntry (const DtActiveSonarSystemEntry &entry)
	sets all active sonar system attributes based on the data in the supplied DtActiveSonarSytemEntry.
virtual void	setSystemId (DtU8 id)
	Sets/gets the system ID of the active sonar system.
virtual DtU8	systemId () const
virtual void	setSystemName (DtUnderwaterAcousticSystemName nameEnum)
	Accessors and mutators for properties of the beam and active sonar system.
virtual DtUnderwaterAcousticSystemName	systemName ()
virtual void	setSystemFunction (DtUnderwaterAcousticFunction functionEnum)
virtual DtUnderwaterAcousticFunction	systemFunction ()
virtual void	setMountLocation (const DtVector &location)
virtual DtVector	mountLocation ()
virtual DtActiveSonarBeamRepository *	addBeam (DtU8 id)
	Adds a new beam if the ID does not already exist and returns a pointer to the beam repository.
virtual void	removeBeam (DtU8 id)
	Removes a beam from this system.
virtual void	removeAllBeams ()
	Removes all beams from the system.
virtual DtActiveSonarBeamRepository *	beam (DtU8 id=0)
	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	numBeams ()
	Returns total number of beams in this system.
virtual DtList *	beamList ()
	Returns list to the beam repositories.
virtual DtString	activeSonarMode () const
virtual void	setActiveSonarMode (DtString mode, const DtActiveSonarSystemEntry &entry)
	Sets the radar mode and also calls setDataFromActiveSonarSystemEntry() to initialize.
virtual const DtList *	activeSonarModeList (const DtActiveSonarSystemEntry &entry)

Protected Attributes
DtVrfObject *	myHostEntity
DtString	myActiveSonarMode
DtU8	myAcousticSystemId

Private Member Functions
	DtVrfActiveSonarSystem (const DtVrfActiveSonarSystem &orig)
	Not implemented.
DtVrfActiveSonarSystem &	operator= (const DtVrfActiveSonarSystem &orig)
	Not implemented.
	DtVrfActiveSonarSystem ()
	Not implemented.

Detailed Description

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.

Constructor & Destructor Documentation

DtVrfActiveSonarSystem::DtVrfActiveSonarSystem ( const DtVrfActiveSonarSystem &  orig )

private

Not implemented.

DtVrfActiveSonarSystem::DtVrfActiveSonarSystem ( )

private

Not implemented.

DtVrfActiveSonarSystem::DtVrfActiveSonarSystem

(

DtVrfObject *

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 ( )

virtual

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

virtual

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

virtual void DtVrfActiveSonarSystem::setSystemId ( DtU8  id )

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 DtU8 DtVrfActiveSonarSystem::systemId ( ) const

virtual

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 DtActiveSonarBeamRepository* DtVrfActiveSonarSystem::addBeam ( DtU8  id )

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 DtActiveSonarBeamRepository* 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 DtList* 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

Member Data Documentation

DtVrfObject* DtVrfActiveSonarSystem::myHostEntity

protected

DtString DtVrfActiveSonarSystem::myActiveSonarMode

protected

DtU8 DtVrfActiveSonarSystem::myAcousticSystemId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfmodel/vrfActiveSonarSystem.h