Detailed Description

A position in 3-dimensional geographical Cartesian space, i.e., in the Inertial-frame, consisting of three components x, y, and z.

#include <include/maliput/api/lane_data.h>

Public Member Functions
	InertialPosition ()
	Default constructor, initializing all components to zero. More...

	InertialPosition (double x, double y, double z)
	Fully parameterized constructor. More...

const math::Vector3 &	xyz () const
	Returns all components as 3-vector `[x, y, z]`. More...

void	set_xyz (const math::Vector3 &xyz)
	Sets all components from 3-vector `[x, y, z]`. More...

Static Public Member Functions
static InertialPosition	FromXyz (const math::Vector3 &xyz)
	Constructs a InertialPosition from a 3-vector `xyz` of the form `[x, y, z]`. More...

Getters and Setters
double	x () const
	Gets `x` value. More...

void	set_x (double x)
	Sets `x` value. More...

double	y () const
	Gets `y` value. More...

void	set_y (double y)
	Sets `y` value. More...

double	z () const
	Gets `z` value. More...

void	set_z (double z)
	Sets `z` value. More...

double	length () const
	Returns L^2 norm of 3-vector. More...

double	Distance (const InertialPosition &inertial_position) const
	Return the Cartesian distance to inertial_position. More...

bool	operator== (const InertialPosition &rhs) const
	Equality operator. More...

bool	operator!= (const InertialPosition &rhs) const
	Inequality operator. More...

InertialPosition	operator+ (const InertialPosition &rhs) const
	Plus operator. More...

InertialPosition	operator- (const InertialPosition &rhs) const
	Minus operator. More...

InertialPosition	operator* (double rhs) const
	Multiplication by scalar operator. More...

InertialPosition	operator* (double lhs, const InertialPosition &rhs)
	Multiplication by scalar operator. More...

Constructor & Destructor Documentation

◆ InertialPosition() [1/2]

InertialPosition ( )

Default constructor, initializing all components to zero.

◆ InertialPosition() [2/2]

InertialPosition	(	double	x,
		double	y,
		double	z
	)

Fully parameterized constructor.

Member Function Documentation

◆ Distance()

double Distance ( const InertialPosition & inertial_position ) const

Return the Cartesian distance to inertial_position.

◆ FromXyz()

static InertialPosition FromXyz ( const math::Vector3 & xyz )

static

Constructs a InertialPosition from a 3-vector xyz of the form [x, y, z].

◆ length()

double length ( ) const

Returns L^2 norm of 3-vector.

◆ operator!=()

bool operator!= ( const InertialPosition & rhs ) const

Inequality operator.

◆ operator*()

InertialPosition operator* ( double rhs ) const

Multiplication by scalar operator.

◆ operator+()

InertialPosition operator+ ( const InertialPosition & rhs ) const

Plus operator.

◆ operator-()

InertialPosition operator- ( const InertialPosition & rhs ) const

Minus operator.

◆ operator==()

bool operator== ( const InertialPosition & rhs ) const

Equality operator.

◆ set_x()

void set_x ( double x )

Sets x value.

◆ set_xyz()

void set_xyz ( const math::Vector3 & xyz )

Sets all components from 3-vector [x, y, z].

◆ set_y()

void set_y ( double y )

Sets y value.

◆ set_z()

void set_z ( double z )

Sets z value.

◆ x()

double x ( ) const

Gets x value.

◆ xyz()

const math::Vector3& xyz ( ) const

Returns all components as 3-vector [x, y, z].

◆ y()

double y ( ) const

Gets y value.

◆ z()

double z ( ) const

Gets z value.

Friends And Related Function Documentation

◆ operator*

InertialPosition operator*	(	double	lhs,
		const InertialPosition &	rhs
	)

friend