DtAvailableFormationsAdmin Class Reference

Admin content which contains the list of formation names that a particular aggregate entity has available. More...

Inheritance diagram for DtAvailableFormationsAdmin:

Public Member Functions
	DtAvailableFormationsAdmin ()
	default constructor
	DtAvailableFormationsAdmin (const DtAvailableFormationsAdmin &orig)
	copy constructor
const DtAvailableFormationsAdmin &	operator= (const DtAvailableFormationsAdmin &orig)
	assignment operator; same as copy costructor.
virtual	~DtAvailableFormationsAdmin ()
	destructor
virtual bool	init ()
	Call after construction.
virtual const DtAdminContentMessageType &	type () const
virtual void	addFormation (const DtString &formationName)
	Add an additional formation name to the end of the current formation list.
virtual void	clearFormationList ()
	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 const std::list < DtString > &	formationList () const
	Direct access to the list of formation names.
virtual std::list< DtString > &	formationList ()
virtual DtString	currentFormation () const
	The current formation of the entity, if it has one.
virtual void	setCurrentFormation (const DtString &formationName)
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 >	myFormationList
	The list of available formation names.
DtString	myCurrentFormation
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 formation names that a particular aggregate entity has available.

These are the formations that the aggregate can assume. This is the response to the DtRequestAvailableFormationsAdmin message. Also contains the current formation of the entity, if it has one.

Constructor & Destructor Documentation

DtAvailableFormationsAdmin::DtAvailableFormationsAdmin

(

)

default constructor

DtAvailableFormationsAdmin::DtAvailableFormationsAdmin

(

const DtAvailableFormationsAdmin &

orig

)

copy constructor

virtual DtAvailableFormationsAdmin::~DtAvailableFormationsAdmin ( )

virtual

destructor

Member Function Documentation

const DtAvailableFormationsAdmin& DtAvailableFormationsAdmin::operator=

(

const DtAvailableFormationsAdmin &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtAvailableFormationsAdmin::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtAvailableFormationsAdmin::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtAvailableFormationsAdmin::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual const std::list<DtString>& DtAvailableFormationsAdmin::formationList ( ) const

virtual

Direct access to the list of formation names.

virtual std::list<DtString>& DtAvailableFormationsAdmin::formationList ( )

virtual

virtual void DtAvailableFormationsAdmin::addFormation ( const DtString &  formationName )

virtual

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

virtual void DtAvailableFormationsAdmin::clearFormationList ( )

virtual

Clear the current formation list.

virtual DtString DtAvailableFormationsAdmin::currentFormation ( ) const

virtual

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

virtual void DtAvailableFormationsAdmin::setCurrentFormation ( const DtString &  formationName )

virtual

virtual DtAdminContent* DtAvailableFormationsAdmin::clone ( ) const

virtual

Make a copy of this content.

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

Implements DtAdminContent.

virtual DtString DtAvailableFormationsAdmin::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtAvailableFormationsAdmin::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtAvailableFormationsAdmin::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

std::list<DtString> DtAvailableFormationsAdmin::myFormationList

protected

The list of available formation names.

DtString DtAvailableFormationsAdmin::myCurrentFormation

protected

---

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

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