A DtGroundMoveToDescriptor that has the speed ratios to use when at, near, or past the desired location relative to the followed entity. More...

Inheritance diagram for DtGroundFollowEntityDescriptor:

[legend]

Public Member Functions
	DtGroundFollowEntityDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtGroundFollowEntityDescriptor (const DtGroundFollowEntityDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtGroundFollowEntityDescriptor &	operator= (const DtGroundFollowEntityDescriptor &orig)
	assignment
virtual	~DtGroundFollowEntityDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const

virtual DtReal	nearCatchUpFactor () const
	Accessor/mutator for myNearCatchUpFactor.
virtual void	setNearCatchUpFactor (DtReal nearCatchUpFactor)
	Accessor/mutator for myNearCatchUpFactor.

virtual DtReal	farCatchUpFactor () const
	Accessor/mutator for myFarCatchUpFactor.
virtual void	setFarCatchUpFactor (DtReal farCatchUpFactor)
	Accessor/mutator for myFarCatchUpFactor.

virtual DtReal	passedSlowDownFactor () const
	Accessor/mutator for myPassedSlowDownFactor.
virtual void	setPassedSlowDownFactor (DtReal passedSlowDownFactor)
	Accessor/mutator for myPassedSlowDownFactor.
Public Member Functions inherited from DtGroundMoveToDescriptor
	DtGroundMoveToDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtGroundMoveToDescriptor (const DtGroundMoveToDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtGroundMoveToDescriptor &	operator= (const DtGroundMoveToDescriptor &orig)
	assignment
virtual	~DtGroundMoveToDescriptor ()
	destructor
virtual void	setAtDistance (DtReal atDistance)
	Accessor/mutator for myAtDistance.
virtual DtReal	atDistance () const
	Accessor/mutator for myAtDistance.
virtual void	setNearDistance (DtReal nearDistance)
	Accessor/mutator for myNearDistance.
virtual DtReal	nearDistance () const
	Accessor/mutator for myNearDistance.
virtual void	setApproachSpeed (DtReal approachSpeed)
	Accessor/mutator for myApproachSpeed.
virtual DtReal	approachSpeed () const
	Accessor/mutator for myApproachSpeed.
virtual void	setRoadCenterOffset (double value)
	Accessor/mutator for myRoadCenterOffset.
virtual double	roadCenterOffset () const
	Accessor/mutator for myRoadCenterOffset.
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 (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, 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
	Type of DtSimComponent this descriptor is associated with.
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
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created or not.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtGroundFollowEntityDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtGroundMoveToDescriptor
	DtGroundMoveToDescriptor ()
	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.
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 DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myNearCatchUpFactor
	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.
DtRwReal	myFarCatchUpFactor
	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.
DtRwReal	myPassedSlowDownFactor
	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.
Protected Attributes inherited from DtGroundMoveToDescriptor
DtRwReal	myNearDistance
	Parameter Name: near-distance Parameter Description: The distance from a destination point at which an entity begins to slow down.
DtRwReal	myAtDistance
	Parameter Name: at-distance Parameter Description: The distance from a destination point at which an entity considers itself to be at the point.
DtRwReal	myApproachSpeed
	Parameter Name: approach-speed Parameter Description: Speed entity should go when approaching (near) its goal.
DtRwReal	myRoadCenterOffset
	Parameter Name: road-center-offset Parameter Description: If the entity is using roads, this is the distance that should be maintained from the center of the road, in meters to the right of the direction of travel (negative numbers will be to the left).
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
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 assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

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.

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

Reimplemented from DtGroundMoveToDescriptor.

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

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation