DtSurfaceEntityRoutePilotDescriptor. More...

Inheritance diagram for DtSurfaceEntityRoutePilotDescriptor:

Public Member Functions
	DtSurfaceEntityRoutePilotDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtSurfaceEntityRoutePilotDescriptor (const DtSurfaceEntityRoutePilotDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSurfaceEntityRoutePilotDescriptor &	operator= (const DtSurfaceEntityRoutePilotDescriptor &orig)
	assignment
virtual	~DtSurfaceEntityRoutePilotDescriptor ()
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
	Clone creates a new copy.
Public Member Functions inherited from DtSurfaceEntityPilotControllerDescriptor
	DtSurfaceEntityPilotControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtSurfaceEntityPilotControllerDescriptor (const DtSurfaceEntityPilotControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSurfaceEntityPilotControllerDescriptor &	operator= (const DtSurfaceEntityPilotControllerDescriptor &orig)
	assignment
virtual	~DtSurfaceEntityPilotControllerDescriptor ()
virtual void	setAtDistance (DtReal atDistance)
virtual DtReal	atDistance () const
	Accessor/mutator for myAtDistance.
virtual void	setNearDistance (DtReal nearDistance)
virtual DtReal	nearDistance () const
	Accessor/mutator for myNearDistance.
virtual void	setNormalAccelerationFraction (const DtReal fraction)
virtual double	normalAccelerationFraction () const
virtual void	setNormalLateralAccelerationFraction (const DtReal fraction)
virtual double	normalLateralAccelerationFraction () const
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
	DtSurfaceEntityRoutePilotDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtSurfaceEntityPilotControllerDescriptor
	DtSurfaceEntityPilotControllerDescriptor ()
	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.

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 )()
Protected Attributes inherited from DtSurfaceEntityPilotControllerDescriptor
DtRwReal	myAtDistance
	Parameter Name: at-distance Parameter Description: The distance from a destination point at which an entity considers itself to have arrived at that point.
DtRwReal	myNearDistance
	Parameter Name: near-distance Parameter Description: The distance from a destination point at which an entity begins to slow down.
DtRwReal	myNormalAccelerationFraction
	Parameter Name: normal-acceleration-fraction Parameter Description: The fraction (0.0, 1.0] of normal max accelerations that the entity prefers to use.
DtRwReal	myNormalLateralAccelerationFraction
	Parameter Name: normal-lateral-acceleration-fraction Parameter Description: The fraction (0.0, 1.0] of normal max lateral acceleration that the entity prefers to use.
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

DtSurfaceEntityRoutePilotDescriptor.

class DtSurfaceEntityRoutePilotDescriptor: A component descriptor for ship controllers that follow a route.

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtSurfaceEntityRoutePilotDescriptor::~DtSurfaceEntityRoutePilotDescriptor ( )

virtual

DtSurfaceEntityRoutePilotDescriptor::DtSurfaceEntityRoutePilotDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

static DtComponentDescriptor* DtSurfaceEntityRoutePilotDescriptor::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 DtSurfaceEntityPilotControllerDescriptor.

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

assignment

virtual DtString DtSurfaceEntityRoutePilotDescriptor::type ( ) const

virtual

Returns the type of descriptor.

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

Reimplemented from DtSurfaceEntityPilotControllerDescriptor.

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

virtual

Clone creates a new copy.

Reimplemented from DtSurfaceEntityPilotControllerDescriptor.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation