DtFormationTableEntry Class Reference

DtFormationTableEntry. More...

Inheritance diagram for DtFormationTableEntry:

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 ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtFormationTableEntry ()
	default constructor. Not Implemented.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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".

Reimplemented from DtReaderWriter.

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