#include <Coordinate.h>

Inheritance diagram for gams::pose::StampedAngularAccleration:

Public Types
using	Base = Stamped< Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration >>>

using	derived_type = typename Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > >::derived_type

using	units_type = units::angular_acceleration

Public Member Functions
	StampedAngularAccleration (AngularAcclerationVector o)

	StampedAngularAccleration (AngularAccleration o)

	StampedAngularAccleration ()=default

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...

StampedAngularAccleration	cross (const BasicVector< Other, units::angular_acceleration > &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	dot (const BasicVector< Other, units::angular_acceleration > &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_container (const madara::knowledge::containers::NativeDoubleVector &container)
	Assign values from a NativeDoubleVector container. More...

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

bool	is_set () const
	Does this coordinate have any values not INVAL_COORD? More...

bool	is_zero () const
	Does this coordinate have values all zeroes? 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...

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

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

	operator AngularAccleration () const

	operator AngularAcclerationVector () const

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...

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

size_t	size () const
	Get number of values in this coordinate. 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_container (madara::knowledge::containers::NativeDoubleVector &container) const
	Assign values into a NativeDoubleVector 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. 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	free ()
	Is this coordinate a free vector? More...

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

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

Static Public Attributes
static constexpr const char *	type_name = "Stamped" "AngularAccleration"

Detailed Description

Definition at line 1061 of file Coordinate.h.

Member Typedef Documentation

using gams::pose::StampedAngularAccleration::Base = Stamped<Framed<BasicVector<StampedAngularAccleration , units::angular_acceleration >>>

Definition at line 1061 of file Coordinate.h.

using gams::pose::Stamped< Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > > >::derived_type = typename Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > > ::derived_type

inherited

Definition at line 107 of file Stamped.h.

using gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::units_type = units::angular_acceleration

inherited

Definition at line 534 of file Coordinate.h.

Constructor & Destructor Documentation

gams::pose::StampedAngularAccleration::StampedAngularAccleration ( AngularAcclerationVector o )

inline

Definition at line 1061 of file Coordinate.h.

gams::pose::StampedAngularAccleration::StampedAngularAccleration ( AngularAccleration o )

inline

Definition at line 1061 of file Coordinate.h.

gams::pose::StampedAngularAccleration::StampedAngularAccleration ( )

default

Member Function Documentation

bool gams::pose::Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > >::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.

StampedAngularAccleration gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::cross ( const BasicVector< Other, units::angular_acceleration > & other ) const

inlineinherited

Passthrough to Eigen vector cross method.

Definition at line 704 of file Coordinate.h.

double gams::pose::Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > >::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::BasicVector< StampedAngularAccleration , units::angular_acceleration >::dot ( const BasicVector< Other, units::angular_acceleration > & other ) const

inlineinherited

Passthrough to Eigen vector dot method.

Definition at line 695 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::fixed ( )

inlinestaticinherited

Is this coordinate a fixed vector?

Definition at line 552 of file Coordinate.h.

const ReferenceFrame& gams::pose::Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > >::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< BasicVector< StampedAngularAccleration, units::angular_acceleration > >::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< StampedAngularAccleration , units::angular_acceleration >::free ( )

inlinestaticinherited

Is this coordinate a free vector?

Definition at line 549 of file Coordinate.h.

void gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::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< StampedAngularAccleration , units::angular_acceleration >::from_container ( const madara::knowledge::containers::NativeDoubleVector & container )

inlineinherited

Assign values from a NativeDoubleVector container.

Parameters

container the container

Definition at line 683 of file Coordinate.h.

double gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::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::BasicVector< StampedAngularAccleration , units::angular_acceleration >::is_set ( ) const

inlineinherited

Does this coordinate have any values not INVAL_COORD?

Definition at line 571 of file Coordinate.h.

bool gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::is_zero ( ) const

inlineinherited

Does this coordinate have values all zeroes?

Definition at line 582 of file Coordinate.h.

uint64_t gams::pose::Stamped< Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > > >::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< BasicVector< StampedAngularAccleration, units::angular_acceleration > > >::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< StampedAngularAccleration , units::angular_acceleration >::norm ( ) const

inlineinherited

Passthrough to Eigen vector norm method.

Definition at line 714 of file Coordinate.h.

void gams::pose::Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > >::normalize ( )

inherited

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

Typically useful for Coordinate types which incorporate angles.

Requres "ReferenceFrame.h"

StampedAngularAccleration gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::normalized ( ) const

inlineinherited

Passthrough to Eigen vector normalized method.

Definition at line 730 of file Coordinate.h.

gams::pose::StampedAngularAccleration::operator AngularAccleration ( ) const

inline

Definition at line 1061 of file Coordinate.h.

gams::pose::StampedAngularAccleration::operator AngularAcclerationVector ( ) const

inline

Definition at line 1061 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::positional ( )

inlinestaticinherited

Is this coordinate a positional one?

Definition at line 543 of file Coordinate.h.

static constexpr bool gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::rotational ( )

inlinestaticinherited

Is this coordinate a rotational one?

Definition at line 546 of file Coordinate.h.

double gams::pose::Stamped< Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > > >::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< BasicVector< StampedAngularAccleration, units::angular_acceleration > > >::secs ( double v )

inlineinherited

Set time as seconds since std::steady_clock epoch.

Definition at line 195 of file Stamped.h.

double gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::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.

size_t gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::size ( void ) const

inlineinherited

Get number of values in this coordinate.

Definition at line 555 of file Coordinate.h.

double gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::squaredNorm ( ) const

inlineinherited

Passthrough to Eigen vector squaredNorm method.

Definition at line 722 of file Coordinate.h.

TimeValue gams::pose::Stamped< Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > > >::time ( ) const

inlineinherited

Get time as std::chrono based TimeValue.

Definition at line 167 of file Stamped.h.

TimeValue gams::pose::Stamped< Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > > >::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< StampedAngularAccleration , units::angular_acceleration >::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< StampedAngularAccleration , units::angular_acceleration >::to_container ( madara::knowledge::containers::NativeDoubleVector & container ) const

inlineinherited

Assign values into a NativeDoubleVector container.

Parameters

container the container

Definition at line 671 of file Coordinate.h.

std::string gams::pose::BasicVector< StampedAngularAccleration , units::angular_acceleration >::to_string	(	const std::string &	delimiter = `","`,
		const std::string &	unset_identifier = `"<unset>"`
	)		const

inlineinherited

Returns a string of the values x, y, z.

Parameters

delimiter	delimiter between values
unset_identifier	value to print if unset

Returns: stringified version of the Linear

Definition at line 641 of file Coordinate.h.

void gams::pose::Framed< BasicVector< StampedAngularAccleration, units::angular_acceleration > >::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< BasicVector< StampedAngularAccleration, units::angular_acceleration > >::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::StampedAngularAccleration::type_name = "Stamped" "AngularAccleration"

static

Definition at line 1061 of file Coordinate.h.

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

src/gams/pose/Coordinate.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation