FireSTARR
Loading...
Searching...
No Matches
fs::topo::StartPoint Class Reference

A Point that has sunrise and sunset times for each day. More...

#include <StartPoint.h>

Inheritance diagram for fs::topo::StartPoint:
Collaboration diagram for fs::topo::StartPoint:

Public Member Functions

 StartPoint (MathSize latitude, MathSize longitude) noexcept
 Constructor.
 
 StartPoint (const StartPoint &rhs) noexcept=default
 Copy constructor.
 
 StartPoint (StartPoint &&rhs) noexcept=default
 Move constructor.
 
StartPointoperator= (const StartPoint &rhs)=default
 Copy assignment.
 
StartPointoperator= (StartPoint &&rhs) noexcept
 Move assignment.
 
constexpr DurationSize dayStart (const size_t day) const
 Sunrise time.
 
constexpr DurationSize dayEnd (const size_t day) const
 Sunset time.
 
- Public Member Functions inherited from fs::topo::Point
constexpr Point (const MathSize latitude, const MathSize longitude) noexcept
 Constructor.
 
 Point (const Point &rhs) noexcept=default
 Copy constructor.
 
 Point (Point &&rhs) noexcept=default
 Move constructor.
 
Pointoperator= (const Point &rhs) noexcept=default
 Copy assignment.
 
Pointoperator= (Point &&rhs) noexcept=default
 Move assignment.
 
constexpr MathSize latitude () const noexcept
 Latitude (decimal degrees)
 
constexpr MathSize longitude () const noexcept
 Longitude (decimal degrees)
 

Private Attributes

array< tuple< DurationSize, DurationSize >, MAX_DAYS > days_
 Array of tuple for sunrise/sunset times by day.
 

Detailed Description

A Point that has sunrise and sunset times for each day.

Constructor & Destructor Documentation

◆ StartPoint() [1/3]

fs::topo::StartPoint::StartPoint ( MathSize latitude,
MathSize longitude )
noexcept

Constructor.

Parameters
latitudeLatitude (decimal degrees)
longitudeLongitude (decimal degrees)

◆ StartPoint() [2/3]

fs::topo::StartPoint::StartPoint ( const StartPoint & rhs)
defaultnoexcept

Copy constructor.

Parameters
rhsStartPoint to copy from

◆ StartPoint() [3/3]

fs::topo::StartPoint::StartPoint ( StartPoint && rhs)
defaultnoexcept

Move constructor.

Parameters
rhsStartPoint to move from

Member Function Documentation

◆ dayEnd()

DurationSize fs::topo::StartPoint::dayEnd ( const size_t day) const
inlinenodiscardconstexpr

Sunset time.

Parameters
dayDay
Returns
Sunset time on give day
Here is the caller graph for this function:

◆ dayStart()

DurationSize fs::topo::StartPoint::dayStart ( const size_t day) const
inlinenodiscardconstexpr

Sunrise time.

Parameters
dayDay
Returns
Sunrise time on give day
Here is the caller graph for this function:

◆ operator=() [1/2]

StartPoint & fs::topo::StartPoint::operator= ( const StartPoint & rhs)
default

Copy assignment.

Parameters
rhsStartPoint to copy from
Returns
This, after assignment

◆ operator=() [2/2]

StartPoint & fs::topo::StartPoint::operator= ( StartPoint && rhs)
noexcept

Move assignment.

Parameters
rhsStartPoint to move from
Returns
This, after assignment
Here is the call graph for this function:

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