![]() |
VR-Forces 4.2 Class Documentation
|
Instances of DtAutomotivePSR are used to hold the shared/checkpointable data for an automotive system. More...

Public Member Functions | |
| DtAutomotivePSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtAutomotivePSR (const DtAutomotivePSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| virtual | ~DtAutomotivePSR () |
| destructor | |
| DtAutomotivePSR & | operator= (const DtAutomotivePSR &orig) |
| assignment operator | |
| virtual DtVrfProcessStateRepository * | clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const |
| returns a newly created copy of this object | |
| virtual DtString | type () const |
| Returns the string type of the repository, as defined in procSRTypes.h. | |
| virtual void | emptyRouteVertices () |
| Empty route vertices. | |
| virtual DtLocalVectorIterator * | routeState () const |
| Get route state (an iterator over the route used to keep track of which point along the route we're heading toward). | |
| virtual void | unspecifyRoadPoints () |
| Sets the valueSpecified flag of both myRoadStartPoint and myRoadEndPoint to false. | |
| virtual bool | roadPointsSpecified () const |
| Returns true only if both myRoadStartPoint and myRoadEndPoint are specified. | |
| virtual int | currentVertex () const |
| Get the current vertex we are moving toward when executuing move-along behavior. | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) |
| Override to set myCurrentVertex from route state before writing. | |
| virtual void | setCurrentGear (DtAutoTransmissionGear gear) |
| Set/get current gear. | |
| virtual DtAutoTransmissionGear | currentGear () const |
| Set/get current gear. | |
| virtual void | setHeadingToTurnTo (double headingToTurnTo) |
| Set/get heading to turn to. | |
| virtual double | headingToTurnTo () const |
| Set/get heading to turn to. | |
| virtual void | setKTurnReverseGoalHeading (double kTurnReverseGoalHeading) |
| Get/Set the heading that is halfway between the original heading and the heading to turn to. | |
| virtual double | kTurnReverseGoalHeading () const |
| Get/Set the heading that is halfway between the original heading and the heading to turn to. | |
| virtual void | setKTurnReverseComplete (bool kTurnReverseComplete) |
| Get/set the flag that indicates whether or not the entity has completed first half of the turn maneuver (backing up until at kTurnReverseGoalHeading()) | |
| virtual bool | kTurnReverseComplete () const |
| Get/set the flag that indicates whether or not the entity has completed first half of the turn maneuver (backing up until at kTurnReverseGoalHeading()) | |
| virtual void | setControlObjectName (const DtString &controlObjectName) |
| Get/set the name of the control object to move to (waypoint name). | |
| virtual const DtString & | controlObjectName () const |
| Get/set the name of the control object to move to (waypoint name). | |
| virtual void | setContinueFlag (bool flag) |
| Get/set the contiue moving flag. | |
| virtual bool | continueFlag () const |
| Get/set the contiue moving flag. | |
| virtual void | setWorldDestination (const DtVector &destination) |
| Get/set the location to which this entity is moving towards for a move to destination (or derivative) task. | |
| virtual const DtVector & | worldDestination () const |
| Get/set the location to which this entity is moving towards for a move to destination (or derivative) task. | |
| virtual void | setEntityToFollow (const DtString &objectName) |
| Get/set the name of the entity to follow. | |
| virtual const DtString & | entityToFollow () const |
| Get/set the name of the entity to follow. | |
| virtual void | setFollowingOffsetVector (const DtVector &offsetVector) |
| Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow). | |
| virtual const DtVector & | followingOffsetVector () const |
| Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow). | |
| virtual void | setEntityToInterceptAndDestroy (const DtString &objectName) |
| Get/set the name of the entity to intercept and destroy. | |
| virtual const DtString & | entityToInterceptAndDestroy () const |
| Get/set the name of the entity to intercept and destroy. | |
| virtual void | setStandOffDistance (const double distance) |
| Get/set distance away from target to stop. | |
| virtual const double | standOffDistance () const |
| Get/set distance away from target to stop. | |
| virtual void | setRouteName (const DtString &routeName) |
| Get/set the name of the route to follow. | |
| virtual const DtString & | routeName () const |
| Get/set the name of the route to follow. | |
| virtual void | setRouteVertices (const DtLocalVectorIterator &routeIterator) |
| Set/get route vertices (local coordinates). | |
| virtual const DtLocalVertexList & | routeVertices () const |
| Set/get route vertices (local coordinates). | |
| virtual void | setReversePatrol (bool flag) |
| Get/set the reverse flag for patrolling (along route or between points). | |
| virtual bool | reversePatrol () const |
| Get/set the reverse flag for patrolling (along route or between points). | |
| virtual void | setFirstWaypoint (const DtString &objectName) |
| Get/set the first waypoint to move to when patrolling between points. | |
| virtual const DtString & | firstWaypoint () const |
| Get/set the first waypoint to move to when patrolling between points. | |
| virtual void | setSecondWaypoint (const DtString &objectName) |
| Get/set the second waypoint to move to when patrolling between points. | |
| virtual const DtString & | secondWaypoint () const |
| Get/set the second waypoint to move to when patrolling between points. | |
| virtual void | setIsColliding (bool colliding) |
| Get/set flag indicating if we are currently in a colliding state. | |
| virtual bool | isColliding () const |
| Get/set flag indicating if we are currently in a colliding state. | |
| virtual void | setIsClearing (bool clearing) |
| Get/set flag indicating if we are currently clearing a collision. | |
| virtual bool | isClearing () const |
| Get/set flag indicating if we are currently clearing a collision. | |
| virtual void | setAvoidingLeft (bool avoidingLeft) |
| Get/set flag indicating if we are turning to left to avoid collision. | |
| virtual bool | avoidingLeft () const |
| Get/set flag indicating if we are turning to left to avoid collision. | |
| virtual void | setCheckForTerrainCollisions (bool checkForCollisions) |
| Check the terrain while moving to ensure that the entity does not move through any terrain polygons. | |
| virtual bool | checkForTerrainCollisions () const |
| Check the terrain while moving to ensure that the entity does not move through any terrain polygons. | |
| virtual void | setUseHighFidelityGroundClamping (bool yesOrNo) |
| When clamping the entity to the ground, using high fidelity ground clamping will cause the entity to use all four support points when determining the plane on which the entity is positioned. | |
| virtual bool | useHighFidelityGroundClamping () const |
| When clamping the entity to the ground, using high fidelity ground clamping will cause the entity to use all four support points when determining the plane on which the entity is positioned. | |
| virtual void | setRoadStartPoint (const DtVector &point) |
| virtual DtVector | roadStartPoint () const |
| virtual void | setRoadEndPoint (const DtVector &point) |
| virtual DtVector | roadEndPoint () const |
| virtual void | setRouteIsDiscovered (bool value) |
| virtual bool | routeIsDiscovered () const |
Public Member Functions inherited from DtVrfProcessStateRepository | |
| DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| const DtVrfProcessStateRepository & | operator= (const DtVrfProcessStateRepository &orig) |
| virtual | ~DtVrfProcessStateRepository () |
| virtual bool | init () |
| Used for virtual construction. This base method simply returns true. | |
| virtual bool | loadedFromMTL () const |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
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 | 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 DtVrfProcessStateRepository * | creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry) |
| Returns a newly created instance of this class. | |
Static Public Member Functions inherited from DtVrfProcessStateRepository | |
| static DtVrfProcessStateRepositoryFactory * | factory () |
| a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set. | |
| static void | setFactory (DtVrfProcessStateRepositoryFactory *factory) |
| static void | addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn) |
| static DtVrfProcessStateRepository * | createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0) |
| Creates a new state repository object, using the factory. | |
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. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
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 Member Functions inherited from DtVrfProcessStateRepository | |
| DtVrfProcessStateRepository () | |
Static Protected Attributes inherited from DtVrfProcessStateRepository | |
| static DtVrfProcessStateRepositoryFactory * | theFactory |
Instances of DtAutomotivePSR are used to hold the shared/checkpointable data for an automotive system.
| DtAutomotivePSR::DtAutomotivePSR | ( | DtVrfObject * | vrfObject, |
| const DtString & | rwName = DtString::nullString(), |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtAutomotivePSR::DtAutomotivePSR | ( | const DtAutomotivePSR & | orig, |
| const DtString & | rwName = DtString::nullString(), |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
| DtAutomotivePSR& DtAutomotivePSR::operator= | ( | const DtAutomotivePSR & | orig | ) |
assignment operator
|
virtual |
returns a newly created copy of this object
Implements DtVrfProcessStateRepository.
|
virtual |
Returns the string type of the repository, as defined in procSRTypes.h.
(DtVrfAutomotiveProcessStateRepositoryType).
Implements DtVrfProcessStateRepository.
|
virtual |
Set/get current gear.
|
virtual |
Set/get current gear.
|
virtual |
Set/get heading to turn to.
|
virtual |
Set/get heading to turn to.
|
virtual |
Get/Set the heading that is halfway between the original heading and the heading to turn to.
This is only used fore entities that are not pivot capable.
|
virtual |
Get/Set the heading that is halfway between the original heading and the heading to turn to.
This is only used fore entities that are not pivot capable.
|
virtual |
Get/set the flag that indicates whether or not the entity has completed first half of the turn maneuver (backing up until at kTurnReverseGoalHeading())
|
virtual |
Get/set the flag that indicates whether or not the entity has completed first half of the turn maneuver (backing up until at kTurnReverseGoalHeading())
|
virtual |
Get/set the name of the control object to move to (waypoint name).
|
virtual |
Get/set the name of the control object to move to (waypoint name).
|
virtual |
Get/set the contiue moving flag.
If this flag is true the entity will not slow down to the approach speed when it nears the destination. This flag signifies that the entity will continue moving once it's at the destination, presumabley the move task was just a subtask part of a more complex movement task like convoying.
|
virtual |
Get/set the contiue moving flag.
If this flag is true the entity will not slow down to the approach speed when it nears the destination. This flag signifies that the entity will continue moving once it's at the destination, presumabley the move task was just a subtask part of a more complex movement task like convoying.
|
virtual |
Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
This point is only valid for that task and is set in world (geocentric) coordinates
|
virtual |
Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
This point is only valid for that task and is set in world (geocentric) coordinates
|
virtual |
Get/set the name of the entity to follow.
|
virtual |
Get/set the name of the entity to follow.
|
virtual |
Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow).
|
virtual |
Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow).
|
virtual |
Get/set the name of the entity to intercept and destroy.
|
virtual |
Get/set the name of the entity to intercept and destroy.
|
virtual |
Get/set distance away from target to stop.
|
virtual |
Get/set distance away from target to stop.
|
virtual |
Get/set the name of the route to follow.
|
virtual |
Get/set the name of the route to follow.
|
virtual |
Set/get route vertices (local coordinates).
Once route is set, can access routeState() to query and set current position along route.
|
virtual |
Set/get route vertices (local coordinates).
Once route is set, can access routeState() to query and set current position along route.
|
virtual |
Empty route vertices.
|
virtual |
Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).
|
virtual |
Get/set the reverse flag for patrolling (along route or between points).
|
virtual |
Get/set the reverse flag for patrolling (along route or between points).
|
virtual |
Get/set the first waypoint to move to when patrolling between points.
|
virtual |
Get/set the first waypoint to move to when patrolling between points.
|
virtual |
Get/set the second waypoint to move to when patrolling between points.
|
virtual |
Get/set the second waypoint to move to when patrolling between points.
|
virtual |
Get/set flag indicating if we are currently in a colliding state.
|
virtual |
Get/set flag indicating if we are currently in a colliding state.
|
virtual |
Get/set flag indicating if we are currently clearing a collision.
|
virtual |
Get/set flag indicating if we are currently clearing a collision.
|
virtual |
Get/set flag indicating if we are turning to left to avoid collision.
|
virtual |
Get/set flag indicating if we are turning to left to avoid collision.
|
virtual |
Check the terrain while moving to ensure that the entity does not move through any terrain polygons.
|
virtual |
Check the terrain while moving to ensure that the entity does not move through any terrain polygons.
|
virtual |
When clamping the entity to the ground, using high fidelity ground clamping will cause the entity to use all four support points when determining the plane on which the entity is positioned.
When not using high fidelity, the entity will only use a single support point, the center, to determine the normal. Defaults to true, as that is the safer initial value.
|
virtual |
When clamping the entity to the ground, using high fidelity ground clamping will cause the entity to use all four support points when determining the plane on which the entity is positioned.
When not using high fidelity, the entity will only use a single support point, the center, to determine the normal. Defaults to true, as that is the safer initial value.
|
virtual |
Points which define the road that the vehicle is moving with respect to. Setting value causes valueSpecified flag to be set true.
|
virtual |
Points which define the road that the vehicle is moving with respect to. Setting value causes valueSpecified flag to be set true.
|
virtual |
Points which define the road that the vehicle is moving with respect to. Setting value causes valueSpecified flag to be set true.
|
virtual |
Points which define the road that the vehicle is moving with respect to. Setting value causes valueSpecified flag to be set true.
|
virtual |
Sets the valueSpecified flag of both myRoadStartPoint and myRoadEndPoint to false.
|
virtual |
Returns true only if both myRoadStartPoint and myRoadEndPoint are specified.
|
virtual |
Sets whether the current task has been sucessfully initialized
|
virtual |
Sets whether the current task has been sucessfully initialized
|
virtual |
Get the current vertex we are moving toward when executuing move-along behavior.
Vertices are numbered starting from 0.
|
virtual |
Override to set myCurrentVertex from route state before writing.
Reimplemented from DtReaderWriter.
|
static |
Returns a newly created instance of this class.
|
protected |
From DtGroundAutoController (gndAutoCntlr.h) (enum DtAutoTransmissionGear)
|
protected |
|
protected |
|
protected |
|
protected |
From DtGroundMoveToControllerComponent (gndMvToCntlr.h)
If tasked() is true, this is the name of the control object we're moving to.
|
protected |
From DtGroundFollowEntityController (gndFollwCtl.h)
Set when a follow entity task is received.
|
protected |
|
protected |
From DtGroundMoveAlongController (gndMvAlgCtl.h)
If tasked() is true, this is the name of the control object we're moving to.
|
protected |
Route state used to get info about the current route we're trying to follow (e.g.
which vertex to move toward).
|
protected |
my copy of the current route
|
protected |
Read/write variables to capture route state.
|
protected |
|
protected |
From DtGroundPatrolBetweenController.
Set when a patrol between task is received.
|
protected |
|
protected |
Reuse above myReverseFlag from DtGroundPatrolRouteController bool myReverseFlag;.
|
protected |
|
protected |
From DtGroundCollisionAvoidanceController (gndColAvoid.h)
Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
|
protected |
|
protected |
|
protected |
World point for move to location tasks.
|
protected |
|
protected |
Used by the automotive actuator when determining the orientation of the entity.
|
protected |
Road currently being used by DtGroundMoveToDestinationControllerComponent.
|
protected |
Road currently being used by DtGroundMoveToDestinationControllerComponent.
|
protected |
|
protected |
Determines whether we will keep moving after this task is done and hence shouldn't slow down.
From DtGroundMoveAlongController (gndMvAlgCtl.h)
Flag indicating whether route to follow has been discovered or not.