sdf::v12::AirPressure Class Reference

AirPressure contains information about a general purpose fluid pressure sensor. More...

#include <AirPressure.hh>

Public Member Functions
	AirPressure ()
	Default constructor. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
Errors	Load (ElementPtr _sdf)
	Load the airPressure based on an element pointer. More...
bool	operator!= (const AirPressure &_air) const
	Return true this AirPressure object does not contain the same values as the passed in parameter. More...
bool	operator== (const AirPressure &_air) const
	Return true if both AirPressure objects contain the same values. More...
const Noise &	PressureNoise () const
	Get the noise values. More...
double	ReferenceAltitude () const
	Get the reference altitude of the sensor in meters. More...
void	SetPressureNoise (const Noise &_noise)
	Set the noise values related to the pressure data. More...
void	SetReferenceAltitude (double _ref)
	Set the reference altitude of the sensor in meters. More...

Detailed Description

AirPressure contains information about a general purpose fluid pressure sensor.

This sensor can be attached to a link.

Constructor & Destructor Documentation

AirPressure()

sdf::v12::AirPressure::AirPressure

(

)

Default constructor.

Member Function Documentation

Element()

sdf::ElementPtr sdf::v12::AirPressure::Element

(

)

const

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()

Errors sdf::v12::AirPressure::Load

(

ElementPtr

_sdf

)

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

[in]

_sdf

The SDF Element pointer

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::v12::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::v12::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::v12::AirPressure::PressureNoise

(

)

const

Get the noise values.

Returns

Noise values for pressure data.

ReferenceAltitude()

double sdf::v12::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::v12::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::v12::AirPressure::SetReferenceAltitude

(

double

_ref

)

Set the reference altitude of the sensor in meters.

See also

ReferenceAltitude()

Parameters

[in]

_ref

Reference altitude in meters.

---

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

• AirPressure.hh