AirPressure contains information about a general purpose fluid pressure sensor.
More...
#include <AirPressure.hh>
AirPressure contains information about a general purpose fluid pressure sensor.
This sensor can be attached to a link.
◆ AirPressure()
sdf::SDF_VERSION_NAMESPACE::AirPressure::AirPressure |
( |
| ) |
|
◆ Element()
Get a pointer to the SDF element that was used during load.
- Returns
- SDF element pointer. The value will be nullptr if Load has not been called.
◆ Load()
Load the airPressure based on an element pointer.
This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.
- Parameters
-
- Returns
- Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.
◆ operator!=()
bool sdf::SDF_VERSION_NAMESPACE::AirPressure::operator!= |
( |
const AirPressure & |
_air | ) |
const |
Return true this AirPressure object does not contain the same values as the passed in parameter.
- Parameters
-
[_in] | _mag AirPressure value to compare. \returen True if 'this' != _mag. |
◆ operator==()
bool sdf::SDF_VERSION_NAMESPACE::AirPressure::operator== |
( |
const AirPressure & |
_air | ) |
const |
Return true if both AirPressure objects contain the same values.
- Parameters
-
[_in] | _mag AirPressure value to compare. \returen True if 'this' == _mag. |
◆ PressureNoise()
const Noise& sdf::SDF_VERSION_NAMESPACE::AirPressure::PressureNoise |
( |
| ) |
const |
Get the noise values.
- Returns
- Noise values for pressure data.
◆ ReferenceAltitude()
double sdf::SDF_VERSION_NAMESPACE::AirPressure::ReferenceAltitude |
( |
| ) |
const |
Get the reference altitude of the sensor in meters.
This value can be used by a sensor implementation to augment the altitude of the sensor. For example, if you are using simulation instead of creating a 1000 m mountain model on which to place your sensor, you could instead set this value to 1000 and place your model on a ground plane with a Z height of zero.
- Returns
- Reference altitude in meters.
◆ SetPressureNoise()
void sdf::SDF_VERSION_NAMESPACE::AirPressure::SetPressureNoise |
( |
const Noise & |
_noise | ) |
|
Set the noise values related to the pressure data.
- Parameters
-
[in] | _noise | Noise values for the pressure data. |
◆ SetReferenceAltitude()
void sdf::SDF_VERSION_NAMESPACE::AirPressure::SetReferenceAltitude |
( |
double |
_ref | ) |
|
Set the reference altitude of the sensor in meters.
- See also
- ReferenceAltitude()
- Parameters
-
[in] | _ref | Reference altitude in meters. |
◆ ToElement() [1/2]
sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::AirPressure::ToElement |
( |
| ) |
const |
Create and return an SDF element filled with data from this air pressure sensor.
Note that parameter passing functionality is not captured with this function.
- Returns
- SDF element pointer with updated sensor values.
◆ ToElement() [2/2]
Create and return an SDF element filled with data from this air pressure sensor.
Note that parameter passing functionality is not captured with this function.
- Parameters
-
[out] | _errors | Vector of errors. |
- Returns
- SDF element pointer with updated sensor values.
The documentation for this class was generated from the following file: