ignite::ignite_period Class Reference

A date-based amount of time. More...

#include <ignite_period.h>

Public Member Functions
constexpr	ignite_period () noexcept=default
constexpr	ignite_period (std::int32_t years, std::int32_t months, std::int32_t days)
constexpr std::int32_t	get_years () const noexcept
constexpr std::int32_t	get_months () const noexcept
constexpr std::int32_t	get_days () const noexcept
constexpr int	compare (const ignite_period &other) const noexcept

Detailed Description

A date-based amount of time.

This is modeled after java.time.Period.

Constructor & Destructor Documentation

ignite_period() [1/2]

ignite::ignite_period::ignite_period ( )

constexprdefaultnoexcept

Default constructor.

ignite_period() [2/2]

ignite::ignite_period::ignite_period ( std::int32_t years, std::int32_t months, std::int32_t days )

inlineconstexpr

Constructor.

Parameters

years	The number of years.
months	The number of months.
days	The number of days.

Member Function Documentation

compare()

int ignite::ignite_period::compare ( const ignite_period & other ) const

inlineconstexprnoexcept

compare to another value.

Parameters

other

Instance to compare to.

Returns

Zero if equals, negative number if less, and positive if greater.

get_days()

std::int32_t ignite::ignite_period::get_days ( ) const

inlineconstexprnoexcept

Gets the days field.

get_months()

std::int32_t ignite::ignite_period::get_months ( ) const

inlineconstexprnoexcept

Gets the months field.

get_years()

std::int32_t ignite::ignite_period::get_years ( ) const

inlineconstexprnoexcept

Gets the years field.

---

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

• ignite/common/ignite_period.h