#include <Pose.h>

Inheritance diagram for gams::pose::StampedPose:

Public Types
typedef BasicPose	BaseType

using	derived_type = typename Framed< BasicPose< StampedPose > >::derived_type

using	units_type = units::absolute< units::length >

using	units_type = units::absolute< units::plane_angle >

Public Member Functions
bool	approximately_equal (const Framed< Base2 > &other, double epsilon) const
	Tests if this Coordinate is within epsilon in distance (as defined by this Coordinate's reference frame's distance metric). More...

bool	approximately_equal (const BasicPose< Derived2 > &other, double epsilon) const
	Tests if this Coordinate is within epsilon in distance (as defined by this Coordinate's reference frame's distance metric). More...

PositionVector &	as_location_vec ()

const PositionVector &	as_location_vec () const

OrientationVector &	as_orientation_vec ()
	Gets a reference to this object's Orientation part. More...

const OrientationVector &	as_orientation_vec () const
	Gets a const reference to this object's Orientation part. More...

PositionVector &	as_position_vec ()
	Gets a reference to this object's Position part. More...

const PositionVector &	as_position_vec () const
	Gets a const reference to this object's Position part. More...

BaseType &	as_vec ()
	Gets a reference to this object. More...

const BaseType &	as_vec () const
	Gets a const reference to this object. More...

PositionVector	cross (const BasicVector< Other, units::absolute< units::length > > &other) const
	Passthrough to Eigen vector cross method. More...

OrientationVector	cross (const BasicVector< Other, units::absolute< units::plane_angle > > &other) const
	Passthrough to Eigen vector cross method. More...

double	distance_to (const derived_type &target) const
	Calculate distance from this Coordinate to a target. More...

double	distance_to (const BasicPose< Derived2 > &target) const

double	dot (const BasicVector< Other, units::absolute< units::plane_angle > > &other) const
	Passthrough to Eigen vector dot method. More...

double	dot (const BasicVector< Other, units::absolute< units::length > > &other) const
	Passthrough to Eigen vector dot method. More...

const ReferenceFrame &	frame () const
	Getter for the ReferenceFrame this Coordinate belongs to. More...

ReferenceFrame	frame (ReferenceFrame new_frame)
	Setter for the ReferenceFrame this Coordinate belongs to. More...

void	from_array (const ContainType &in)
	Overwrites this Coordinate's values with those pulled from the referenced array. More...

void	from_array (const ContainType &in)
	Overwrites this Coordinate's values with those pulled from the referenced array. More...

void	from_container (const madara::knowledge::containers::NativeDoubleVector &container)
	Imports the pose from a MADARA container. More...

void	from_container (const std::vector< double > &container)
	Imports the pose from a STL vector container. More...

double	get (int i) const
	Retrives i'th coordinate, 0-indexed, in order x, y, z, rx, ry, rz. More...

double	get (size_t i) const
	Get i'th value in this Coordinate. More...

double	get (size_t i) const
	Get i'th value in this Coordinate. More...

bool	is_location_set () const

bool	is_location_zero () const

bool	is_orientation_set () const
	Tests if the orientation/orientation has been set. More...

bool	is_orientation_zero () const
	Tests if all orientation information is zero. More...

bool	is_position_set () const
	Tests if the position is set (valid). More...

bool	is_position_zero () const
	Tests if all position information is zero. More...

bool	is_set () const
	Tests if this Pose is invalid; i.e., any values are INVAL_COORD. More...

bool	is_zero () const
	Tests if all pose information is zero. More...

uint64_t	nanos () const
	Get time as nanos since std::steady_clock epoch. More...

uint64_t	nanos (uint64_t v)
	Set time as nanos since std::steady_clock epoch. More...

double	norm () const
	Passthrough to Eigen vector norm method. More...

double	norm () const
	Passthrough to Eigen vector norm method. More...

void	normalize ()
	Reduces this Coordinate to it's normalized form, should one exist. More...

OrientationVector	normalized () const
	Passthrough to Eigen vector normalized method. More...

PositionVector	normalized () const
	Passthrough to Eigen vector normalized method. More...

	operator BasicVector< Derived2, units::absolute< units::length >> () const

	operator BasicVector< Derived2, units::absolute< units::plane_angle >> () const

bool	operator== (const BasicPose &rhs) const
	Tests for exact equality. More...

double	secs () const
	Get time as seconds since std::steady_clock epoch. More...

double	secs (double v)
	Set time as seconds since std::steady_clock epoch. More...

StampedPose &	self ()

const StampedPose &	self () const

double	set (int i, double val)
	Sets i'th coordinate, 0-indexed, in order x, y, z, rx, ry, rz. More...

double	set (size_t i, double v)
	Set i'th value in this Coordinate. More...

double	set (size_t i, double v)
	Set i'th value in this Coordinate. More...

int	size () const
	Get the number of values this coordinate type uses. More...

double	squaredNorm () const
	Passthrough to Eigen vector squaredNorm method. More...

double	squaredNorm () const
	Passthrough to Eigen vector squaredNorm method. More...

TimeValue	time () const
	Get time as std::chrono based TimeValue. More...

TimeValue	time (TimeValue v)
	Set time from std::chrono based TimeValue. More...

void	to_array (ContainType &out) const
	Outputs this Coordinates values to the referenced container. More...

void	to_array (ContainType &out) const
	Outputs this Coordinates values to the referenced container. More...

void	to_container (madara::knowledge::containers::NativeDoubleVector &container) const
	Saves the pose to a MADARA container. More...

std::string	to_string (const std::string &delimiter=", ", const std::string &unset_identifier="<unset>") const
	Returns a string of the values x, y, z, rx, ry, rz. More...

void	transform_this_to (const ReferenceFrame &new_frame)
	Transform this coordinate, in place, to a new reference frame. More...

derived_type WARN_UNUSED	transform_to (const ReferenceFrame &new_frame) const
	Copy and transform this coordinate to a new reference frame. More...

Static Public Member Functions
static constexpr bool	fixed ()
	Is this coordinate a fixed vector? More...

static constexpr bool	fixed ()
	Is this coordinate a fixed vector? More...

static constexpr bool	free ()
	Is this coordinate a free vector? More...

static constexpr bool	free ()
	Is this coordinate a free vector? More...

static std::string	name ()
	Get the name of this coordinate type. More...

static constexpr bool	positional ()
	Is this coordinate a positional one? More...

static constexpr bool	positional ()
	Is this coordinate a positional one? More...

static constexpr bool	rotational ()
	Is this coordinate a rotational one? More...

static constexpr bool	rotational ()
	Is this coordinate a rotational one? More...

Private Types
using	Base = Stamped< Framed< BasicPose< StampedPose >>>

Private Member Functions
	StampedPose ()=default

	StampedPose (const Position &pos)

	StampedPose (const StampedPosition &pos)

	StampedPose (const Orientation &ori)

	StampedPose (const StampedOrientation &ori)

	StampedPose (const Position &pos, const Orientation &ori)

	StampedPose (const StampedPosition &pos, const StampedOrientation &ori)

	operator StampedOrientation () const
	Castig operator to extract StampedOrientation from this Pose. More...

	operator StampedPosition () const
	Casting operator to extract StampedPosition from this Pose. More...

Static Private Attributes
static constexpr const char *	type_name = "StampedPose"

Detailed Description

Definition at line 467 of file Pose.h.

Member Typedef Documentation

using gams::pose::StampedPose::Base = Stamped<Framed<BasicPose<StampedPose>>>

private

Definition at line 470 of file Pose.h.

typedef BasicPose gams::pose::BasicPose< StampedPose >::BaseType

inherited

Definition at line 276 of file Pose.h.

using gams::pose::Stamped< Framed< BasicPose< StampedPose > > >::derived_type = typename Framed< BasicPose< StampedPose > > ::derived_type

inherited

Definition at line 107 of file Stamped.h.

using gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::units_type = units::absolute< units::plane_angle >

inherited

Definition at line 534 of file Coordinate.h.

using gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::units_type = units::absolute< units::length >

inherited

Definition at line 534 of file Coordinate.h.

Constructor & Destructor Documentation

gams::pose::StampedPose::StampedPose ( )

privatedefault

gams::pose::StampedPose::StampedPose ( const Position & pos )

inlineprivate

Definition at line 477 of file Pose.h.

gams::pose::StampedPose::StampedPose ( const StampedPosition & pos )

inlineprivate

Definition at line 480 of file Pose.h.

gams::pose::StampedPose::StampedPose ( const Orientation & ori )

inlineprivate

Definition at line 483 of file Pose.h.

gams::pose::StampedPose::StampedPose ( const StampedOrientation & ori )

inlineprivate

Definition at line 486 of file Pose.h.

gams::pose::StampedPose::StampedPose	(	const Position &	pos,
		const Orientation &	ori
	)

inlineprivate

Definition at line 489 of file Pose.h.

gams::pose::StampedPose::StampedPose	(	const StampedPosition &	pos,
		const StampedOrientation &	ori
	)

inlineprivate

Definition at line 492 of file Pose.h.

Member Function Documentation

bool gams::pose::Framed< BasicPose< StampedPose > >::approximately_equal	(	const Framed< Base2 > &	other,
		double	epsilon
	)		const

inlineinherited

Tests if this Coordinate is within epsilon in distance (as defined by this Coordinate's reference frame's distance metric).

If the other Coordinate is in a different reference frame, it is first copied, and converted to this Coordinate's reference frame.

Parameters

other	the other Coordinate to test against
epsilon	the maximum distance permitted to return true

Returns: true if the distance is less than or equal to epsilon

Definition at line 208 of file Framed.h.

bool gams::pose::BasicPose< StampedPose >::approximately_equal	(	const BasicPose< Derived2 > &	other,
		double	epsilon
	)		const

inlineinherited

Tests if this Coordinate is within epsilon in distance (as defined by this Coordinate's reference frame's distance metric).

If the other Coordinate is in a different reference frame, it is first copied, and converted to this Coordinate's reference frame.

Parameters

other	the other Coordinate to test against
epsilon	the maximum distance permitted to return true

Returns: true if the distance is less than or equal to epsilon

Definition at line 333 of file Pose.h.

PositionVector& gams::pose::BasicPose< StampedPose >::as_location_vec ( )

inherited

const PositionVector& gams::pose::BasicPose< StampedPose >::as_location_vec ( ) const

inherited

OrientationVector& gams::pose::BasicPose< StampedPose >::as_orientation_vec ( )

inherited

Gets a reference to this object's Orientation part.

Returns: reference to the OrientationVector

const OrientationVector& gams::pose::BasicPose< StampedPose >::as_orientation_vec ( ) const

inherited

Gets a const reference to this object's Orientation part.

Returns: const reference to the OrientationVector

PositionVector& gams::pose::BasicPose< StampedPose >::as_position_vec ( )

inherited

Gets a reference to this object's Position part.

Returns: reference to the PositionVector

const PositionVector& gams::pose::BasicPose< StampedPose >::as_position_vec ( ) const

inherited

Gets a const reference to this object's Position part.

Returns: const reference to the PositionVector

BaseType& gams::pose::BasicPose< StampedPose >::as_vec ( )

inherited

Gets a reference to this object.

Useful for derived types.

Returns: reference to this object.

const BaseType& gams::pose::BasicPose< StampedPose >::as_vec ( ) const

inherited

Gets a const reference to this object.

Useful for derived types.

Returns: const reference to this object.

PositionVector gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::cross ( const BasicVector< Other, units::absolute< units::length > > & other ) const

inlineinherited

Passthrough to Eigen vector cross method.

Definition at line 704 of file Coordinate.h.

OrientationVector gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::cross ( const BasicVector< Other, units::absolute< units::plane_angle > > & other ) const

inlineinherited

Passthrough to Eigen vector cross method.

Definition at line 704 of file Coordinate.h.

double gams::pose::Framed< BasicPose< StampedPose > >::distance_to ( const derived_type & target ) const

inherited

Calculate distance from this Coordinate to a target.

If the target is in another reference frame, this and the target will be copied, and converted to their closest common frame.

Requres "ReferenceFrame.h"

Parameters

target the target Coordinate to calculate distance to

Returns: the distance according to the distance metric in the common frame, for CoordType. Typically, return will be meters or degrees.

Exceptions

unrelated_frames	thrown if the target's reference frame is not part of the same tree as the current one.
undefined_transform	thrown if no conversion between two frames along the conversion path has been defined.

double gams::pose::BasicPose< StampedPose >::distance_to ( const BasicPose< Derived2 > & target ) const

inlineinherited

Definition at line 343 of file Pose.h.

double gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::dot ( const BasicVector< Other, units::absolute< units::plane_angle > > & other ) const

inlineinherited

Passthrough to Eigen vector dot method.

Definition at line 695 of file Coordinate.h.

double gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::dot ( const BasicVector< Other, units::absolute< units::length > > & other ) const

inlineinherited

Passthrough to Eigen vector dot method.

Definition at line 695 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::fixed ( )

inlinestaticinherited

Is this coordinate a fixed vector?

Definition at line 552 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::fixed ( )

inlinestaticinherited

Is this coordinate a fixed vector?

Definition at line 552 of file Coordinate.h.

const ReferenceFrame& gams::pose::Framed< BasicPose< StampedPose > >::frame ( ) const

inlineinherited

Getter for the ReferenceFrame this Coordinate belongs to.

Returns: the frame

Definition at line 179 of file Framed.h.

ReferenceFrame gams::pose::Framed< BasicPose< StampedPose > >::frame ( ReferenceFrame new_frame )

inlineinherited

Setter for the ReferenceFrame this Coordinate belongs to.

Any further calculations using this Coordinate will use this frame.

Not thread-safe.

Parameters

new_frame the frame the Coordinate will now belong to

Returns: the old frame

Definition at line 190 of file Framed.h.

static constexpr bool gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::free ( )

inlinestaticinherited

Is this coordinate a free vector?

Definition at line 549 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::free ( )

inlinestaticinherited

Is this coordinate a free vector?

Definition at line 549 of file Coordinate.h.

void gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::from_array ( const ContainType & in )

inlineinherited

Overwrites this Coordinate's values with those pulled from the referenced array.

These values will be within this object's current reference frame. The container must support operator[],

If the array's size is smaller than the cardinality of this coordinate type, the behavior is undefined. If it is larger, the extra elements are ignored.

Template Parameters

ContainType the type of the container; must support operator[]

Parameters

in	the container to pull new values from.

Definition at line 627 of file Coordinate.h.

void gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::from_array ( const ContainType & in )

inlineinherited

Overwrites this Coordinate's values with those pulled from the referenced array.

These values will be within this object's current reference frame. The container must support operator[],

If the array's size is smaller than the cardinality of this coordinate type, the behavior is undefined. If it is larger, the extra elements are ignored.

Template Parameters

ContainType the type of the container; must support operator[]

Parameters

in	the container to pull new values from.

Definition at line 627 of file Coordinate.h.

void gams::pose::BasicPose< StampedPose >::from_container ( const madara::knowledge::containers::NativeDoubleVector & container )

inherited

Imports the pose from a MADARA container.

Parameters

container the container to import from

void gams::pose::BasicPose< StampedPose >::from_container ( const std::vector< double > & container )

inherited

Imports the pose from a STL vector container.

Parameters

container the container to import from

double gams::pose::BasicPose< StampedPose >::get ( int i ) const

inherited

Retrives i'th coordinate, 0-indexed, in order x, y, z, rx, ry, rz.

Parameters

i the index

Returns: the i'th coordinate value

Exceptions

std::range_error if index is less than 0, or greater than 6

double gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::get ( size_t i ) const

inlineinherited

Get i'th value in this Coordinate.

No range checking!

Definition at line 560 of file Coordinate.h.

double gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::get ( size_t i ) const

inlineinherited

Get i'th value in this Coordinate.

No range checking!

Definition at line 560 of file Coordinate.h.

bool gams::pose::BasicPose< StampedPose >::is_location_set ( ) const

inherited

bool gams::pose::BasicPose< StampedPose >::is_location_zero ( ) const

inherited

bool gams::pose::BasicPose< StampedPose >::is_orientation_set ( ) const

inherited

Tests if the orientation/orientation has been set.

Returns: true if orientation has been set to something valid

bool gams::pose::BasicPose< StampedPose >::is_orientation_zero ( ) const

inherited

Tests if all orientation information is zero.

Returns: true if all orientation information is zero

bool gams::pose::BasicPose< StampedPose >::is_position_set ( ) const

inherited

Tests if the position is set (valid).

Returns: true if position has been set to something valid

bool gams::pose::BasicPose< StampedPose >::is_position_zero ( ) const

inherited

Tests if all position information is zero.

Returns: true if all position information is zero

bool gams::pose::BasicPose< StampedPose >::is_set ( ) const

inherited

Tests if this Pose is invalid; i.e., any values are INVAL_COORD.

Returns: true if at least one value is INVAL_COORD

bool gams::pose::BasicPose< StampedPose >::is_zero ( ) const

inherited

Tests if all pose information is zero.

If true, is_position_zero and is_orientation_zero are also true

Returns: true if all pose information is zero

static std::string gams::pose::BasicPose< StampedPose >::name ( )

staticinherited

Get the name of this coordinate type.

Returns: "Pose"

uint64_t gams::pose::Stamped< Framed< BasicPose< StampedPose > > >::nanos ( ) const

inlineinherited

Get time as nanos since std::steady_clock epoch.

Definition at line 174 of file Stamped.h.

uint64_t gams::pose::Stamped< Framed< BasicPose< StampedPose > > >::nanos ( uint64_t v )

inlineinherited

Set time as nanos since std::steady_clock epoch.

Definition at line 181 of file Stamped.h.

double gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::norm ( ) const

inlineinherited

Passthrough to Eigen vector norm method.

Definition at line 714 of file Coordinate.h.

double gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::norm ( ) const

inlineinherited

Passthrough to Eigen vector norm method.

Definition at line 714 of file Coordinate.h.

void gams::pose::Framed< BasicPose< StampedPose > >::normalize ( )

inherited

Reduces this Coordinate to it's normalized form, should one exist.

Typically useful for Coordinate types which incorporate angles.

Requres "ReferenceFrame.h"

OrientationVector gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::normalized ( ) const

inlineinherited

Passthrough to Eigen vector normalized method.

Definition at line 730 of file Coordinate.h.

PositionVector gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::normalized ( ) const

inlineinherited

Passthrough to Eigen vector normalized method.

Definition at line 730 of file Coordinate.h.

gams::pose::BasicPose< StampedPose >::operator BasicVector< Derived2, units::absolute< units::length >> ( ) const

inlineinherited

Definition at line 145 of file Pose.h.

gams::pose::BasicPose< StampedPose >::operator BasicVector< Derived2, units::absolute< units::plane_angle >> ( ) const

inlineinherited

Definition at line 151 of file Pose.h.

gams::pose::StampedPose::operator StampedOrientation ( ) const

inlineprivate

Castig operator to extract StampedOrientation from this Pose.

Returns: StampedOrientation with same frame and timestamp as this pose, and same rx/ry/rz values

Definition at line 514 of file Pose.h.

gams::pose::StampedPose::operator StampedPosition ( ) const

inlineprivate

Casting operator to extract StampedPosition from this Pose.

Returns: Position with same frame as this pose, and same x/y/z values; StampedPosition with same frame and timestamp as this pose, and same x/y/z values

Definition at line 503 of file Pose.h.

bool gams::pose::BasicPose< StampedPose >::operator== ( const BasicPose< StampedPose > & rhs ) const

inherited

Tests for exact equality.

Parameters

rhs	the other pose to test against

Returns: true if all values equal corresponding values in other pose

static constexpr bool gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::positional ( )

inlinestaticinherited

Is this coordinate a positional one?

Definition at line 543 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::positional ( )

inlinestaticinherited

Is this coordinate a positional one?

Definition at line 543 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::rotational ( )

inlinestaticinherited

Is this coordinate a rotational one?

Definition at line 546 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::rotational ( )

inlinestaticinherited

Is this coordinate a rotational one?

Definition at line 546 of file Coordinate.h.

double gams::pose::Stamped< Framed< BasicPose< StampedPose > > >::secs ( ) const

inlineinherited

Get time as seconds since std::steady_clock epoch.

Definition at line 188 of file Stamped.h.

double gams::pose::Stamped< Framed< BasicPose< StampedPose > > >::secs ( double v )

inlineinherited

Set time as seconds since std::steady_clock epoch.

Definition at line 195 of file Stamped.h.

StampedPose & gams::pose::BasicPose< StampedPose >::self ( )

inlineinherited

Definition at line 141 of file Pose.h.

const StampedPose & gams::pose::BasicPose< StampedPose >::self ( ) const

inlineinherited

Definition at line 142 of file Pose.h.

double gams::pose::BasicPose< StampedPose >::set	(	int	i,
		double	val
	)

inherited

Sets i'th coordinate, 0-indexed, in order x, y, z, rx, ry, rz.

Parameters

i	the index
val	the new value

Returns: the new i'th coordinate value

Exceptions

std::range_error if index is less than 0, or greater than 6

double gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::set	(	size_t	i,
		double	v
	)

inlineinherited

Set i'th value in this Coordinate.

No range checking!

Parameters

v	the value to set to

Returns: the new value

Definition at line 568 of file Coordinate.h.

double gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::set	(	size_t	i,
		double	v
	)

inlineinherited

Set i'th value in this Coordinate.

No range checking!

Parameters

v	the value to set to

Returns: the new value

Definition at line 568 of file Coordinate.h.

int gams::pose::BasicPose< StampedPose >::size ( void ) const

inherited

Get the number of values this coordinate type uses.

Returns: 6

double gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::squaredNorm ( ) const

inlineinherited

Passthrough to Eigen vector squaredNorm method.

Definition at line 722 of file Coordinate.h.

double gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::squaredNorm ( ) const

inlineinherited

Passthrough to Eigen vector squaredNorm method.

Definition at line 722 of file Coordinate.h.

TimeValue gams::pose::Stamped< Framed< BasicPose< StampedPose > > >::time ( ) const

inlineinherited

Get time as std::chrono based TimeValue.

Definition at line 167 of file Stamped.h.

TimeValue gams::pose::Stamped< Framed< BasicPose< StampedPose > > >::time ( TimeValue v )

inlineinherited

Set time from std::chrono based TimeValue.

Returns: the new time

Definition at line 171 of file Stamped.h.

void gams::pose::BasicVector< OrientationVector , units::absolute< units::plane_angle > >::to_array ( ContainType & out ) const

inlineinherited

Outputs this Coordinates values to the referenced container.

This container type must support operator[] for setting by index.

If the array's size is smaller than the cardinality of this coordinate type, the behavior is undefined. If it is larger, the extra elements are not changed.

The MADARA DoubleVector and NativeDoubleVector types are supported.

Template Parameters

ContainType the type of the container; must support "set"

Parameters

out	the container to put this Coordinate's values into.

Definition at line 606 of file Coordinate.h.

void gams::pose::BasicVector< PositionVector , units::absolute< units::length > >::to_array ( ContainType & out ) const

inlineinherited

Outputs this Coordinates values to the referenced container.

This container type must support operator[] for setting by index.

If the array's size is smaller than the cardinality of this coordinate type, the behavior is undefined. If it is larger, the extra elements are not changed.

The MADARA DoubleVector and NativeDoubleVector types are supported.

Template Parameters

ContainType the type of the container; must support "set"

Parameters

out	the container to put this Coordinate's values into.

Definition at line 606 of file Coordinate.h.

void gams::pose::BasicPose< StampedPose >::to_container ( madara::knowledge::containers::NativeDoubleVector & container ) const

inherited

Saves the pose to a MADARA container.

Parameters

container the container to save to

std::string gams::pose::BasicPose< StampedPose >::to_string	(	const std::string &	delimiter = `", "`,
		const std::string &	unset_identifier = `"<unset>"`
	)		const

inherited

Returns a string of the values x, y, z, rx, ry, rz.

Parameters

delimiter	delimiter between values
unset_identifier	if true, include unset values

Returns: stringified version of the Pose

void gams::pose::Framed< BasicPose< StampedPose > >::transform_this_to ( const ReferenceFrame & new_frame )

inherited

Transform this coordinate, in place, to a new reference frame.

Requres "ReferenceFrame.h"

Parameters

new_frame the frame to transform to

Exceptions

unrelated_frames	thrown if the new reference frame is not part of the same tree as the current one.
undefined_transform	thrown if no conversion between two frames along the conversion path has been defined.

derived_type WARN_UNUSED gams::pose::Framed< BasicPose< StampedPose > >::transform_to ( const ReferenceFrame & new_frame ) const

inherited

Copy and transform this coordinate to a new reference frame.

Requres "ReferenceFrame.h"

Parameters

new_frame the frame to transform to

Returns: the new coordinate in the new frame

Exceptions

unrelated_frames	thrown if the new reference frame is not part of the same tree as the current one.
undefined_transform	thrown if no conversion between two frames along the conversion path has been defined.

Member Data Documentation

constexpr const char* gams::pose::StampedPose::type_name = "StampedPose"

staticprivate

Definition at line 473 of file Pose.h.

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

src/gams/pose/Pose.h

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation