configuration.hpp
Go to the documentation of this file.
1 /*********************************************************************
2 * Copyright (c) 2017 - for information on the respective copyright
3 * owner see the NOTICE file and/or the repository
4 *
5 * https://github.com/hbanzhaf/steering_functions.git
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16 * implied. See the License for the specific language governing
17 * permissions and limitations under the License.
18 
19 * This source code is derived from Continuous Curvature (CC) Steer.
20 * Copyright (c) 2016, Thierry Fraichard and Institut national de
21 * recherche en informatique et en automatique (Inria), licensed under
22 * the BSD license, cf. 3rd-party-licenses.txt file in the root
23 * directory of this source tree.
24 **********************************************************************/
25 
26 #ifndef CONFIGURATION_HPP
27 #define CONFIGURATION_HPP
28 
29 namespace steering
30 {
31 
32 class Configuration
33 {
34 public:
36  Configuration(double _x = 0.0, double _y = 0.0, double _theta = 0.0, double _kappa = 0.0);
37 
39  void print(bool eol) const;
40 
42  double x, y;
43 
45  double theta;
46 
48  double kappa;
49 };
50 
52 double configuration_distance(const Configuration &q1, const Configuration &q2);
53 
56 
58 bool configuration_equal(const Configuration &q1, const Configuration &q2);
59 
60 } // namespace steering
61 
62 #endif
steering::Configuration::Configuration
Configuration(double _x=0.0, double _y=0.0, double _theta=0.0, double _kappa=0.0)
Constructor.
Definition: configuration.cpp:37
steering::Configuration::print
void print(bool eol) const
Alphanumeric display.
Definition: configuration.cpp:45
steering::configuration_distance
double configuration_distance(const Configuration &q1, const Configuration &q2)
Cartesian distance between two configurations.
Definition: configuration.cpp:54
steering::Configuration::kappa
double kappa
Curvature.
Definition: configuration.hpp:94
steering::Configuration
Definition: configuration.hpp:55
steering
Definition: dubins_state_space.hpp:70
steering::configuration_aligned
bool configuration_aligned(const Configuration &q1, const Configuration &q2)
Are two configurations aligned?
Definition: configuration.cpp:59
steering::configuration_equal
bool configuration_equal(const Configuration &q1, const Configuration &q2)
Are two configurations equal?
Definition: configuration.cpp:69
steering::Configuration::y
double y
Definition: configuration.hpp:88
steering::Configuration::x
double x
Position.
Definition: configuration.hpp:88
steering::Configuration::theta
double theta
Orientation in rad between [0, 2*pi[.
Definition: configuration.hpp:91


steering_functions
Author(s): Holger Banzhaf
autogenerated on Mon Dec 11 2023 03:27:43