DtGroundMoveDirectionControllerDescriptor. More...

Inheritance diagram for DtGroundMoveDirectionControllerDescriptor:

Public Member Functions
	DtGroundMoveDirectionControllerDescriptor (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtGroundMoveDirectionControllerDescriptor (const DtGroundMoveDirectionControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	Copy constructor.
DtGroundMoveDirectionControllerDescriptor &	operator= (const DtGroundMoveDirectionControllerDescriptor &orig)
	Assignment operator.
virtual	~DtGroundMoveDirectionControllerDescriptor ()
	Destructor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const

virtual double	highSpeedMinPivotAngle () const
	Accessor/mutator for myHighSpeedMinPivotAngle.
virtual void	setHighSpeedMinPivotAngle (const double &newValue)
	Accessor/mutator for myHighSpeedMinPivotAngle.

virtual double	lowSpeedMinPivotAngle () const
	Accessor/mutator for myLowSpeedMinPivotAngle.
virtual void	setLowSpeedMinPivotAngle (const double &newValue)
	Accessor/mutator for myLowSpeedMinPivotAngle.

virtual bool	pivotOnTurns () const
	Accessor/mutator for myPivotOnTurns.
virtual void	setPivotOnTurns (const bool &newValue)
	Accessor/mutator for myPivotOnTurns.

virtual double	pivotSpeedCutoff () const
	Accessor/mutator for myPivotSpeedCutoff.
virtual void	setPivotSpeedCutoff (const double &newValue)
	Accessor/mutator for myPivotSpeedCutoff.
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.
	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.
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
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 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 ()
	Static creator function for factory registration.
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

Protected Attributes

DtRwReal	myHighSpeedMinPivotAngle
	Parameter Name: high-speed-min-pivot-angle Parameter Description: When the speed of the entity is above the pivot-speed-cutoff, it will pivot to its desired heading any time the desired heading is greater than this value from the actual heading.
DtRwReal	myLowSpeedMinPivotAngle
	Parameter Name: low-speed-min-pivot-angle Parameter Description: When the speed of the entity is below the pivot-speed-cutoff, it will pivot to its desired heading any time the desired heading is greater than this value from the actual heading.
DtRwBoolean	myPivotOnTurns
	Parameter Name: pivot-on-turns Parameter Description: Specifies whether or not the entity should pivot when turning.
DtRwReal	myPivotSpeedCutoff
	Parameter Name: pivot-speed-cutoff Parameter Description: Specifies the speed used to differentiate between hish-speed and low-speed-min-pivot-angles.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
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
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

DtGroundMoveDirectionControllerDescriptor.

This is the descriptor for DtGroundMoveDirectionController components. It contains all parameters which can be specified in the OPD file for this component.

Constructor & Destructor Documentation

DtGroundMoveDirectionControllerDescriptor::DtGroundMoveDirectionControllerDescriptor	(	const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Constructor.

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

Copy constructor.

virtual DtGroundMoveDirectionControllerDescriptor::~DtGroundMoveDirectionControllerDescriptor ( )

virtual

Destructor.

Member Function Documentation

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

Assignment operator.

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

virtual

Returns: a copy of this class using the copy constructor.

Reimplemented from DtComponentDescriptor.

virtual DtString DtGroundMoveDirectionControllerDescriptor::type ( ) const

virtual

Returns: DtGroundMoveDirectionControllerDescriptorType

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtGroundMoveDirectionControllerDescriptor::creator ( )

static

Static creator function for factory registration.

Reimplemented from DtComponentDescriptor.

virtual double DtGroundMoveDirectionControllerDescriptor::highSpeedMinPivotAngle ( ) const

virtual

Accessor/mutator for myHighSpeedMinPivotAngle.

virtual void DtGroundMoveDirectionControllerDescriptor::setHighSpeedMinPivotAngle ( const double & newValue )

virtual

Accessor/mutator for myHighSpeedMinPivotAngle.

virtual double DtGroundMoveDirectionControllerDescriptor::lowSpeedMinPivotAngle ( ) const

virtual

Accessor/mutator for myLowSpeedMinPivotAngle.

virtual void DtGroundMoveDirectionControllerDescriptor::setLowSpeedMinPivotAngle ( const double & newValue )

virtual

Accessor/mutator for myLowSpeedMinPivotAngle.

virtual bool DtGroundMoveDirectionControllerDescriptor::pivotOnTurns ( ) const

virtual

Accessor/mutator for myPivotOnTurns.

virtual void DtGroundMoveDirectionControllerDescriptor::setPivotOnTurns ( const bool & newValue )

virtual

Accessor/mutator for myPivotOnTurns.

virtual double DtGroundMoveDirectionControllerDescriptor::pivotSpeedCutoff ( ) const

virtual

Accessor/mutator for myPivotSpeedCutoff.

virtual void DtGroundMoveDirectionControllerDescriptor::setPivotSpeedCutoff ( const double & newValue )

virtual

Accessor/mutator for myPivotSpeedCutoff.

Member Data Documentation

DtRwReal DtGroundMoveDirectionControllerDescriptor::myHighSpeedMinPivotAngle

protected

Parameter Name: high-speed-min-pivot-angle
Parameter Description: When the speed of the entity is above the pivot-speed-cutoff, it will pivot to its desired heading any time the desired heading is greater than this value from the actual heading.

Parameter Default Value: pi/2 (90 degrees).
Parameter Units: Radians.

DtRwReal DtGroundMoveDirectionControllerDescriptor::myLowSpeedMinPivotAngle

protected

Parameter Name: low-speed-min-pivot-angle
Parameter Description: When the speed of the entity is below the pivot-speed-cutoff, it will pivot to its desired heading any time the desired heading is greater than this value from the actual heading.

Parameter Default Value: 0.175 (10 degrees)
Parameter Units: Radians.

DtRwBoolean DtGroundMoveDirectionControllerDescriptor::myPivotOnTurns

protected

Parameter Name: pivot-on-turns
Parameter Description: Specifies whether or not the entity should pivot when turning.

Pivoting will only occur if the entity is capable of pivoting, and if the conditions for a pivot turn are met, based on the other parameters.
Parameter Default Value: true

DtRwReal DtGroundMoveDirectionControllerDescriptor::myPivotSpeedCutoff

protected

Parameter Name: pivot-speed-cutoff
Parameter Description: Specifies the speed used to differentiate between hish-speed and low-speed-min-pivot-angles.

Parameter Default Value: 0.5 Parameter Units: m/s.

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

include/vrfobjparam/groundMoveDirectionControllerDesc.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation