Collection of statistics for a Vector3 signal.
More...
#include <math/gzmath.hh>
Collection of statistics for a Vector3 signal.
◆ Vector3Stats() [1/2]
Constructor.
- Deprecated:
- See ignition::math::Vector3Stats
◆ Vector3Stats() [2/2]
Ignition math copy constructor.
- Parameters
-
[in] | _stats | An ignition math vector3stats to copy |
◆ ~Vector3Stats()
◆ Ign()
ignition::math::Vector3Stats Ign |
( |
| ) |
const |
Convert this Vector3Stats to an ignition::math::Vector3Stats.
- Returns
- This vector as an ignition::math::Vector3d.
◆ InsertData()
void InsertData |
( |
const Vector3 & |
_data | ) |
|
Add a new sample to the statistical measures.
- Parameters
-
[in] | _data | New signal data point. |
◆ InsertStatistic()
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.
◆ InsertStatistics()
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.
◆ Mag() [1/2]
Get statistics for mag component of signal.
- Returns
- Statistics for mag component of signal.
◆ Mag() [2/2]
Get mutable reference to statistics for magnitude of signal.
- Returns
- Statistics for magnitude of signal.
◆ operator=()
Vector3Stats& operator= |
( |
const ignition::math::Vector3Stats & |
_v | ) |
|
Assignment operator for ignition math.
- Parameters
-
[in] | _v | An ignition math vector3stats to copy |
- Returns
- this
◆ Reset()
Forget all previous data.
◆ X() [1/2]
Get statistics for x component of signal.
- Returns
- Statistics for x component of signal.
◆ X() [2/2]
Get mutable reference to statistics for x component of signal.
- Returns
- Statistics for x component of signal.
◆ Y() [1/2]
Get statistics for y component of signal.
- Returns
- Statistics for y component of signal.
◆ Y() [2/2]
Get mutable reference to statistics for y component of signal.
- Returns
- Statistics for y component of signal.
◆ Z() [1/2]
Get statistics for z component of signal.
- Returns
- Statistics for z component of signal.
◆ Z() [2/2]
Get mutable reference to statistics for z component of signal.
- Returns
- Statistics for z component of signal.
◆ dataPtr
Vector3StatsPrivate* dataPtr |
|
protected |
The documentation for this class was generated from the following file: