Position Struct Reference

Store 3D position. More...

#include <position.h>

Inheritance diagram for Position:

Public Member Functions
	Position ()
	Implicit constructor Instantiate position to (0,0,0)m. More...
	Position (double x, double y, double z)
	Explicit constructor. More...
double	norm () const
	Returns the norm of the vector. More...
bool	operator== (const Position &p) const
	Compare two positions. More...
bool	operator!= (const Position &p) const
	Compare two positions. More...
Position	operator+ (const Position &p) const
Position	operator- (const Position &p) const
Position	operator* (const double &m) const
	Multiply times a scalar. More...
Position	operator/ (const double &m) const
	Divide by a scalar. More...

Public Attributes
double	x
	x component in m More...
double	y
	y component in m More...
double	z
	z component in m More...

Detailed Description

Store 3D position.

Constructor & Destructor Documentation

Position::Position ( )

inline

Implicit constructor Instantiate position to (0,0,0)m.

Position::Position ( double  x, double  y, double  z  )

inline

Explicit constructor.

Parameters

x	x component in m
y	y component in m
z	z component in m

Member Function Documentation

double Position::norm ( ) const

inline

Returns the norm of the vector.

Returns

the norm

bool Position::operator!= ( const Position &  p ) const

inline

Compare two positions.

Parameters

p	Position to compare against

Returns

True if two positions are not same

Position Position::operator* ( const double &  m ) const

inline

Multiply times a scalar.

Parameters

m	Multiplier

Returns

Scaled position

Position Position::operator+ ( const Position &  p ) const

inline

@ brief Add two positions

Parameters

p	Position to add

Returns

Sum of this position and p

Position Position::operator- ( const Position &  p ) const

inline

@ brief Subtract two positions

Parameters

p	Position to subtract

Returns

Difference of this position and p

Position Position::operator/ ( const double &  m ) const

inline

Divide by a scalar.

Parameters

m

Divisor

Returns

Scaled position

bool Position::operator== ( const Position &  p ) const

inline

Compare two positions.

Parameters

p	Position to compare against

Returns

True if two positions are same

Member Data Documentation

double Position::x

x component in m

double Position::y

y component in m

double Position::z

z component in m

---

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

• include/aerial_autonomy/types/position.h