DtActiveSonarModesAdmin Class Reference

Admin content which contains the list of active sonar modes for an active sonar system. More...

Inheritance diagram for DtActiveSonarModesAdmin:

Public Member Functions
	DtActiveSonarModesAdmin ()
	default constructor
	DtActiveSonarModesAdmin (const DtActiveSonarModesAdmin &orig)
	copy constructor
const DtActiveSonarModesAdmin &	operator= (const DtActiveSonarModesAdmin &orig)
	assignment operator; same as copy costructor.
virtual	~DtActiveSonarModesAdmin ()
	destructor
virtual bool	init ()
	Call after construction.
virtual const DtAdminContentMessageType &	type () const
virtual DtAdminContent *	clone () const
	Make a copy of this content.
virtual DtString	stringRepModeName () const
virtual void	setActiveSonarId (int)
virtual int	activeSonarId () const
Public Member Functions inherited from DtRadarModesAdmin
	DtRadarModesAdmin ()
	default constructor
	DtRadarModesAdmin (const DtRadarModesAdmin &orig)
	copy constructor
const DtRadarModesAdmin &	operator= (const DtRadarModesAdmin &orig)
	assignment operator; same as copy costructor.
virtual	~DtRadarModesAdmin ()
	destructor
virtual void	addMode (const DtString &modeName)
	Add an additional formation name to the end of the current formation list.
virtual void	clearModeList ()
	Clear the current formation list.
virtual DtString	stringRep () const
	Get a readable string representation of this content.
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Decodes content from buffer.
virtual bool	setToNet ()
	Encodes content into buffer.
virtual const std::list < DtString > &	modeList () const
	Direct access to the list of formation names.
virtual std::list< DtString > &	modeList ()
virtual const DtString &	currentMode () const
	The current mode of the emitter.
virtual void	setCurrentMode (const DtString &modeName)
virtual const DtString &	emitterName () const
	The emitter system descriptive name.
virtual void	setEmitterName (const DtString &modeName)
virtual int	emitterId () const
	The current formation of the entity, if it has one.
virtual void	setEmitterId (int id)
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
	destructor
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
	Creator function. Returns new instance of this class.

Additional Inherited Members
Protected Member Functions inherited from DtAdminContent
	DtAdminContent ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtAdminContent (const DtAdminContent &orig)
	copy constructor
const DtAdminContent &	operator= (const DtAdminContent &orig)
	assignment operator; same as copy costructor.
virtual char *	createNetworkBuffer ()
Protected Attributes inherited from DtRadarModesAdmin
std::list< DtString >	myModeList
	The list of available formation names.
DtString	myCurrentMode
DtString	myEmitterName
int	myEmitterId
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Detailed Description

Admin content which contains the list of active sonar modes for an active sonar system.

This is the response to the DtRequestActiveSonarModesAdmin message. Also contains the current mode of the active sonar, if it has one.

Constructor & Destructor Documentation

DtActiveSonarModesAdmin::DtActiveSonarModesAdmin

(

)

default constructor

DtActiveSonarModesAdmin::DtActiveSonarModesAdmin

(

const DtActiveSonarModesAdmin &

orig

)

copy constructor

virtual DtActiveSonarModesAdmin::~DtActiveSonarModesAdmin ( )

virtual

destructor

Member Function Documentation

const DtActiveSonarModesAdmin& DtActiveSonarModesAdmin::operator=

(

const DtActiveSonarModesAdmin &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtActiveSonarModesAdmin::create ( )

static

Creator function. Returns new instance of this class.

Reimplemented from DtRadarModesAdmin.

virtual bool DtActiveSonarModesAdmin::init ( )

virtual

Call after construction.

Reimplemented from DtRadarModesAdmin.

virtual const DtAdminContentMessageType& DtActiveSonarModesAdmin::type ( ) const

virtual

Returns

Reimplemented from DtRadarModesAdmin.

virtual DtAdminContent* DtActiveSonarModesAdmin::clone ( ) const

virtual

Make a copy of this content.

Returns a pointer to a newly created copy of this class.

Reimplemented from DtRadarModesAdmin.

virtual DtString DtActiveSonarModesAdmin::stringRepModeName ( ) const

virtual

Reimplemented from DtRadarModesAdmin.

virtual void DtActiveSonarModesAdmin::setActiveSonarId ( int  )

virtual

virtual int DtActiveSonarModesAdmin::activeSonarId ( ) const

virtual

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrftasks/activeSonarModesAdmin.h