sdf::v11::Altimeter Class Reference

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

#include <Altimeter.hh>

## Public Member Functions

Altimeter ()
Default constructor. More...

sdf::ElementPtr Element () const
Get a pointer to the SDF element that was used during load. More...

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...

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 NoiseVerticalPositionNoise () const
Get the noise values related to the vertical position. More...

const NoiseVerticalVelocityNoise () 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.

## ◆ Altimeter()

 sdf::v11::Altimeter::Altimeter ( )

Default constructor.

## ◆ Element()

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

 Errors sdf::v11::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::v11::Altimeter::operator!= ( const Altimeter & _alt ) const

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

Parameters

## ◆ operator==()

 bool sdf::v11::Altimeter::operator== ( const Altimeter & _alt ) const

Return true if both Altimeter objects contain the same values.

Parameters

## ◆ SetVerticalPositionNoise()

 void sdf::v11::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::v11::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::v11::Altimeter::VerticalPositionNoise ( ) const

Get the noise values related to the vertical position.

Returns
Noise values for the vertical position.

## ◆ VerticalVelocityNoise()

 const Noise& sdf::v11::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: