Ignition Sensors

API Reference

5.0.0
AirPressureSensor Class Reference

AirPressure Sensor Class. More...

#include <AirPressureSensor.hh>

Public Member Functions

 AirPressureSensor ()
 constructor More...
 
virtual ~AirPressureSensor ()
 destructor More...
 
virtual bool Init () override
 Initialize values in the sensor. More...
 
virtual bool Load (const sdf::Sensor &_sdf) override
 Load the sensor based on data from an sdf::Sensor object. More...
 
virtual bool Load (sdf::ElementPtr _sdf) override
 Load the sensor with SDF parameters. More...
 
double ReferenceAltitude () const
 Get the vertical reference altitude. More...
 
void SetReferenceAltitude (double _reference)
 Set the reference altitude. More...
 
virtual bool Update (const ignition::common::Time &_now) override
 Update the sensor and generate data. More...
 
virtual bool Update (const std::chrono::steady_clock::duration &_now) override
 Update the sensor and generate data. More...
 
- Public Member Functions inherited from Sensor
virtual ~Sensor ()
 destructor More...
 
void AddSequence (ignition::msgs::Header *_msg, const std::string &_seqKey="default")
 Add a sequence number to an ignition::msgs::Header. This function can be called by a sensor that wants to add a sequence number to a sensor message in order to have improved accountability for generated sensor data. More...
 
SensorId Id () const
 Get the sensor's ID. More...
 
std::string Name () const
 Get name. More...
 
std::chrono::steady_clock::duration NextDataUpdateTime () const
 Return the next time the sensor will generate data. More...
 
ignition::common::Time NextUpdateTime () const
 Return the next time the sensor will generate data. More...
 
std::string Parent () const
 Get parent link of the sensor. More...
 
ignition::math::Pose3d Pose () const
 Get the current pose. More...
 
sdf::ElementPtr SDF () const
 Get the SDF used to load this sensor. More...
 
virtual void SetParent (const std::string &_parent)
 Set the parent of the sensor. More...
 
void SetPose (const ignition::math::Pose3d &_pose)
 Update the pose of the sensor. More...
 
bool SetTopic (const std::string &_topic)
 Set topic where sensor data is published. More...
 
void SetUpdateRate (const double _hz)
 Set the update rate of the sensor. An update rate of zero means that the sensor is updated every cycle. It's zero by default. Negative rates become zero. More...
 
std::string Topic () const
 Get topic where sensor data is published. More...
 
virtual bool Update (const common::Time &_now)=0
 Force the sensor to generate data. More...
 
bool Update (const ignition::common::Time &_now, const bool _force)
 Update the sensor. More...
 
bool Update (const std::chrono::steady_clock::duration &_now, const bool _force)
 Update the sensor. More...
 
double UpdateRate () const
 Get the update rate of the sensor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Sensor
 Sensor ()
 constructor More...
 

Detailed Description

AirPressure Sensor Class.

A sensor that reports air pressure readings.

Constructor & Destructor Documentation

◆ AirPressureSensor()

constructor

◆ ~AirPressureSensor()

virtual ~AirPressureSensor ( )
virtual

destructor

Member Function Documentation

◆ Init()

virtual bool Init ( )
overridevirtual

Initialize values in the sensor.

Returns
True on success

Reimplemented from Sensor.

◆ Load() [1/2]

virtual bool Load ( const sdf::Sensor &  _sdf)
overridevirtual

Load the sensor based on data from an sdf::Sensor object.

Parameters
[in]_sdfSDF Sensor parameters.
Returns
true if loading was successful

Reimplemented from Sensor.

◆ Load() [2/2]

virtual bool Load ( sdf::ElementPtr  _sdf)
overridevirtual

Load the sensor with SDF parameters.

Parameters
[in]_sdfSDF Sensor parameters.
Returns
true if loading was successful

Reimplemented from Sensor.

◆ ReferenceAltitude()

double ReferenceAltitude ( ) const

Get the vertical reference altitude.

Returns
Verical reference position in meters

◆ SetReferenceAltitude()

void SetReferenceAltitude ( double  _reference)

Set the reference altitude.

Parameters
[in]_refVerical reference position in meters

◆ Update() [1/2]

virtual bool Update ( const ignition::common::Time &  _now)
overridevirtual

Update the sensor and generate data.

Parameters
[in]_nowThe current time
Returns
true if the update was successfull

◆ Update() [2/2]

virtual bool Update ( const std::chrono::steady_clock::duration &  _now)
overridevirtual

Update the sensor and generate data.

Parameters
[in]_nowThe current time
Returns
true if the update was successfull

Implements Sensor.


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