VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtRadarModesAdmin Class Reference

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

Inheritance diagram for DtRadarModesAdmin:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtRadarModesAdmin ()
 default constructor
 DtRadarModesAdmin (const DtRadarModesAdmin &orig)
 copy constructor
const DtRadarModesAdminoperator= (const DtRadarModesAdmin &orig)
 assignment operator; same as copy costructor.
virtual ~DtRadarModesAdmin ()
 destructor
virtual bool init ()
 Call after construction.
virtual int 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 DtAdminContentclone () 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 const std::list
< DtString > & 
modeList () const
 Direct access to the list of formation names.
virtual std::list< DtString > & modeList ()
 Direct access to the list of formation names.
virtual DtString currentMode () const
 The current formation of the entity, if it has one.
virtual void setCurrentMode (const DtString &modeName)
 The current formation of the entity, if it has one.
virtual int emitterId () const
 The current formation of the entity, if it has one.
virtual void setEmitterId (int id)
 The current formation of the entity, if it has one.

Static Public Member Functions

static DtAdminContentcreate ()
 Creator function. Returns new instance of this class.

Protected Attributes

std::list< DtStringmyModeList
 The list of available formation names.
DtString myCurrentMode
int myEmitterId

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

default constructor

copy constructor

destructor


Member Function Documentation

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

assignment operator; same as copy costructor.

Creator function. Returns new instance of this class.

virtual bool DtRadarModesAdmin::init ( ) [virtual]

Call after construction.

Reimplemented from DtAdminContent.

virtual int DtRadarModesAdmin::type ( ) const [virtual]
Returns:

Implements DtAdminContent.

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

Direct access to the list of formation names.

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

Direct access to the list of formation names.

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 DtString DtRadarModesAdmin::currentMode ( ) const [virtual]

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

virtual void DtRadarModesAdmin::setCurrentMode ( const DtString modeName) [virtual]

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

virtual int DtRadarModesAdmin::emitterId ( ) const [virtual]

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

virtual void DtRadarModesAdmin::setEmitterId ( int  id) [virtual]

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

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.

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.


Member Data Documentation

std::list<DtString> DtRadarModesAdmin::myModeList [protected]

The list of available formation names.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)