Vector3Stats Class Reference

Collection of statistics for a Vector3 signal. More...

#include <math/gzmath.hh>

Public Member Functions
	Vector3Stats () GAZEBO_DEPRECATED(8.0)
	Constructor. More...
	Vector3Stats (const ignition::math::Vector3Stats &_stats)
	Ignition math copy constructor. More...
	~Vector3Stats ()
	Destructor. More...
ignition::math::Vector3Stats	Ign () const
	Convert this Vector3Stats to an ignition::math::Vector3Stats. More...
void	InsertData (const Vector3 &_data)
	Add a new sample to the statistical measures. More...
bool	InsertStatistic (const std::string &_name)
	Add a new type of statistic. More...
bool	InsertStatistics (const std::string &_names)
	Add multiple statistics. More...
SignalStats	Mag () const
	Get statistics for mag component of signal. More...
SignalStats &	Mag ()
	Get mutable reference to statistics for magnitude of signal. More...
Vector3Stats &	operator= (const ignition::math::Vector3Stats &_v)
	Assignment operator for ignition math. More...
void	Reset ()
	Forget all previous data. More...
SignalStats	X () const
	Get statistics for x component of signal. More...
SignalStats &	X ()
	Get mutable reference to statistics for x component of signal. More...
SignalStats	Y () const
	Get statistics for y component of signal. More...
SignalStats &	Y ()
	Get mutable reference to statistics for y component of signal. More...
SignalStats	Z () const
	Get statistics for z component of signal. More...
SignalStats &	Z ()
	Get mutable reference to statistics for z component of signal. More...

Protected Attributes
Vector3StatsPrivate *	dataPtr
	Pointer to private data. More...

Detailed Description

Collection of statistics for a Vector3 signal.

Constructor & Destructor Documentation

Vector3Stats

(

)

Constructor.

Deprecated:

See ignition::math::Vector3Stats

Vector3Stats

(

const ignition::math::Vector3Stats &

_stats

)

Ignition math copy constructor.

Parameters

[in]

_stats

An ignition math vector3stats to copy

~Vector3Stats

(

)

Destructor.

Member Function Documentation

ignition::math::Vector3Stats Ign

(

)

const

Convert this Vector3Stats to an ignition::math::Vector3Stats.

Returns

This vector as an ignition::math::Vector3d.

void InsertData

(

const Vector3 &

_data

)

Add a new sample to the statistical measures.

Parameters

[in]

_data

New signal data point.

bool InsertStatistic

(

const std::string &

_name

)

Add a new type of statistic.

Parameters

[in]

_name

Short name of new statistic. Valid values include: "maxAbs" "mean" "rms"

Returns

True if statistic was successfully added, false if name was not recognized or had already been inserted.

bool InsertStatistics

(

const std::string &

_names

)

Add multiple statistics.

Parameters

[in]

_names

Comma-separated list of new statistics. For example, all statistics could be added with: "maxAbs,mean,rms"

Returns

True if all statistics were successfully added, false if any names were not recognized or had already been inserted.

SignalStats Mag

(

)

const

Get statistics for mag component of signal.

Returns

Statistics for mag component of signal.

SignalStats& Mag

(

)

Get mutable reference to statistics for magnitude of signal.

Returns

Statistics for magnitude of signal.

Vector3Stats& operator=

(

const ignition::math::Vector3Stats &

_v

)

Assignment operator for ignition math.

Parameters

[in]

_v

An ignition math vector3stats to copy

Returns

this

void Reset

(

)

Forget all previous data.

SignalStats X

(

)

const

Get statistics for x component of signal.

Returns

Statistics for x component of signal.

SignalStats& X

(

)

Get mutable reference to statistics for x component of signal.

Returns

Statistics for x component of signal.

SignalStats Y

(

)

const

Get statistics for y component of signal.

Returns

Statistics for y component of signal.

SignalStats& Y

(

)

Get mutable reference to statistics for y component of signal.

Returns

Statistics for y component of signal.

SignalStats Z

(

)

const

Get statistics for z component of signal.

Returns

Statistics for z component of signal.

SignalStats& Z

(

)

Get mutable reference to statistics for z component of signal.

Returns

Statistics for z component of signal.

Member Data Documentation

Vector3StatsPrivate* dataPtr

protected

Pointer to private data.

---

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

• Vector3Stats.hh