nc::coordinates::reference_frames::Dec Class Reference

Holds a Declination object. More...

#include <Celestial.hpp>

Public Types
enum class	Sign { NEGATIVE = 0 , POSITIVE }
	Struct Enum for positive or negative Dec angle. More...

Public Member Functions
	Dec ()=default
	Dec (double inDegrees)
	Dec (Sign inSign, uint8 inDegrees, uint8 inMinutes, double inSeconds) noexcept
double	degrees () const noexcept
uint8	degreesWhole () const noexcept
uint8	minutes () const noexcept
bool	operator!= (const Dec &inRhs) const noexcept
bool	operator== (const Dec &inRhs) const noexcept
void	print () const
double	radians () const noexcept
double	seconds () const noexcept
Sign	sign () const noexcept
std::string	str () const

Friends
std::ostream &	operator<< (std::ostream &inStream, const Dec &inDec)

Detailed Description

Holds a Declination object.

Member Enumeration Documentation

Sign

enum class nc::coordinates::reference_frames::Dec::Sign

strong

Struct Enum for positive or negative Dec angle.

Enumerator
NEGATIVE
POSITIVE

Constructor & Destructor Documentation

Dec() [1/3]

nc::coordinates::reference_frames::Dec::Dec ( )

default

Default Constructor

Dec() [2/3]

nc::coordinates::reference_frames::Dec::Dec ( double  inDegrees )

inlineexplicit

Constructor

Parameters

inDegrees

Dec() [3/3]

nc::coordinates::reference_frames::Dec::Dec ( Sign  inSign, uint8  inDegrees, uint8  inMinutes, double  inSeconds  )

inlinenoexcept

Constructor

Parameters

inSign
inDegrees
inMinutes
inSeconds

Member Function Documentation

degrees()

double nc::coordinates::reference_frames::Dec::degrees ( ) const

inlinenoexcept

Get the degrees value

Returns

degrees

degreesWhole()

uint8 nc::coordinates::reference_frames::Dec::degreesWhole ( ) const

inlinenoexcept

Get the whole degrees value

Returns

whole degrees

minutes()

uint8 nc::coordinates::reference_frames::Dec::minutes ( ) const

inlinenoexcept

Get the minute value

Returns

minutes

operator!=()

bool nc::coordinates::reference_frames::Dec::operator!= ( const Dec &  inRhs ) const

inlinenoexcept

Not equality operator

Parameters

inRhs

Returns

bool

operator==()

bool nc::coordinates::reference_frames::Dec::operator== ( const Dec &  inRhs ) const

inlinenoexcept

Equality operator

Parameters

inRhs

Returns

bool

print()

void nc::coordinates::reference_frames::Dec::print ( ) const

inline

Prints the Dec object to the console

radians()

double nc::coordinates::reference_frames::Dec::radians ( ) const

inlinenoexcept

Get the radians value

Returns

minutes

seconds()

double nc::coordinates::reference_frames::Dec::seconds ( ) const

inlinenoexcept

Get the seconds value

Returns

seconds

sign()

Sign nc::coordinates::reference_frames::Dec::sign ( ) const

inlinenoexcept

Get the sign of the degrees (positive or negative)

Returns

Sign

str()

std::string nc::coordinates::reference_frames::Dec::str ( ) const

inline

Return the dec object as a string representation

Returns

std::string

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  inStream, const Dec &  inDec  )

friend

Ostream operator

Parameters

inStream
inDec

Returns

std::ostream

---

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

• Celestial.hpp