LevelingOptions.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="LevelingOptions.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/object.h>
#include <system/nullable.h>
#include <system/date_time.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class ICancellationTracker;
class IMessageHandler;
namespace Leveling
{
class LevelingAlgorithm;
enum class LevelingOrder;
} // namespace Leveling
enum class MessageLevel;
class Project;
class Resource;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IList;
} // namespace Generic
} // namespace Collections
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
namespace Leveling {
 
/// <summary>
/// Allows to specify parameters of resource leveling.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS LevelingOptions final : public System::Object
{
    typedef LevelingOptions ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Leveling::LevelingAlgorithm;
    
public:
 
    /// <summary>
    /// Gets leveling period start date. The default value is the project`s start date.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Nullable<System::DateTime> get_StartDate() const;
    /// <summary>
    /// Sets leveling period start date. The default value is the project`s start date.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StartDate(System::Nullable<System::DateTime> value);
    /// <summary>
    /// Gets leveling period end date. The default value is the project`s finish date.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Nullable<System::DateTime> get_FinishDate() const;
    /// <summary>
    /// Sets leveling period end date. The default value is the project`s finish date.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FinishDate(System::Nullable<System::DateTime> value);
    /// <summary>
    /// Gets the list of the resources which will be leveled. If null is set, all project resources will be leveled.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Resource>>>& get_Resources() const;
    /// <summary>
    /// Sets the list of the resources which will be leveled. If null is set, all project resources will be leveled.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Resources(const System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Resource>>>& value);
    /// <summary>
    /// Gets the order in which the leveling algorithm delays tasks that have overallocations.
    /// After determination of tasks causing the overallocation and which tasks can be delayed, the specified order is used which task should be delayed first.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Leveling::LevelingOrder get_LevelingOrder() const;
    /// <summary>
    /// Gets the order in which the leveling algorithm delays tasks that have overallocations.
    /// After determination of tasks causing the overallocation and which tasks can be delayed, the specified order is used which task should be delayed first.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_LevelingOrder(Aspose::Tasks::Leveling::LevelingOrder value);
    /// <summary>
    /// Gets level of log messages emitted by Aspose.Tasks during resource leveling.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::MessageLevel get_MessageLevel() const;
    /// <summary>
    /// Sets level of log messages emitted by Aspose.Tasks during resource leveling.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MessageLevel(Aspose::Tasks::MessageLevel value);
    /// <summary>
    /// Gets message handler callback which can be used to intercept log messages produced by Aspose.Tasks during resource leveling.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<IMessageHandler>& get_MessageHandler() const;
    /// <summary>
    /// Sets message handler callback which can be used to intercept log messages produced by Aspose.Tasks during resource leveling.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MessageHandler(const System::SharedPtr<IMessageHandler>& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="LevelingOptions"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API LevelingOptions();
    
protected:
 
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ICancellationTracker> GetCancellationTracker();
    ASPOSE_TASKS_SHARED_API void Validate(const System::SharedPtr<Project>& project);
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::Nullable<System::DateTime> pr_StartDate;
    System::Nullable<System::DateTime> pr_FinishDate;
    System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Resource>>> pr_Resources;
    Aspose::Tasks::Leveling::LevelingOrder pr_LevelingOrder;
    Aspose::Tasks::MessageLevel pr_MessageLevel;
    System::SharedPtr<IMessageHandler> pr_MessageHandler;
    
};
 
} // namespace Leveling
} // namespace Tasks
} // namespace Aspose