BaseCalendar Class

Quartz.NET 3.0 API Documentation
This implementation of the Calendar may be used (you don't have to) as a base class for more sophisticated one's. It merely implements the base functionality required by each Calendar.
Inheritance Hierarchy
SystemObject
  Quartz.Impl.CalendarBaseCalendar
    More...

Namespace:  Quartz.Impl.Calendar
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax
C#
Copy
[SerializableAttribute]
public class BaseCalendar : ICalendar, 
	ISerializable, IEquatable<BaseCalendar>

The BaseCalendar type exposes the following members.

Constructors
  NameDescription
Public methodBaseCalendar
Initializes a new instance of the BaseCalendar class.
Public methodBaseCalendar(TimeZoneInfo)
Initializes a new instance of the BaseCalendar class.
Public methodBaseCalendar(ICalendar)
Initializes a new instance of the BaseCalendar class.
Protected methodBaseCalendar(SerializationInfo, StreamingContext)
Serialization constructor.
Public methodBaseCalendar(ICalendar, TimeZoneInfo)
Initializes a new instance of the BaseCalendar class.
Top
Properties
  NameDescription
Public propertyCalendarBase
Set a new base calendar or remove the existing one
Public propertyDescription
Gets or sets the description given to the ICalendar instance by its creator (if any).
Public propertyTimeZone
Gets or sets the time zone.
Top
Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
Protected methodCloneFields
Public methodEquals(Object) (Overrides ObjectEquals(Object).)
Public methodEquals(BaseCalendar)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode (Overrides ObjectGetHashCode.)
Public methodGetNextIncludedTimeUtc
Determine the next UTC time (in milliseconds) that is 'included' by the Calendar after the given time. Return the original value if timeStamp is included. Return 0 if all days are excluded.
Public methodGetObjectData
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsTimeIncluded
Check if date/time represented by timeStamp is included. If included return true. The implementation of BaseCalendar simply calls the base calendars IsTimeIncluded() method if base calendar is set.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
Regarded as base functionality is the treatment of base calendars. Base calendar allow you to chain (stack) as much calendars as you may need. For example to exclude weekends you may use WeeklyCalendar. In order to exclude holidays as well you may define a WeeklyCalendar instance to be the base calendar for HolidayCalendar instance.
See Also

Reference

Quartz.Impl.Calendar Namespace
QuartzICalendar
Inheritance Hierarchy
SystemObject
  Quartz.Impl.CalendarBaseCalendar
    Quartz.Impl.CalendarAnnualCalendar
    Quartz.Impl.CalendarCronCalendar
    Quartz.Impl.CalendarDailyCalendar
    Quartz.Impl.CalendarHolidayCalendar
    Quartz.Impl.CalendarMonthlyCalendar
    Quartz.Impl.CalendarWeeklyCalendar