woss::CoordZ::CartCoords Class Reference

Class that represents cartesian coordinates. More...

#include <coordinates-definitions.h>

Collaboration diagram for woss::CoordZ::CartCoords:

Public Member Functions
constexpr	CartCoords ()
constexpr	CartCoords (double in_x, double in_y, double in_z, CoordZSpheroidType in_type)
constexpr double	getX () const
constexpr double	getY () const
constexpr double	getZ () const
constexpr CoordZSpheroidType	getType () const

Protected Attributes
double	x
double	y
	X-asis value in meters.
double	z
	Y-asis value in meters.
CoordZSpheroidType	type
	Z-asis value in meters.

Friends
std::ostream &	operator<< (std::ostream &os, const CartCoords &instance)

Detailed Description

Class that represents cartesian coordinates.

Class that represents cartesian coordinates

Constructor & Destructor Documentation

CartCoords() [1/2]

constexpr woss::CoordZ::CartCoords::CartCoords ( )

inlineconstexpr

CartCoords default constructor.

CartCoords() [2/2]

constexpr woss::CoordZ::CartCoords::CartCoords ( double  in_x, double  in_y, double  in_z, CoordZSpheroidType  in_type  )

inlineconstexpr

Coord constructor.

Parameters

in_x	number of meters along the X axis
in_y	number of meters along the X axis
in_z	number of meters along the X axis
in_type	Spheroid model that has been used

Member Function Documentation

getType()

constexpr CoordZSpheroidType woss::CoordZ::CartCoords::getType ( ) const

inlineconstexpr

Returns the CoordZSpheroidType used for computation

Returns

CoordZSpheroidType spheroid model

References type.

Referenced by woss::CoordZ::getCoordZFromCartesianCoords().

getX()

constexpr double woss::CoordZ::CartCoords::getX ( ) const

inlineconstexpr

Returns the number of meters along the X axis

Returns

x axis value [m]

References x.

Referenced by woss::CoordZ::getCartDistance(), woss::CoordZ::getCartRelAzimuth(), woss::CoordZ::getCartX(), woss::CoordZ::getCoordZAlongCartLine(), and woss::CoordZ::getCoordZFromCartesianCoords().

getY()

constexpr double woss::CoordZ::CartCoords::getY ( ) const

inlineconstexpr

Returns the number of meters along the Y axis

Returns

y axis value [m]

References y.

Referenced by woss::CoordZ::getCartDistance(), woss::CoordZ::getCartRelAzimuth(), woss::CoordZ::getCartY(), woss::CoordZ::getCoordZAlongCartLine(), and woss::CoordZ::getCoordZFromCartesianCoords().

getZ()

constexpr double woss::CoordZ::CartCoords::getZ ( ) const

inlineconstexpr

Returns the number of meters along the z axis

Returns

Z axis value [m]

References z.

Referenced by woss::CoordZ::getCartDistance(), woss::CoordZ::getCartRelZenith(), woss::CoordZ::getCartZ(), woss::CoordZ::getCoordZAlongCartLine(), and woss::CoordZ::getCoordZFromCartesianCoords().

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const CartCoords &  instance  )

friend

<< operator

Parameters

os	left operand ostream reference
instance	right operand const CartCoords reference

Returns

os reference after the operation

Member Data Documentation

type

CoordZSpheroidType woss::CoordZ::CartCoords::type

protected

Z-asis value in meters.

Referenced by getType().

x

double woss::CoordZ::CartCoords::x

protected

Referenced by getX().

y

double woss::CoordZ::CartCoords::y

protected

X-asis value in meters.

Referenced by getY().

z

double woss::CoordZ::CartCoords::z

protected

Y-asis value in meters.

Referenced by getZ().

---

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

• woss/woss_def/coordinates-definitions.h