nc::coordinates::reference_frames::RA Class Reference

Holds a right ascension object. More...

#include <Celestial.hpp>

Public Member Functions
	RA ()=default
	RA (double inDegrees)
	RA (uint8 inHours, uint8 inMinutes, double inSeconds) noexcept
double	degrees () const noexcept
uint8	hours () const noexcept
uint8	minutes () const noexcept
bool	operator!= (const RA &inRhs) const noexcept
bool	operator== (const RA &inRhs) const noexcept
void	print () const
double	radians () const noexcept
double	seconds () const noexcept
std::string	str () const

Friends
std::ostream &	operator<< (std::ostream &inStream, const RA &inRa)

Detailed Description

Holds a right ascension object.

Constructor & Destructor Documentation

RA() [1/3]

nc::coordinates::reference_frames::RA::RA ( )

default

Default Constructor

RA() [2/3]

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

inlineexplicit

Constructor

Parameters

inDegrees

RA() [3/3]

nc::coordinates::reference_frames::RA::RA ( uint8  inHours, uint8  inMinutes, double  inSeconds  )

inlinenoexcept

Constructor

Parameters

inHours
inMinutes
inSeconds

Member Function Documentation

degrees()

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

inlinenoexcept

Get the degrees value

Returns

degrees

hours()

uint8 nc::coordinates::reference_frames::RA::hours ( ) const

inlinenoexcept

Get the hour value

Returns

hours

minutes()

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

inlinenoexcept

Get the minute value

Returns

minutes

operator!=()

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

inlinenoexcept

Not equality operator

Parameters

inRhs

Returns

bool

operator==()

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

inlinenoexcept

Equality operator

Parameters

inRhs

Returns

bool

print()

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

inline

Prints the RA object to the console

radians()

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

inlinenoexcept

Get the radians value

Returns

radians

seconds()

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

inlinenoexcept

Get the seconds value

Returns

seconds

str()

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

inline

Return the RA object as a string representation

Returns

std::string

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  inStream, const RA &  inRa  )

friend

Ostream operator

Parameters

inStream
inRa

---

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

• Celestial.hpp