CelestialCalendar 1.0.0 · unreleased development @ 67a7c4c79a4a4a6aa7e703c9e6f0039ae34bee82
Loading...
Searching...
No Matches
astro::planet Namespace Reference

Namespaces

namespace  detail
namespace  geocentric_coord
namespace  observation
namespace  phenomena

Enumerations

enum class  Planet : uint8_t {
  MERCURY , VENUS , MARS , JUPITER ,
  SATURN , URANUS , NEPTUNE , PLUTO
}
 A planetary target whose geocentric position can be calculated. More...

Functions

auto name (const Planet planet) -> std::string_view
 Return the canonical English name of a planetary target.

Enumeration Type Documentation

◆ Planet

enum class astro::planet::Planet : uint8_t
strong

A planetary target whose geocentric position can be calculated.

Enumerator
MERCURY 
VENUS 
MARS 
JUPITER 
SATURN 
URANUS 
NEPTUNE 
PLUTO 

Function Documentation

◆ name()

auto astro::planet::name ( const Planet planet) ->std::string_view
inlinenodiscard

Return the canonical English name of a planetary target.

Parameters
planetA named planetary enumerator.
Returns
The target name.
Exceptions
std::invalid_argumentIf the target is unknown.