DtRotaryWingColAvoidanceControllerDescriptor; descriptor for the DtRotaryWingCollisionAvoidanceController component. More...

Inheritance diagram for DtRotaryWingColAvoidanceControllerDescriptor:

[legend]

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

virtual DtReal	nominalDistance () const
	Accessor/mutator for myNominalDistance.
virtual void	setNominalDistance (DtReal val)
	Accessor/mutator for myNominalDistance.

virtual DtReal	searchDistance () const
	Accessor/mutator for mySearchDistance.
virtual void	setSearchDistance (DtReal val)
	Accessor/mutator for mySearchDistance.

virtual DtReal	collisionLimit () const
	Accessor/mutator for myCollisionLimit.
virtual void	setCollisionLimit (DtReal val)
	Accessor/mutator for myCollisionLimit.

virtual DtReal	clearingDistance () const
	Accessor/mutator for myClearingDistance.
virtual void	setClearingDistance (DtReal val)
	Accessor/mutator for myClearingDistance.

virtual DtReal	timeToMinDistance () const
	Accessor/mutator for myTimeToMinDistance.
virtual void	setTimeToMinDistance (DtReal val)
	Accessor/mutator for myTimeToMinDistance.

virtual DtReal	driftSpeed () const
	Accessor/mutator for myDriftSpeed.
virtual void	setDriftSpeed (DtReal val)
	Accessor/mutator for myDriftSpeed.

virtual DtReal	minDiveAltitude () const
	Accessor/mutator for myMinDiveAltitude.
virtual void	setMinDiveAltitude (DtReal val)
	Accessor/mutator for myMinDiveAltitude.
Public Member Functions inherited from DtRotaryWingTaskDescriptor
	DtRotaryWingTaskDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtRotaryWingTaskDescriptor (const DtRotaryWingTaskDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtRotaryWingTaskDescriptor &	operator= (const DtRotaryWingTaskDescriptor &orig)
	assignment
virtual	~DtRotaryWingTaskDescriptor ()
	destructor
virtual DtReal	defaultAggressiveness () const
	Accessor/mutator for myDefaultAggressiveness.
virtual void	setDefaultAggressiveness (const DtReal value)
	Accessor/mutator for myDefaultAggressiveness.
virtual DtReal	transitionRadius () const
	Accessor/mutator for myTransitionRadius.
virtual void	setTransitionRadius (const DtReal value)
	Accessor/mutator for myTransitionRadius.
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
virtual void	setDefaults ()
virtual void	copyValues (const DtRotaryWingColAvoidanceControllerDescriptor &orig)
	DtRotaryWingColAvoidanceControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtRotaryWingTaskDescriptor
	DtRotaryWingTaskDescriptor ()
	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	myNominalDistance
	Parameter Name: nominal-distance Parameter Description: This entity will move this distnace from an entity when it is avoiding a collision with it.
DtRwReal	mySearchDistance
	Parameter Name: search-distance Parameter Description: Entities within this distance will be checked for potential collisions with this entity.
DtRwReal	myCollisionLimit
	Parameter Name: collision-limit Parameter Description: The closest this entity should come to another entity.
DtRwReal	myClearingDistance
	Parameter Name: clearing-distance Parameter Description: When avoiding a collision, the collision is considered clear once this distance is between the two entities.
DtRwReal	myTimeToMinDistance
	Parameter Name: time-to-minimum-distance Parameter Description: Entity will start responding to potential collisions when the projected time to the entities being closer than collision-limit distance is smaller than this value.
DtRwReal	myDriftSpeed
	Parameter Name: drifting-speed Parameter Description: The maximum speed which is still considered stopped.
DtRwReal	myMinDiveAltitude
	Parameter Name: minimum-diving-altitude Parameter Description: When altitude is lower than this value, the entity will not dive to avoid a collision.
Protected Attributes inherited from DtRotaryWingTaskDescriptor
DtRwReal	myDefaultAggressiveness
	Parameter Name: default-aggressiveness Parameter Description: Acceleration level used by the helicopter in maneuvers is scaled by this value.
DtRwReal	myTransitionRadius
	Parameter Name: transition-radius Parameter Description: Distance (in meters) from a point or route endpoint within with the helicopter will complete movement tasks.
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

DtRotaryWingColAvoidanceControllerDescriptor; descriptor for the DtRotaryWingCollisionAvoidanceController component.

Instances of DtRotaryWingColAvoidanceControllerDescriptor are used to specify the parameters for a DtRotaryWingCollisionAvoidanceController object.

Constructor & Destructor Documentation

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

constructor

virtual DtRotaryWingColAvoidanceControllerDescriptor::~DtRotaryWingColAvoidanceControllerDescriptor ( )

virtual

destructor

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

copy constructor

DtRotaryWingColAvoidanceControllerDescriptor::DtRotaryWingColAvoidanceControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtRotaryWingColAvoidanceControllerDescriptor& DtRotaryWingColAvoidanceControllerDescriptor::operator= ( const DtRotaryWingColAvoidanceControllerDescriptor & orig )

assignment operator

virtual DtString DtRotaryWingColAvoidanceControllerDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns: DtRotaryWingColAvoidanceControllerDescriptorType

Reimplemented from DtRotaryWingTaskDescriptor.

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

virtual

Returns: New copy of this object.

Reimplemented from DtRotaryWingTaskDescriptor.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::nominalDistance ( ) const

virtual

Accessor/mutator for myNominalDistance.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setNominalDistance ( DtReal val )

virtual

Accessor/mutator for myNominalDistance.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::searchDistance ( ) const

virtual

Accessor/mutator for mySearchDistance.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setSearchDistance ( DtReal val )

virtual

Accessor/mutator for mySearchDistance.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::collisionLimit ( ) const

virtual

Accessor/mutator for myCollisionLimit.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setCollisionLimit ( DtReal val )

virtual

Accessor/mutator for myCollisionLimit.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::clearingDistance ( ) const

virtual

Accessor/mutator for myClearingDistance.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setClearingDistance ( DtReal val )

virtual

Accessor/mutator for myClearingDistance.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::timeToMinDistance ( ) const

virtual

Accessor/mutator for myTimeToMinDistance.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setTimeToMinDistance ( DtReal val )

virtual

Accessor/mutator for myTimeToMinDistance.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::driftSpeed ( ) const

virtual

Accessor/mutator for myDriftSpeed.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setDriftSpeed ( DtReal val )

virtual

Accessor/mutator for myDriftSpeed.

virtual DtReal DtRotaryWingColAvoidanceControllerDescriptor::minDiveAltitude ( ) const

virtual

Accessor/mutator for myMinDiveAltitude.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setMinDiveAltitude ( DtReal val )

virtual

Accessor/mutator for myMinDiveAltitude.

static DtComponentDescriptor* DtRotaryWingColAvoidanceControllerDescriptor::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 DtRotaryWingTaskDescriptor.

virtual void DtRotaryWingColAvoidanceControllerDescriptor::setDefaults ( )

protectedvirtual

virtual void DtRotaryWingColAvoidanceControllerDescriptor::copyValues ( const DtRotaryWingColAvoidanceControllerDescriptor & orig )

protectedvirtual

Member Data Documentation

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myNominalDistance

protected

Parameter Name: nominal-distance
Parameter Description: This entity will move this distnace from an entity when it is avoiding a collision with it.

Parameter Default Value: 100.0
Parameter Units: meters

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::mySearchDistance

protected

Parameter Name: search-distance
Parameter Description: Entities within this distance will be checked for potential collisions with this entity.

Parameter Default Value: 1000.0
Parameter Units: meters

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myCollisionLimit

protected

Parameter Name: collision-limit
Parameter Description: The closest this entity should come to another entity.

Parameter Default Value: 40.0
Parameter Units: meters

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myClearingDistance

protected

Parameter Name: clearing-distance
Parameter Description: When avoiding a collision, the collision is considered clear once this distance is between the two entities.

Parameter Default Value: 50.0
Parameter Units: meters

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myTimeToMinDistance

protected

Parameter Name: time-to-minimum-distance
Parameter Description: Entity will start responding to potential collisions when the projected time to the entities being closer than collision-limit distance is smaller than this value.

Smaller times will result in later responses to potential collisions.
Parameter Default Value: 10.0
Parameter Units: seconds

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myDriftSpeed

protected

Parameter Name: drifting-speed
Parameter Description: The maximum speed which is still considered stopped.

This applied both to this entity, and to other entities this controller is examining.
Parameter Default Value: 5.0
Parameter Units: meters/second

DtRwReal DtRotaryWingColAvoidanceControllerDescriptor::myMinDiveAltitude

protected

Parameter Name: minimum-diving-altitude
Parameter Description: When altitude is lower than this value, the entity will not dive to avoid a collision.

Parameter Default Value: 100.0
Parameter Units: meters

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/rotWgColAvDsc.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