AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxVehicle::PurePursuit::SteeringInformation Class Referenceabstract

Base class for a vehicle/robot/machine for which pure pursuit should compute steering information. More...

#include <PurePursuit.h>

+ Inheritance diagram for agxVehicle::PurePursuit::SteeringInformation:

Public Member Functions

 SteeringInformation (agx::RigidBody *referenceBody, agx::Frame *localFrame)
 Constructor for base representation.
 
virtual bool computeSteeringInformation (agx::Vec3 target, double *outputBuffer)=0
 Compute steering information and write result to output buffer.
 
agx::Frame * getFrame () const
 Returns the reference frame for the vehicle.
 
virtual size_t getNumOutputElements () const =0
 Return number of data elements that are produced by the implementation.
 
agx::RigidBody * getRigidBody () const
 Returns the RigidBody for this vehicle.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 

Protected Attributes

agx::RigidBodyRef m_body
 
agx::FrameRef m_coordinates
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 

Detailed Description

Base class for a vehicle/robot/machine for which pure pursuit should compute steering information.

The information needed to control e.g. a car-like vehicle where front and back wheels can have different steering angle is different to e.g. a tracked machine where the steering is handled via different track speeds.

Definition at line 89 of file PurePursuit.h.

Constructor & Destructor Documentation

◆ SteeringInformation()

agxVehicle::PurePursuit::SteeringInformation::SteeringInformation ( agx::RigidBody *  referenceBody,
agx::Frame *  localFrame 
)
explicit

Constructor for base representation.

The localFrame should have the referenceBody:s model frame as parent. If that is not the case, the local frame will be re-parented.

Member Function Documentation

◆ computeSteeringInformation()

virtual bool agxVehicle::PurePursuit::SteeringInformation::computeSteeringInformation ( agx::Vec3  target,
double *  outputBuffer 
)
pure virtual

Compute steering information and write result to output buffer.

Specializations of this class are not allowed to use a varying number of output elements or write more elements to outputBuffer than the value returned via getNumOutputElements.

Returns
true if steering information could be computed

Implemented in agxVehicle::TrackedVehicleSteeringInformation, and agxVehicle::CarSteeringInformation.

◆ getFrame()

agx::Frame * agxVehicle::PurePursuit::SteeringInformation::getFrame ( ) const

Returns the reference frame for the vehicle.

This is normally in model coordinates for the body to which the wheels or tracks are attached.

◆ getNumOutputElements()

virtual size_t agxVehicle::PurePursuit::SteeringInformation::getNumOutputElements ( ) const
pure virtual

Return number of data elements that are produced by the implementation.

Implemented in agxVehicle::TrackedVehicleSteeringInformation, and agxVehicle::CarSteeringInformation.

◆ getRigidBody()

agx::RigidBody * agxVehicle::PurePursuit::SteeringInformation::getRigidBody ( ) const

Returns the RigidBody for this vehicle.

Member Data Documentation

◆ m_body

agx::RigidBodyRef agxVehicle::PurePursuit::SteeringInformation::m_body
protected

Definition at line 128 of file PurePursuit.h.

◆ m_coordinates

agx::FrameRef agxVehicle::PurePursuit::SteeringInformation::m_coordinates
protected

Definition at line 129 of file PurePursuit.h.


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