sdf::v10::Altimeter Class Reference

Altimeter contains information about an altimeter sensor. More...

#include <Altimeter.hh>

Public Member Functions
	Altimeter ()
	Default constructor. More...
	Altimeter (Altimeter &&_altimeter) noexcept
	Move constructor. More...
	Altimeter (const Altimeter &_altimeter)
	Copy constructor. More...
	~Altimeter ()
	Destructor. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
Errors	Load (ElementPtr _sdf)
	Load the altimeter based on an element pointer. More...
bool	operator!= (const Altimeter &_alt) const
	Return true this Altimeter object does not contain the same values as the passed in parameter. More...
Altimeter &	operator= (Altimeter &&_altimeter) noexcept
	Move assignment operator. More...
Altimeter &	operator= (const Altimeter &_altimeter)
	Assignment operator. More...
bool	operator== (const Altimeter &_alt) const
	Return true if both Altimeter objects contain the same values. More...
void	SetVerticalPositionNoise (const Noise &_noise)
	Set the noise values related to the vertical position. More...
void	SetVerticalVelocityNoise (const Noise &_noise)
	Set the noise values related to the vertical velocity. More...
const Noise &	VerticalPositionNoise () const
	Get the noise values related to the vertical position. More...
const Noise &	VerticalVelocityNoise () const
	Get the noise values related to the vertical velocity. More...

Detailed Description

Altimeter contains information about an altimeter sensor.

This sensor can be attached to a link.

Constructor & Destructor Documentation

Altimeter() [1/3]

sdf::v10::Altimeter::Altimeter

(

)

Default constructor.

Altimeter() [2/3]

sdf::v10::Altimeter::Altimeter

(

const Altimeter &

_altimeter

)

Copy constructor.

Parameters

[in]

_altimeter

Altimeter to copy.

Altimeter() [3/3]

sdf::v10::Altimeter::Altimeter ( Altimeter &&  _altimeter )

noexcept

Move constructor.

Parameters

[in]

_altimeter

Altimeter to move.

~Altimeter()

sdf::v10::Altimeter::~Altimeter

(

)

Destructor.

Member Function Documentation

Element()

sdf::ElementPtr sdf::v10::Altimeter::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::v10::Altimeter::Load

(

ElementPtr

_sdf

)

Load the altimeter 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::v10::Altimeter::operator!=

(

const Altimeter &

_alt

)

const

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

Parameters

[_in]

_alt Altimeter value to compare. \returen True if 'this' != _alt.

operator=() [1/2]

Altimeter& sdf::v10::Altimeter::operator= ( Altimeter &&  _altimeter )

noexcept

Move assignment operator.

Parameters

[in]

_altimeter

The altimeter to set values from.

Returns

*this

operator=() [2/2]

Altimeter& sdf::v10::Altimeter::operator=

(

const Altimeter &

_altimeter

)

Assignment operator.

Parameters

[in]

_altimeter

The altimeter to set values from.

Returns

*this

operator==()

bool sdf::v10::Altimeter::operator==

(

const Altimeter &

_alt

)

const

Return true if both Altimeter objects contain the same values.

Parameters

[_in]

_alt Altimeter value to compare. \returen True if 'this' == _alt.

SetVerticalPositionNoise()

void sdf::v10::Altimeter::SetVerticalPositionNoise

(

const Noise &

_noise

)

Set the noise values related to the vertical position.

Parameters

[in]

_noise

Noise values for the vertical position.

SetVerticalVelocityNoise()

void sdf::v10::Altimeter::SetVerticalVelocityNoise

(

const Noise &

_noise

)

Set the noise values related to the vertical velocity.

Parameters

[in]

_noise

Noise values for the vertical velocity.

VerticalPositionNoise()

const Noise& sdf::v10::Altimeter::VerticalPositionNoise

(

)

const

Get the noise values related to the vertical position.

Returns

Noise values for the vertical position.

VerticalVelocityNoise()

const Noise& sdf::v10::Altimeter::VerticalVelocityNoise

(

)

const

Get the noise values related to the vertical velocity.

Returns

Noise values for the vertical velocity.

---

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

• Altimeter.hh