[JEDI.NET-commits] docs Jedi.Timers.Schedules.xml,NONE,1.1

[Marcel B. <jed...@us...>]

Update of /cvsroot/jedidotnet/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24373/docs

Added Files:
	Jedi.Timers.Schedules.xml 
Log Message:
Partially done with the Schedules documentation

--- NEW FILE: Jedi.Timers.Schedules.xml ---
<?xml version="1.0" encoding="utf-8"?>
<!--Timestamp most recent auto generation: 2005-06-19 06:13:14 UTC-->
<members>
  <member name="T:Jedi.Timers.DaySchedule">
    <summary>
      Schedule to select single days within an optional parent schedule.
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Day"
           arg1="day"
           arg2="days"
           arg3="64" />
  <member name="M:Jedi.Timers.DaySchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)">
    <exclude />
  </member>
  <member name="M:Jedi.Timers.DaySchedule.InternalUnitInterval">
    <exclude />
  </member>
  <member name="T:Jedi.Timers.FixedIntervalSchedule">
    <summary>
    </summary>
  </member>
  <member name="M:Jedi.Timers.FixedIntervalSchedule.#ctor(System.Int64,System.Int64,System.Int64,Jedi.Timers.Schedule[],Jedi.Timers.FixedIntervalSchedule.ParamInTicks)">
    <summary>
    </summary>
    <param name="start">
    </param>
    <param name="stop">
    </param>
    <param name="span">
    </param>
    <param name="schedules">
    </param>
    <param name="paramsInTicks">
    </param>
  </member>
  <member name="M:Jedi.Timers.FixedIntervalSchedule.CalculateOffset(System.Int64,System.Boolean)">
    <summary>
    </summary>
    <param name="parentStart">
    </param>
    <param name="isLimit">
    </param>
    <returns>
    </returns>
  </member>
  <member name="M:Jedi.Timers.FixedIntervalSchedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)">
    <exclude />
  </member>
  <member name="M:Jedi.Timers.FixedIntervalSchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)">
    <exclude />
  </member>
  <member name="M:Jedi.Timers.FixedIntervalSchedule.InternalUnitInterval">
    <summary>
    </summary>
    <returns>
    </returns>
  </member>
  <member name="P:Jedi.Timers.FixedIntervalSchedule.Interval">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="T:Jedi.Timers.FixedIntervalSchedule.ParamInTicks">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.All">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Interval">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Limits">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.None">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Start">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.FixedIntervalSchedule.ParamInTicks.Stop">
    <summary>
    </summary>
  </member>
  <member name="M:Jedi.Timers.FixedIntervalSchedule.ScheduleLimit">
    <exclude />
  </member>
  <member name="P:Jedi.Timers.FixedIntervalSchedule.Span">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="P:Jedi.Timers.FixedIntervalSchedule.Start">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="P:Jedi.Timers.FixedIntervalSchedule.StartDT">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="P:Jedi.Timers.FixedIntervalSchedule.Stop">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="P:Jedi.Timers.FixedIntervalSchedule.StopDT">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="T:Jedi.Timers.HourSchedule">
    <summary>
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Hour"
           arg1="hour"
           arg2="hours" 
           arg3="64" />
  <member name="M:Jedi.Timers.HourSchedule.InternalUnitInterval">
    <exclude />
  </member>
  <member name="T:Jedi.Timers.MillisecondSchedule">
    <summary>
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Millisecond"
           arg1="millisecond"
           arg2="milliseconds" 
           arg3="64" />
  <member name="M:Jedi.Timers.MillisecondSchedule.InternalUnitInterval">
    <exclude />
  </member>
  <member name="T:Jedi.Timers.MinuteSchedule">
    <summary>
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Minute"
           arg1="minute"
           arg2="minutes" 
           arg3="64" />
  <member name="M:Jedi.Timers.MinuteSchedule.InternalUnitInterval">
    <exclude />
  </member>
  <member name="T:Jedi.Timers.MonthSchedule">
    <summary>
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Month"
           arg1="month"
           arg2="months" 
           arg3="32" />
  <member name="M:Jedi.Timers.MonthSchedule.FromMonths(System.Int32)">
    <summary>
    </summary>
    <param name="months">
    </param>
    <returns>
    </returns>
  </member>
  <member name="M:Jedi.Timers.MonthSchedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)">
    <exclude />
  </member>
  <member name="M:Jedi.Timers.MonthSchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)">
    <exclude />
  </member>
  <member name="P:Jedi.Timers.MonthSchedule.Interval">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="F:Jedi.Timers.MonthSchedule.MaxMonth">
    <summary>
    </summary>
  </member>
  <member name="M:Jedi.Timers.MonthSchedule.ScheduleLimit">
    <exclude />
  </member>
  <member name="P:Jedi.Timers.MonthSchedule.Start">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="P:Jedi.Timers.MonthSchedule.Stop">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="M:Jedi.Timers.MonthSchedule.ToMonths(System.DateTime)">
    <summary>
    </summary>
    <param name="date">
    </param>
    <returns>
    </returns>
  </member>
  <member name="T:Jedi.Timers.Schedule">
    <summary>
      Base class used to create complex schedules with varying intervals.
    </summary>
    <remarks>
      <para>
        Using derivatives of the <see cref="T:Jedi.Timers.Schedule" /> class, you can create any kind of schedule, as
        simple or as complex as you like.
      </para>
      <para>
        Each schedule will have the ability to add child schedules, thus serving as a date range limiter for these
        child schedules. A schedule can have multiple children. In cases where two or more child schedules select the
        exact same date, the first child to do so will be used. This is important to realize if the child schedules also
        have child schedules, since in that case only the child schedules of the first child schedule will be
        considered.
      </para>
      <para>
        To avoid the problem above, a defined schedule and its children can be wrapped as a single schedule. By wrapping
        them as one, you can assign child schedules to the entire selection. This is also useful in cases where a
        complex selection, with multiple children selecting various ranges, requires complex child selections. Instead
        of adding identical schedule hierarchies to all base selections, you can wrap the base selection and add one
        schedule hierarchy as its child.
      </para>
    </remarks>
  </member>
  <member name="M:Jedi.Timers.Schedule.#ctor(Jedi.Timers.Schedule[])">
    <summary>
      Initializes a new instance of the <see-class /> class.
    </summary>
    <param name="schedules">
      Child schedules to add to the schedule immediately.
    </param>
  </member>
  <member name="M:Jedi.Timers.Schedule.AddSchedule(Jedi.Timers.Schedule)">
    <overloads>
      Adds one or more schedules as children of this schedule.
    </overloads>
    <summary>
      Adds a schedule as a child of this schedule.
    </summary>
    <param name="schedule">
      The schedule to add as a child of this schedule.
    </param>
  </member>
  <member name="M:Jedi.Timers.Schedule.AddSchedule(Jedi.Timers.Schedule[])">
    <summary>
      Adds several schedules as child schedules of this schedule.
    </summary>
    <param name="schedules">
      The schedules to add as children of this schedule.
    </param>
  </member>
  <member name="E:Jedi.Timers.Schedule.Changed">
    <summary>
      The event that is raised when the schedule has been changed.
    </summary>
  </member>
  <member name="M:Jedi.Timers.Schedule.ClearSchedules">
    <summary>
      Removes all child schedules.
    </summary>
  </member>
  <member name="P:Jedi.Timers.Schedule.ContainedSchedules">
    <summary>
      The internal list of child schedules.
    </summary>
    <value>
      An <see cref="T:System.Collections.ArrayList" /> containing all child schedules.
    </value>
    <remarks>
      Derivatives should not modify this list; instead use the <see cref="M:Jedi.Timers.Schedule.AddSchedule" />,
      <see cref="M:Jedi.Timers.Schedule.ClearSchedules" /> and
      <see cref="M:Jedi.Timers.Schedule.RemoveSchedule(Jedi.Timers.Schedule)" /> methods.
    </remarks>
  </member>
  <member name="T:Jedi.Timers.Schedule.Enumerator">
    <summary>
    </summary>
  </member>
  <member name="M:Jedi.Timers.Schedule.Enumerator.#ctor(Jedi.Timers.Schedule,System.DateTime,System.Boolean)">
    <summary>
      Initializes a new instance of the <see-class /> class.
    </summary>
    <param name="owner">
      The <see cref="T:Jedi.Timers.Schedule" /> instance to which this enumerator belongs.
    </param>
    <param name="from">
      A <see cref="T:System.DateTime" /> indicating the starting point of the enumerator. Note that this should
      be greater than <ref type="System.DateTime" member="MinValue" memberType="F" />.
    </param>
    <param name="recursive">
      <true-if> the child schedules should be considered when enumerating</true-if>
    </param>
  </member>
  <member name="M:Jedi.Timers.Schedule.Enumerator.Clone">
    <exclude />
  </member>
  <member name="M:Jedi.Timers.Schedule.Enumerator.get_Current">
    <exclude />
  </member>
  <member name="M:Jedi.Timers.Schedule.Enumerator.MoveNext">
    <exclude />
  </member>
  <member name="P:Jedi.Timers.Schedule.Enumerator.Owner">
    <summary>
      Indicates the owning <see cref="T:Jedi.Timers.Schedule" /> of the enumerator.
    </summary>
    <value>
      A reference to a <see cref="T:jedi.Timers.Schedule" /> derivative that is the owner of the enumerator.
    </value>
  </member>
  <member name="M:Jedi.Timers.Schedule.Enumerator.Reset">
    <exclude />
  </member>
  <member name="F:Jedi.Timers.Schedule.FVersion">
    <summary>
      The internal version of the schedule.
    </summary>
    <remarks>
      This field is used internally by the enumerator to check whether the schedule has changed since the enumerator
      was first created. The value is incremented upon each call to <see cref="M:Jedi.Timers.Schedule.Modified" />,
      which in turn is called automatically when one of the schedule properties are changed.
    </remarks>
  </member>
  <member name="M:Jedi.Timers.Schedule.GetEnumerator">
    <overloads>
      Retrieves an enumerator to enumerate through the list of scheduled dates and times.
    </overloads>
    <summary>
      Retrieves an enumerator to enumerate through the list of scheduled dates and times as specified in the entire
      schedule hierarchy.
    </summary>
    <returns>
      An <see cref="T:System.Collections.IEnumerator" /> that is the requested enumerator.
    </returns>
  </member>
  <member name="M:Jedi.Timers.Schedule.GetEnumerator(System.Boolean)">
    <summary>
      Retrieves an enumerator to enumerate through the list of scheduled dates and times, optionally include the
      entire schedule hierarchy.
    </summary>
    <param name="recursive">
      <see langword="true" /> if the entire schedule hierarchy should be enumerated. <see langword="false" /> if only
      the date and times of this schedule should be enumerated.
    </param>
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator"]/returns' />
  </member>
  <member name="M:Jedi.Timers.Schedule.GetEnumerator(System.DateTime)">
    <summary>
      Retrieves an enumerator to enumerate through the list of scheduled dates and times as specified in the entire
      schedule hierarchy, starting at a specific date/time.
    </summary>
    <param name="from">
    </param>
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator"]/returns' />
  </member>
  <member name="M:Jedi.Timers.Schedule.GetEnumerator(System.DateTime,System.Boolean)">
    <summary>
      Retrieves an enumerator to enumerate through the list of scheduled dates and times, optionally include the
      entire schedule hierarchy, starting at a specific date/time.
    </summary>
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator(System.DateTime)"]/param[@name="from"]' />
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator(System.Boolean)"]/param[@name="recursive"]' />
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetEnumerator"]/returns' />
  </member>
  <member name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)">
    <summary>
      Determines the selection range for child schedules, considering all parent schedules.
    </summary>
    <param name="date">
      The date for which to determine the selection range.
    </param>
    <param name="start">
      <para>
        Upon return, a <see cref="T:System.DateTime" /> indicating the start of this schedules selection range
      </para>
      <para>-or-</para>
      <para>
        <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the date does not lie within
        the schedule's defined range.
      </para>
    </param>
    <param name="stop">
      <para>
        Upon return, a <see cref="T:System.DateTime" /> indicating the end of this schedules selection range
      </para>
      <para>-or-</para>
      <para>
        <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the date does not lie within
        the schedule's defined range.
      </para>
    </param>
  </member>
  <member name="M:Jedi.Timers.Schedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)">
    <summary>
      Determines the selection range for child schedules, considering this schedule only.
    </summary>
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="date"]' />
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="start"]' />
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.GetLimitsFor(System.DateTime,System.DateTime@,System.DateTime@)"]/param[@name="stop"]' />
    <remarks>
      <para>
        Inheritors should implement this method in such a way that if <paramref name="date" /> lies before the first
        selection, or in between two selections, the next available selection range is returned.
      </para>
      <para>
        Even though this method will return a range based on this schedule only, in most scenarios any parent schedules
        will have to be consulted to determine the selection range for this schedule. However, the returned range may
        start before or end after the parent selection. This allows cases where the selection start, which influences
        child schedules, lies before the parent's selection, eg. when selecting week numbers, which may start a few
        days before the first of the month. Actually selected dates (as returned by
        <see cref="M:Jedi.Timers.Schedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)" />) will always
        be limited to the limits imposed by all parent schedules.
      </para>
    </remarks>
  </member>
  <member name="M:Jedi.Timers.Schedule.GetNext(System.DateTime,System.Boolean)">
    <summary>
      Retrieves the next date in the schedule from a given date.
    </summary>
    <param name="from">
      The minimum date to retrieve. The returned value is guaranteed to be greater than or equal to this date.
    </param>
    <param name="recursive">
      Flag to indicate whether child schedules are to be considered (<see langword="true" />) or not
      (<see langword="false" />)
    </param>
    <returns>
      <para>A <see cref="T:System.DateTime" /> of the next date according to the schedule or its hierarchy</para>
      <para>-or-</para>
      <para>
        <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if no more dates follow the one
        specified by the <paramref name="from" /> parameter.
      </para>
    </returns>
    <seealso cref="M:Jedi.Timers.Schedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)" />
  </member>
  <member name="M:Jedi.Timers.Schedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)">
    <summary>
      Retrieves the next date of this schedule.
    </summary>
    <param name="date">
      The minimum date to retrieve.
    </param>
    <param name="offset">
      <para>The starting date of the parent schedule</para>
      <para>-or-</para>
      <para>
        <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MinValue" /> if the schedule doesn't have a
        parent schedule.
      </para>
    </param>
    <param name="maxDate">
      <para>The end date of the parent schedule</para>
      <para>-or-</para>
      <para>
        <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the schedule doesn't have a
        parent schedule.
      </para>
      <para>
        Implementers are not required to adjust the return value if it happens to be greater than this parameter.
      </para>
    </param>
    <returns>
      <para>A <see cref="T:System.DateTime" /> representing the next date of this schedule</para>
      <para>-or-</para>
      <para>
        <see cref="T:System.DateTime" />.<see cref="F:System.DateTime.MaxValue" /> if the schedule doesn't have a
        next date.
      </para>
    </returns>
    <remarks>
      <para>
        Inheritors should implement this method to return the next date for this schedule, ignoring any child schedules
        that may have been assigned. The value should not be smaller that the one specified by the
        <paramref name="offset" /> parameter or the one specified by the <paramref name="date" /> parameter.
      </para>
      <para>
        Normally, the date returned by this method should be the same as the one returned in the start parameter of the
        <see cref="M:Jedi.Timers.Schedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)" />
        method.
      </para>
    </remarks>
    <seealso cref="M:Jedi.Timers.Schedule.GetNext(System.DateTime,System.Boolean)" />
  </member>
  <member name="M:Jedi.Timers.Schedule.IsValidDate(System.DateTime)">
    <summary>
      Determines whether the specified date is a valid date for this schedule.
    </summary>
    <param name="date">
      The date to check for validity.
    </param>
    <returns>
      <see langword="true" /> if the date specified by the <paramref name="date" /> parameter is valid for this
      schedule; <see langword="false" /> otherwise.
    </returns>
  </member>
  <member name="M:Jedi.Timers.Schedule.Modified">
    <summary>
      Marks the schedule as changed.
    </summary>
    <remarks>
      <para>
        This method will increment the <see cref="F:Jedi.Timers.Schedules.Schedule.FVersion" /> field and
        call the <see cref="M:Jedi.Timers.Schedules.Schedule.OnChanged" /> method.
      </para>
      <para>
      	Derivatives should call this method from every property setter that might change the list of scheduled
      	dates.
      </para>
    </remarks>
  </member>
  <member name="M:Jedi.Timers.Schedule.OnChanged">
    <summary>
      Raises the <see cref="E:Jedi.Timers.Schedule.Changed" /> event.
    </summary>
  </member>
  <member name="P:Jedi.Timers.Schedule.Parent">
    <summary>
      Reference to the parent (owner) of this schedule.
    </summary>
    <value>
      <para>The <see cref="T:Jedi.Timers.Schedule" /> (or derivative) that is the owner of this schedule</para>
      <para>-or-</para>
      <para><see langword="null" /> if this schedule is at the root of the hierarchy.</para>
    </value>
  </member>
  <member name="M:Jedi.Timers.Schedule.RemoveSchedule(Jedi.Timers.Schedule)">
    <summary>
      Removes a schedule from the list of child schedules.
    </summary>
    <param name="schedule">
      The schedule to remove from the list of child schedules.
    </param>
  </member>
  <member name="M:Jedi.Timers.Schedule.RemoveScheduleAt(System.Int32)">
    <summary>
      Removes a schedule from the list of child schedules.
    </summary>
    <param name="index">
      The zero-based index of the schedule to remove from the list of child schedules.
    </param>
  </member>
  <member name="M:Jedi.Timers.Schedule.RemoveSchedulesInRange(System.Int32,System.Int32)">
    <summary>
      Removes a range of schedules from the list of child schedules.
    </summary>
    <param name="index">
      The zero-based index of the first schedule to remove from the list of child schedules.
    </param>
    <param name="count">
      The number of schedules to remove from the list of child schedules.
    </param>
  </member>
  <member name="P:Jedi.Timers.Schedule.Schedule(System.Int32)">
    <summary>
      Retrieves a reference to a child schedule.
    </summary>
    <param name="index">
      The zero-based index of the child schedule to retrieve.
    </param>
    <value>
      A reference to a <see cref="T:Jedi.Timers.Schedule" /> derivative that is the specified child schedule.
    </value>
  </member>
  <member name="P:Jedi.Timers.Schedule.ScheduleCount">
    <summary>
      Contains the number of child schedules.
    </summary>
    <value>
      An <see cref="T:System.Int32" /> indicating how many child schedules have been assigned to this schedule.
    </value>
  </member>
  <member name="M:Jedi.Timers.Schedule.ScheduleLimit">
    <summary>
      Indicates the maximum time span this schedule will select for its child schedules.
    </summary>
    <returns>
      A <see cref="T:System.TimeSpan" /> indicating the maximum time span the schedule will select for its child
      schedules.
    </returns>
    <remarks>
      Derivatives will need to specify the amount of time this schedule will select. The value returned is used to
      determine whether one schedule class can be a child of another schedule class. Child schedules can only be
      assigned when their maximum time span is less than that of their prospective parent schedule.
    </remarks>
  </member>
  <member name="M:Jedi.Timers.Schedule.SetParent(Jedi.Timers.Schedule)">
    <summary>
      Sets the parent schedule for this schedule.
    </summary>
    <param name="schedule">
      The schedule to set as parent.
    </param>
    <remarks>
    	This method is called internally when a schedule is added to the list of child schedules of another schedule.
    </remarks>
  </member>
  <member name="M:Jedi.Timers.Schedule.Wrap(Jedi.Timers.Schedule)">
    <overloads>
      Wraps a schedule hierarchy as a single schedule.
    </overloads>
    <summary>
      Wraps a schedule hierarchy as a single schedule.
    </summary>
    <remarks>
      <para>
        Wrapping a schedule hierarchy as a single hierarchy is often used when a complex hierarchy is defined to select
        a certain range, but each of selections in that range requires the exact same child selections.
      </para>
      <para>
        For example, suppose you want to select every 15 minutes in every 4 hours of every odd day of the odd months
        and every 15 minutes in every 4 hours of every even day of the even months. To do this, you would define the
        schedule hierarchy for selecting the appropriate months and days, pass it to the Wrap method and add the
        schedule hierarchy for selecting the appropriate hours and months to the returned schedule.
      </para>
    </remarks>
    <param name="scheduleHierarchy">
      The schedule hierarchy to wrap as a single schedule.
    </param>
    <returns>
      A reference to a <see cref="T:Jedi.Timers.Schedule" /> derivative that represents the wrapped hierarchy.
    </returns>
  </member>
  <member name="M:Jedi.Timers.Schedule.Wrap(Jedi.Timers.Schedule,Jedi.Timers.Schedule[])">
    <summary>
      Wraps a schedule hierarchy as a single schedule and adds the specified child schedules.
    </summary>
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.Wrap(Jedi.Timers.Schedule)"]/param[@name="scheduleHierarchy"]' />
    <param name="schedules">
      The schedules to add as children of the wrapped schedule.
    </param>
    <include file='Jedi.Timers.Schedules.xml' path='/members/member[@name="M:Jedi.Timers.Schedule.Wrap(Jedi.Timers.Schedule)"]/returns' />
  </member>
  <member name="T:Jedi.Timers.ScheduleException">
    <summary>
      The exception that is thrown when an error with <see cref="T:Jedi.Timers.Schedule">schedules</see> occurs.
    </summary>
  </member>
  <member name="M:Jedi.Timers.ScheduleException.#ctor">
  	<exclude />
  </member>
  <member name="M:Jedi.Timers.ScheduleException.#ctor(System.String)">
  	<exclude />
  </member>
  <member name="M:Jedi.Timers.ScheduleException.#ctor(System.String,System.Exception)">
  	<exclude />
  </member>
  <member name="T:Jedi.Timers.SecondSchedule">
    <summary>
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Second"
           arg1="second"
           arg2="seconds" 
           arg3="64" />
  <member name="M:Jedi.Timers.SecondSchedule.InternalUnitInterval">
    <exclude />
  </member>
  <member name="T:Jedi.Timers.TickSchedule">
    <summary>
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Tick"
           arg1="tick (100 nanoseconds)"
           arg2="ticks (multiples of 100 nanoseconds)" 
           arg3="64" />
  <member name="M:Jedi.Timers.TickSchedule.InternalUnitInterval">
    <exclude />
  </member>
  <member name="T:Jedi.Timers.WeekSchedule">
    <summary>
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Week"
           arg1="week"
           arg2="weeks" 
           arg3="64" />
  <member name="P:Jedi.Timers.WeekSchedule.FirstDayOfWeek">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="P:Jedi.Timers.WeekSchedule.FirstPartialWeek">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="M:Jedi.Timers.WeekSchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)">
    <exclude />
  </member>
  <member name="M:Jedi.Timers.WeekSchedule.InternalUnitInterval">
    <exclude />
  </member>
  <member name="P:Jedi.Timers.WeekSchedule.LastPartialWeek">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="T:Jedi.Timers.WeekSchedule.PartialWeekOption">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.Allowed">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.ForChildSchedulesOnly">
    <summary>
    </summary>
  </member>
  <member name="F:Jedi.Timers.WeekSchedule.PartialWeekOption.NotAllowed">
    <summary>
    </summary>
  </member>
  <member name="T:Jedi.Timers.YearSchedule">
    <summary>
    </summary>
  </member>
  <include file='snippets\Jedi.Timers.Schedules.xml' path='/snippets/ScheduleCommonMembers/*'
           arg0="Year"
           arg1="year"
           arg2="years" 
           arg3="32" />
  <member name="M:Jedi.Timers.YearSchedule.GetLimitsForImpl(System.DateTime,System.DateTime@,System.DateTime@)">
    <exclude />
  </member>
  <member name="M:Jedi.Timers.YearSchedule.GetNextImpl(System.DateTime,System.DateTime,System.DateTime)">
    <exclude />
  </member>
  <member name="P:Jedi.Timers.YearSchedule.Interval">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="M:Jedi.Timers.YearSchedule.ScheduleLimit">
    <exclude />
  </member>
  <member name="P:Jedi.Timers.YearSchedule.Start">
    <summary>
    </summary>
    <value>
    </value>
  </member>
  <member name="P:Jedi.Timers.YearSchedule.Stop">
    <summary>
    </summary>
    <value>
    </value>
  </member>
</members>