A class to provide position related functionalities. More...

#include <position.h>

Public Member Functions
double	bearing (geometry_msgs::Pose p) const
	Compute the bearing from the current pose of the CPS to a given pose. More...

geometry_msgs::Pose	compute_goal (double distance, double direction) const
	Compute the goal coordinates relative to the current position. More...

geometry_msgs::Pose	compute_goal (geometry_msgs::Pose start, double distance, double direction) const
	Compute the goal coordinates relative to a given start position. More...

double	dist (geometry_msgs::Pose p) const
	Compute the straight-line distance from the current position to the given position. More...

double	dist (geometry_msgs::Pose p1, geometry_msgs::Pose p2) const
	Compute the straight-line distance between two positions. More...

geometry_msgs::Pose	get_pose () const
	Get the current pose of the CPS. More...

double	get_yaw () const
	Get the current yaw orientation of the CPS. More...

bool	move (geometry_msgs::Pose pose)
	Move the CPS to the given pose. More...

bool	occupied (geometry_msgs::Pose pose)
	Check whether there is an obstacle in the direction of the given pose. More...

bool	out_of_bounds (geometry_msgs::Pose pose)
	Check whether a given pose is out of the mission area boundaries. More...

	position ()
	Constructor that initializes the private member variables. More...

	~position ()
	Destructor that deletes the private member objects. More...

Private Member Functions
double	get_yaw (geometry_msgs::Pose pose) const
	Get the yaw orientation from a pose. More...

void	pose_callback (const geometry_msgs::PoseStamped::ConstPtr &msg)
	Callback function for position updates. More...

bool	reached (geometry_msgs::Pose goal)
	Check whether the CPS has reached a given pose. More...

Private Attributes
double	goal_timeout
	The time in seconds that the CPS is given time to reach a destination before giving up. More...

double	goal_tolerance
	The distance that the CPS can be away from a goal while still being considered to have reached that goal. More...

NodeHandle	nh
	A node handle for the main ROS node. More...

ServiceClient	occupied_sector_client
	Service client for determining the sector occupied by obstacles. More...

ServiceClient	out_of_bounds_client
	Service client for determining whether the goal is out of the area bounds. More...

geometry_msgs::Pose	pose
	Current position of the CPS. More...

Publisher	pose_pub
	Publisher for sending the goal position of the CPS to the position controller in the abstraction library. More...

Subscriber	pose_sub
	Subscriber for the position of the CPS. More...

bool	pose_valid
	Whether a valid position has been received. More...

Rate *	rate
	The loop rate object for running the behavior control loops at a specific frequency. More...

Detailed Description

A class to provide position related functionalities.

Definition at line 16 of file position.h.

Constructor & Destructor Documentation

◆ position()

position::position ( )

Constructor that initializes the private member variables.

Definition at line 3 of file position.cpp.

◆ ~position()

position::~position ( )

Destructor that deletes the private member objects.

Definition at line 33 of file position.cpp.

Member Function Documentation

◆ bearing()

double position::bearing ( geometry_msgs::Pose p ) const

Compute the bearing from the current pose of the CPS to a given pose.

Parameters

p	The pose to compute bearing of.

Returns: The bearing of the given pose relative to the current yaw of the CPS, counterclockwise.

Definition at line 38 of file position.cpp.

◆ compute_goal() [1/2]

geometry_msgs::Pose position::compute_goal	(	double	distance,
		double	direction
	)		const

Compute the goal coordinates relative to the current position.

Parameters

distance	The distance of the goal from the current position.
direction	The direction of the goal relative to the current position. It is in radian, counterclockwise starting from east / x-axis.

Returns: The goal pose.

Definition at line 46 of file position.cpp.

◆ compute_goal() [2/2]

geometry_msgs::Pose position::compute_goal	(	geometry_msgs::Pose	start,
		double	distance,
		double	direction
	)		const

Compute the goal coordinates relative to a given start position.

Parameters

start	The starting position.
distance	The distance of the goal from start.
direction	The direction of the goal relative to start. It is in radian, counterclockwise starting from east / x-axis.

Returns: The goal pose.

Definition at line 51 of file position.cpp.

◆ dist() [1/2]

double position::dist ( geometry_msgs::Pose p ) const

Compute the straight-line distance from the current position to the given position.

Parameters

p	The pose to compute distance to.

Returns: The distance in meters.

Definition at line 68 of file position.cpp.

◆ dist() [2/2]

double position::dist	(	geometry_msgs::Pose	p1,
		geometry_msgs::Pose	p2
	)		const

Compute the straight-line distance between two positions.

Parameters

p1	First pose.
p2	Second pose.

Returns: The distance in meters.

Definition at line 73 of file position.cpp.

◆ get_pose()

geometry_msgs::Pose position::get_pose ( ) const

Get the current pose of the CPS.

Returns: The current pose of the CPS in local coordinates.

Definition at line 78 of file position.cpp.

◆ get_yaw() [1/2]

double position::get_yaw ( ) const

Get the current yaw orientation of the CPS.

Returns: The current yaw angle of the CPS counterclockwise starting from x-axis/east.

Definition at line 83 of file position.cpp.

◆ get_yaw() [2/2]

double position::get_yaw ( geometry_msgs::Pose pose ) const

private

Get the yaw orientation from a pose.

Parameters

pose	The pose that contains the orientation.

Returns: The yaw angle of the given pose counterclockwise starting from x-axis/east.

Definition at line 161 of file position.cpp.

◆ move()

bool position::move ( geometry_msgs::Pose pose )

Move the CPS to the given pose.

Parameters

pose	The position to move to.

Returns: Whether the CPS reached the goal position.

Definition at line 88 of file position.cpp.

◆ occupied()

bool position::occupied ( geometry_msgs::Pose pose )

Check whether there is an obstacle in the direction of the given pose.

Parameters

pose	The pose to check.

Returns: True, if there is an obstacle in the direction of the pose, false otherwise.

Definition at line 125 of file position.cpp.

◆ out_of_bounds()

bool position::out_of_bounds ( geometry_msgs::Pose pose )

Check whether a given pose is out of the mission area boundaries.

Parameters

pose	The pose to check.

Returns: True, if the given pose is outside the mission area or it could not be checked, false otherwise.

Definition at line 148 of file position.cpp.

◆ pose_callback()

void position::pose_callback ( const geometry_msgs::PoseStamped::ConstPtr & msg )

private

Callback function for position updates.

Parameters

msg	Position received from the CPS.

Definition at line 178 of file position.cpp.

◆ reached()

bool position::reached ( geometry_msgs::Pose goal )

private

Check whether the CPS has reached a given pose.

Parameters

goal	The pose to check.

Returns: True if the CPS is close to the given pose, false otherwise.

Definition at line 168 of file position.cpp.

Member Data Documentation

◆ goal_timeout

double position::goal_timeout

private

The time in seconds that the CPS is given time to reach a destination before giving up.

Definition at line 165 of file position.h.

◆ goal_tolerance

double position::goal_tolerance

private

The distance that the CPS can be away from a goal while still being considered to have reached that goal.

Definition at line 170 of file position.h.

◆ nh

NodeHandle position::nh

private

A node handle for the main ROS node.

Definition at line 145 of file position.h.

◆ occupied_sector_client

ServiceClient position::occupied_sector_client

private

Service client for determining the sector occupied by obstacles.

Definition at line 135 of file position.h.

◆ out_of_bounds_client

ServiceClient position::out_of_bounds_client

private

Service client for determining whether the goal is out of the area bounds.

Definition at line 130 of file position.h.

◆ pose

geometry_msgs::Pose position::pose

private

Current position of the CPS.

Definition at line 155 of file position.h.

◆ pose_pub

Publisher position::pose_pub

private

Publisher for sending the goal position of the CPS to the position controller in the abstraction library.

Definition at line 140 of file position.h.

◆ pose_sub

Subscriber position::pose_sub

private

Subscriber for the position of the CPS.

Definition at line 125 of file position.h.

◆ pose_valid

bool position::pose_valid

private

Whether a valid position has been received.

Definition at line 160 of file position.h.

◆ rate

Rate* position::rate

private

The loop rate object for running the behavior control loops at a specific frequency.

Definition at line 150 of file position.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ position()

◆ ~position()

Member Function Documentation

◆ bearing()

◆ compute_goal() [1/2]

◆ compute_goal() [2/2]

◆ dist() [1/2]

◆ dist() [2/2]

◆ get_pose()

◆ get_yaw() [1/2]

◆ get_yaw() [2/2]

◆ move()

◆ occupied()

◆ out_of_bounds()

◆ pose_callback()

◆ reached()

Member Data Documentation

◆ goal_timeout

◆ goal_tolerance

◆ nh

◆ occupied_sector_client

◆ out_of_bounds_client

◆ pose

◆ pose_pub

◆ pose_sub

◆ pose_valid

◆ rate