DtAggregateMoveAlongDescriptor Class Reference

Class DtAggregateMoveAlongDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateMoveAlongController model component. More...

Inheritance diagram for DtAggregateMoveAlongDescriptor:

Public Member Functions
	DtAggregateMoveAlongDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAggregateMoveAlongDescriptor (const DtAggregateMoveAlongDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtAggregateMoveAlongDescriptor &	operator= (const DtAggregateMoveAlongDescriptor &orig)
	assignment
virtual	~DtAggregateMoveAlongDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	catchUpFactor () const
	Accessor/mutator for myCatchupFactor.
virtual void	setCatchUpFactor (double catchUpFactor)
virtual DtReal	slowDownFactor () const
	Accessor/mutator for mySlowDownFactor.
virtual void	setSlowDownFactor (double slowDownFactor)
virtual double	inPositionTolerance () const
	Accessor/mutator for myInPositionTolerance.
virtual void	setInPositionTolerance (double tolerance)
virtual DtTime	evaluationInterval () const
	Accessor/mutator for myEvaluationInterval.
virtual void	setEvaluationInterval (DtTime intervalInSeconds)
virtual bool	generateRoutesWithRoundedCorners () const
	Accessor/mutator for myGenerateRoutesWithRoundedCorners.
virtual void	setGenerateRoutesWithRoundedCorners (bool yesNo)
virtual double	vertexSpacingAlongRoundedCorners () const
	Accessor/mutator for myVertexSpacingAlongRoundedCorners.
virtual void	setVertexSpacingAlongRoundedCorners (double spacingInMeters)
virtual bool	groundClamp () const
	Accessor/mutator for myGroundClamp.
virtual void	setGroundClamp (bool yesNo)
Public Member Functions inherited from DtAggregatedMoveToDescriptor
	DtAggregatedMoveToDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtAggregatedMoveToDescriptor (const DtAggregatedMoveToDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtAggregatedMoveToDescriptor ()
DtAggregatedMoveToDescriptor &	operator= (const DtAggregatedMoveToDescriptor &orig)
	assignment
virtual double	atDistance () const
	Accessor/mutator for myAtDistance.
virtual void	setAtDistance (double distance)
virtual bool	allowRetrogradeMovement () const
	Accessor/mutator for myAllowRetrogradeMovement.
virtual void	setAllowRetrogradeMovement (bool)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object.
virtual bool	createOnRemoteObject () const
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 void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original 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 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	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 DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
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	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.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtAggregateMoveAlongDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtAggregatedMoveToDescriptor
	DtAggregatedMoveToDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myCatchupFactor
	Parameter Name: catchup-factor Parameter Description: Speed multiplier factor set in its subordiantes when they are falling behind in formation.
DtRwReal	mySlowDownFactor
	Parameter Name: slowdown-factor Parameter Description: Speed multiplier the aggregate uses to send speed control messages to a subordinate when it is ahead of where it should be in formation.
DtRwReal	myInPositionTolerance
	Parameter Name: in-position-tolerance Parameter Description: Tolerance about which an entity is considered to be 'in position' while moving in formation.
DtRwReal	myEvaluationInterval
	Parameter Name: evaluation-interval Parameter Description: Evaluation rate for monitoring subordinate position status.
DtRwBoolean	myGenerateRoutesWithRoundedCorners
	Parameter Name: generate-routes-with-rounded-corners Parameter Description: Choice as to whether or not to generate offset routes with 'rounded' corners.
DtRwReal	myVertexSpacingAlongRoundedCorners
	Parameter Name: vertex-spacing-along-rounded-corners Parameter Description: Spacing between vertices in meters on the rounded corners of generated routes, if generateRoutesWithRoundedCorners() is true.
DtRwBoolean	myGroundClamp
	Parameter Name: ground-clamp Parameter Description: Ground-clamp generated route vertices.
Protected Attributes inherited from DtAggregatedMoveToDescriptor
DtRwReal	myAtDistance
	Parameter Name: at-distance Parameter Description: Maximum distance from goal entity is considered to be 'at' desired location.
DtRwBoolean	myAllowRetrogradeMovement
	Parameter Name: allow-retrograde-movement Parameter Description: Whether or not retrograde movement is allowed.
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component.
DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not.
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations.
DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled.
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local.
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.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

Class DtAggregateMoveAlongDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateMoveAlongController model component.

End User Description: The DtAggregateMoveAlongDescriptor should only be configured as a part of aggregate entity types (entities configured with a vrf-aggregate-state-repository).

Constructor & Destructor Documentation

DtAggregateMoveAlongDescriptor::DtAggregateMoveAlongDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtAggregateMoveAlongDescriptor::DtAggregateMoveAlongDescriptor	(	const DtAggregateMoveAlongDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtAggregateMoveAlongDescriptor::~DtAggregateMoveAlongDescriptor ( )

virtual

destructor

DtAggregateMoveAlongDescriptor::DtAggregateMoveAlongDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtAggregateMoveAlongDescriptor& DtAggregateMoveAlongDescriptor::operator=

(

const DtAggregateMoveAlongDescriptor &

orig

)

assignment

virtual DtString DtAggregateMoveAlongDescriptor::type ( ) const

virtual

Returns the type of descriptor.

Used to create the descriptor when read in from an mtl file. Descriptor types are defined in compDescTypes.h

Returns

DtAggregateMoveAlongControllerDescriptorType

Reimplemented from DtAggregatedMoveToDescriptor.

virtual DtReal DtAggregateMoveAlongDescriptor::catchUpFactor ( ) const

virtual

Accessor/mutator for myCatchupFactor.

virtual void DtAggregateMoveAlongDescriptor::setCatchUpFactor ( double  catchUpFactor )

virtual

virtual DtReal DtAggregateMoveAlongDescriptor::slowDownFactor ( ) const

virtual

Accessor/mutator for mySlowDownFactor.

virtual void DtAggregateMoveAlongDescriptor::setSlowDownFactor ( double  slowDownFactor )

virtual

virtual double DtAggregateMoveAlongDescriptor::inPositionTolerance ( ) const

virtual

Accessor/mutator for myInPositionTolerance.

virtual void DtAggregateMoveAlongDescriptor::setInPositionTolerance ( double  tolerance )

virtual

virtual DtTime DtAggregateMoveAlongDescriptor::evaluationInterval ( ) const

virtual

Accessor/mutator for myEvaluationInterval.

virtual void DtAggregateMoveAlongDescriptor::setEvaluationInterval ( DtTime  intervalInSeconds )

virtual

virtual bool DtAggregateMoveAlongDescriptor::generateRoutesWithRoundedCorners ( ) const

virtual

Accessor/mutator for myGenerateRoutesWithRoundedCorners.

virtual void DtAggregateMoveAlongDescriptor::setGenerateRoutesWithRoundedCorners ( bool  yesNo )

virtual

virtual double DtAggregateMoveAlongDescriptor::vertexSpacingAlongRoundedCorners ( ) const

virtual

Accessor/mutator for myVertexSpacingAlongRoundedCorners.

virtual void DtAggregateMoveAlongDescriptor::setVertexSpacingAlongRoundedCorners ( double  spacingInMeters )

virtual

virtual bool DtAggregateMoveAlongDescriptor::groundClamp ( ) const

virtual

Accessor/mutator for myGroundClamp.

virtual void DtAggregateMoveAlongDescriptor::setGroundClamp ( bool  yesNo )

virtual

virtual DtComponentDescriptor* DtAggregateMoveAlongDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtAggregatedMoveToDescriptor.

static DtComponentDescriptor* DtAggregateMoveAlongDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtAggregatedMoveToDescriptor.

Member Data Documentation

DtRwReal DtAggregateMoveAlongDescriptor::myCatchupFactor

protected

Parameter Name: catchup-factor
Parameter Description: Speed multiplier factor set in its subordiantes when they are falling behind in formation.

Catchup factor is multiplied by ordered speed.
Parameter Default Value: 1.5

DtRwReal DtAggregateMoveAlongDescriptor::mySlowDownFactor

protected

Parameter Name: slowdown-factor
Parameter Description: Speed multiplier the aggregate uses to send speed control messages to a subordinate when it is ahead of where it should be in formation.

Factor is multiplied by ordered speed.
Parameter Default Value: 0.1

DtRwReal DtAggregateMoveAlongDescriptor::myInPositionTolerance

protected

Parameter Name: in-position-tolerance
Parameter Description: Tolerance about which an entity is considered to be 'in position' while moving in formation.

Expressed as a fraction of formation spacing (distance between an entity and the entity it is relative to in formation). If entity is +/- (0.5 * tolerance * formation spacing), aggregate sends a set speed message to the subordinate, indicating it should slow down or speed up, accordingly.
Parameter Default Value: 0.25

DtRwReal DtAggregateMoveAlongDescriptor::myEvaluationInterval

protected

Parameter Name: evaluation-interval
Parameter Description: Evaluation rate for monitoring subordinate position status.

Parameter Default Value: 1.0
Parameter Units: seconds

DtRwBoolean DtAggregateMoveAlongDescriptor::myGenerateRoutesWithRoundedCorners

protected

Parameter Name: generate-routes-with-rounded-corners
Parameter Description: Choice as to whether or not to generate offset routes with 'rounded' corners.

A value of true will result in the move-along-controller generating routes that sweep out an arc for entities on the outside of a turn along the route. A value of false will result in the move-along-controller generating routes that 'cut corners' on the ourside of turns.
Parameter Default Value: true

DtRwReal DtAggregateMoveAlongDescriptor::myVertexSpacingAlongRoundedCorners

protected

Parameter Name: vertex-spacing-along-rounded-corners
Parameter Description: Spacing between vertices in meters on the rounded corners of generated routes, if generateRoutesWithRoundedCorners() is true.

Closer spacing results in a better approximation of an arc.
Parameter Default Value: 20.0
Parameter Units: meters

DtRwBoolean DtAggregateMoveAlongDescriptor::myGroundClamp

protected

Parameter Name: ground-clamp
Parameter Description: Ground-clamp generated route vertices.

Ground-vehicles and human aggregates should set this value to true. Fixed-wing and rotary-wing entities should set this value to false.
Parameter Default Value: True

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/aggregateMoveAlongDescriptor.h