#include <Coordinate.h>

Inheritance diagram for gams::pose::DisplacementVector:

Public Types
using	Base = BasicVector< DisplacementVector, units::length >

using	derived_type = DisplacementVector

using	units_type = units::length

Public Member Functions
DisplacementVector	cross (const BasicVector< Other, units::length > &other) const
	Passthrough to Eigen vector cross method. More...

double	dot (const BasicVector< Other, units::length > &other) const
	Passthrough to Eigen vector dot method. 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...

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

DisplacementVector	normalized () const
	Passthrough to Eigen vector normalized method. 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...

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

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 = "Displacement" "Vector"

Private Types
using	mixin = typename unit_traits< units::length >::template mixin< DisplacementVector >

using	storage_mixin = typename unit_traits< units::length >::storage_mixin

using	traits = unit_traits< units::length >

Private Attributes
Eigen::Vector3d	vec_

Detailed Description

Definition at line 1221 of file Coordinate.h.

Member Typedef Documentation

◆ Base

using gams::pose::DisplacementVector::Base = BasicVector< DisplacementVector, units::length >

Definition at line 1221 of file Coordinate.h.

◆ derived_type

using gams::pose::BasicVector< DisplacementVector , units::length >::derived_type = DisplacementVector

inherited

Definition at line 542 of file Coordinate.h.

◆ mixin

using gams::pose::BasicVector< DisplacementVector , units::length >::mixin = typename unit_traits<units::length >::template mixin<DisplacementVector >

privateinherited

Definition at line 534 of file Coordinate.h.

◆ storage_mixin

using gams::pose::BasicVector< DisplacementVector , units::length >::storage_mixin = typename unit_traits<units::length >::storage_mixin

privateinherited

Definition at line 533 of file Coordinate.h.

◆ traits

using gams::pose::BasicVector< DisplacementVector , units::length >::traits = unit_traits<units::length >

privateinherited

Definition at line 532 of file Coordinate.h.

◆ units_type

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

inherited

Definition at line 543 of file Coordinate.h.

Member Function Documentation

◆ cross()

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

inlineinherited

Passthrough to Eigen vector cross method.

Definition at line 714 of file Coordinate.h.

◆ dot()

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

inlineinherited

Passthrough to Eigen vector dot method.

Definition at line 705 of file Coordinate.h.

◆ fixed()

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

inlinestaticconstexprinherited

Is this coordinate a fixed vector?

Definition at line 561 of file Coordinate.h.

◆ free()

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

inlinestaticconstexprinherited

Is this coordinate a free vector?

Definition at line 558 of file Coordinate.h.

◆ from_array()

void gams::pose::BasicVector< DisplacementVector , 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 637 of file Coordinate.h.

◆ from_container()

void gams::pose::BasicVector< DisplacementVector , units::length >::from_container ( const madara::knowledge::containers::NativeDoubleVector & container )

inlineinherited

Assign values from a NativeDoubleVector container.

Parameters

container the container

Definition at line 693 of file Coordinate.h.

◆ get()

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

inlineinherited

Get i'th value in this Coordinate.

No range checking!

Definition at line 569 of file Coordinate.h.

◆ is_set()

bool gams::pose::BasicVector< DisplacementVector , units::length >::is_set ( ) const

inlineinherited

Does this coordinate have any values not INVAL_COORD?

Definition at line 581 of file Coordinate.h.

◆ is_zero()

bool gams::pose::BasicVector< DisplacementVector , units::length >::is_zero ( ) const

inlineinherited

Does this coordinate have values all zeroes?

Definition at line 592 of file Coordinate.h.

◆ norm()

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

inlineinherited

Passthrough to Eigen vector norm method.

Definition at line 724 of file Coordinate.h.

◆ normalized()

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

inlineinherited

Passthrough to Eigen vector normalized method.

Definition at line 740 of file Coordinate.h.

◆ positional()

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

inlinestaticconstexprinherited

Is this coordinate a positional one?

Definition at line 552 of file Coordinate.h.

◆ rotational()

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

inlinestaticconstexprinherited

Is this coordinate a rotational one?

Definition at line 555 of file Coordinate.h.

◆ set()

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

inlineinherited

Set i'th value in this Coordinate.

No range checking!

Parameters

i	the index of the coordinate
v	the value to set to

Returns: the new value

Definition at line 578 of file Coordinate.h.

◆ size()

size_t gams::pose::BasicVector< DisplacementVector , units::length >::size ( void ) const

inlineinherited

Get number of values in this coordinate.

Definition at line 564 of file Coordinate.h.

◆ squaredNorm()

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

inlineinherited

Passthrough to Eigen vector squaredNorm method.

Definition at line 732 of file Coordinate.h.

◆ to_array()

void gams::pose::BasicVector< DisplacementVector , 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 616 of file Coordinate.h.

◆ to_container()

void gams::pose::BasicVector< DisplacementVector , units::length >::to_container ( madara::knowledge::containers::NativeDoubleVector & container ) const

inlineinherited

Assign values into a NativeDoubleVector container.

Parameters

container the container

Definition at line 681 of file Coordinate.h.

◆ to_string()

std::string gams::pose::BasicVector< DisplacementVector , units::length >::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 651 of file Coordinate.h.

Member Data Documentation

◆ type_name

constexpr const char* gams::pose::DisplacementVector::type_name = "Displacement" "Vector"

staticconstexpr

Definition at line 1221 of file Coordinate.h.

◆ vec_

Eigen::Vector3d gams::pose::BasicVector< DisplacementVector , units::length >::vec_

privateinherited

Definition at line 530 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

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Base

◆ derived_type

◆ mixin

◆ storage_mixin

◆ traits

◆ units_type

Member Function Documentation

◆ cross()

◆ dot()

◆ fixed()

◆ free()

◆ from_array()

◆ from_container()

◆ get()

◆ is_set()

◆ is_zero()

◆ norm()

◆ normalized()

◆ positional()

◆ rotational()

◆ set()

◆ size()

◆ squaredNorm()

◆ to_array()

◆ to_container()

◆ to_string()

Member Data Documentation

◆ type_name

◆ vec_