1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
/*
* Copyright (C) 2015 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef IGNITION_MATH_VECTOR3STATS_HH_
#define IGNITION_MATH_VECTOR3STATS_HH_
#include <string>
#include <ignition/math/Helpers.hh>
#include <ignition/math/SignalStats.hh>
#include <ignition/math/Vector3.hh>
#include <ignition/math/config.hh>
namespace ignition
{
namespace math
{
inline namespace IGNITION_MATH_VERSION_NAMESPACE
{
/// \brief Forward declare private data class.
class Vector3StatsPrivate;
/// \class Vector3Stats Vector3Stats.hh ignition/math/Vector3Stats.hh
/// \brief Collection of statistics for a Vector3 signal.
class IGNITION_MATH_VISIBLE Vector3Stats
{
/// \brief Constructor
public: Vector3Stats();
/// \brief Destructor
public: ~Vector3Stats();
/// \brief Add a new sample to the statistical measures.
/// \param[in] _data New signal data point.
public: void InsertData(const Vector3d &_data);
/// \brief Add a new type of statistic.
/// \param[in] _name Short name of new statistic.
/// Valid values include:
/// "maxAbs"
/// "mean"
/// "rms"
/// \return True if statistic was successfully added,
/// false if name was not recognized or had already
/// been inserted.
public: bool InsertStatistic(const std::string &_name);
/// \brief Add multiple statistics.
/// \param[in] _names Comma-separated list of new statistics.
/// For example, all statistics could be added with:
/// "maxAbs,mean,rms"
/// \return True if all statistics were successfully added,
/// false if any names were not recognized or had already
/// been inserted.
public: bool InsertStatistics(const std::string &_names);
/// \brief Forget all previous data.
public: void Reset();
/// \brief Get statistics for x component of signal.
/// \return Statistics for x component of signal.
public: const SignalStats &X() const;
/// \brief Get statistics for y component of signal.
/// \return Statistics for y component of signal.
public: const SignalStats &Y() const;
/// \brief Get statistics for z component of signal.
/// \return Statistics for z component of signal.
public: const SignalStats &Z() const;
/// \brief Get statistics for magnitude component of signal.
/// \return Statistics for magnitude component of signal.
public: const SignalStats &Mag() const;
/// \brief Get mutable reference to statistics for x component of signal.
/// \return Statistics for x component of signal.
public: SignalStats &X();
/// \brief Get mutable reference to statistics for y component of signal.
/// \return Statistics for y component of signal.
public: SignalStats &Y();
/// \brief Get mutable reference to statistics for z component of signal.
/// \return Statistics for z component of signal.
public: SignalStats &Z();
/// \brief Get mutable reference to statistics for magnitude of signal.
/// \return Statistics for magnitude of signal.
public: SignalStats &Mag();
/// \brief Pointer to private data.
protected: Vector3StatsPrivate *dataPtr;
};
}
}
}
#endif
|
