World Ocean Simulation System (WOSS) library
woss::CoordZ::CartCoords Class Reference

Class that represents cartesian coordinates. More...

#include <coordinates-definitions.h>

Collaboration diagram for woss::CoordZ::CartCoords:
Collaboration graph

Public Member Functions

 CartCoords ()
 
 CartCoords (double in_x, double in_y, double in_z, CoordZSpheroidType in_type)
 
double getX () const
 
double getY () const
 
double getZ () const
 
CoordZSpheroidType getType () const
 
friend::std::ostream & operator<< (::std::ostream &os, const CartCoords &instance)
 

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.
 

Detailed Description

Class that represents cartesian coordinates.

Class that represents cartesian coordinates

Constructor & Destructor Documentation

◆ CartCoords() [1/2]

CoordZ::CartCoords::CartCoords ( )

CartCoords default constructor.

◆ CartCoords() [2/2]

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

Coord constructor.

Parameters
in_xnumber of meters along the X axis
in_ynumber of meters along the X axis
in_znumber of meters along the X axis
in_typeSpheroid model that has been used

Member Function Documentation

◆ getType()

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

Returns the CoordZSpheroidType used for computation

Returns
CoordZSpheroidType spheroid model

References type.

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

◆ getX()

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

◆ getY()

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

◆ getZ()

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

◆ operator<<()

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

<< operator

Parameters
osleft operand ostream reference
instanceright operand const CartCoords reference
Returns
os reference after the operation

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