Vector3Stats.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 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 GAZEBO_VECTOR3_STATS_HH_
18 #define GAZEBO_VECTOR3_STATS_HH_
19 
20 #include <string>
21 #include <ignition/math/Vector3Stats.hh>
23 #include "gazebo/math/Vector3.hh"
24 #include "gazebo/util/system.hh"
25 
26 #ifndef _WIN32
27 #pragma GCC diagnostic push
28 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
29 #endif
30 
31 namespace gazebo
32 {
33  namespace math
34  {
37 
39  class Vector3StatsPrivate;
40 
43  class GZ_MATH_VISIBLE Vector3Stats
44  {
47  public: Vector3Stats() GAZEBO_DEPRECATED(8.0);
48 
51  public: Vector3Stats(const ignition::math::Vector3Stats &_stats);
52 
54  public: ~Vector3Stats();
55 
58  public: void InsertData(const Vector3 &_data);
59 
69  public: bool InsertStatistic(const std::string &_name);
70 
78  public: bool InsertStatistics(const std::string &_names);
79 
81  public: void Reset();
82 
85  public: SignalStats X() const;
86 
89  public: SignalStats Y() const;
90 
93  public: SignalStats Z() const;
94 
97  public: SignalStats Mag() const;
98 
101  public: SignalStats &X();
102 
105  public: SignalStats &Y();
106 
109  public: SignalStats &Z();
110 
113  public: SignalStats &Mag();
114 
118  public: ignition::math::Vector3Stats Ign() const;
119 
123  public: Vector3Stats &operator=(const ignition::math::Vector3Stats &_v);
124 
126  protected: Vector3StatsPrivate *dataPtr;
127  };
129  }
130 }
131 #ifndef _WIN32
132 #pragma GCC diagnostic pop
133 #endif
134 #endif
135 
The Vector3 class represents the generic vector containing 3 elements.
Definition: Vector3.hh:44
static const double GAZEBO_DEPRECATED(8.0) MAX_D
Double maximum value. This value will be similar to 1.79769e+308.
Definition: Helpers.hh:140
Collection of statistics for a scalar signal.
Definition: SignalStats.hh:138
Collection of statistics for a Vector3 signal.
Definition: Vector3Stats.hh:43
Vector3StatsPrivate * dataPtr
Pointer to private data.
Definition: Vector3Stats.hh:126