DtFormationTable Class Reference

DtFormationTable. More...

Inheritance diagram for DtFormationTable:

Classes
struct	FormationAdder

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)
	DtFormationTable (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 DtReaderWriter::SearchPaths &searchPaths, 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.
virtual void	setAutoLayoutForGui (bool)
	For entity editor only, set to true to always layout entries automatically when added to any formation in this table.
virtual bool	autoLayoutForGui () const
bool	operator== (const DtFormationTable &) const
	Equality operator.
bool	operator!= (const DtFormationTable &) const
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual void	removeAndDeleteAll ()
	Removes and deletes all items in the list.
virtual void	reset ()
	Calls removeAndDeleteAll.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
bool	operator!= (const DtRwList &rhs) const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, 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.
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtRwBoolean	myAutoLayoutForGui
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual const char *	xmlType () const
virtual std::set< DtString >	supportedXmlTypes () const
	Returns the list of xml types supported by this list. Default is DtXMLFormationEntryType.
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtRwList
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent

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
	)

DtFormationTable::DtFormationTable	(	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 DtReaderWriter::SearchPaths &  searchPaths, 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.

virtual void DtFormationTable::setAutoLayoutForGui ( bool  )

virtual

For entity editor only, set to true to always layout entries automatically when added to any formation in this table.

virtual bool DtFormationTable::autoLayoutForGui ( ) const

virtual

bool DtFormationTable::operator==

(

const DtFormationTable &

)

const

Equality operator.

bool DtFormationTable::operator!=

(

const DtFormationTable &

)

const

virtual void DtFormationTable::putData ( DtEnvironmentSP  , DtEnvValueSP  parent  ) const

virtual

Routines to archive/dearchive from an XML Environment

Reimplemented from DtRwList.

virtual void DtFormationTable::getData ( const DtEnvironmentSP  , const DtEnvValueSP  value, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(), const DtVariableBindingsList &  bindings = DtVariableBindingsList()  )

virtual

Reimplemented from DtRwList.

static const char* DtFormationTable::theXmlType ( )

static

The type that is used when archiving to an XML stream.

Reimplemented from DtRwList.

virtual const char* DtFormationTable::xmlType ( ) const

inlinevirtual

Reimplemented from DtRwList.

References DtRwList::theXmlType().

virtual std::set<DtString> DtFormationTable::supportedXmlTypes ( ) const

virtual

Returns the list of xml types supported by this list. Default is DtXMLFormationEntryType.

Reimplemented from DtRwList.

virtual DtlObjPtr DtFormationTable::getData ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

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.

Member Data Documentation

DtRwBoolean DtFormationTable::myAutoLayoutForGui

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfutil/formationTable.h