.. index:: pair: struct; EE::System::CalendarDate
.. _doxid-struct_e_e_1_1_system_1_1_calendar_date:

struct EE::System::CalendarDate
===============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Civil Gregorian calendar date without timezone or timestamp semantics. :ref:`More...<details-struct_e_e_1_1_system_1_1_calendar_date>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <datetime.hpp>
	
	struct CalendarDate {
		// fields
	
		:ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` :target:`year<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a8a84a8591ee24ed1996f6870e7f3a5ab>` { 1970 };
		:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>` :target:`month<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a4f6e349e9fdeee6082ea57d757a2f583>` { 1 };
		:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>` :target:`day<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a27cedce1681059936d2d1140144acb4e>` { 1 };

		// methods
	
		bool :target:`isValid<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a5a9c64892a32f42ec713802fe762f5b3>`() const;
		int :target:`daysInMonth<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a9e60122cae7a76f3ea5393a38d826e90>`() const;
		:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` :ref:`daysSinceEpoch<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a667ef4df8f9b8db9cf869e3f04053c60>`() const;
		std::optional<:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>`> :ref:`toUnixTimestamp<doxid-struct_e_e_1_1_system_1_1_calendar_date_1ae67dd14d43de60d471d2e03756b73b85>`() const;
		CalendarDate :target:`addDays<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a235c3de596c99b33850d7d146a61672d>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` days) const;
		CalendarDate :target:`addMonths<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a6b7912c5d4d863334f98a1549f6449bc>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` months) const;
		CalendarDate :target:`addYears<doxid-struct_e_e_1_1_system_1_1_calendar_date_1abdcc9c775114e242b6bc5d4915e3b174>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` years) const;
		auto :target:`operator<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a827c220b79d6ce0555b8dc26a38f6129>`(const CalendarDate&) const;
		static std::optional<CalendarDate> :ref:`fromUnixTimestamp<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a0ac41da330acac3bcefa0c86899e113e>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` seconds);
		static bool :target:`isLeapYear<doxid-struct_e_e_1_1_system_1_1_calendar_date_1aa176040427177e3b344f17b9aa220dd0>`(:ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` year);
		static int :target:`daysInMonth<doxid-struct_e_e_1_1_system_1_1_calendar_date_1a54b35b310858ec5646bb9fa122ac5ea7>`(:ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` year, :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>` month);
		static CalendarDate :target:`today<doxid-struct_e_e_1_1_system_1_1_calendar_date_1afeb87f623e07169dd04367fba6247604>`();
	};
.. _details-struct_e_e_1_1_system_1_1_calendar_date:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Civil Gregorian calendar date without timezone or timestamp semantics. Arithmetic outside the Int32 year range leaves the value unchanged.

Methods
-------

.. index:: pair: function; daysSinceEpoch
.. _doxid-struct_e_e_1_1_system_1_1_calendar_date_1a667ef4df8f9b8db9cf869e3f04053c60:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` daysSinceEpoch() const

Signed number of Gregorian days since 1970-01-01; requires a valid date.

.. index:: pair: function; toUnixTimestamp
.. _doxid-struct_e_e_1_1_system_1_1_calendar_date_1ae67dd14d43de60d471d2e03756b73b85:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::optional<:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>`> toUnixTimestamp() const

Unix seconds at midnight UTC; returns nullopt for an invalid date.

.. index:: pair: function; fromUnixTimestamp
.. _doxid-struct_e_e_1_1_system_1_1_calendar_date_1a0ac41da330acac3bcefa0c86899e113e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static std::optional<CalendarDate> fromUnixTimestamp(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` seconds)

UTC date containing the Unix timestamp, including negative timestamps. Returns nullopt if the date is outside the Int32 year range.