PX4 Firmware
PX4 Autopilot Software http://px4.io
StraightLine.hpp
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Copyright (c) 2018-2019 PX4 Development Team. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * 3. Neither the name PX4 nor the names of its contributors may be
16  * used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  ****************************************************************************/
33 
34 /**
35  * @file StraightLine.hpp
36  *
37  * lib to return setpoints on a straight line
38  *
39  * @author Christoph Tobler <christoph@px4.io>
40  */
41 
42 #pragma once
43 
44 #include <matrix/matrix/math.hpp>
45 
47 {
48 public:
49  StraightLine(const matrix::Vector3f &pos) : _position(pos) {};
50  ~StraightLine() = default;
51 
52  // setter functions
53  void setLineFromTo(const matrix::Vector3f &start, const matrix::Vector3f &end);
54  void setSpeed(const float &speed) { _speed = speed; };
55 
56  /**
57  * Generate setpoints on a straight line according to parameters
58  *
59  * @param position_setpoint: reference to the 3D vector with the position setpoint to update
60  * @param velocity_setpoint: reference to the 3D vector with the velocity setpoint to update
61  */
62  void generateSetpoints(matrix::Vector3f &position_setpoint, matrix::Vector3f &velocity_setpoint);
63 
64  /**
65  * Check if the end was reached
66  *
67  * @return false when on the way from start to end, true when end was reached
68  */
69  bool isEndReached() { return end_reached; }
70 
71 private:
72  const matrix::Vector3f &_position; /**< vehicle position (dependency injection) */
73 
74  matrix::Vector3f _start; /**< Start point of the straight line */
75  matrix::Vector3f _end; /**< End point of the straight line */
76  float _speed = 1.f; /**< desired speed between accelerating and decelerating */
77 
78  bool end_reached = true; /**< Flag to lock further movement when end is reached */
79 };
const matrix::Vector3f & _position
vehicle position (dependency injection)
matrix::Vector3f _end
End point of the straight line.
matrix::Vector3f _start
Start point of the straight line.
void setLineFromTo(const matrix::Vector3f &start, const matrix::Vector3f &end)
~StraightLine()=default
static int start()
Definition: dataman.cpp:1452
float _speed
desired speed between accelerating and decelerating
bool isEndReached()
Check if the end was reached.
StraightLine(const matrix::Vector3f &pos)
void setSpeed(const float &speed)
bool end_reached
Flag to lock further movement when end is reached.
void generateSetpoints(matrix::Vector3f &position_setpoint, matrix::Vector3f &velocity_setpoint)
Generate setpoints on a straight line according to parameters.