Botan::calendar_point Class Reference

#include <calendar.h>

Public Member Functions
	calendar_point (const std::chrono::system_clock::time_point &time_point)
	calendar_point (uint32_t y, uint32_t mon, uint32_t d, uint32_t h, uint32_t min, uint32_t sec)
uint32_t	day () const
uint32_t	hour () const
uint32_t	minutes () const
uint32_t	month () const
uint32_t	seconds () const
int64_t	seconds_since_epoch () const
std::chrono::system_clock::time_point	to_std_timepoint () const
uint32_t	year () const

Detailed Description

Struct representing a particular date and time

Definition at line 20 of file calendar.h.

Constructor & Destructor Documentation

calendar_point() [1/2]

Botan::calendar_point::calendar_point	(	uint32_t	y,
		uint32_t	mon,
		uint32_t	d,
		uint32_t	h,
		uint32_t	min,
		uint32_t	sec )

Initialize a calendar_point

Parameters

y	the year
mon	the month
d	the day
h	the hour
min	the minute
sec	the second

Definition at line 83 of file calendar.cpp.

                                                                                                           :
      m_year(static_cast<uint16_t>(y)),
      m_month(static_cast<uint8_t>(mon)),
      m_day(static_cast<uint8_t>(d)),
      m_hour(static_cast<uint8_t>(h)),
      m_minutes(static_cast<uint8_t>(min)),
      m_seconds(static_cast<uint8_t>(sec)) {
   BOTAN_ARG_CHECK(y <= 9999, "Year is outside representable range");
   BOTAN_ARG_CHECK(mon >= 1 && mon <= 12, "Month is outside range");
   BOTAN_ARG_CHECK(d >= 1 && d <= 31, "Day is outside range");
   BOTAN_ARG_CHECK(h < 24, "Hour is outside range");
   BOTAN_ARG_CHECK(min < 60, "Minute is outside range");
   BOTAN_ARG_CHECK(sec < 60, "Seconds is outside range");
}

References BOTAN_ARG_CHECK.

calendar_point() [2/2]

Botan::calendar_point::calendar_point ( const std::chrono::system_clock::time_point & time_point )

explicit

Convert a time_point to a calendar_point

Parameters

time_point

a time point from the system clock

Definition at line 128 of file calendar.cpp.

                                                                                {
   const auto [year, month, day, hour, minute, second] = civil_from_time_point(time_point);
 
   BOTAN_ARG_CHECK(year <= 9999, "Year is outside representable range");
 
   m_year = static_cast<uint16_t>(year);
   m_month = static_cast<uint8_t>(month);
   m_day = static_cast<uint8_t>(day);
   m_hour = static_cast<uint8_t>(hour);
   m_minutes = static_cast<uint8_t>(minute);
   m_seconds = static_cast<uint8_t>(second);
}

References BOTAN_ARG_CHECK, day(), hour(), month(), and year().

Member Function Documentation

day()

uint32_t Botan::calendar_point::day ( ) const

inline

The day of the month, 1 through 31

Definition at line 29 of file calendar.h.

{ return m_day; }

Referenced by calendar_point(), Botan::ASN1_Time::from_time_point(), and seconds_since_epoch().

hour()

uint32_t Botan::calendar_point::hour ( ) const

inline

Hour in 24-hour form, 0 to 23

Definition at line 32 of file calendar.h.

{ return m_hour; }

Referenced by calendar_point(), Botan::ASN1_Time::from_time_point(), and seconds_since_epoch().

minutes()

uint32_t Botan::calendar_point::minutes ( ) const

inline

Minutes in the hour, 0 to 59

Definition at line 35 of file calendar.h.

{ return m_minutes; }

Referenced by Botan::ASN1_Time::from_time_point(), and seconds_since_epoch().

month()

uint32_t Botan::calendar_point::month ( ) const

inline

The month, 1 through 12 for Jan to Dec

Definition at line 26 of file calendar.h.

{ return m_month; }

Referenced by calendar_point(), Botan::ASN1_Time::from_time_point(), and seconds_since_epoch().

seconds()

uint32_t Botan::calendar_point::seconds ( ) const

inline

Seconds in the minute, 0 to 59

Definition at line 38 of file calendar.h.

{ return m_seconds; }

Referenced by Botan::ASN1_Time::from_time_point(), and seconds_since_epoch().

seconds_since_epoch()

int64_t Botan::calendar_point::seconds_since_epoch

(

)

const

Return seconds since epoch

This is negative for dates before 1970

Definition at line 98 of file calendar.cpp.

                                                  {
   return (days_since_epoch(year(), month(), day()) * 86400) + (hour() * 60 * 60) + (minutes() * 60) + seconds();
}

References day(), hour(), minutes(), month(), seconds(), and year().

Referenced by Botan::ASN1_Time::time_since_epoch(), and to_std_timepoint().

to_std_timepoint()

std::chrono::system_clock::time_point Botan::calendar_point::to_std_timepoint

(

)

const

Returns an STL timepoint object

Note this throws an exception if the time is not representable in the system time_t

Definition at line 102 of file calendar.cpp.

                                                                       {
   const int64_t seconds_64 = this->seconds_since_epoch();
 
   /*
   * The tick of a system_clock varies by implementation, and so also the
   * largest and smallest representable values vary. Ensure this date is within
   * range of the clock implementation.
   */
   constexpr int64_t max_representable_seconds = static_cast<int64_t>(
      std::chrono::duration_cast<std::chrono::seconds>(std::chrono::system_clock::duration::max()).count());
   constexpr int64_t min_representable_seconds = static_cast<int64_t>(
      std::chrono::duration_cast<std::chrono::seconds>(std::chrono::system_clock::duration::min()).count());
 
   if(seconds_64 > max_representable_seconds || seconds_64 < min_representable_seconds) {
      throw Invalid_Argument("calendar_point::to_std_timepoint time is outside the representable range");
   }
 
   const time_t seconds_time_t = static_cast<time_t>(seconds_64);
 
   if(seconds_64 - seconds_time_t != 0) {
      throw Invalid_Argument("calendar_point::to_std_timepoint time is outside the representable range");
   }
 
   return std::chrono::system_clock::from_time_t(seconds_time_t);
}

References seconds_since_epoch().

Referenced by Botan::ASN1_Time::to_std_timepoint().

year()

uint32_t Botan::calendar_point::year ( ) const

inline

The year, less than or equal to 9999

Definition at line 23 of file calendar.h.

{ return m_year; }

Referenced by calendar_point(), Botan::ASN1_Time::from_time_point(), and seconds_since_epoch().

---

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

• src/lib/utils/calendar.h
• src/lib/utils/calendar.cpp