RiskPattern.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="RiskPattern.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/object.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace RiskAnalysis
{
enum class ConfidenceLevel;
enum class ProbabilityDistributionType;
class RndDurationAlgorithm;
} // namespace RiskAnalysis
class Task;
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
namespace RiskAnalysis {
 
/// <summary>
/// Represents a risk pattern for a project task.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS RiskPattern : public System::Object
{
    typedef RiskPattern ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::RiskAnalysis::RndDurationAlgorithm;
    
public:
 
    /// <summary>
    /// Gets a project task to which this risk pattern is applied.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::Task> get_Task() const;
    /// <summary>
    /// Gets the probability distribution used in Monte Carlo simulation.
    /// The default value is ProbabilityDistributionType.Normal.
    /// </summary>
    /// <remarks>Can be one of the values defined in the <see cref="ProbabilityDistributionType"></see> enumeration.</remarks>
    ASPOSE_TASKS_SHARED_API ProbabilityDistributionType get_Distribution() const;
    /// <summary>
    /// Sets the probability distribution used in Monte Carlo simulation.
    /// The default value is ProbabilityDistributionType.Normal.
    /// </summary>
    /// <remarks>Can be one of the values defined in the <see cref="ProbabilityDistributionType"></see> enumeration.</remarks>
    ASPOSE_TASKS_SHARED_API void set_Distribution(ProbabilityDistributionType value);
    /// <summary>
    /// Gets the confidence level that correspond to the percentage of the time the actual generated values will be within optimistic and pessimistic estimates.
    /// The default value is CL99.
    /// </summary>
    /// <remarks>Can be one of the values defined in the <see cref="ConfidenceLevel"></see> enumeration.</remarks>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::RiskAnalysis::ConfidenceLevel get_ConfidenceLevel() const;
    /// <summary>
    /// Sets the confidence level that correspond to the percentage of the time the actual generated values will be within optimistic and pessimistic estimates.
    /// The default value is CL99.
    /// </summary>
    /// <remarks>Can be one of the values defined in the <see cref="ConfidenceLevel"></see> enumeration.</remarks>
    ASPOSE_TASKS_SHARED_API void set_ConfidenceLevel(Aspose::Tasks::RiskAnalysis::ConfidenceLevel value);
    /// <summary>
    /// Gets the percentage of the most likely task duration which can happen in the best possible project scenario.
    /// The default value is 75, which means that if the estimated specified task duration is 4 days then the optimistic duration will be 3 days.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Optimistic() const;
    /// <summary>
    /// Sets the percentage of the most likely task duration which can happen in the best possible project scenario.
    /// The default value is 75, which means that if the estimated specified task duration is 4 days then the optimistic duration will be 3 days.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Optimistic(int32_t value);
    /// <summary>
    /// Gets the percentage of the most likely task duration which can happen in the worst possible project scenario.
    /// The default value is 125, which means that if the estimated specified task duration is 4 days then the pessimistic duration will be 5 days.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Pessimistic() const;
    /// <summary>
    /// Sets the percentage of the most likely task duration which can happen in the worst possible project scenario.
    /// The default value is 125, which means that if the estimated specified task duration is 4 days then the pessimistic duration will be 5 days.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Pessimistic(int32_t value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="RiskPattern"></see> class.
    /// </summary>
    /// <param name="task">the specified project task for which this risk will be applied in Monte Carlo simulation.</param>
    ASPOSE_TASKS_SHARED_API RiskPattern(const System::SharedPtr<Aspose::Tasks::Task>& task);
    
protected:
 
    /// <summary>
    /// Gets the optimistic duration calculated from the most likely one.
    /// </summary>
    ASPOSE_TASKS_SHARED_API double get_OptimisticDuration();
    /// <summary>
    /// Gets the pessimistic duration calculated from the most likely one.
    /// </summary>
    ASPOSE_TASKS_SHARED_API double get_PessimisticDuration();
    /// <summary>
    /// Gets the mean task duration based on pessimistic and optimistic values.
    /// </summary>
    ASPOSE_TASKS_SHARED_API double get_MeanDuration();
    /// <summary>
    /// Gets the half range of optimistic and pessimistic values.
    /// </summary>
    ASPOSE_TASKS_SHARED_API double get_HalfRange();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::SharedPtr<Aspose::Tasks::Task> task;
    int32_t optimistic;
    int32_t pessimistic;
    ProbabilityDistributionType pr_Distribution;
    Aspose::Tasks::RiskAnalysis::ConfidenceLevel pr_ConfidenceLevel;
    
    /// <summary>
    /// Gets the most likely task duration.
    /// </summary>
    double get_MostLikelyDuration();
    
    void ValidatePercentGreaterThanZero(int32_t value);
    
};
 
} // namespace RiskAnalysis
} // namespace Tasks
} // namespace Aspose