ignite::ignite_date Class Reference

A date. More...

#include <ignite_date.h>

Inheritance diagram for ignite::ignite_date:

Public Member Functions
constexpr	ignite_date () noexcept=default
constexpr	ignite_date (std::int32_t year, std::int32_t month, std::int32_t day_of_month)
constexpr std::int32_t	get_year () const noexcept
constexpr std::int_fast8_t	get_month () const noexcept
constexpr std::int_fast8_t	get_day_of_month () const noexcept
constexpr int	compare (const ignite_date &other) const noexcept

Detailed Description

A date.

This is modeled after java.time.LocalDate.

Constructor & Destructor Documentation

ignite_date() [1/2]

ignite::ignite_date::ignite_date ( )

constexprdefaultnoexcept

Default constructor.

ignite_date() [2/2]

ignite::ignite_date::ignite_date ( std::int32_t year, std::int32_t month, std::int32_t day_of_month )

inlineconstexpr

Constructor.

Parameters

year	Year to represent, from -999,999,999 to 999,999,999.
month	Month-of-year, from 1 (January) to 12 (December).
day_of_month	Day-of-month, from 1 to 31.

Member Function Documentation

compare()

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

inlinenodiscardconstexprnoexcept

compare to another value.

Parameters

other

Instance to compare to.

Returns

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

get_day_of_month()

std::int_fast8_t ignite::ignite_date::get_day_of_month ( ) const

inlinenodiscardconstexprnoexcept

Gets the day-of-month field.

get_month()

std::int_fast8_t ignite::ignite_date::get_month ( ) const

inlinenodiscardconstexprnoexcept

Gets the month-of-year field.

get_year()

std::int32_t ignite::ignite_date::get_year ( ) const

inlinenodiscardconstexprnoexcept

Gets the year field.

---

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

• ignite/common/ignite_date.h