Loading...
Searching...
No Matches
Vector3Stats.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_MATH_VECTOR3STATS_HH_
18#define IGNITION_MATH_VECTOR3STATS_HH_
19
20#include <string>
24#include <ignition/math/config.hh>
25
26namespace ignition
27{
28 namespace math
29 {
30 inline namespace IGNITION_MATH_VERSION_NAMESPACE
31 {
33 class Vector3StatsPrivate;
34
37 class IGNITION_MATH_VISIBLE Vector3Stats
38 {
40 public: Vector3Stats();
41
43 public: ~Vector3Stats();
44
47 public: void InsertData(const Vector3d &_data);
48
58 public: bool InsertStatistic(const std::string &_name);
59
67 public: bool InsertStatistics(const std::string &_names);
68
70 public: void Reset();
71
74 public: const SignalStats &X() const;
75
78 public: const SignalStats &Y() const;
79
82 public: const SignalStats &Z() const;
83
86 public: const SignalStats &Mag() const;
87
90 public: SignalStats &X();
91
94 public: SignalStats &Y();
95
98 public: SignalStats &Z();
99
102 public: SignalStats &Mag();
103
105 protected: Vector3StatsPrivate *dataPtr;
106 };
107 }
108 }
109}
110#endif
111
Collection of statistics for a scalar signal.
Definition SignalStats.hh:189
Collection of statistics for a Vector3 signal.
Definition Vector3Stats.hh:38
SignalStats & Z()
Get mutable reference to statistics for z component of signal.
const SignalStats & Y() const
Get statistics for y component of signal.
const SignalStats & X() const
Get statistics for x component of signal.
bool InsertStatistics(const std::string &_names)
Add multiple statistics.
Vector3StatsPrivate * dataPtr
Pointer to private data.
Definition Vector3Stats.hh:105
SignalStats & Mag()
Get mutable reference to statistics for magnitude of signal.
bool InsertStatistic(const std::string &_name)
Add a new type of statistic.
SignalStats & Y()
Get mutable reference to statistics for y component of signal.
const SignalStats & Z() const
Get statistics for z component of signal.
const SignalStats & Mag() const
Get statistics for magnitude component of signal.
void InsertData(const Vector3d &_data)
Add a new sample to the statistical measures.
SignalStats & X()
Get mutable reference to statistics for x component of signal.
The Vector3 class represents the generic vector containing 3 elements.
Definition Vector3.hh:40
Definition Angle.hh:40