All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SignalStats.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 #ifndef _IGNITION_SIGNAL_STATS_HH_
18 #define _IGNITION_SIGNAL_STATS_HH_
19 
20 #include <map>
21 #include <string>
22 #include <ignition/math/Helpers.hh>
23 
24 namespace ignition
25 {
26  namespace math
27  {
29  class SignalStatisticPrivate;
30 
34  {
36  public: SignalStatistic();
37 
39  public: virtual ~SignalStatistic();
40 
43  public: virtual double Value() const = 0;
44 
47  public: virtual std::string ShortName() const = 0;
48 
51  public: virtual size_t Count() const;
52 
55  public: virtual void InsertData(const double _data) = 0;
56 
58  public: virtual void Reset();
59 
62  };
64 
68  {
69  // Documentation inherited.
70  public: virtual double Value() const;
71 
74  public: virtual std::string ShortName() const;
75 
76  // Documentation inherited.
77  public: virtual void InsertData(const double _data);
78  };
80 
84  {
85  // Documentation inherited.
86  public: virtual double Value() const;
87 
90  public: virtual std::string ShortName() const;
91 
92  // Documentation inherited.
93  public: virtual void InsertData(const double _data);
94  };
96 
100  {
101  // Documentation inherited.
102  public: virtual double Value() const;
103 
106  public: virtual std::string ShortName() const;
107 
108  // Documentation inherited.
109  public: virtual void InsertData(const double _data);
110  };
112 
117  {
118  // Documentation inherited.
119  public: virtual double Value() const;
120 
123  public: virtual std::string ShortName() const;
124 
125  // Documentation inherited.
126  public: virtual void InsertData(const double _data);
127  };
129 
136  {
137  // Documentation inherited.
138  public: virtual double Value() const;
139 
142  public: virtual std::string ShortName() const;
143 
144  // Documentation inherited.
145  public: virtual void InsertData(const double _data);
146  };
148 
153  {
154  // Documentation inherited.
155  public: virtual double Value() const;
156 
159  public: virtual std::string ShortName() const;
160 
161  // Documentation inherited.
162  public: virtual void InsertData(const double _data);
163  };
165 
167  class SignalStatsPrivate;
168 
172  {
174  public: SignalStats();
175 
177  public: ~SignalStats();
178 
184  public: size_t Count() const;
185 
190  public: std::map<std::string, double> Map() const;
191 
194  public: void InsertData(const double _data);
195 
205  public: bool InsertStatistic(const std::string &_name);
206 
214  public: bool InsertStatistics(const std::string &_names);
215 
217  public: void Reset();
218 
221  };
223  }
224 }
225 #endif
226 
#define IGNITION_VISIBLE
Use to represent &quot;symbol visible&quot; if supported.
Definition: Helpers.hh:408
Statistical properties of a discrete time scalar signal.
Definition: SignalStats.hh:33
Computing the incremental variance of a discretely sampled signal.
Definition: SignalStats.hh:152
Private data class for the SignalStats class.
Definition: SignalStatsPrivate.hh:52
Computing the minimum value of a discretely sampled signal.
Definition: SignalStats.hh:99
ignition/math/SignalStats.hh
Definition: SignalStats.hh:135
Computing the maximum value of a discretely sampled signal.
Definition: SignalStats.hh:67
Computing the mean value of a discretely sampled signal.
Definition: SignalStats.hh:83
Private data class for the SignalStatistic class.
Definition: SignalStatsPrivate.hh:28
SignalStatisticPrivate * dataPtr
Pointer to private data.
Definition: SignalStats.hh:61
Collection of statistics for a scalar signal.
Definition: SignalStats.hh:171
Computing the square root of the mean squared value of a discretely sampled signal.
Definition: SignalStats.hh:116
SignalStatsPrivate * dataPtr
Pointer to private data.
Definition: SignalStats.hh:220