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 const std::list < DtString > &	modeList () const
virtual std::list< DtString > &	modeList ()
virtual void	addMode (const DtString &modeName)
virtual void	clearModeList ()
virtual DtString	currentMode () const
virtual void	setCurrentMode (const DtString &modeName)
virtual int	activeSonarId () const
virtual void	setActiveSonarId (int id)
virtual DtAdminContent *	clone () const
	Make a copy of this content.
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.
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.
Static Public Member Functions inherited from DtAdminContent
static void	addAdminContentCreatorFcn (const DtString &contentName, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	isTypeRegistered (DtString type)

Protected Attributes
std::list< DtString >	myModeList
	The list of available formation names.
DtString	myCurrentMode
int	myActiveSonarId
Protected Attributes inherited from DtAdminContent
char *	myNetRep

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

virtual bool DtActiveSonarModesAdmin::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtActiveSonarModesAdmin::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual const std::list<DtString>& DtActiveSonarModesAdmin::modeList ( ) const

virtual

virtual std::list<DtString>& DtActiveSonarModesAdmin::modeList ( )

virtual

virtual void DtActiveSonarModesAdmin::addMode ( const DtString &  modeName )

virtual

virtual void DtActiveSonarModesAdmin::clearModeList ( )

virtual

virtual DtString DtActiveSonarModesAdmin::currentMode ( ) const

virtual

virtual void DtActiveSonarModesAdmin::setCurrentMode ( const DtString &  modeName )

virtual

virtual int DtActiveSonarModesAdmin::activeSonarId ( ) const

virtual

virtual void DtActiveSonarModesAdmin::setActiveSonarId ( int  id )

virtual

virtual DtAdminContent* DtActiveSonarModesAdmin::clone ( ) const

virtual

Make a copy of this content.

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

Implements DtAdminContent.

virtual DtString DtActiveSonarModesAdmin::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtActiveSonarModesAdmin::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

virtual bool DtActiveSonarModesAdmin::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtActiveSonarModesAdmin::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

std::list<DtString> DtActiveSonarModesAdmin::myModeList

protected

The list of available formation names.

DtString DtActiveSonarModesAdmin::myCurrentMode

protected

int DtActiveSonarModesAdmin::myActiveSonarId

protected

---

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

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