Vector3Stats Class Reference
Collection of statistics for a Vector3 signal. More...
#include <ignition/math/Vector3Stats.hh>
Public Member Functions | |
| Vector3Stats () | |
| Constructor. More... | |
| ~Vector3Stats () | |
| Destructor. More... | |
| void | InsertData (const Vector3d &_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 () |
| Get mutable reference to statistics for magnitude of signal. More... | |
| const SignalStats & | Mag () const |
| Get statistics for magnitude component of signal. More... | |
| void | Reset () |
| Forget all previous data. More... | |
| SignalStats & | X () |
| Get mutable reference to statistics for x component of signal. More... | |
| const SignalStats & | X () const |
| Get statistics for x component of signal. More... | |
| SignalStats & | Y () |
| Get mutable reference to statistics for y component of signal. More... | |
| const SignalStats & | Y () const |
| Get statistics for y component of signal. More... | |
| SignalStats & | Z () |
| Get mutable reference to statistics for z component of signal. More... | |
| const SignalStats & | Z () const |
| Get 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()
| Vector3Stats | ( | ) |
Constructor.
◆ ~Vector3Stats()
| ~Vector3Stats | ( | ) |
Destructor.
Member Function Documentation
◆ InsertData()
| void InsertData | ( | const Vector3d & | _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]
| SignalStats& Mag | ( | ) |
Get mutable reference to statistics for magnitude of signal.
- Returns
- Statistics for magnitude of signal.
◆ Mag() [2/2]
| const SignalStats& Mag | ( | ) | const |
Get statistics for magnitude component of signal.
- Returns
- Statistics for magnitude component of signal.
◆ Reset()
| void Reset | ( | ) |
Forget all previous data.
◆ X() [1/2]
| SignalStats& X | ( | ) |
Get mutable reference to statistics for x component of signal.
- Returns
- Statistics for x component of signal.
◆ X() [2/2]
| const SignalStats& X | ( | ) | const |
Get statistics for x component of signal.
- Returns
- Statistics for x component of signal.
◆ Y() [1/2]
| SignalStats& Y | ( | ) |
Get mutable reference to statistics for y component of signal.
- Returns
- Statistics for y component of signal.
◆ Y() [2/2]
| const SignalStats& Y | ( | ) | const |
Get statistics for y component of signal.
- Returns
- Statistics for y component of signal.
◆ Z() [1/2]
| SignalStats& Z | ( | ) |
Get mutable reference to statistics for z component of signal.
- Returns
- Statistics for z component of signal.
◆ Z() [2/2]
| const SignalStats& Z | ( | ) | const |
Get statistics for z component of signal.
- Returns
- Statistics for z component of signal.
Member Data Documentation
◆ dataPtr
|
protected |
Pointer to private data.
The documentation for this class was generated from the following file: