Inheritance diagram for DtFormationTable:

Public Member Functions
	DtFormationTable ()
	default constructor
	DtFormationTable (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtFormationTable (const DtSymbolString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtFormationTable ()
	destructor
	DtFormationTable (const DtString &writeName, const DtFormationTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtFormationTable (const DtSymbolString &writeName, const DtFormationTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtFormationTable &	operator= (const DtFormationTable &orig)
	assignment operator
virtual DtFormationTable *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtFormationTable *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtFormation *	getFormation (const DtString &formationName) const
	Returns the formation associated with the formation name.
virtual DtFormation *	getDefaultFormation () const
virtual DtFormationTableEntry *	getDefaultFormationEntry () const
virtual void	setFormationToDefault (DtFormationTableEntry *entry)
	Sets the specified formation entry to be the default formation.
virtual void	addFormation (const DtString &formationName, const DtFormation &formation)
	Adds a new formation to the table.
virtual bool	removeFormation (const DtString &formationName)
	Removes formation with given formation name.
virtual void	addFormationEntry (DtFormationTableEntry *entry)
	Adds the DtFormation from the DtFormationTableEntry into the list, using the formation name specified in the entry.
virtual DtFormationTableEntry *	getFormationEntry (const DtString &formationName) const
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	from parent to ensure list is clear before getting self
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
bool	operator== (const DtFormationTable &) const
	Equality operator.
bool	operator!= (const DtFormationTable &) const
Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a DtFormationEntry, reads the data from the mtl stream, and adds it to the list.
void	copyTable (const DtFormationTable &other)
	Adds all items from other to this table.
void	emptyTable ()
	Removes and deletes all items from this table.

Detailed Description

DtFormationTable.

Instances of DtFormationTable are used to process the "formation-list" section of the pseudo-aggregate-formation-controller entry in the vrfSim.opd file. Formations are maintained by formation name.

Constructor & Destructor Documentation

DtFormationTable::DtFormationTable ( )

default constructor

DtFormationTable::DtFormationTable	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

constructor

DtFormationTable::DtFormationTable	(	const DtSymbolString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

virtual DtFormationTable::~DtFormationTable ( ) [virtual]

destructor

DtFormationTable::DtFormationTable	(	const DtString &	writeName,
		const DtFormationTable &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

DtFormationTable::DtFormationTable	(	const DtSymbolString &	writeName,
		const DtFormationTable &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Member Function Documentation

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

assignment operator

virtual DtFormationTable* DtFormationTable::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const `[virtual]`

virtual DtFormationTable* DtFormationTable::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const `[virtual]`

virtual DtFormation* DtFormationTable::getFormation ( const DtString & formationName ) const [virtual]

Returns the formation associated with the formation name.

virtual DtFormation* DtFormationTable::getDefaultFormation ( ) const [virtual]

Returns:: The formation that is considered the default formation in this table.

virtual DtFormationTableEntry* DtFormationTable::getDefaultFormationEntry ( ) const [virtual]

Returns:: The default formation table entry

virtual void DtFormationTable::setFormationToDefault ( DtFormationTableEntry * entry ) [virtual]

Sets the specified formation entry to be the default formation.

Parameters:

entry must be a formation entry already in this table.

virtual void DtFormationTable::addFormation	(	const DtString &	formationName,
		const DtFormation &	formation
	)		`[virtual]`

Adds a new formation to the table.

The formationName is the name that will refer to this formation in the table. If the name matches an existing formation in the table, that formation is replaced.

virtual bool DtFormationTable::removeFormation ( const DtString & formationName ) [virtual]

Removes formation with given formation name.

Returns:: True if formation name was successfully found and removed, false otherwise.

virtual void DtFormationTable::addFormationEntry ( DtFormationTableEntry * entry ) [virtual]

Adds the DtFormation from the DtFormationTableEntry into the list, using the formation name specified in the entry.

Note:: Does not clone the entry. The table takes ownership of this entry pointer after this call.

virtual DtFormationTableEntry* DtFormationTable::getFormationEntry ( const DtString & formationName ) const [virtual]

Returns:: The formation entry that represents the particular formation

virtual void DtFormationTable::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		`[virtual]`

from parent to ensure list is clear before getting self

Reimplemented from DtRwList.

virtual const char* DtFormationTable::readerWriterType ( ) const [virtual]

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtRwList.

bool DtFormationTable::operator== ( const DtFormationTable & ) const

Equality operator.

bool DtFormationTable::operator!= ( const DtFormationTable & ) const

virtual DtlObjPtr DtFormationTable::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		`[protected, virtual]`

Constructs a DtFormationEntry, reads the data from the mtl stream, and adds it to the list.

Implements DtRwList.

void DtFormationTable::copyTable ( const DtFormationTable & other ) [protected]

Adds all items from other to this table.

Does not clear this table first. Non-virtual because it is used by the constructor/destructor.

void DtFormationTable::emptyTable ( ) [protected]

Removes and deletes all items from this table.

Non-virtual because it is used by the constructor/destructor.

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

include/vrfutil/formTbl.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation