AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxSensor::AccelerometerModel Class Reference

Base accelerometer model describing the fundamental parameters, such as measurement range and zero bias, of an accelerometer. More...

#include <AccelerometerModel.h>

+ Inheritance diagram for agxSensor::AccelerometerModel:

Public Member Functions

 AccelerometerModel (TriaxialRange range=agx::RangeReal(std::numeric_limits< agx::Real >::lowest(), std::numeric_limits< agx::Real >::max()), TriaxialCrossSensitivity crossSensitivity=0.01, agx::Vec3 zeroGBias=agx::Vec3(260.0), ITriaxialSignalSystemNodeRefVector outputModifiers=ITriaxialSignalSystemNodeRefVector())
 Constructs an accelerometer model with the specified parameters.
 
const TriaxialCrossSensitivity & getCrossAxisSensitivity () const
 
const ITriaxialSignalSystemNodeRefVector & getOutputModifiers () const
 
const TriaxialRange & getRange () const
 
const agx::Vec3 & getZeroGBias () const
 
void setCrossAxisSensitivity (const TriaxialCrossSensitivity &crossSensitivity)
 Set the accelerometer cross-axis sensitivity.
 
void setRange (const TriaxialRange &range)
 Set the detectable range for the accelerometer.
 
void setZeroGBias (const agx::Vec3 &zeroGBias)
 Set the bias in acceleration at zero externally applied acceleration.
 
- 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.
 
- Public Member Functions inherited from agxStream::Serializable
virtual ~Serializable ()
 Destructor for normal C++ use but hidden from SWIG bindings.
 
virtual const char * getClassName () const
 
bool getEnableSerialization () const
 
bool getEnableUuidGeneration ()
 
agx::UInt32 getIndex () const
 This index is given at creation of this object.
 
virtual StorageAgent * getStorageAgent () const =0
 
agx::Uuid getUuid () const
 
bool isFinished () const
 
void setEnableSerialization (bool flag)
 Set to false to disable serialization of this object.
 
void setFinished ()
 Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
 
void setUuid (const agx::Uuid &uuid)
 Explicitly set a Uuid on a serializable object.
 

Static Public Member Functions

static AccelerometerModel * makeIdealModel ()
 Creates an accelerometer model outputting ideal measurement data (ground truth values).
 
- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Static Public Member Functions inherited from agxStream::Serializable
static void setEnableUuidGeneration (bool flag)
 Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.
 

Additional Inherited Members

- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Protected Member Functions inherited from agxStream::Serializable
 Serializable ()
 Default constructor.
 
 Serializable (const Serializable &other)
 Copy constructor.
 
void generateUuid ()
 
- 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.
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

Base accelerometer model describing the fundamental parameters, such as measurement range and zero bias, of an accelerometer.

Note
The configuration in this model is shared and synchronized across all instances.

Definition at line 35 of file AccelerometerModel.h.

Constructor & Destructor Documentation

◆ AccelerometerModel()

agxSensor::AccelerometerModel::AccelerometerModel ( TriaxialRange  range = agx::RangeReal(std::numeric_limits< agx::Real >::lowest(), std::numeric_limits< agx::Real >::max()),
TriaxialCrossSensitivity  crossSensitivity = 0.01,
agx::Vec3  zeroGBias = agx::Vec3(260.0),
ITriaxialSignalSystemNodeRefVector  outputModifiers = ITriaxialSignalSystemNodeRefVector() 
)

Constructs an accelerometer model with the specified parameters.

Parameters
range- detectable range of acceleration, in m/s^2
crossSensitivity- cross axis sensitivity
zeroGBias- bias acceleration reported in each axis under conditions without externally applied acceleration, in m/s^2
outputModifiers- list of modifiers to apply to the output of the accelerometer

Member Function Documentation

◆ getCrossAxisSensitivity()

const TriaxialCrossSensitivity & agxSensor::AccelerometerModel::getCrossAxisSensitivity ( ) const
Returns
the cross sensitivity, describing the effects that acceleration along one axis has on every other axis.

◆ getOutputModifiers()

const ITriaxialSignalSystemNodeRefVector & agxSensor::AccelerometerModel::getOutputModifiers ( ) const
Returns
the list of output modifiers to apply to the output

◆ getRange()

const TriaxialRange & agxSensor::AccelerometerModel::getRange ( ) const
Returns
the range of acceleration, in m/s^2, that the accelerometer can detect.

◆ getZeroGBias()

const agx::Vec3 & agxSensor::AccelerometerModel::getZeroGBias ( ) const
Returns
the bias acceleration, in m/s^2, reported in each axis at under conditions without externally applied acceleration.

◆ makeIdealModel()

static AccelerometerModel * agxSensor::AccelerometerModel::makeIdealModel ( )
static

Creates an accelerometer model outputting ideal measurement data (ground truth values).

Returns
new ideal accelerometer model

◆ setCrossAxisSensitivity()

void agxSensor::AccelerometerModel::setCrossAxisSensitivity ( const TriaxialCrossSensitivity &  crossSensitivity)

Set the accelerometer cross-axis sensitivity.

Parameters
crossSensitivity- cross axis sensitivity

◆ setRange()

void agxSensor::AccelerometerModel::setRange ( const TriaxialRange &  range)

Set the detectable range for the accelerometer.

Parameters
range- detectable range of acceleration, in m/s^2

◆ setZeroGBias()

void agxSensor::AccelerometerModel::setZeroGBias ( const agx::Vec3 &  zeroGBias)

Set the bias in acceleration at zero externally applied acceleration.

Parameters
zeroGBias- bias acceleration reported in each axis under conditions without externally applied acceleration, in m/s^2

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