Gazebo Math

API Reference

7.5.1
gz/math/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 GZ_MATH_VECTOR3STATS_HH_
18 #define GZ_MATH_VECTOR3STATS_HH_
19 
20 #include <string>
21 #include <gz/math/Helpers.hh>
22 #include <gz/math/SignalStats.hh>
23 #include <gz/math/Vector3.hh>
24 #include <gz/math/config.hh>
25 #include <gz/utils/ImplPtr.hh>
26 
27 namespace gz::math
28 {
29  // Inline bracket to help doxygen filtering.
30  inline namespace GZ_MATH_VERSION_NAMESPACE {
33  class GZ_MATH_VISIBLE Vector3Stats
34  {
36  public: Vector3Stats();
37 
40  public: void InsertData(const Vector3d &_data);
41 
51  public: bool InsertStatistic(const std::string &_name);
52 
60  public: bool InsertStatistics(const std::string &_names);
61 
63  public: void Reset();
64 
67  public: const SignalStats &X() const;
68 
71  public: const SignalStats &Y() const;
72 
75  public: const SignalStats &Z() const;
76 
79  public: const SignalStats &Mag() const;
80 
83  public: SignalStats &X();
84 
87  public: SignalStats &Y();
88 
91  public: SignalStats &Z();
92 
95  public: SignalStats &Mag();
96 
98  GZ_UTILS_IMPL_PTR(dataPtr)
99  };
100  } // namespace GZ_MATH_VERSION_NAMESPACE
101 } // namespace gz::math
102 #endif // GZ_MATH_VECTOR3STATS_HH_