sdf::v12::NavSat Class Reference

NavSat contains information about a NavSat sensor. More...

#include <NavSat.hh>

Public Member Functions
	NavSat ()
	Default constructor. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
const Noise &	HorizontalPositionNoise () const
	Get noise value for horizontal position sensor. More...
const Noise &	HorizontalVelocityNoise () const
	Get noise value for horizontal velocity sensor. More...
Errors	Load (ElementPtr _sdf)
	Load the navsat based on an element pointer. More...
bool	operator!= (const NavSat &_navsat) const
	Return true this NavSat object does not contain the same values as the passed in parameter. More...
bool	operator== (const NavSat &_navsat) const
	Return true if both NavSat objects contain the same values. More...
void	SetHorizontalPositionNoise (const Noise &_noise)
	Set the noise values for the horizontal position sensor. More...
void	SetHorizontalVelocityNoise (const Noise &_noise)
	Set the noise values for the horizontal velocity sensor. More...
void	SetVerticalPositionNoise (const Noise &_noise)
	Set the noise values for the vertical position sensor. More...
void	SetVerticalVelocityNoise (const Noise &_noise)
	Set the noise values for the vertical velocity sensor. More...
const Noise &	VerticalPositionNoise () const
	Get noise value for vertical position sensor. More...
const Noise &	VerticalVelocityNoise () const
	Get noise value for vertical velocity sensor. More...

Detailed Description

NavSat contains information about a NavSat sensor.

This sensor can be attached to a link. The NavSat sensor can be defined SDF XML by the "navsat" type.

Example SDF XML using navsat type:

<sensor name="navsat_sensor" type="navsat">
  <pose>1 2 3 0 0 0</pose>
  <topic>/navsat</topic>
  <navsat>
    <position_sensing>
      <horizontal>
        <noise type="gaussian">
            <mean>0.98</mean>
            <stddev>0.76</stddev>
        </noise>
      </horizontal>
      <vertical>
        <noise type="gaussian">
            <mean>0.98</mean>
            <stddev>0.76</stddev>
        </noise>
      </vertical>
    </position_sensing>
    <velocity_sensing>
      <horizontal>
        <noise type="gaussian">
            <mean>0.98</mean>
            <stddev>0.76</stddev>
        </noise>
      </horizontal>
      <vertical>
        <noise type="gaussian">
            <mean>0.98</mean>
            <stddev>0.76</stddev>
        </noise>
      </vertical>
    </velocity_sensing>
  </navsat>
</sensor>

Constructor & Destructor Documentation

NavSat()

sdf::v12::NavSat::NavSat

(

)

Default constructor.

Member Function Documentation

Element()

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

HorizontalPositionNoise()

const Noise& sdf::v12::NavSat::HorizontalPositionNoise

(

)

const

Get noise value for horizontal position sensor.

Returns

Noise values

HorizontalVelocityNoise()

const Noise& sdf::v12::NavSat::HorizontalVelocityNoise

(

)

const

Get noise value for horizontal velocity sensor.

Returns

Noise values

Load()

Errors sdf::v12::NavSat::Load

(

ElementPtr

_sdf

)

Load the navsat 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::NavSat::operator!=

(

const NavSat &

_navsat

)

const

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

Parameters

[_in]

_navsat NavSat value to compare.

Returns

True if 'this' != _navsat.

operator==()

bool sdf::v12::NavSat::operator==

(

const NavSat &

_navsat

)

const

Return true if both NavSat objects contain the same values.

Parameters

[_in]

_navsat NavSat value to compare.

Returns

True if 'this' == _navsat.

SetHorizontalPositionNoise()

void sdf::v12::NavSat::SetHorizontalPositionNoise

(

const Noise &

_noise

)

Set the noise values for the horizontal position sensor.

Parameters

[in]

_noise

Noise values to set to

SetHorizontalVelocityNoise()

void sdf::v12::NavSat::SetHorizontalVelocityNoise

(

const Noise &

_noise

)

Set the noise values for the horizontal velocity sensor.

Parameters

[in]

_noise

Noise values to set to

SetVerticalPositionNoise()

void sdf::v12::NavSat::SetVerticalPositionNoise

(

const Noise &

_noise

)

Set the noise values for the vertical position sensor.

Parameters

[in]

_noise

Noise values to set to

SetVerticalVelocityNoise()

void sdf::v12::NavSat::SetVerticalVelocityNoise

(

const Noise &

_noise

)

Set the noise values for the vertical velocity sensor.

Parameters

[in]

_noise

Noise values to set to

VerticalPositionNoise()

const Noise& sdf::v12::NavSat::VerticalPositionNoise

(

)

const

Get noise value for vertical position sensor.

Returns

Noise values

VerticalVelocityNoise()

const Noise& sdf::v12::NavSat::VerticalVelocityNoise

(

)

const

Get noise value for vertical velocity sensor.

Returns

Noise values

---

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

• NavSat.hh