RiskItemStatistics.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="RiskItemStatistics.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/object.h>
#include <system/date_time.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class Duration;
namespace RiskAnalysis
{
template <typename> class Percentile;
namespace Reporting
{
class RiskReportBuilder;
} // namespace Reporting
class RiskItemStatisticsCollection;
enum class RiskItemType;
class RiskValueCollection;
class SampleCollector;
} // namespace RiskAnalysis
class Task;
} // namespace Tasks
} // namespace Aspose
namespace System
{
class String;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
namespace RiskAnalysis {
 
/// <summary>
/// Represents an item which stores statistical data for the task of the analyzed project.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS RiskItemStatistics : public System::Object
{
    typedef RiskItemStatistics ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::RiskAnalysis::SampleCollector;
    friend class Aspose::Tasks::RiskAnalysis::Reporting::RiskReportBuilder;
    friend class Aspose::Tasks::RiskAnalysis::RiskItemStatisticsCollection;
    
public:
 
    /// <summary>
    /// Gets an instance of the <see cref="RiskItemType"></see> enumeration.
    /// </summary>
    ASPOSE_TASKS_SHARED_API RiskItemType get_ItemType() const;
    /// <summary>
    /// Gets the minimum value which was generated during Monte Carlo simulation.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_Minimum() const;
    /// <summary>
    /// Gets the maximum value which was generated during Monte Carlo simulation.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_Maximum() const;
    /// <summary>
    /// Gets the expected value of the risk item.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_ExpectedValue() const;
    /// <summary>
    /// Gets the standard deviation of the risk item.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Duration get_StandardDeviation() const;
    
    /// <summary>
    /// Gets a value below which a specified percentage of generated samples fall.
    /// </summary>
    /// <param name="percent">the specified percent between 0 and 100.</param>
    /// <returns>a value below which a specified percentage of generated samples fall.</returns>
    ASPOSE_TASKS_SHARED_API System::DateTime GetPercentile(int32_t percent);
    /// <summary>
    /// Returns short string representation of a risk item.
    /// The exact details of the representation are unspecified and subject to change.
    /// </summary>
    /// <returns>short string which represents RiskItem object.</returns>
    ASPOSE_TASKS_SHARED_API System::String ToString() const override;
    
protected:
 
    ASPOSE_TASKS_SHARED_API System::SharedPtr<RiskValueCollection> get_Values() const;
    
    ASPOSE_TASKS_SHARED_API RiskItemStatistics(const System::SharedPtr<Task>& task, RiskItemType itemType, const System::SharedPtr<RiskItemStatisticsCollection>& parentStatisticsCollection);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(RiskItemStatistics, CODEPORTING_ARGS(const System::SharedPtr<Task>& task, RiskItemType itemType, const System::SharedPtr<RiskItemStatisticsCollection>& parentStatisticsCollection));
    ASPOSE_TASKS_SHARED_API void AddSample(System::DateTime value);
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    RiskItemType itemType;
    System::SharedPtr<Task> task;
    System::SharedPtr<RiskValueCollection> riskValues;
    System::SharedPtr<Percentile<System::DateTime>> percentile;
    
};
 
} // namespace RiskAnalysis
} // namespace Tasks
} // namespace Aspose