Description:

This class represents a time span, measured in human units like days, hours, minutes and so on. Besides conversion from and to nanoseconds, conversions from and to objects of types DateTime::Duration and Ticks::Duration is supported.

Note: This class is part of sub-namespace alib::lang::format of module ALib BaseCamp. While it is a pure utility class for type DateTime and Ticks found in module found ALib Time, the class was located there to keep module ALib Time lean and free from dependencies to module ALib BaseCamp.

Definition at line 205 of file calendar.hpp.

#include <calendar.hpp>

Public Field Index:
int	Days
	The number of days within the duration.

int	Hours
	The number of hours (not the total, hence 0-23) within the duration.

int	Microseconds
	The number of microseconds (not the total, hence 0-999) within the duration.

int	Milliseconds
	The number of milliseconds (not the total, hence 0-999) within the duration.

int	Minutes
	The number of minutes (not the total, hence 0-59) within the duration.

int	Nanoseconds
	The number of nanoseconds (not the total, hence 0-999) within the duration.

int	Seconds
	The number of seconds (not the total, hence 0-59) within the duration.

Public Method Index:
	CalendarDuration (DateTime::Duration duration)

	CalendarDuration (int64_t nanos)

	CalendarDuration (lang::Initialization init=Initialization::Default)

	CalendarDuration (Ticks::Duration duration)

ALIB_API void	Clear ()
	Sets all public values to 0.

void	FromDuration (DateTime::Duration duration)

void	FromDuration (Ticks::Duration duration)

ALIB_API void	FromNanoSeconds (int64_t nanos)

DateTime::Duration	ToDateTimeDuration ()

ALIB_API int64_t	ToNanoSeconds ()

Ticks::Duration	ToTicksDuration ()

Field Details:

◆ Days

int Days

The number of days within the duration.

Definition at line 209 of file calendar.hpp.

◆ Hours

int Hours

The number of hours (not the total, hence 0-23) within the duration.

Definition at line 212 of file calendar.hpp.

◆ Microseconds

int Microseconds

The number of microseconds (not the total, hence 0-999) within the duration.

Definition at line 224 of file calendar.hpp.

◆ Milliseconds

int Milliseconds

The number of milliseconds (not the total, hence 0-999) within the duration.

Definition at line 221 of file calendar.hpp.

◆ Minutes

int Minutes

The number of minutes (not the total, hence 0-59) within the duration.

Definition at line 215 of file calendar.hpp.

◆ Nanoseconds

int Nanoseconds

The number of nanoseconds (not the total, hence 0-999) within the duration.

Definition at line 227 of file calendar.hpp.

◆ Seconds

int Seconds

The number of seconds (not the total, hence 0-59) within the duration.

Definition at line 218 of file calendar.hpp.

Constructor(s) / Destructor Details:

◆ CalendarDuration() [1/4]

CalendarDuration ( lang::Initialization init = Initialization::Default )

inline

Constructs the object to represent a duration of 0. (Sets all public fields to 0.)

Parameters

init	If Initialization::Default or Nulled, Clear is invoked. Otherwise fields are not initialized. Defaults to Initialization::Default.

Definition at line 235 of file calendar.hpp.

Here is the call graph for this function:

◆ CalendarDuration() [2/4]

CalendarDuration ( int64_t nanos )

inline

Constructs the object using the given duration measured in nanoseconds. Invokes FromNanoSeconds.

Parameters

nanos The duration to use for setting the public fields.

Definition at line 246 of file calendar.hpp.

Here is the call graph for this function:

◆ CalendarDuration() [3/4]

CalendarDuration ( DateTime::Duration duration )

inline

Constructs the object using the given duration object. Invokes FromDuration.

Parameters

duration The duration to use for setting the public fields.

Definition at line 256 of file calendar.hpp.

Here is the call graph for this function:

◆ CalendarDuration() [4/4]

CalendarDuration ( Ticks::Duration duration )

inline

Constructs the object using the given duration object. Invokes FromDuration.

Parameters

duration The duration to use for setting the public fields.

Definition at line 266 of file calendar.hpp.

Here is the call graph for this function:

Method Details:

◆ Clear()

void Clear ( )

Sets all public values to 0.

Definition at line 136 of file calendar.cpp.

◆ FromDuration() [1/2]

void FromDuration ( DateTime::Duration duration )

inline

Sets the public fields to represent the given duration value. The state of the object will hereafter be the same as it was when constructed with the same parameter.

Parameters

duration The duration to use for setting the public fields.

Definition at line 277 of file calendar.hpp.

Here is the call graph for this function:

◆ FromDuration() [2/2]

void FromDuration ( Ticks::Duration duration )

inline

Sets the public fields to represent the given duration value. The state of the object will hereafter be the same as it was when constructed with the same parameter.

Parameters

duration The duration to use for setting the public fields.

Definition at line 288 of file calendar.hpp.

Here is the call graph for this function:

◆ FromNanoSeconds()

void FromNanoSeconds ( int64_t nanos )

Sets the public fields to represent the given duration value. The state of the object will hereafter be the same as it was when constructed with the same parameter.

Parameters

nanos The duration to use for setting the public fields.

Definition at line 154 of file calendar.cpp.

Here is the call graph for this function:

◆ ToDateTimeDuration()

DateTime::Duration ToDateTimeDuration ( )

inline

Takes the current values of the public fields and returns a duration value compatible with class DateTime.

Returns: The duration represented by the public fields of this class.

Definition at line 298 of file calendar.hpp.

Here is the call graph for this function:

◆ ToNanoSeconds()

int64_t ToNanoSeconds ( )

Takes the current values of the public fields and returns the duration.

Returns: The duration represented by the public fields of this class in nanoseconds.

Definition at line 166 of file calendar.cpp.

◆ ToTicksDuration()

Ticks::Duration ToTicksDuration ( )

inline

Takes the current values of the public fields and returns a duration value compatible with class Ticks.

Returns: The duration represented by the public fields of this class.

Definition at line 308 of file calendar.hpp.

Here is the call graph for this function:

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

Description:

Public Field Index:

Public Method Index:

Field Details:

◆ Days

◆ Hours

◆ Microseconds

◆ Milliseconds

◆ Minutes

◆ Nanoseconds

◆ Seconds

Constructor(s) / Destructor Details:

◆ CalendarDuration() [1/4]

◆ CalendarDuration() [2/4]

◆ CalendarDuration() [3/4]

◆ CalendarDuration() [4/4]

Method Details:

◆ Clear()

◆ FromDuration() [1/2]

◆ FromDuration() [2/2]

◆ FromNanoSeconds()

◆ ToDateTimeDuration()

◆ ToNanoSeconds()

◆ ToTicksDuration()