DtFormationTableEntry Class Reference

DtFormationTableEntry. More...

Inheritance diagram for DtFormationTableEntry:

List of all members.

Public Member Functions
	DtFormationTableEntry (const DtString &formationName, const DtFormation &formation)
	constructor
	DtFormationTableEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	reader-writer constructor
	DtFormationTableEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtFormationTableEntry ()
	destructor
	DtFormationTableEntry (const DtString &name, const DtFormationTableEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtFormationTableEntry (const DtSymbolString &name, const DtFormationTableEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtFormationTableEntry &	operator= (const DtFormationTableEntry &orig)
	assignment operator
virtual DtFormationTableEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtFormationTableEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	formationString ()
	Returns the formation type.
virtual DtFormation *	formation ()
	Returns the formation.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Overridden to retrieve the legacy parameter "formation-type" and covert it to "formation-name".
bool	operator== (const DtFormationTableEntry &) const
	Equality operators.
bool	operator!= (const DtFormationTableEntry &) const
virtual DtString	formationName () const
virtual void	setFormationName (const DtString &formName)
virtual DtReaderWriterFile &	formationFile ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtFormation	myFormation
	Parameter Name: Parameter Description: Parameter Default Value: .
DtReaderWriterFile	myFormationFile
	Parameter Name: formation-file Parameter Description: Parameter Default Value: .
DtRwString	myFormationName
	Parameter Name: formation-name Parameter Description: Name of this formation entry.
Private Member Functions
	DtFormationTableEntry ()
	default constructor. Not Implemented.

---

Detailed Description

DtFormationTableEntry.

Instances of DtFormationTableEntry are used by the DtFormationTable class to parse the "formation" and "formation-file" fields of entries in the "formation-list" section of the pseudo-aggregate-formation-controller.

---

Constructor & Destructor Documentation

DtFormationTableEntry::DtFormationTableEntry

(

)

[private]

default constructor. Not Implemented.

DtFormationTableEntry::DtFormationTableEntry	(	const DtString &	formationName,
		const DtFormation &	formation
	)

constructor

DtFormationTableEntry::DtFormationTableEntry	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

reader-writer constructor

DtFormationTableEntry::DtFormationTableEntry	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtFormationTableEntry::~DtFormationTableEntry

(

)

[virtual]

destructor

DtFormationTableEntry::DtFormationTableEntry	(	const DtString &	name,
		const DtFormationTableEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtFormationTableEntry::DtFormationTableEntry	(	const DtSymbolString &	name,
		const DtFormationTableEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

---

Member Function Documentation

DtFormationTableEntry& DtFormationTableEntry::operator=

(

const DtFormationTableEntry &

orig

)

assignment operator

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

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

virtual DtString DtFormationTableEntry::formationString

(

)

[virtual]

Returns the formation type.

Returns:

The string name of the formation.

Deprecated:

After VRF 3.11. Use formationName() instead.

virtual DtString DtFormationTableEntry::formationName

(

)

const [virtual]

See also:

myFormationName.

virtual void DtFormationTableEntry::setFormationName

(

const DtString &

formName

)

[virtual]

See also:

myFormationName.

virtual DtReaderWriterFile& DtFormationTableEntry::formationFile

(

)

[virtual]

See also:

myFormationFile

virtual DtFormation* DtFormationTableEntry::formation

(

)

[virtual]

Returns the formation.

virtual void DtFormationTableEntry::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath = DtFilename::nullFilename(),
		const DtVariableBindingsList &	variableBindings = nullVariableReference()
	)		[virtual]

Overridden to retrieve the legacy parameter "formation-type" and covert it to "formation-name".

bool DtFormationTableEntry::operator==

(

const DtFormationTableEntry &

)

const

Equality operators.

bool DtFormationTableEntry::operator!=

(

const DtFormationTableEntry &

)

const

---

Member Data Documentation

DtFormation DtFormationTableEntry::myFormation [protected]

Parameter Name:
Parameter Description:
Parameter Default Value:
.

DtReaderWriterFile DtFormationTableEntry::myFormationFile [protected]

Parameter Name: formation-file
Parameter Description:
Parameter Default Value:
.

DtRwString DtFormationTableEntry::myFormationName [protected]

Parameter Name: formation-name
Parameter Description: Name of this formation entry.

This name is presented in the GUI when picking formations.
Parameter Default Value:

---

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

• include/vrfutil/formTblEntry.h