nc::DateTime Class Reference

Date Time class for working with iso formatted date times. More...

#include <DateTime.hpp>

Public Member Functions
	DateTime ()=default
	DateTime (const std::string &timestamp)
	DateTime (const TimePoint &tp)
	DateTime (int year, int month, int day, int hour, int minute, int second, double fractionalSecond=0.0) noexcept
int	day () const noexcept
	day getter
double	fractionalSecond () const noexcept
	fractionalSecond getter
int	hour () const noexcept
	hour getter
int	minute () const noexcept
	minute getter
int	month () const noexcept
	month getter
int	second () const noexcept
	second getter
void	setDay (int day)
	day setter
void	setFractionalSecond (double fractionalSecond)
	fractionalSecond setter
void	setHour (int hour)
	hour setter
void	setMinute (int minute)
	minute setter
void	setMonth (int month)
	month setter
void	setSecond (int second)
	second setter
void	setYear (int year)
	year setter
std::string	toStr () const
	Converts the struct to an iso string.
TimePoint	toTimePoint () const
	Converts the struct to a TimePoint.
int	year () const noexcept
	year getter

Static Public Member Functions
static DateTime	now () noexcept
	Factory static method for returning a DateTime object cooresponding to the system clock now.
static TimePoint	strToTimepoint (const std::string &timestamp)
	Converts the struct to an iso string.

Static Public Attributes
static constexpr int	MAX_DAY = 31
static constexpr int	MAX_HOUR = 23
static constexpr int	MAX_MINUTE = 59
static constexpr int	MAX_MONTH = 12
static constexpr int	MAX_SECOND = 59

Detailed Description

Date Time class for working with iso formatted date times.

Constructor & Destructor Documentation

DateTime() [1/4]

nc::DateTime::DateTime ( )

default

Constructor

DateTime() [2/4]

nc::DateTime::DateTime ( const TimePoint & tp )

inlineexplicit

Constructor

Parameters

tp	a timepoint object

DateTime() [3/4]

nc::DateTime::DateTime ( const std::string & timestamp )

inlineexplicit

Constructor

Parameters

timestamp

an iso formatted datetime string (0001-01-01T00:00:00.00000Z)

DateTime() [4/4]

nc::DateTime::DateTime ( int year, int month, int day, int hour, int minute, int second, double fractionalSecond = 0.0 )

inlinenoexcept

Constructor

Parameters

year	year value
month	month value
day	day value
hour	hour value
minute	minute value
second	second value
fractionalSecond	fractionalSecond value

Member Function Documentation

day()

int nc::DateTime::day ( ) const

inlinenodiscardnoexcept

day getter

Returns

int

fractionalSecond()

double nc::DateTime::fractionalSecond ( ) const

inlinenodiscardnoexcept

fractionalSecond getter

Returns

double

hour()

int nc::DateTime::hour ( ) const

inlinenodiscardnoexcept

hour getter

Returns

int

minute()

int nc::DateTime::minute ( ) const

inlinenodiscardnoexcept

minute getter

Returns

int

month()

int nc::DateTime::month ( ) const

inlinenodiscardnoexcept

month getter

Returns

int

now()

DateTime nc::DateTime::now ( )

inlinestaticnodiscardnoexcept

Factory static method for returning a DateTime object cooresponding to the system clock now.

Returns

DateTime

second()

int nc::DateTime::second ( ) const

inlinenodiscardnoexcept

second getter

Returns

int

setDay()

void nc::DateTime::setDay ( int day )

inline

day setter

Parameters

day

day value

setFractionalSecond()

void nc::DateTime::setFractionalSecond ( double fractionalSecond )

inline

fractionalSecond setter

Parameters

fractionalSecond

fractionalSecond value

setHour()

void nc::DateTime::setHour ( int hour )

inline

hour setter

Parameters

hour	hour value

setMinute()

void nc::DateTime::setMinute ( int minute )

inline

minute setter

Parameters

minute

minute value

setMonth()

void nc::DateTime::setMonth ( int month )

inline

month setter

Parameters

month

month value

setSecond()

void nc::DateTime::setSecond ( int second )

inline

second setter

Parameters

second

second value

setYear()

void nc::DateTime::setYear ( int year )

inline

year setter

Parameters

year	year value

strToTimepoint()

TimePoint nc::DateTime::strToTimepoint ( const std::string & timestamp )

inlinestatic

Converts the struct to an iso string.

Parameters

timestamp

an iso formatted datetime string (0001-01-01T00:00:00.00000Z)

Returns

Timepoint

toStr()

std::string nc::DateTime::toStr ( ) const

inlinenodiscard

Converts the struct to an iso string.

Returns

std::string

toTimePoint()

TimePoint nc::DateTime::toTimePoint ( ) const

inlinenodiscard

Converts the struct to a TimePoint.

Returns

TimePoint

year()

int nc::DateTime::year ( ) const

inlinenodiscardnoexcept

year getter

Returns

int

Field Documentation

MAX_DAY

int nc::DateTime::MAX_DAY = 31

staticconstexpr

MAX_HOUR

int nc::DateTime::MAX_HOUR = 23

staticconstexpr

MAX_MINUTE

int nc::DateTime::MAX_MINUTE = 59

staticconstexpr

MAX_MONTH

int nc::DateTime::MAX_MONTH = 12

staticconstexpr

MAX_SECOND

int nc::DateTime::MAX_SECOND = 59

staticconstexpr

---

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

• DateTime/DateTime.hpp