DtGroundFollowEntityDescriptor Class Reference

A DtGroundMoveToDescriptor that has the speed ratios to use when at, near, or past the desired location relative to the followed entity. End User Description: You can set the at-distance, near-distance, passed-slow-down-factor, near-catch-up-factor, and far-catch-up-factor parameters in the object parameters database.
Developer Description: The terms 'at' and 'near' are used with the same meaning as in the DtGroundMoveToDescriptor.

Inheritance diagram for DtGroundFollowEntityDescriptor:

Public Member Functions
	DtGroundFollowEntityDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtGroundFollowEntityDescriptor (const DtGroundFollowEntityDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtGroundFollowEntityDescriptor &	operator= (const DtGroundFollowEntityDescriptor &orig)
virtual	~DtGroundFollowEntityDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	nearCatchUpFactor () const
virtual void	setNearCatchUpFactor (DtReal nearCatchUpFactor)
virtual DtReal	farCatchUpFactor () const
virtual void	setFarCatchUpFactor (DtReal farCatchUpFactor)
virtual DtReal	passedSlowDownFactor () const
virtual void	setPassedSlowDownFactor (DtReal passedSlowDownFactor)
virtual double	distanceReplanThreshold () const
virtual void	setDistanceReplanThreshold (double replanDistance)
virtual double	timeReplanThreshold () const
virtual void	setTimeReplanThreshold (double replanDistance)
virtual double	targetLookaheadTime () const
virtual void	setTargetLookaheadTime (double time)
virtual double	destinationSmoothingPeriod () const
virtual void	setDestinationSmoothingPeriod (double time)
Public Member Functions inherited from DtGroundMoveToDescriptor
	DtGroundMoveToDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtGroundMoveToDescriptor (const DtGroundMoveToDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtGroundMoveToDescriptor &	operator= (const DtGroundMoveToDescriptor &orig)
virtual	~DtGroundMoveToDescriptor ()
virtual void	setAtDistance (DtReal atDistance)
virtual DtReal	atDistance () const
virtual void	setNearDistance (DtReal nearDistance)
virtual DtReal	nearDistance () const
virtual void	setApproachSpeed (DtReal approachSpeed)
virtual DtReal	approachSpeed () const
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 ()
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	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 DtGroundMoveToDescriptor
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
	DtGroundFollowEntityDescriptor ()
Protected Member Functions inherited from DtGroundMoveToDescriptor
	DtGroundMoveToDescriptor ()
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	myNearCatchUpFactor
DtRwReal	myFarCatchUpFactor
DtRwReal	myPassedSlowDownFactor
DtRwReal	myDistanceReplanThreshold
DtRwReal	myTimeReplanThreshold
DtRwReal	myTargetLookaheadTime
DtRwReal	myDestinationSmoothingPeriod
Protected Attributes inherited from DtGroundMoveToDescriptor
DtRwReal	myNearDistance
DtRwReal	myAtDistance
DtRwReal	myApproachSpeed
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
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

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

constructor

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

copy constructor

virtual DtGroundFollowEntityDescriptor::~DtGroundFollowEntityDescriptor ( )

virtual

destructor

DtGroundFollowEntityDescriptor::DtGroundFollowEntityDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtGroundFollowEntityDescriptor& DtGroundFollowEntityDescriptor::operator=

(

const DtGroundFollowEntityDescriptor &

orig

)

assignment

virtual DtString DtGroundFollowEntityDescriptor::type ( ) const

virtual

Returns the type of descriptor. This will be used to create the descriptor on read from an mtl file.

Reimplemented from DtGroundMoveToDescriptor.

virtual DtReal DtGroundFollowEntityDescriptor::nearCatchUpFactor ( ) const

virtual

Accessor/mutator for myNearCatchUpFactor.

virtual void DtGroundFollowEntityDescriptor::setNearCatchUpFactor ( DtReal  nearCatchUpFactor )

virtual

Accessor/mutator for myNearCatchUpFactor.

virtual DtReal DtGroundFollowEntityDescriptor::farCatchUpFactor ( ) const

virtual

Accessor/mutator for myFarCatchUpFactor.

virtual void DtGroundFollowEntityDescriptor::setFarCatchUpFactor ( DtReal  farCatchUpFactor )

virtual

Accessor/mutator for myFarCatchUpFactor.

virtual DtReal DtGroundFollowEntityDescriptor::passedSlowDownFactor ( ) const

virtual

Accessor/mutator for myPassedSlowDownFactor.

virtual void DtGroundFollowEntityDescriptor::setPassedSlowDownFactor ( DtReal  passedSlowDownFactor )

virtual

Accessor/mutator for myPassedSlowDownFactor.

virtual double DtGroundFollowEntityDescriptor::distanceReplanThreshold ( ) const

virtual

Accessor/mutator for myDistanceReplanThreshold.

virtual void DtGroundFollowEntityDescriptor::setDistanceReplanThreshold ( double  replanDistance )

virtual

Accessor/mutator for myDistanceReplanThreshold.

virtual double DtGroundFollowEntityDescriptor::timeReplanThreshold ( ) const

virtual

Accessor/mutator for myTimeReplanThreshold.

virtual void DtGroundFollowEntityDescriptor::setTimeReplanThreshold ( double  replanDistance )

virtual

Accessor/mutator for myTimeReplanThreshold.

virtual double DtGroundFollowEntityDescriptor::targetLookaheadTime ( ) const

virtual

Accessor/mutator for myTargetLookaheadTime.

virtual void DtGroundFollowEntityDescriptor::setTargetLookaheadTime ( double  time )

virtual

Accessor/mutator for myTargetLookaheadTime.

virtual double DtGroundFollowEntityDescriptor::destinationSmoothingPeriod ( ) const

virtual

Accessor/mutator for myDestinationSmoothingPeriod.

virtual void DtGroundFollowEntityDescriptor::setDestinationSmoothingPeriod ( double  time )

virtual

Accessor/mutator for myDestinationSmoothingPeriod.

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

virtual

Reimplemented from DtGroundMoveToDescriptor.

static DtComponentDescriptor* DtGroundFollowEntityDescriptor::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 DtGroundFollowEntityDescriptor::myNearCatchUpFactor

protected

Parameter Name: near-catch-up-factor
Parameter Description: The speed the entity uses to catch up to the followed entity if it is 'near', but not 'at' the point at which it is supposed to be relative to the followed entity.
Parameter Default Value: 1.1.

DtRwReal DtGroundFollowEntityDescriptor::myFarCatchUpFactor

protected

Parameter Name: far-catch-up-factor Parameter Description: The amount by which the ordered speed increases so that the entity can catch up to the followed entity if it is further away from the followed entity than the 'near' distance. Parameter Default Value: 1.25.

DtRwReal DtGroundFollowEntityDescriptor::myPassedSlowDownFactor

protected

Parameter Name: passed-slow-down-factor
Parameter Description: Speed the entity is to use if it is closer to the followed entity than the specified following distance. The default slowdown factor is 0.1 times the speed of the followed entity.
Parameter Default Value: 0.1
.

DtRwReal DtGroundFollowEntityDescriptor::myDistanceReplanThreshold

protected

Parameter Name: distance-replan-threshold
Parameter Description: Parameter Units: meters Parameter Default Value: 10.0.

DtRwReal DtGroundFollowEntityDescriptor::myTimeReplanThreshold

protected

Parameter Name: time-replan-threshold
Parameter Description: Parameter Units: seconds Parameter Default Value: 10.0.

DtRwReal DtGroundFollowEntityDescriptor::myTargetLookaheadTime

protected

Parameter Name: target-lookahead-time
Parameter Description: Parameter Units: seconds Parameter Default Value: 10.0.

DtRwReal DtGroundFollowEntityDescriptor::myDestinationSmoothingPeriod

protected

Parameter Name: destination-smoothing-period
Parameter Description: Parameter Units: seconds Parameter Default Value: 0.2.

---

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

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