cogip::cogip_defs::Pose Class Reference

A robot position. More...

Detailed Description

A robot position.

Definition at line 24 of file Pose.hpp.

#include <Pose.hpp>

Inheritance diagram for cogip::cogip_defs::Pose:

Collaboration diagram for cogip::cogip_defs::Pose:

Public Member Functions
	Pose (double x=0.0, double y=0.0, double O=0.0)
	Constructor. More...
	Pose (const PB_Pose &pose)
	Constructor from Protobuf class.
Coords	coords (void) const
	Return coordinates.
void	set_coords (const Coords &coords)
	Set coordinates. More...
double	O (void) const
	Return 0-orientation.
void	set_O (double O)
	Set 0-orientation. More...
bool	operator== (const Pose other) const
	Check if this pose is equal to another. More...
void	pb_copy (PB_Pose &pose) const
	Copy data to Protobuf message. More...
Polar	operator- (const Pose &p)
Public Member Functions inherited from cogip::cogip_defs::Coords
	Coords (double x=0.0, double y=0.0)
	Constructor. More...
	Coords (const PB_Coords &coords)
	Constructor from Protobuf class.
double	x (void) const
	Return X coordinate.
double	y (void) const
	Return Y coordinate.
void	set_x (double x)
	Set X coordinate. More...
void	set_y (double y)
	Set Y coordinate. More...
double	distance (const Coords &dest) const
	Compute the distance the destination point. More...
bool	on_segment (const Coords &a, const Coords &b) const
	Check if this point is placed on a segment defined by two points A,B. More...
bool	operator== (const Coords other) const
	Check if this point is equal to another. More...
void	pb_copy (PB_Coords &coords) const
	Copy data to Protobuf message. More...

Protected Attributes
double	O_
	0-orientation
Protected Attributes inherited from cogip::cogip_defs::Coords
double	x_
	x-position
double	y_
	y-position

Constructor & Destructor Documentation

Pose()

cogip::cogip_defs::Pose::Pose ( double  x = 0.0, double  y = 0.0, double  O = 0.0  )

inline

Constructor.

Parameters

[in]	x	[in] X coordinate
[in]	y	[in] Y coordinate
[in]	O	[in] 0-orientation

Definition at line 27 of file Pose.hpp.

Member Function Documentation

operator==()

bool cogip::cogip_defs::Pose::operator== ( const Pose  other ) const

inline

Check if this pose is equal to another.

Returns

true if poses are equal, false otherwise

Parameters

[in]

other

[in] pose to compare

Definition at line 54 of file Pose.hpp.

pb_copy()

void cogip::cogip_defs::Pose::pb_copy ( PB_Pose &  pose ) const

inline

Copy data to Protobuf message.

Parameters

[out]

pose

[out] Protobuf message to fill

Definition at line 59 of file Pose.hpp.

set_coords()

void cogip::cogip_defs::Pose::set_coords ( const Coords &  coords )

inline

Set coordinates.

Parameters

[in]

coords

[in] new coordinates

Definition at line 40 of file Pose.hpp.

Here is the call graph for this function:

set_O()

void cogip::cogip_defs::Pose::set_O ( double  O )

inline

Set 0-orientation.

Parameters

[in]

O

[in] new 0-orientation

Definition at line 48 of file Pose.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• lib/cogip_defs/include/cogip_defs/Pose.hpp