types.h
Go to the documentation of this file.
1 /**
2  * This file is part of ArmarX.
3  *
4  * ArmarX is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * ArmarX is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * @author Fabian Reister ( fabian dot reister at kit dot edu )
17  * @author Christian R. G. Dreher ( c dot dreher at kit dot edu )
18  * @date 2021
19  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20  * GNU General Public License
21  */
22 
23 #pragma once
24 
25 #include <limits>
26 #include <optional>
27 
28 #include <Eigen/Geometry>
29 
30 #include <SimoxUtility/meta/enum/EnumNames.hpp>
31 #include <VirtualRobot/VirtualRobot.h>
32 
34 
39 
41 {
42  enum class NavigationFrame
43  {
44  Relative,
45  Absolute
46  };
47 
48  inline const simox::meta::EnumNames<NavigationFrame> NavigationFrameNames{
49  {NavigationFrame::Relative, "Relative"},
50  {NavigationFrame::Absolute, "Absolute"}};
51 
52 
53  class TimeServerInterface;
54 
55  struct SceneGraph
56  {
58  };
59 
60  struct Scene
61  {
63 
64  std::optional<core::StaticScene> staticScene = std::nullopt;
65  std::optional<core::DynamicScene> dynamicScene = std::nullopt;
66 
69 
70  std::optional<core::SceneGraph> graph;
71  };
72 
73  struct PIDParams
74  {
75  float Kp{1.0};
76  float Ki{0.F};
77  float Kd{0.F};
78  };
79 
80  struct TwistLimits
81  {
84 
85  static TwistLimits
87  {
89  .angular = std::numeric_limits<float>::max()};
90  }
91 
92  static TwistLimits
94  {
95  return TwistLimits{.linear = 0, .angular = 0};
96  }
97  };
98 
99 } // namespace armarx::navigation::core
armarx::navigation::core::PIDParams
Definition: types.h:73
armarx::navigation::core::Scene::graph
std::optional< core::SceneGraph > graph
Definition: types.h:70
armarx::navigation::core::Scene::robot
VirtualRobot::RobotPtr robot
Definition: types.h:67
armarx::navigation::core::TwistLimits::ZeroLimits
static TwistLimits ZeroLimits()
Definition: types.h:93
armarx::navigation::core::Scene::staticScene
std::optional< core::StaticScene > staticScene
Definition: types.h:64
armarx::navigation::core::NavigationFrame
NavigationFrame
Definition: types.h:42
basic_types.h
armarx::navigation::core::Twist::Zero
static Twist Zero()
Definition: basic_types.cpp:13
DateTime.h
DynamicScene.h
armarx::navigation::core::Graphs
std::vector< Graph > Graphs
Definition: Graph.h:105
armarx::navigation::core
This file is part of ArmarX.
Definition: aron_conversions.cpp:19
StaticScene.h
armarx::navigation::core::TwistLimits::linear
float linear
Definition: types.h:82
armarx::navigation::core::SceneGraph::subgraphs
core::Graphs subgraphs
Definition: types.h:57
armarx::navigation::core::TwistLimits::angular
float angular
Definition: types.h:83
armarx::navigation::core::Twist
Definition: basic_types.h:53
armarx::navigation::core::NavigationFrameNames
const simox::meta::EnumNames< NavigationFrame > NavigationFrameNames
Definition: types.h:48
armarx::navigation::core::Scene::platformVelocity
core::Twist platformVelocity
Definition: types.h:68
armarx::navigation::core::Scene::timestamp
DateTime timestamp
Definition: types.h:62
armarx::navigation::core::NavigationFrame::Absolute
@ Absolute
armarx::navigation::core::PIDParams::Ki
float Ki
Definition: types.h:76
armarx::navigation::core::TwistLimits
Definition: types.h:80
max
T max(T t1, T t2)
Definition: gdiam.h:51
armarx::navigation::core::Scene
Definition: types.h:60
armarx::navigation::core::PIDParams::Kp
float Kp
Definition: types.h:75
armarx::navigation::core::Scene::dynamicScene
std::optional< core::DynamicScene > dynamicScene
Definition: types.h:65
armarx::navigation::core::PIDParams::Kd
float Kd
Definition: types.h:77
armarx::core::time::DateTime
Represents a point in time.
Definition: DateTime.h:24
Graph.h
armarx::navigation::core::NavigationFrame::Relative
@ Relative
armarx::navigation::core::SceneGraph
Definition: types.h:55
armarx::core::time::DateTime::Invalid
static DateTime Invalid()
Definition: DateTime.cpp:57
armarx::navigation::core::TwistLimits::NoLimits
static TwistLimits NoLimits()
Definition: types.h:86
VirtualRobot::RobotPtr
std::shared_ptr< class Robot > RobotPtr
Definition: Bus.h:19