Collection of statistics for a Vector3 signal.
More...
#include <math/gzmath.hh>
Collection of statistics for a Vector3 signal.
Constructor.
 Deprecated:
 See ignition::math::Vector3Stats
Ignition math copy constructor.
 Parameters

[in]  _stats  An ignition math vector3stats to copy 
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  Commaseparated 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.
Get statistics for mag component of signal.
 Returns
 Statistics for mag component of signal.
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
Forget all previous data.
Get statistics for x component of signal.
 Returns
 Statistics for x component of signal.
Get mutable reference to statistics for x component of signal.
 Returns
 Statistics for x component of signal.
Get statistics for y component of signal.
 Returns
 Statistics for y component of signal.
Get mutable reference to statistics for y component of signal.
 Returns
 Statistics for y component of signal.
Get statistics for z component of signal.
 Returns
 Statistics for z component of signal.
Get mutable reference to statistics for z component of signal.
 Returns
 Statistics for z component of signal.
Vector3StatsPrivate* dataPtr 

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