ICalendar.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ICalendar.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/object.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class Duration;
class Task;
class WorkingTimeCollection;
class WorkUnit;
} // namespace Tasks
} // namespace Aspose
namespace System
{
class DateTime;
class TimeSpan;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a calendar abstraction which can be used for various calculations of dates and durations.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ICalendar : public virtual System::Object
{
    typedef ICalendar ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
public:
 
    /// <summary>
    /// Returns start date based on the specified finish date and duration.
    /// </summary>
    /// <param name="finish">The specified finish date.</param>
    /// <param name="duration">The specified duration.</param>
    /// <returns>Calculated start date.</returns>
    virtual System::DateTime GetStartDateFromFinishAndDuration(System::DateTime finish, Duration duration) = 0;
    /// <summary>
    /// Returns start date based on specified finish date and duration.
    /// </summary>
    /// <param name="finish">The specified finish date.</param>
    /// <param name="duration">The specified duration.</param>
    /// <returns>Calculated start date.</returns>
    virtual System::DateTime GetStartDateFromFinishAndDuration(System::DateTime finish, System::TimeSpan duration) = 0;
    /// <summary>
    /// Determines whether the specified day is a working day according to the calendar.
    /// </summary>
    /// <param name="dt">The date to check whether the day is working.</param>
    /// <returns>True if the day is a working day.</returns>
    virtual bool IsDayWorking(System::DateTime dt) = 0;
    /// <summary>
    /// Returns WorkUnit - Start, Finish and Duration of working hours for the specified date time interval.
    /// </summary>
    /// <param name="start">Start date of the interval.</param>
    /// <param name="finish">Finish date of the interval.</param>
    /// <returns>Instance of <see cref="WorkUnit"></see> class containing Start, Finish and Duration of working hours.</returns>
    virtual System::SharedPtr<WorkUnit> GetWorkingHours(System::DateTime start, System::DateTime finish) = 0;
    /// <summary>
    /// Returns the amount of working hours at the specified date.
    /// </summary>
    /// <param name="dt">The date to get working hours for.</param>
    /// <returns>Working hours at the specified date.</returns>
    virtual System::TimeSpan GetWorkingHours(System::DateTime dt) = 0;
    /// <summary>
    /// Returns amount of working hours between the specified dates.
    /// </summary>
    /// <param name="start">Start date of the interval.</param>
    /// <param name="finish">Finish date of the interval.</param>
    /// <returns>Amount of working hours according to the calendar instance.</returns>
    virtual System::TimeSpan GetWorkingHoursTimeSpan(System::DateTime start, System::DateTime finish) = 0;
    /// <summary>
    /// Calculates the date when the specified amount of work time will pass according to the calendar.
    /// </summary>
    /// <param name="start">Start date.</param>
    /// <param name="work">Work duration.</param>
    /// <returns>Finish date.</returns>
    virtual System::DateTime GetFinishDateByStartAndWork(System::DateTime start, Duration work) = 0;
    /// <summary>
    /// Calculates the date when the specified amount of work time will pass according to the calendar.
    /// </summary>
    /// <param name="start">Start date.</param>
    /// <param name="work">Work duration.</param>
    /// <returns>Finish date.</returns>
    virtual System::DateTime GetFinishDateByStartAndWork(System::DateTime start, System::TimeSpan work) = 0;
    /// <summary>
    /// Calculates the task finish date and time from its start date, split parts and the work duration.
    /// </summary>
    /// <param name="task">The task to calculate finish date for.</param>
    /// <param name="duration">The duration to calculate.</param>
    /// <returns>Task's finish date for the given start date and duration.</returns>
    /// <remarks>Returns DateTime.MinValue if task is summary, null or its start date is not set.</remarks>
    virtual System::DateTime GetTaskFinishDateFromDuration(System::SharedPtr<Task> task, System::TimeSpan duration) = 0;
    /// <summary>
    /// Returns <see cref="WorkingTimeCollection"></see> of working times for the specified date.
    /// </summary>
    /// <param name="dt">The date to get working times for.</param>
    /// <returns>Collection of <see cref="WorkingTime"></see> instances.</returns>
    virtual System::SharedPtr<WorkingTimeCollection> GetWorkingTimes(System::DateTime dt) = 0;
    /// <summary>
    /// Calculates the end of the previous working date from the specified date.
    /// </summary>
    /// <param name="date">the date to calculate the previous working day end.</param>
    /// <returns>The end of the previous working day end</returns>
    virtual System::DateTime GetPreviousWorkingDayEnd(System::DateTime date) = 0;
    /// <summary>
    /// Calculates next working day start for the specified date.
    /// </summary>
    /// <param name="date">The date to get next working day start for.</param>
    /// <returns>Next working day start <see cref="System::DateTime"></see>.</returns>
    virtual System::DateTime GetNextWorkingDayStart(System::DateTime date) = 0;
    /// <summary>
    /// Calculates next working time start beginning from the specified date and time.
    /// </summary>
    /// <param name="date">The date and time.</param>
    /// <returns>The nearest working time start.</returns>
    virtual System::DateTime GetWorkStart(System::DateTime date) = 0;
    /// <summary>
    /// Returns whether the calendar doesn't have working hours defined.
    /// </summary>
    virtual bool IsEmpty() = 0;
    
};
 
} // namespace Tasks
} // namespace Aspose