DtFormationEntry Class Reference

DtFormationEntry; readable/writeable entry in a DtFormation. More...

Inheritance diagram for DtFormationEntry:

Public Member Functions
	DtFormationEntry ()
	default constructor
	DtFormationEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	constructor
	DtFormationEntry (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtFormationEntry ()
	destructor
	DtFormationEntry (const DtString &name, const DtFormationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtFormationEntry (const DtSymbolString &name, const DtFormationEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtFormationEntry &	operator= (const DtFormationEntry &orig)
	assignment operator
DtFormationEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Clones a formation entry.
DtFormationEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
bool	operator== (const DtFormationEntry &) const
bool	operator!= (const DtFormationEntry &) const
virtual const DtRwInt &	promotionId () const
	Accessor/mutator for myPromotionId.
virtual void	setPromotionId (int id)
	Accessor/mutator for myPromotionId.
virtual const DtRwInt &	leaderPromotionId () const
	Accessor/mutator for myLeaderPromotionId.
virtual void	setLeaderPromotionId (int id)
	Accessor/mutator for myLeaderPromotionId.
virtual const DtRwVector &	positionOffset () const
	Accessor/mutator for myPositionOffsetRelLeader.
virtual void	setPositionOffset (const DtVector &offset)
	Accessor/mutator for myPositionOffsetRelLeader.
virtual const DtRwString &	subordinateFormation () const
	Accessor/mutator for mySubordinateFormation.
virtual void	setSubordinateFormation (const DtString &formationName)
	Accessor/mutator for mySubordinateFormation.
virtual void	setListItem (DtListItem *item)
	Used by DtFormation.
virtual DtListItem *	listItem ()
	Used by DtFormation.
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 (FILE *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 (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 void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
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 void	putData (FILE *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)
	Deriving class overrides these to get/put class specific data.
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 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)
	The variable name, if this object is a variable reference.
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 ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
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 ()
	Collection of child DtReaderWriter nodes owned by this object.
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 &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
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 Attributes
DtListItem *	myListItem
parameters
These parameters are available for setting in the OPD files.
DtRwInt	myPromotionId
	Parameter Name: promotion-id Parameter Description: Integer identifying position in formation.
DtRwInt	myLeaderPromotionId
	Parameter Name: leader-promotion-id Parameter Description: promotion-id of the formation position that this formation position is relative to.
DtRwVector	myPositionOffsetRelLeader
	Parameter Name: position-offset Parameter Description: Offset relative to the to leader-promotion-id.
DtRwString	mySubordinateFormation
	Parameter Name: subordinate-formation Parameter Description: The formation that will be used for the subordinates of the entity in this formation position.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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 (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
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 &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	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.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

Detailed Description

DtFormationEntry; readable/writeable entry in a DtFormation.

Instances of DtFormationEntry are entries in a DtFormation. Each entry contains the promotion ID of a given entity, the promotion ID of the entity it should be following in the formation, and the relative position it should maintain in following (in body coordinates of the entity being followed).

Constructor & Destructor Documentation

DtFormationEntry::DtFormationEntry

(

)

default constructor

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

constructor

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

virtual DtFormationEntry::~DtFormationEntry ( )

virtual

destructor

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

copy constructor

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

Member Function Documentation

DtFormationEntry& DtFormationEntry::operator=

(

const DtFormationEntry &

orig

)

assignment operator

virtual const DtRwInt& DtFormationEntry::promotionId ( ) const

virtual

Accessor/mutator for myPromotionId.

virtual void DtFormationEntry::setPromotionId ( int  id )

virtual

Accessor/mutator for myPromotionId.

virtual const DtRwInt& DtFormationEntry::leaderPromotionId ( ) const

virtual

Accessor/mutator for myLeaderPromotionId.

virtual void DtFormationEntry::setLeaderPromotionId ( int  id )

virtual

Accessor/mutator for myLeaderPromotionId.

virtual const DtRwVector& DtFormationEntry::positionOffset ( ) const

virtual

Accessor/mutator for myPositionOffsetRelLeader.

virtual void DtFormationEntry::setPositionOffset ( const DtVector &  offset )

virtual

Accessor/mutator for myPositionOffsetRelLeader.

virtual const DtRwString& DtFormationEntry::subordinateFormation ( ) const

virtual

Accessor/mutator for mySubordinateFormation.

virtual void DtFormationEntry::setSubordinateFormation ( const DtString &  formationName )

virtual

Accessor/mutator for mySubordinateFormation.

virtual void DtFormationEntry::setListItem ( DtListItem *  item )

virtual

Used by DtFormation.

virtual DtListItem* DtFormationEntry::listItem ( )

virtual

Used by DtFormation.

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

Clones a formation entry.

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

bool DtFormationEntry::operator==

(

const DtFormationEntry &

)

const

bool DtFormationEntry::operator!=

(

const DtFormationEntry &

)

const

Member Data Documentation

DtRwInt DtFormationEntry::myPromotionId

protected

Parameter Name: promotion-id
Parameter Description: Integer identifying position in formation.

Values start with 0, in order of decreasing importance (so in the case of a column formation, the head of the column would have the lowest number, and the tail would have the highest).
Parameter Default Value: -1

DtRwInt DtFormationEntry::myLeaderPromotionId

protected

Parameter Name: leader-promotion-id
Parameter Description: promotion-id of the formation position that this formation position is relative to.

A value of -1 indicates that this entry is the overall leader.
Parameter Default Value: -1

DtRwVector DtFormationEntry::myPositionOffsetRelLeader

protected

Parameter Name: position-offset
Parameter Description: Offset relative to the to leader-promotion-id.

If leader-promotion-id is -1, then this offset is relative to the aggregate as a whole. Parameter Default Value: (0. 0. 0.)

DtRwString DtFormationEntry::mySubordinateFormation

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

DtListItem* DtFormationEntry::myListItem

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfutil/formationEntry.h