ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats Class Reference

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

#include <ignition/math/Vector3Stats.hh>

Public Member Functions
	Vector3Stats ()
	Constructor.
	~Vector3Stats ()
	Destructor.
void	InsertData (const Vector3d &_data)
	Add a new sample to the statistical measures.
bool	InsertStatistic (const std::string &_name)
	Add a new type of statistic.
bool	InsertStatistics (const std::string &_names)
	Add multiple statistics.
SignalStats &	Mag ()
	Get mutable reference to statistics for magnitude of signal.
const SignalStats &	Mag () const
	Get statistics for magnitude component of signal.
void	Reset ()
	Forget all previous data.
SignalStats &	X ()
	Get mutable reference to statistics for x component of signal.
const SignalStats &	X () const
	Get statistics for x component of signal.
SignalStats &	Y ()
	Get mutable reference to statistics for y component of signal.
const SignalStats &	Y () const
	Get statistics for y component of signal.
SignalStats &	Z ()
	Get mutable reference to statistics for z component of signal.
const SignalStats &	Z () const
	Get statistics for z component of signal.

Protected Attributes
Vector3StatsPrivate *	dataPtr
	Pointer to private data.

Detailed Description

Collection of statistics for a Vector3 signal.

Constructor & Destructor Documentation

Vector3Stats()

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::Vector3Stats

(

)

Constructor.

~Vector3Stats()

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::~Vector3Stats

(

)

Destructor.

Member Function Documentation

InsertData()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::InsertData

(

const Vector3d &

_data

)

Add a new sample to the statistical measures.

Parameters

[in]

_data

New signal data point.

InsertStatistic()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::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.

InsertStatistics()

bool ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::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.

Mag() [1/2]

SignalStats & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::Mag

(

)

Get mutable reference to statistics for magnitude of signal.

Returns

Statistics for magnitude of signal.

Mag() [2/2]

const SignalStats & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::Mag

(

)

const

Get statistics for magnitude component of signal.

Returns

Statistics for magnitude component of signal.

Reset()

void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::Reset

(

)

Forget all previous data.

X() [1/2]

SignalStats & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::X

(

)

Get mutable reference to statistics for x component of signal.

Returns

Statistics for x component of signal.

X() [2/2]

const SignalStats & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::X

(

)

const

Get statistics for x component of signal.

Returns

Statistics for x component of signal.

Y() [1/2]

SignalStats & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::Y

(

)

Get mutable reference to statistics for y component of signal.

Returns

Statistics for y component of signal.

Y() [2/2]

const SignalStats & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::Y

(

)

const

Get statistics for y component of signal.

Returns

Statistics for y component of signal.

Z() [1/2]

SignalStats & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::Z

(

)

Get mutable reference to statistics for z component of signal.

Returns

Statistics for z component of signal.

Z() [2/2]

const SignalStats & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::Z

(

)

const

Get statistics for z component of signal.

Returns

Statistics for z component of signal.

Member Data Documentation

dataPtr

Vector3StatsPrivate* ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Vector3Stats::dataPtr

protected

Pointer to private data.

---

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

• Vector3Stats.hh