sdf::SDF_VERSION_NAMESPACE::AirSpeed Class Reference

AirSpeed contains information about a general purpose air speed sensor. More...

#include <AirSpeed.hh>

Public Member Functions
	AirSpeed ()
	Default constructor.
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load.
Errors	Load (ElementPtr _sdf)
	Load the air speed based on an element pointer.
bool	operator!= (const AirSpeed &_air) const
	Return true this AirSpeed object does not contain the same values as the passed in parameter.
bool	operator== (const AirSpeed &_air) const
	Return true if both AirSpeed objects contain the same values.
const Noise &	PressureNoise () const
	Get the noise values.
void	SetPressureNoise (const Noise &_noise)
	Set the noise values related to the differential pressure data.
sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this air pressure sensor.

Detailed Description

AirSpeed contains information about a general purpose air speed sensor.

This sensor can be attached to a link.

Constructor & Destructor Documentation

AirSpeed()

sdf::SDF_VERSION_NAMESPACE::AirSpeed::AirSpeed

(

)

Default constructor.

Referenced by operator!=(), and operator==().

Member Function Documentation

Element()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::AirSpeed::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::SDF_VERSION_NAMESPACE::AirSpeed::Load

(

ElementPtr

_sdf

)

Load the air speed 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::SDF_VERSION_NAMESPACE::AirSpeed::operator!=

(

const AirSpeed &

_air

)

const

Return true this AirSpeed object does not contain the same values as the passed in parameter.

Parameters

[_in]

_air AirSpeed value to compare.

Returns

True if 'this' != _air.

References AirSpeed().

operator==()

bool sdf::SDF_VERSION_NAMESPACE::AirSpeed::operator==

(

const AirSpeed &

_air

)

const

Return true if both AirSpeed objects contain the same values.

Parameters

[_in]

_air AirSpeed value to compare.

Returns

True if 'this' == _air.

References AirSpeed().

PressureNoise()

const Noise & sdf::SDF_VERSION_NAMESPACE::AirSpeed::PressureNoise

(

)

const

Get the noise values.

Returns

Noise values for differential pressure data.

SetPressureNoise()

void sdf::SDF_VERSION_NAMESPACE::AirSpeed::SetPressureNoise

(

const Noise &

_noise

)

Set the noise values related to the differential pressure data.

Parameters

[in]

_noise

Noise values for the pressure data.

ToElement()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::AirSpeed::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.

---

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

• AirSpeed.hh