DtAggregateMoveAlongDescriptor Class Reference

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

Inheritance diagram for DtAggregateMoveAlongDescriptor:

Public Member Functions
	DtAggregateMoveAlongDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtAggregateMoveAlongDescriptor (const DtAggregateMoveAlongDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtAggregateMoveAlongDescriptor &	operator= (const DtAggregateMoveAlongDescriptor &orig)
virtual	~DtAggregateMoveAlongDescriptor () override
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtReal	catchUpFactor () const
virtual void	setCatchUpFactor (double catchUpFactor)
virtual DtReal	slowDownFactor () const
virtual void	setSlowDownFactor (double slowDownFactor)
virtual double	inPositionTolerance () const
virtual void	setInPositionTolerance (double tolerance)
virtual DtTime	evaluationInterval () const
virtual void	setEvaluationInterval (DtTime intervalInSeconds)
virtual bool	generateRoutesWithRoundedCorners () const
virtual void	setGenerateRoutesWithRoundedCorners (bool yesNo)
virtual double	vertexSpacingAlongRoundedCorners () const
virtual void	setVertexSpacingAlongRoundedCorners (double spacingInMeters)
virtual bool	groundClamp () const
virtual void	setGroundClamp (bool yesNo)
Public Member Functions inherited from DtAggregatedMoveToDescriptor
	DtAggregatedMoveToDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	DtAggregatedMoveToDescriptor (const DtAggregatedMoveToDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtAggregatedMoveToDescriptor () override
DtAggregatedMoveToDescriptor &	operator= (const DtAggregatedMoveToDescriptor &orig)
virtual double	atDistance () const
virtual void	setAtDistance (double distance)
virtual bool	allowRetrogradeMovement () const
virtual void	setAllowRetrogradeMovement (bool)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor () override
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual bool	init ()
virtual const DtString &	stateAndParameterDataPrefix () const
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)
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	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () const
virtual void	setDebugActive (bool active)
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)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
virtual const DtRwProperties &	internalStateData () const
virtual DtRwProperties &	internalStateData ()
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	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	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
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 DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtAggregatedMoveToDescriptor
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *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 Member Functions
	DtAggregateMoveAlongDescriptor ()
Protected Member Functions inherited from DtAggregatedMoveToDescriptor
	DtAggregatedMoveToDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myCatchupFactor
DtRwReal	mySlowDownFactor
DtRwReal	myInPositionTolerance
DtRwReal	myEvaluationInterval
DtRwBoolean	myGenerateRoutesWithRoundedCorners
DtRwReal	myVertexSpacingAlongRoundedCorners
DtRwBoolean	myGroundClamp
Protected Attributes inherited from DtAggregatedMoveToDescriptor
DtRwReal	myAtDistance
DtRwBoolean	myAllowRetrogradeMovement
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwProperties	myInternalStateData
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
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 )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	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

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

constructor

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

copy constructor

virtual DtAggregateMoveAlongDescriptor::~DtAggregateMoveAlongDescriptor ( )

overridevirtual

destructor

DtAggregateMoveAlongDescriptor::DtAggregateMoveAlongDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtAggregateMoveAlongDescriptor& DtAggregateMoveAlongDescriptor::operator=

(

const DtAggregateMoveAlongDescriptor &

orig

)

assignment

virtual DtString DtAggregateMoveAlongDescriptor::type ( ) const

overridevirtual

Returns the type of descriptor. Used to create the descriptor when read in from an mtl file. Descriptor types are defined in simComponentDescriptorTypes.h.

Returns

DtAggregateMoveAlongDescriptorType

Reimplemented from DtAggregatedMoveToDescriptor.

virtual DtReal DtAggregateMoveAlongDescriptor::catchUpFactor ( ) const

virtual

Accessor/mutator for myCatchupFactor.

virtual void DtAggregateMoveAlongDescriptor::setCatchUpFactor ( double  catchUpFactor )

virtual

Accessor/mutator for myCatchupFactor.

virtual DtReal DtAggregateMoveAlongDescriptor::slowDownFactor ( ) const

virtual

Accessor/mutator for mySlowDownFactor.

virtual void DtAggregateMoveAlongDescriptor::setSlowDownFactor ( double  slowDownFactor )

virtual

Accessor/mutator for mySlowDownFactor.

virtual double DtAggregateMoveAlongDescriptor::inPositionTolerance ( ) const

virtual

Accessor/mutator for myInPositionTolerance.

virtual void DtAggregateMoveAlongDescriptor::setInPositionTolerance ( double  tolerance )

virtual

Accessor/mutator for myInPositionTolerance.

virtual DtTime DtAggregateMoveAlongDescriptor::evaluationInterval ( ) const

virtual

Accessor/mutator for myEvaluationInterval.

virtual void DtAggregateMoveAlongDescriptor::setEvaluationInterval ( DtTime  intervalInSeconds )

virtual

Accessor/mutator for myEvaluationInterval.

virtual bool DtAggregateMoveAlongDescriptor::generateRoutesWithRoundedCorners ( ) const

virtual

Accessor/mutator for myGenerateRoutesWithRoundedCorners.

virtual void DtAggregateMoveAlongDescriptor::setGenerateRoutesWithRoundedCorners ( bool  yesNo )

virtual

Accessor/mutator for myGenerateRoutesWithRoundedCorners.

virtual double DtAggregateMoveAlongDescriptor::vertexSpacingAlongRoundedCorners ( ) const

virtual

Accessor/mutator for myVertexSpacingAlongRoundedCorners.

virtual void DtAggregateMoveAlongDescriptor::setVertexSpacingAlongRoundedCorners ( double  spacingInMeters )

virtual

Accessor/mutator for myVertexSpacingAlongRoundedCorners.

virtual bool DtAggregateMoveAlongDescriptor::groundClamp ( ) const

virtual

Accessor/mutator for myGroundClamp.

virtual void DtAggregateMoveAlongDescriptor::setGroundClamp ( bool  yesNo )

virtual

Accessor/mutator for myGroundClamp.

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

overridevirtual

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.

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjparam/aggregateMoveAlongDescriptor.h