DtRadarModesAdmin Class Reference

Admin content which contains the list of radar modes for an emitter. More...

Inheritance diagram for DtRadarModesAdmin:

Public Member Functions
	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 bool	init ()
	Call after construction.
virtual const DtAdminContentMessageType &	type () const
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 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.
virtual DtString	stringRepModeName () const
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.
Static Public Member Functions inherited from DtAdminContent
static void	addAdminContentCreatorFcn (const DtAdminContentMessageType &contentName, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	isTypeRegistered (const DtAdminContentMessageType &type)

Protected Attributes
std::list< DtString >	myModeList
	The list of available formation names.
DtString	myCurrentMode
DtString	myEmitterName
int	myEmitterId
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 radar modes for an emitter.

This is the response to the DtRequestRadarModesAdmin message. Also contains the current mode of the radar, if it has one.

Constructor & Destructor Documentation

DtRadarModesAdmin::DtRadarModesAdmin

(

)

default constructor

DtRadarModesAdmin::DtRadarModesAdmin

(

const DtRadarModesAdmin &

orig

)

copy constructor

virtual DtRadarModesAdmin::~DtRadarModesAdmin ( )

virtual

destructor

Member Function Documentation

const DtRadarModesAdmin& DtRadarModesAdmin::operator=

(

const DtRadarModesAdmin &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtRadarModesAdmin::create ( )

static

Creator function. Returns new instance of this class.

Reimplemented in DtActiveSonarModesAdmin, and DtJammingModesAdmin.

virtual bool DtRadarModesAdmin::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

Reimplemented in DtActiveSonarModesAdmin.

virtual const DtAdminContentMessageType& DtRadarModesAdmin::type ( ) const

virtual

Returns

Implements DtAdminContent.

Reimplemented in DtActiveSonarModesAdmin, and DtJammingModesAdmin.

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

virtual

Direct access to the list of formation names.

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

virtual

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

virtual

Add an additional formation name to the end of the current formation list.

virtual void DtRadarModesAdmin::clearModeList ( )

virtual

Clear the current formation list.

virtual const DtString& DtRadarModesAdmin::currentMode ( ) const

virtual

The current mode of the emitter.

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

virtual

virtual const DtString& DtRadarModesAdmin::emitterName ( ) const

virtual

The emitter system descriptive name.

virtual void DtRadarModesAdmin::setEmitterName ( const DtString &  modeName )

virtual

virtual int DtRadarModesAdmin::emitterId ( ) const

virtual

The current formation of the entity, if it has one.

virtual void DtRadarModesAdmin::setEmitterId ( int  id )

virtual

virtual DtAdminContent* DtRadarModesAdmin::clone ( ) const

virtual

Make a copy of this content.

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

Implements DtAdminContent.

Reimplemented in DtActiveSonarModesAdmin, and DtJammingModesAdmin.

virtual DtString DtRadarModesAdmin::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtRadarModesAdmin::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtRadarModesAdmin::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

virtual DtString DtRadarModesAdmin::stringRepModeName ( ) const

virtual

Reimplemented in DtActiveSonarModesAdmin, and DtJammingModesAdmin.

Member Data Documentation

std::list<DtString> DtRadarModesAdmin::myModeList

protected

The list of available formation names.

DtString DtRadarModesAdmin::myCurrentMode

protected

DtString DtRadarModesAdmin::myEmitterName

protected

int DtRadarModesAdmin::myEmitterId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrftasks/radarModesAdmin.h