Calendar which defines how the dates are handled, calculated, formatted, etc. Setter operations are only enabled on non-read-only objects. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include "calendar.h"

Inherits System::ICloneable.

Inherited by System::Globalization::EastAsianLunisolarCalendar, System::Globalization::GregorianCalendar, System::Globalization::HebrewCalendar, System::Globalization::HijriCalendar, System::Globalization::JapaneseCalendar, System::Globalization::JulianCalendar, System::Globalization::KoreanCalendar, System::Globalization::PersianCalendar, System::Globalization::TaiwanCalendar, System::Globalization::ThaiBuddhistCalendar, and System::Globalization::UmAlQuraCalendar.

Public Member Functions

 Calendar (const Calendar &)=delete
 RTTI information. More...
 
Calendaroperator= (const Calendar &)=delete
 
virtual ASPOSECPP_SHARED_API CalendarAlgorithmType get_AlgorithmType () const =0
 Gets algorithm type. More...
 
virtual ASPOSECPP_SHARED_API ArrayPtr< int > get_Eras () const =0
 Gets list of eras existing in calendar. More...
 
virtual ASPOSECPP_SHARED_API DateTime get_MaxSupportedDateTime () const =0
 Maximal point in time that is supported by the calendar. More...
 
virtual ASPOSECPP_SHARED_API DateTime get_MinSupportedDateTime () const =0
 Minimal point in time that is supported by the calendar. More...
 
virtual ASPOSECPP_SHARED_API DateTime AddDays (DateTime time, int days) const
 Adds days to time point. More...
 
virtual ASPOSECPP_SHARED_API DateTime AddHours (DateTime time, int hours) const
 Adds hours to time point. More...
 
virtual ASPOSECPP_SHARED_API DateTime AddMilliseconds (DateTime time, double milliseconds) const
 Adds milliseconds to time point. More...
 
virtual ASPOSECPP_SHARED_API DateTime AddMinutes (DateTime time, int minutes) const
 Adds minutes to time point. More...
 
virtual ASPOSECPP_SHARED_API DateTime AddMonths (DateTime time, int months) const
 Adds months to time point. More...
 
virtual ASPOSECPP_SHARED_API DateTime AddSeconds (DateTime time, int seconds) const
 Adds seconds to time point. More...
 
virtual ASPOSECPP_SHARED_API DateTime AddWeeks (DateTime time, int weeks) const
 Adds weeks to time point. More...
 
virtual ASPOSECPP_SHARED_API DateTime AddYears (DateTime time, int years) const
 Adds years to time point. More...
 
virtual ASPOSECPP_SHARED_API int GetDayOfMonth (DateTime time) const
 Gets day of month for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API DayOfWeek GetDayOfWeek (DateTime time) const
 Gets day of week for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetDayOfYear (DateTime time) const
 Gets day of year for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetDaysInMonth (int year, int month) const
 Gets number of days in specific month. More...
 
virtual ASPOSECPP_SHARED_API int GetDaysInMonth (int year, int month, int era) const
 Gets number of days in specific month. More...
 
virtual ASPOSECPP_SHARED_API int GetDaysInYear (int year) const
 Gets number of days in specific year. More...
 
virtual ASPOSECPP_SHARED_API int GetDaysInYear (int year, int era) const
 Gets number of days in specific year. More...
 
virtual ASPOSECPP_SHARED_API int GetEra (DateTime time) const
 Gets era for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetHour (DateTime time) const
 Gets hours for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetLeapMonth (int year) const
 Gets the leap month for the specified year. More...
 
virtual ASPOSECPP_SHARED_API int GetLeapMonth (int year, int era) const =0
 Gets the leap month for the specified year. More...
 
virtual ASPOSECPP_SHARED_API double GetMilliseconds (DateTime time) const
 Gets milliseconds for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetMinute (DateTime time) const
 Gets minutes for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetMonth (DateTime time) const
 Gets month for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetMonthsInYear (int year) const
 Gets number of months in the specified year. More...
 
virtual ASPOSECPP_SHARED_API int GetMonthsInYear (int year, int era) const
 Gets number of months in the specified year. More...
 
virtual ASPOSECPP_SHARED_API int GetSecond (DateTime time) const
 Gets seconds for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetWeekOfYear (DateTime time, CalendarWeekRule rule, DayOfWeek first_day_of_week) const
 Gets week of the year for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API int GetYear (DateTime time) const
 Gets year for the specified time point. More...
 
virtual ASPOSECPP_SHARED_API bool IsLeapDay (int year, int month, int day) const
 Checks if the day is leap. More...
 
virtual ASPOSECPP_SHARED_API bool IsLeapDay (int year, int month, int day, int era) const =0
 Checks if the day is leap. More...
 
virtual ASPOSECPP_SHARED_API bool IsLeapMonth (int year, int month) const
 Checks if the month is leap. More...
 
virtual ASPOSECPP_SHARED_API bool IsLeapMonth (int year, int month, int era) const
 Checks if the month is leap. More...
 
virtual ASPOSECPP_SHARED_API bool IsLeapYear (int year) const
 Checks if the year is leap. More...
 
virtual ASPOSECPP_SHARED_API bool IsLeapYear (int year, int era) const =0
 Checks if the year is leap. More...
 
virtual ASPOSECPP_SHARED_API DateTime ToDateTime (int year, int month, int day, int hour, int minute, int second, int millisecond) const
 Constructs DateTime object from components. More...
 
virtual ASPOSECPP_SHARED_API DateTime ToDateTime (int year, int month, int day, int hour, int minute, int second, int millisecond, int era) const
 Constructs DateTime object from components. More...
 
virtual Details::CalendarId get_ID () const
 Gets calendar identifier. More...
 
ASPOSECPP_SHARED_API bool get_IsReadOnly () const
 Checks if the calendar is read only. More...
 
ASPOSECPP_SHARED_API int get_CurrentEra () const
 Gets index of current era. More...
 
ASPOSECPP_SHARED_API int get_CurrentEraValue () const
 Gets value of current era. More...
 
bool IsValidDay (int year, int month, int day, int era) const
 Checks year, month, day and era values. More...
 
virtual ASPOSECPP_SHARED_API int get_TwoDigitYearMax () const
 Gets the last year that can be represented by a 2-digit. More...
 
virtual ASPOSECPP_SHARED_API void set_TwoDigitYearMax (int value)
 Sets the last year that can be represented by a 2-digit. More...
 
virtual ASPOSECPP_SHARED_API int ToFourDigitYear (int year) const
 Converts the year to 4-digit year using TwoDigitYearMax property. More...
 
- Public Member Functions inherited from System::ICloneable
virtual System::SharedPtr< System::ObjectClone ()=0
 Creates a copy of the current object and returns a shared pointer to it. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Static Public Member Functions

static ASPOSECPP_SHARED_API CalendarPtr ReadOnly (const CalendarPtr &calendar)
 Gets read only version of calendar. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Protected Member Functions

ASPOSECPP_SHARED_API Calendar ()
 Default constructor. More...
 
 Calendar (std::unique_ptr< codeporting_icu::Calendar > &&calendar)
 Constructor. More...
 
virtual bool IsGregorianBasedCalendar () const
 Checks if the calendar is Gregorian-based. More...
 
virtual void VerifyYear (int year, int era) const
 Verify year and era values. More...
 
virtual void VerifyMonth (int year, int month, int era) const
 Verify year, month and era values. More...
 
virtual void VerifyDate (int year, int month, int day, int era) const
 Verify year, month, day and era values. More...
 
void VerifyTime (int hour, int minute, int second, int millisecond) const
 Verify hour, minute, second and millisecond values. More...
 
void VerifyDateTimeRange (DateTime time) const
 Verify time value. More...
 
void VerifyWriteable () const
 Verify that calendar is not read-only. More...
 
virtual int EraToIcuEra (int era) const
 Convert Framework era value to ICU era format. More...
 
virtual int IcuEraToEra (int icu_era) const
 Convert ICU era value to Framework era format. More...
 
void UseExtendedYearField ()
 Use the UCAL_EXTENDED_YEAR field instead of the UCAL_YEAR field. Must be set for the ChineseLunisolar-based calendars. More...
 
void SetYearOffset (int year_offset)
 Set year offset. result_year = icu_year + year_offset. More...
 
void SetDateAdjustment (int date_adjustment)
 Sets the number of days to add or subtract from the calendar. More...
 
int GetYearInternal (DateTime time) const
 Gets year (UCAL_YEAR) for the specified time point. More...
 
int GetDaysInMonthInternal (int year, int month, int era) const
 Gets days in month (UCAL_DAY_OF_MONTH) for the specified year, month and era. More...
 
DateTime ToDateTimeInternal (int year, int month, int day, int hour, int minute, int second, int millisecond, int era) const
 Constructs DateTime object from components. More...
 
void SetTwoDigitYearMaxInternal (int year)
 Sets the last year that can be represented by a 2-digit. More...
 

Static Protected Attributes

static constexpr int CurrentEra = 0
 Current era value. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

Calendar which defines how the dates are handled, calculated, formatted, etc. Setter operations are only enabled on non-read-only objects. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ Calendar() [1/3]

System::Globalization::Calendar::Calendar ( const Calendar )
delete

RTTI information.

◆ Calendar() [2/3]

ASPOSECPP_SHARED_API System::Globalization::Calendar::Calendar ( )
protected

Default constructor.

◆ Calendar() [3/3]

System::Globalization::Calendar::Calendar ( std::unique_ptr< codeporting_icu::Calendar > &&  calendar)
protected

Constructor.

Parameters
calendarImplementation.

Member Function Documentation

◆ AddDays()

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::AddDays ( DateTime  time,
int  days 
) const
virtual

Adds days to time point.

Parameters
timeOriginal time point value.
daysNumber of days to add.
Returns
Time point after calculation is done.

◆ AddHours()

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::AddHours ( DateTime  time,
int  hours 
) const
virtual

Adds hours to time point.

Parameters
timeOriginal time point value.
hoursNumber of hours to add.
Returns
Time point after calculation is done.

◆ AddMilliseconds()

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::AddMilliseconds ( DateTime  time,
double  milliseconds 
) const
virtual

Adds milliseconds to time point.

Parameters
timeOriginal time point value.
millisecondsNumber of milliseconds to add.
Returns
Time point after calculation is done.

◆ AddMinutes()

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::AddMinutes ( DateTime  time,
int  minutes 
) const
virtual

Adds minutes to time point.

Parameters
timeOriginal time point value.
minutesNumber of minutes to add.
Returns
Time point after calculation is done.

◆ AddMonths()

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::AddMonths ( DateTime  time,
int  months 
) const
virtual

Adds months to time point.

Parameters
timeOriginal time point value.
monthsNumber of months to add.
Returns
Time point after calculation is done.

◆ AddSeconds()

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::AddSeconds ( DateTime  time,
int  seconds 
) const
virtual

Adds seconds to time point.

Parameters
timeOriginal time point value.
secondsNumber of seconds to add.
Returns
Time point after calculation is done.

◆ AddWeeks()

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::AddWeeks ( DateTime  time,
int  weeks 
) const
virtual

Adds weeks to time point.

Parameters
timeOriginal time point value.
weeksNumber of weeks to add.
Returns
Time point after calculation is done.

◆ AddYears()

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::AddYears ( DateTime  time,
int  years 
) const
virtual

Adds years to time point.

Parameters
timeOriginal time point value.
yearsNumber of years to add.
Returns
Time point after calculation is done.

◆ EraToIcuEra()

virtual int System::Globalization::Calendar::EraToIcuEra ( int  era) const
protectedvirtual

Convert Framework era value to ICU era format.

Parameters
eraFramework era value.
Returns
ICU era value.

◆ get_AlgorithmType()

◆ get_CurrentEra()

ASPOSECPP_SHARED_API int System::Globalization::Calendar::get_CurrentEra ( ) const

Gets index of current era.

Returns
Current era index.

◆ get_CurrentEraValue()

ASPOSECPP_SHARED_API int System::Globalization::Calendar::get_CurrentEraValue ( ) const

Gets value of current era.

Returns
Current era value.

◆ get_Eras()

◆ get_ID()

◆ get_IsReadOnly()

ASPOSECPP_SHARED_API bool System::Globalization::Calendar::get_IsReadOnly ( ) const

Checks if the calendar is read only.

Returns
True if the calendar is read only, false otherwise.

◆ get_MaxSupportedDateTime()

◆ get_MinSupportedDateTime()

◆ get_TwoDigitYearMax()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::get_TwoDigitYearMax ( ) const
virtual

Gets the last year that can be represented by a 2-digit.

◆ GetDayOfMonth()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetDayOfMonth ( DateTime  time) const
virtual

Gets day of month for the specified time point.

Parameters
timeTime and date to extract data from.
Returns
Day of month in the time point passed.

Reimplemented in System::Globalization::GregorianCalendar, System::Globalization::KoreanCalendar, System::Globalization::ThaiBuddhistCalendar, System::Globalization::TaiwanCalendar, and System::Globalization::JapaneseCalendar.

◆ GetDayOfWeek()

virtual ASPOSECPP_SHARED_API DayOfWeek System::Globalization::Calendar::GetDayOfWeek ( DateTime  time) const
virtual

◆ GetDayOfYear()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetDayOfYear ( DateTime  time) const
virtual

Gets day of year for the specified time point.

Parameters
timeTime and date to extract data from.
Returns
Day of year in the time point passed.

Reimplemented in System::Globalization::GregorianCalendar, System::Globalization::KoreanCalendar, System::Globalization::ThaiBuddhistCalendar, System::Globalization::JapaneseCalendar, and System::Globalization::TaiwanCalendar.

◆ GetDaysInMonth() [1/2]

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetDaysInMonth ( int  year,
int  month 
) const
virtual

Gets number of days in specific month.

Parameters
yearYear.
monthMonth to get number of days in.
Returns
Number of days in specified month of specified year.

◆ GetDaysInMonth() [2/2]

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetDaysInMonth ( int  year,
int  month,
int  era 
) const
virtual

◆ GetDaysInMonthInternal()

int System::Globalization::Calendar::GetDaysInMonthInternal ( int  year,
int  month,
int  era 
) const
protected

Gets days in month (UCAL_DAY_OF_MONTH) for the specified year, month and era.

◆ GetDaysInYear() [1/2]

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetDaysInYear ( int  year) const
virtual

Gets number of days in specific year.

Parameters
yearYear to get number of days in.
Returns
Number of days in specified year.

◆ GetDaysInYear() [2/2]

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetDaysInYear ( int  year,
int  era 
) const
virtual

Gets number of days in specific year.

Parameters
yearYear to get number of days in.
eraEra.
Returns
Number of days in specified year of specified era.

Reimplemented in System::Globalization::GregorianCalendar, System::Globalization::KoreanCalendar, System::Globalization::ThaiBuddhistCalendar, System::Globalization::JulianCalendar, System::Globalization::PersianCalendar, System::Globalization::JapaneseCalendar, and System::Globalization::TaiwanCalendar.

◆ GetEra()

◆ GetHour()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetHour ( DateTime  time) const
virtual

Gets hours for the specified time point.

Parameters
timeTime and date to extract data from.
Returns
Hours in the time point passed.

◆ GetLeapMonth() [1/2]

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetLeapMonth ( int  year) const
virtual

Gets the leap month for the specified year.

Parameters
yearYear to get leap month in.
Returns
Leap month of the speicified year or zero if the year has no leap month.

◆ GetLeapMonth() [2/2]

◆ GetMilliseconds()

virtual ASPOSECPP_SHARED_API double System::Globalization::Calendar::GetMilliseconds ( DateTime  time) const
virtual

Gets milliseconds for the specified time point.

Parameters
timeTime and date to extract data from.
Returns
Milliseconds in the time point passed.

◆ GetMinute()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetMinute ( DateTime  time) const
virtual

Gets minutes for the specified time point.

Parameters
timeTime and date to extract data from.
Returns
Minutes in the time point passed.

◆ GetMonth()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetMonth ( DateTime  time) const
virtual

Gets month for the specified time point.

Parameters
timeTime and date to extract data from.
Returns
Month in the time point passed.

Reimplemented in System::Globalization::GregorianCalendar, System::Globalization::KoreanCalendar, System::Globalization::ThaiBuddhistCalendar, System::Globalization::TaiwanCalendar, System::Globalization::JapaneseCalendar, and System::Globalization::HebrewCalendar.

◆ GetMonthsInYear() [1/2]

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetMonthsInYear ( int  year) const
virtual

Gets number of months in the specified year.

Parameters
yearYear to get number of months in.
Returns
Number of months in the specified year.

◆ GetMonthsInYear() [2/2]

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetMonthsInYear ( int  year,
int  era 
) const
virtual

◆ GetSecond()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetSecond ( DateTime  time) const
virtual

Gets seconds for the specified time point.

Parameters
timeTime and date to extract data from.
Returns
Seconds in the time point passed.

◆ GetWeekOfYear()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetWeekOfYear ( DateTime  time,
CalendarWeekRule  rule,
DayOfWeek  first_day_of_week 
) const
virtual

Gets week of the year for the specified time point.

Parameters
timeTime and date to extract data from.
ruleDetermines how to determine the first week of the year.
first_day_of_weekDetermines first day of week.
Returns
Year week number in the time point passed.

◆ GetYear()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::GetYear ( DateTime  time) const
virtual

Gets year for the specified time point.

Parameters
timeTime and date to extract data from.
Returns
Year in the time point passed.

Reimplemented in System::Globalization::GregorianCalendar, System::Globalization::KoreanCalendar, System::Globalization::ThaiBuddhistCalendar, System::Globalization::TaiwanCalendar, and System::Globalization::JapaneseLunisolarCalendar.

◆ GetYearInternal()

int System::Globalization::Calendar::GetYearInternal ( DateTime  time) const
protected

Gets year (UCAL_YEAR) for the specified time point.

◆ IcuEraToEra()

virtual int System::Globalization::Calendar::IcuEraToEra ( int  icu_era) const
protectedvirtual

Convert ICU era value to Framework era format.

Parameters
icu_eraICU era value.
Returns
Framework era value.

◆ IsGregorianBasedCalendar()

virtual bool System::Globalization::Calendar::IsGregorianBasedCalendar ( ) const
protectedvirtual

◆ IsLeapDay() [1/2]

virtual ASPOSECPP_SHARED_API bool System::Globalization::Calendar::IsLeapDay ( int  year,
int  month,
int  day 
) const
virtual

Checks if the day is leap.

Parameters
yearYear.
monthMonth.
dayDay.
Returns
True if specified date is leap, false otherwise.

◆ IsLeapDay() [2/2]

◆ IsLeapMonth() [1/2]

virtual ASPOSECPP_SHARED_API bool System::Globalization::Calendar::IsLeapMonth ( int  year,
int  month 
) const
virtual

Checks if the month is leap.

Parameters
yearYear.
monthMonth.
Returns
True if specified month is leap, false otherwise.

◆ IsLeapMonth() [2/2]

virtual ASPOSECPP_SHARED_API bool System::Globalization::Calendar::IsLeapMonth ( int  year,
int  month,
int  era 
) const
virtual

◆ IsLeapYear() [1/2]

virtual ASPOSECPP_SHARED_API bool System::Globalization::Calendar::IsLeapYear ( int  year) const
virtual

Checks if the year is leap.

Parameters
yearYear.
Returns
True if specified year is leap, false otherwise.

◆ IsLeapYear() [2/2]

◆ IsValidDay()

bool System::Globalization::Calendar::IsValidDay ( int  year,
int  month,
int  day,
int  era 
) const

Checks year, month, day and era values.

Parameters
yearYear.
monthMonth.
dayDay.
eraEra.
Returns
True if values are valid.

◆ operator=()

Calendar& System::Globalization::Calendar::operator= ( const Calendar )
delete

◆ ReadOnly()

static ASPOSECPP_SHARED_API CalendarPtr System::Globalization::Calendar::ReadOnly ( const CalendarPtr calendar)
static

Gets read only version of calendar.

Parameters
calendarCalendar to get read only version of.
Returns
Same calendar if it is read only or a copy of it with read-only flag set.

◆ set_TwoDigitYearMax()

virtual ASPOSECPP_SHARED_API void System::Globalization::Calendar::set_TwoDigitYearMax ( int  value)
virtual

Sets the last year that can be represented by a 2-digit.

Parameters
valueLast year of a 100-year range.

Reimplemented in System::Globalization::HebrewCalendar, and System::Globalization::UmAlQuraCalendar.

◆ SetDateAdjustment()

void System::Globalization::Calendar::SetDateAdjustment ( int  date_adjustment)
protected

Sets the number of days to add or subtract from the calendar.

Parameters
date_adjustmentDate adjustment.

◆ SetTwoDigitYearMaxInternal()

void System::Globalization::Calendar::SetTwoDigitYearMaxInternal ( int  year)
protected

Sets the last year that can be represented by a 2-digit.

◆ SetYearOffset()

void System::Globalization::Calendar::SetYearOffset ( int  year_offset)
protected

Set year offset. result_year = icu_year + year_offset.

Parameters
year_offsetYear offset.

◆ ToDateTime() [1/2]

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::ToDateTime ( int  year,
int  month,
int  day,
int  hour,
int  minute,
int  second,
int  millisecond 
) const
virtual

Constructs DateTime object from components.

Parameters
yearYear.
monthMonth.
dayDay.
hourHour.
minuteMinute.
secondSecond.
millisecondMillisecond.
Returns
DateTime object that has specified components.

◆ ToDateTime() [2/2]

virtual ASPOSECPP_SHARED_API DateTime System::Globalization::Calendar::ToDateTime ( int  year,
int  month,
int  day,
int  hour,
int  minute,
int  second,
int  millisecond,
int  era 
) const
virtual

Constructs DateTime object from components.

Parameters
yearYear.
monthMonth.
dayDay.
hourHour.
minuteMinute.
secondSecond.
millisecondMillisecond.
eraEra.
Returns
DateTime object that has specified components.

Reimplemented in System::Globalization::GregorianCalendar, System::Globalization::KoreanCalendar, System::Globalization::ThaiBuddhistCalendar, System::Globalization::TaiwanCalendar, System::Globalization::JapaneseCalendar, and System::Globalization::HebrewCalendar.

◆ ToDateTimeInternal()

DateTime System::Globalization::Calendar::ToDateTimeInternal ( int  year,
int  month,
int  day,
int  hour,
int  minute,
int  second,
int  millisecond,
int  era 
) const
protected

Constructs DateTime object from components.

◆ ToFourDigitYear()

virtual ASPOSECPP_SHARED_API int System::Globalization::Calendar::ToFourDigitYear ( int  year) const
virtual

Converts the year to 4-digit year using TwoDigitYearMax property.

Returns
Four-digit representation of year.

◆ UseExtendedYearField()

void System::Globalization::Calendar::UseExtendedYearField ( )
protected

Use the UCAL_EXTENDED_YEAR field instead of the UCAL_YEAR field. Must be set for the ChineseLunisolar-based calendars.

◆ VerifyDate()

virtual void System::Globalization::Calendar::VerifyDate ( int  year,
int  month,
int  day,
int  era 
) const
protectedvirtual

Verify year, month, day and era values.

Exceptions
ArgumentExceptionIf year, month, day or era has invalid values.

◆ VerifyDateTimeRange()

void System::Globalization::Calendar::VerifyDateTimeRange ( DateTime  time) const
protected

Verify time value.

Exceptions
ArgumentOutOfRangeExceptionIf time is out of range.

◆ VerifyMonth()

virtual void System::Globalization::Calendar::VerifyMonth ( int  year,
int  month,
int  era 
) const
protectedvirtual

Verify year, month and era values.

Exceptions
ArgumentExceptionIf year, month or era has invalid values.

◆ VerifyTime()

void System::Globalization::Calendar::VerifyTime ( int  hour,
int  minute,
int  second,
int  millisecond 
) const
protected

Verify hour, minute, second and millisecond values.

Exceptions
ArgumentExceptionIf hour, minute, second or millisecond has invalid values.

◆ VerifyWriteable()

void System::Globalization::Calendar::VerifyWriteable ( ) const
protected

Verify that calendar is not read-only.

◆ VerifyYear()

virtual void System::Globalization::Calendar::VerifyYear ( int  year,
int  era 
) const
protectedvirtual

Verify year and era values.

Exceptions
ArgumentExceptionIf year or era has invalid values.

Member Data Documentation

◆ CurrentEra

constexpr int System::Globalization::Calendar::CurrentEra = 0
staticprotected

Current era value.