Asposecpplib
System::Globalization::PersianCalendar Class Reference

Persian calendar. 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...

Inherits System::Globalization::Calendar.

Public Member Functions

 PersianCalendar ()
 Constructor. More...
 
CalendarAlgorithmType get_AlgorithmType () const override
 Gets algorithm type. More...
 
DateTime get_MinSupportedDateTime () const override
 Minimal point in time that is supported by the calendar. More...
 
DateTime get_MaxSupportedDateTime () const override
 Maximal point in time that is supported by the calendar. More...
 
ArrayPtr< int > get_Eras () const override
 Gets list of eras existing in calendar. More...
 
int GetDaysInMonth (int year, int month, int era) const override
 Gets number of days in specific month. More...
 
int GetDaysInYear (int year, int era) const override
 Gets number of days in specific year. More...
 
int GetMonthsInYear (int year, int era) const override
 Gets number of months in the specified year. More...
 
DayOfWeek GetDayOfWeek (DateTime time) const override
 Gets day of week for the specified time point. More...
 
int GetLeapMonth (int year, int era) const override
 Gets the leap month for the specified year. More...
 
bool IsLeapYear (int year, int era) const override
 Checks if the year is leap. More...
 
bool IsLeapDay (int year, int month, int day, int era) const override
 Checks if the day is leap. More...
 
bool IsLeapMonth (int year, int month, int era) const override
 Checks if the month is leap. More...
 
SharedPtr< ObjectClone () override
 Creates a copy of the current object and returns a shared pointer to it. More...
 
virtual int GetDaysInMonth (int year, int month) const
 RTTI information. More...
 
virtual int GetDaysInMonth (int year, int month, int era) const
 RTTI information. More...
 
virtual int GetDaysInYear (int year) const
 Gets number of days in specific year. More...
 
virtual int GetDaysInYear (int year, int era) const
 Gets number of days in specific year. More...
 
virtual int GetMonthsInYear (int year) const
 Gets number of months in the specified year. More...
 
virtual int GetMonthsInYear (int year, int era) const
 Gets number of months in the specified year. More...
 
virtual int GetLeapMonth (int year) const
 Gets the leap month for the specified year. More...
 
virtual int GetLeapMonth (int year, int era) const=0
 Gets the leap month for the specified year. More...
 
virtual bool IsLeapDay (int year, int month, int day) const
 Checks if the day is leap. More...
 
virtual bool IsLeapDay (int year, int month, int day, int era) const=0
 Checks if the day is leap. More...
 
virtual bool IsLeapMonth (int year, int month) const
 Checks if the month is leap. More...
 
virtual bool IsLeapMonth (int year, int month, int era) const
 Checks if the month is leap. More...
 
virtual bool IsLeapYear (int year) const
 Checks if the year is leap. More...
 
virtual bool IsLeapYear (int year, int era) const=0
 Checks if the year is leap. More...
 
- Public Member Functions inherited from System::Globalization::Calendar
 Calendar (const Calendar &)=delete
 RTTI information. More...
 
Calendaroperator= (const Calendar &)=delete
 
virtual DateTime AddDays (DateTime time, int days) const
 Adds days to time point. More...
 
virtual DateTime AddHours (DateTime time, int hours) const
 Adds hours to time point. More...
 
virtual DateTime AddMilliseconds (DateTime time, double milliseconds) const
 Adds milliseconds to time point. More...
 
virtual DateTime AddMinutes (DateTime time, int minutes) const
 Adds minutes to time point. More...
 
virtual DateTime AddMonths (DateTime time, int months) const
 Adds months to time point. More...
 
virtual DateTime AddSeconds (DateTime time, int seconds) const
 Adds seconds to time point. More...
 
virtual DateTime AddWeeks (DateTime time, int weeks) const
 Adds weeks to time point. More...
 
virtual DateTime AddYears (DateTime time, int years) const
 Adds years to time point. More...
 
virtual int GetDayOfMonth (DateTime time) const
 Gets day of month for the specified time point. More...
 
virtual int GetDayOfYear (DateTime time) const
 Gets day of year for the specified time point. More...
 
virtual int GetDaysInMonth (int year, int month) const
 Gets number of days in specific month. More...
 
virtual int GetDaysInYear (int year) const
 Gets number of days in specific year. More...
 
virtual int GetEra (DateTime time) const
 Gets era for the specified time point. More...
 
virtual int GetHour (DateTime time) const
 Gets hours for the specified time point. More...
 
virtual int GetLeapMonth (int year) const
 Gets the leap month for the specified year. More...
 
virtual double GetMilliseconds (DateTime time) const
 Gets milliseconds for the specified time point. More...
 
virtual int GetMinute (DateTime time) const
 Gets minutes for the specified time point. More...
 
virtual int GetMonth (DateTime time) const
 Gets month for the specified time point. More...
 
virtual int GetMonthsInYear (int year) const
 Gets number of months in the specified year. More...
 
virtual int GetSecond (DateTime time) const
 Gets seconds for the specified time point. More...
 
virtual int GetWeekOfYear (DateTime time, CalendarWeekRule rule, DayOfWeek first_day_of_week) const
 Gets week of the year for the specified time point. More...
 
virtual int GetYear (DateTime time) const
 Gets year for the specified time point. More...
 
virtual bool IsLeapDay (int year, int month, int day) const
 Checks if the day is leap. More...
 
virtual bool IsLeapMonth (int year, int month) const
 Checks if the month is leap. More...
 
virtual bool IsLeapYear (int year) const
 Checks if the year is leap. More...
 
virtual DateTime ToDateTime (int year, int month, int day, int hour, int minute, int second, int millisecond) const
 Constructs DateTime object from components. More...
 
virtual 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...
 
bool get_IsReadOnly () const
 Checks if the calendar is read only. More...
 
int get_CurrentEra () const
 Gets index of current era. More...
 
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 int get_TwoDigitYearMax () const
 Gets the last year that can be represented by a 2-digit. More...
 
virtual void set_TwoDigitYearMax (int value)
 Sets the last year that can be represented by a 2-digit. More...
 
virtual int ToFourDigitYear (int year) const
 Converts the year to 4-digit year using TwoDigitYearMax property. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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 bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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 Attributes

static constexpr int PersianEra = 1
 Current persian era. More...
 

Protected Member Functions

Details::CalendarId get_ID () const override
 Gets calendar identifier. More...
 
- Protected Member Functions inherited from System::Globalization::Calendar
 Calendar ()
 Default constructor. More...
 
 Calendar (std::unique_ptr< icu::Calendar > &&calendar)
 Constructor. More...
 
virtual bool IsGregorianBasedCalendar () const
 Checks if the calendar is Gregorian-based. 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...
 
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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Globalization::Calendar
static 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...
 
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...
 
- Static Protected Attributes inherited from System::Globalization::Calendar
static constexpr int CurrentEra = 0
 Current era value. More...
 

Detailed Description

Persian calendar. 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

◆ PersianCalendar()

System::Globalization::PersianCalendar::PersianCalendar ( )

Constructor.

Member Function Documentation

◆ Clone()

SharedPtr<Object> System::Globalization::PersianCalendar::Clone ( )
overridevirtual

Creates a copy of the current object and returns a shared pointer to it.

Implements System::ICloneable.

◆ get_AlgorithmType()

CalendarAlgorithmType System::Globalization::PersianCalendar::get_AlgorithmType ( ) const
overridevirtual

Gets algorithm type.

Returns
Value indicating how the calendar is built.

Implements System::Globalization::Calendar.

◆ get_Eras()

ArrayPtr<int> System::Globalization::PersianCalendar::get_Eras ( ) const
overridevirtual

Gets list of eras existing in calendar.

Returns
Array of numbers defining eras numbers.

Implements System::Globalization::Calendar.

◆ get_ID()

Details::CalendarId System::Globalization::PersianCalendar::get_ID ( ) const
overrideprotectedvirtual

Gets calendar identifier.

Returns
Identifier as defined by calendar.

Reimplemented from System::Globalization::Calendar.

◆ get_MaxSupportedDateTime()

DateTime System::Globalization::PersianCalendar::get_MaxSupportedDateTime ( ) const
overridevirtual

Maximal point in time that is supported by the calendar.

Implements System::Globalization::Calendar.

◆ get_MinSupportedDateTime()

DateTime System::Globalization::PersianCalendar::get_MinSupportedDateTime ( ) const
overridevirtual

Minimal point in time that is supported by the calendar.

Implements System::Globalization::Calendar.

◆ GetDayOfWeek()

DayOfWeek System::Globalization::PersianCalendar::GetDayOfWeek ( DateTime  time) const
overridevirtual

Gets day of week for the specified time point.

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

Reimplemented from System::Globalization::Calendar.

◆ GetDaysInMonth() [1/3]

virtual int System::Globalization::Calendar::GetDaysInMonth

RTTI information.

◆ GetDaysInMonth() [2/3]

virtual int System::Globalization::Calendar::GetDaysInMonth

RTTI information.

◆ GetDaysInMonth() [3/3]

int System::Globalization::PersianCalendar::GetDaysInMonth ( int  year,
int  month,
int  era 
) const
overridevirtual

Gets number of days in specific month.

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

Reimplemented from System::Globalization::Calendar.

◆ GetDaysInYear() [1/3]

virtual int System::Globalization::Calendar::GetDaysInYear

Gets number of days in specific year.

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

◆ GetDaysInYear() [2/3]

virtual int System::Globalization::Calendar::GetDaysInYear

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.

◆ GetDaysInYear() [3/3]

int System::Globalization::PersianCalendar::GetDaysInYear ( int  year,
int  era 
) const
overridevirtual

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 from System::Globalization::Calendar.

◆ GetLeapMonth() [1/3]

virtual int System::Globalization::Calendar::GetLeapMonth

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/3]

int System::Globalization::PersianCalendar::GetLeapMonth ( int  year,
int  era 
) const
overridevirtual

Gets the leap month for the specified year.

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

Implements System::Globalization::Calendar.

◆ GetLeapMonth() [3/3]

virtual int System::Globalization::Calendar::GetLeapMonth

Gets the leap month for the specified year.

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

◆ GetMonthsInYear() [1/3]

virtual int System::Globalization::Calendar::GetMonthsInYear

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/3]

virtual int System::Globalization::Calendar::GetMonthsInYear

Gets number of months in the specified year.

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

◆ GetMonthsInYear() [3/3]

int System::Globalization::PersianCalendar::GetMonthsInYear ( int  year,
int  era 
) const
overridevirtual

Gets number of months in the specified year.

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

Reimplemented from System::Globalization::Calendar.

◆ IsLeapDay() [1/3]

virtual bool System::Globalization::Calendar::IsLeapDay

Checks if the day is leap.

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

◆ IsLeapDay() [2/3]

bool System::Globalization::PersianCalendar::IsLeapDay ( int  year,
int  month,
int  day,
int  era 
) const
overridevirtual

Checks if the day is leap.

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

Implements System::Globalization::Calendar.

◆ IsLeapDay() [3/3]

virtual bool System::Globalization::Calendar::IsLeapDay

Checks if the day is leap.

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

◆ IsLeapMonth() [1/3]

virtual bool System::Globalization::Calendar::IsLeapMonth

Checks if the month is leap.

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

◆ IsLeapMonth() [2/3]

virtual bool System::Globalization::Calendar::IsLeapMonth

Checks if the month is leap.

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

◆ IsLeapMonth() [3/3]

bool System::Globalization::PersianCalendar::IsLeapMonth ( int  year,
int  month,
int  era 
) const
overridevirtual

Checks if the month is leap.

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

Reimplemented from System::Globalization::Calendar.

◆ IsLeapYear() [1/3]

virtual bool System::Globalization::Calendar::IsLeapYear

Checks if the year is leap.

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

◆ IsLeapYear() [2/3]

bool System::Globalization::PersianCalendar::IsLeapYear ( int  year,
int  era 
) const
overridevirtual

Checks if the year is leap.

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

Implements System::Globalization::Calendar.

◆ IsLeapYear() [3/3]

virtual bool System::Globalization::Calendar::IsLeapYear

Checks if the year is leap.

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

Member Data Documentation

◆ PersianEra

constexpr int System::Globalization::PersianCalendar::PersianEra = 1
staticconstexpr

Current persian era.