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.

Inheritance diagram for DtFormationTableEntry:

[legend]

Public Member Functions
	DtFormationTableEntry (const DtString &formationName, const DtFormation &formation)

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

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

virtual	~DtFormationTableEntry () override

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

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

DtFormationTableEntry &	operator= (const DtFormationTableEntry &orig)

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

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

virtual const char *	readerWriterType () const override

virtual DtString	formationString ()

virtual DtFormation *	formation ()

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

bool	operator== (const DtFormationTableEntry &) const

bool	operator!= (const DtFormationTableEntry &) const


virtual DtString	formationName () const

virtual void	setFormationName (const DtString &formName)


virtual DtReaderWriterFile &	formationFile ()

virtual const DtReaderWriterFile &	formationFile () const

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

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 DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

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

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtFormation	myFormation

DtReaderWriterFile	myFormationFile

DtRwString	myFormationName

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

Private Member Functions
	DtFormationTableEntry ()

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

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 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 inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

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

overridevirtual

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 const char* DtFormationTableEntry::readerWriterType ( ) const

overridevirtual

Returns the formation type.

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

virtual DtString DtFormationTableEntry::formationString ( )

virtual

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

Referenced by DtFormationTable::FormationAdder::operator()().

virtual const DtReaderWriterFile& DtFormationTableEntry::formationFile ( ) const

virtual

See Also: myFormationFile

virtual DtFormation* DtFormationTableEntry::formation ( )

virtual

Returns the formation.

virtual void DtFormationTableEntry::getSelf	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths = `DtReaderWriter::SearchPaths()`,
		const DtVariableBindingsList &	variableBindings = `nullVariableReference()`
	)

overridevirtual

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

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

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

virtual void DtFormationTableEntry::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 DtReaderWriter.

static const char* DtFormationTableEntry::theXmlType ( )

static

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

virtual const char* DtFormationTableEntry::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

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:

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

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation