DtSubordinateAggregateEntry Class Reference

Inheritance diagram for DtSubordinateAggregateEntry:

Public Member Functions
	DtSubordinateAggregateEntry ()
	DtSubordinateAggregateEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSubordinateAggregateEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSubordinateAggregateEntry (const DtString &name, const DtSubordinateAggregateEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSubordinateAggregateEntry (const DtSymbolString &name, const DtSubordinateAggregateEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtSubordinateAggregateEntry &	operator= (const DtSubordinateAggregateEntry &orig)
virtual	~DtSubordinateAggregateEntry ()
virtual DtSubordinateAggregateEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtSubordinateAggregateEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setFormationName (const DtString &formationName)
virtual const DtString &	formationName () const
virtual const DtSubordinateObjectsList &	subordinateObjectsList () const
virtual void	setSubordinateObjectsList (const DtSubordinateObjectsList &subordList)
virtual DtSubordinateObjectsList &	getSubordinateObjects ()
Public Member Functions inherited from DtSubordinateEntry
	DtSubordinateEntry ()
	DtSubordinateEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSubordinateEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSubordinateEntry (const DtString &name, const DtSubordinateEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSubordinateEntry (const DtSymbolString &name, const DtSubordinateEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtSubordinateEntry &	operator= (const DtSubordinateEntry &orig)
virtual	~DtSubordinateEntry ()
virtual DtPoint	positionOffset (const DtPoint &accumOffset=DtPoint(0, 0, 0)) const
virtual void	setPositionOffset (const DtVector &offset=DtVector(0, 0, 0))
virtual const DtString &	subordinateEntryType () const
virtual void	setSubordinateEntryType (const DtString &entryType)
virtual const DtRwObjectType &	subordinateType () const
virtual void	setSubordinateType (const DtObjectType &subordinateType)
virtual bool	isDestroyed () const
virtual void	setDestroyed (bool trueFalse)
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)
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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 const char *	readerWriterType () const
virtual const char *	xmlType () const
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	wasUpdatedSince (DtTime t) 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	putData (DtEnvironmentSP, DtEnvValueSP value) 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	getData (const DtEnvironmentSP, const DtEnvValueSP, 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)

Static Public Member Functions
static DtSubordinateAggregateEntry *	createSubordinateEntry (const DtString &rwName, DtReaderWriterRegistry *parentRegistry)
static DtSubordinateEntry *	creator ()
Static Public Member Functions inherited from DtSubordinateEntry
static void	addSubordinateEntryCreatorFcn (const DtString &type, DtSubordinateEntryCreatorFcn fcn)
static DtSubordinateEntry *	createSubordinateEntry (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtSubordinateEntry *	createSubordinateEntry (const char *pName)
static DtSubordinateEntryFactory *	factory ()
static void	setFactory (DtSubordinateEntryFactory *factory)
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 Attributes
DtRwString	mySubordinateFormationName
DtSubordinateObjectsList	mySubordinateObjectsList
Protected Attributes inherited from DtSubordinateEntry
DtRwString	mySubordinateEntryType
DtRwObjectType	mySubordinateType
DtRwBoolean	myDestroyed
DtRwVector	myPositionOffset
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

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 )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSubordinateEntry
static DtSubordinateEntryFactory *	myFactory
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

DtSubordinateAggregateEntry::DtSubordinateAggregateEntry

(

)

default constructor

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

real constructor

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

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

copy constructor

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

virtual DtSubordinateAggregateEntry::~DtSubordinateAggregateEntry ( )

virtual

Member Function Documentation

const DtSubordinateAggregateEntry& DtSubordinateAggregateEntry::operator=

(

const DtSubordinateAggregateEntry &

orig

)

assignment operator

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

virtual

Reimplemented from DtSubordinateEntry.

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

virtual

Reimplemented from DtSubordinateEntry.

virtual void DtSubordinateAggregateEntry::setFormationName ( const DtString &  formationName )

virtual

Accessor/mutator for mySubordinateFormationName.

virtual const DtString& DtSubordinateAggregateEntry::formationName ( ) const

virtual

Accessor/mutator for mySubordinateFormationName.

virtual const DtSubordinateObjectsList& DtSubordinateAggregateEntry::subordinateObjectsList ( ) const

virtual

Accessor/mutator for mySubordinateObjectsList.

virtual void DtSubordinateAggregateEntry::setSubordinateObjectsList ( const DtSubordinateObjectsList &  subordList )

virtual

Accessor/mutator for mySubordinateObjectsList.

virtual DtSubordinateObjectsList& DtSubordinateAggregateEntry::getSubordinateObjects ( )

virtual

Accessor/mutator for mySubordinateObjectsList.

static DtSubordinateAggregateEntry* DtSubordinateAggregateEntry::createSubordinateEntry ( const DtString &  rwName, DtReaderWriterRegistry *  parentRegistry  )

static

static DtSubordinateEntry* DtSubordinateAggregateEntry::creator ( )

static

Member Data Documentation

DtRwString DtSubordinateAggregateEntry::mySubordinateFormationName

protected

Parameter Name: subordinate-formation
Parameter Description: The formation that will be used for the subordinates of the entity in this formation position. This allows for formations such as a line of columns. This parameter is ignored if an individual entity occupies the formation position. If the string is empty, then default formation will be used. Parameter Default Value: ""
.

DtSubordinateObjectsList DtSubordinateAggregateEntry::mySubordinateObjectsList

protected

Parameter Name: subordinate-objects
Parameter Description: List of SubordinateObjects
Parameter Default Value:
.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/subordinateAggregateEntry.h