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.

Inheritance diagram for DtFormationTable:

[legend]

Classes
struct	FormationAdder

Public Member Functions
	DtFormationTable ()

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

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

virtual	~DtFormationTable () override

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

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

	DtFormationTable (const DtFormationTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)

const DtFormationTable &	operator= (const DtFormationTable &orig)

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, DtString *actualName=0) const

virtual DtFormation *	getDefaultFormation () const

virtual DtFormationTableEntry *	getDefaultFormationEntry () const

virtual void	setFormationToDefault (DtFormationTableEntry *entry)

virtual void	addFormation (const DtString &formationName, const DtFormation &formation)

virtual bool	removeFormation (const DtString &formationName)

virtual void	addFormationEntry (DtFormationTableEntry *entry)

virtual DtFormationTableEntry *	getFormationEntry (const DtString &formationName) const

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

virtual const char *	readerWriterType () const override

virtual void	setAutoLayoutForGui (bool)

virtual bool	autoLayoutForGui () const

bool	operator== (const DtFormationTable &) const

bool	operator!= (const DtFormationTable &) const

Public Member Functions inherited from DtRwList
	DtRwList ()

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

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

virtual	~DtRwList () override

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	add (DtReaderWriter *data)

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual void *	remove (DtReaderWriter data, DtListItem item)

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAll ()

virtual void	removeAndDeleteAll ()

virtual void	reset () override

bool	operator== (const DtRwList &rhs) const

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)

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

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

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

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtString	standardFormationName (const DtString &name)

static void	standardizeFormationName (DtString &nameToChange)

Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()

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 char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

void	copyTable (const DtFormationTable &other)

void	emptyTable ()

Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwBoolean	myAutoLayoutForGui

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const override

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

virtual const char *	xmlType () const override

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

static const char *	theXmlType ()

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

static DtOutputStream *	theOutputStream

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 ( )

overridevirtual

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,
		DtString *	actualName = `0`
	)		const

virtual

Returns the formation associated with the formation name. If the second argument is provided, it returns the name that the formation is actually stored under. This is the regularized 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
	)

overridevirtual

from parent to ensure list is clear before getting self

Reimplemented from DtRwList.

virtual const char* DtFormationTable::readerWriterType ( ) const

overridevirtual

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

overridevirtual

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()`
	)

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwList.

static const char* DtFormationTable::theXmlType ( )

static

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

virtual const char* DtFormationTable::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwList.

References DtRwList::theXmlType().

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

overridevirtual

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

Reimplemented from DtRwList.

static DtString DtFormationTable::standardFormationName ( const DtString & name )

static

Provides a service for standardizing the formation name for other modules.

static void DtFormationTable::standardizeFormationName ( DtString & nameToChange )

static

Changes the given formation name to one in standard form.

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

overrideprotectedvirtual

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/formationTable.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation