TimephasedData.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="TimephasedData.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/timespan.h>
#include <system/object.h>
#include <system/date_time.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace Calculations
{
class ResourceAssignmentCalculator;
class ResourceAssignmentRateByDateEnumerator;
class ResourceAssignmentWorkCalculator;
class TimephasedDataCalculator;
class TimeScaledCalculator;
} // namespace Calculations
class CalendarTDMaker;
namespace IO
{
namespace MSProject
{
class MPP14ResourceAssignmentWriter;
class MPP9ResourceAssignmentReader;
class MppTimephasedDataWriter;
} // namespace MSProject
namespace Xml
{
class TimephasedDataNodeReader;
} // namespace Xml
} // namespace IO
namespace Recalculation
{
class TaskSplitCalculator;
class TimephasedDataCalculationUtil;
} // namespace Recalculation
class Resource;
class ResourceAssignment;
class ResourceAssignmentTimephasedDataCollection;
class SplitsCalculator;
class Task;
class TaskPlanner;
class TimephasedDataCollection;
class TimephasedDataMaker;
enum class TimephasedDataType : int8_t;
class TimephasedWorkCostSelector;
enum class TimeUnitType : int8_t;
namespace Visualization
{
class UsageCostCell;
class UsageWorkCell;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
class String;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a time phased data.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS TimephasedData : public System::Object
{
    typedef TimephasedData ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Calculations::TimeScaledCalculator;
    friend class Aspose::Tasks::Calculations::ResourceAssignmentRateByDateEnumerator;
    friend class Aspose::Tasks::Calculations::ResourceAssignmentCalculator;
    friend class Aspose::Tasks::Calculations::ResourceAssignmentWorkCalculator;
    friend class Aspose::Tasks::Calculations::TimephasedDataCalculator;
    friend class Aspose::Tasks::Resource;
    friend class Aspose::Tasks::ResourceAssignment;
    friend class Aspose::Tasks::Task;
    friend class Aspose::Tasks::Recalculation::TimephasedDataCalculationUtil;
    friend class Aspose::Tasks::IO::MSProject::MPP9ResourceAssignmentReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14ResourceAssignmentWriter;
    friend class Aspose::Tasks::IO::MSProject::MppTimephasedDataWriter;
    friend class Aspose::Tasks::IO::Xml::TimephasedDataNodeReader;
    friend class Aspose::Tasks::SplitsCalculator;
    friend class Aspose::Tasks::Recalculation::TaskSplitCalculator;
    friend class Aspose::Tasks::ResourceAssignmentTimephasedDataCollection;
    friend class Aspose::Tasks::TimephasedDataCollection;
    friend class Aspose::Tasks::CalendarTDMaker;
    friend class Aspose::Tasks::TimephasedDataMaker;
    friend class Aspose::Tasks::TimephasedWorkCostSelector;
    friend class Aspose::Tasks::Visualization::UsageCostCell;
    friend class Aspose::Tasks::Visualization::UsageWorkCell;
    friend class Aspose::Tasks::TaskPlanner;
    
public:
 
    /// <summary>
    /// Gets <see cref="double"></see> instance which represents string value of this object for unit-based time phased data.
    /// </summary>
    /// <returns>a floating point representation of this object.</returns>
    ASPOSE_TASKS_SHARED_API double get_ValueToUnits();
    /// <summary>
    /// Gets the unique identifier of a time phased data
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Uid() const;
    /// <summary>
    /// Sets the unique identifier of a time phased data
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Uid(int32_t value);
    /// <summary>
    /// Gets the start date of a time phased data period.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_Start() const;
    /// <summary>
    /// Sets the start date of a time phased data period.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Start(System::DateTime value);
    /// <summary>
    /// Gets the finish date of a time phased data period.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_Finish() const;
    /// <summary>
    /// Sets the finish date of a time phased data period.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Finish(System::DateTime value);
    /// <summary>
    /// Gets the time unit of a time phased data period.
    /// </summary>
    ASPOSE_TASKS_SHARED_API TimeUnitType get_Unit() const;
    /// <summary>
    /// Sets the time unit of a time phased data period.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Unit(TimeUnitType value);
    /// <summary>
    /// Gets the type of a time phased data.
    /// </summary>
    /// <remarks> <see cref="Value"></see> property will be cleared, if it is not suitable for type, specified here. </remarks>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::TimephasedDataType get_TimephasedDataType() const;
    /// <summary>
    /// Sets the type of a time phased data.
    /// </summary>
    /// <remarks> <see cref="Value"></see> property will be cleared, if it is not suitable for type, specified here. </remarks>
    ASPOSE_TASKS_SHARED_API void set_TimephasedDataType(Aspose::Tasks::TimephasedDataType value);
    /// <summary>
    /// Gets the value per unit of time for a time phased data period.
    /// </summary>
    /// <exception cref="TasksException"> When value is incorrect for specified <see cref="TimephasedDataType"></see> or have negative value.</exception>
    ASPOSE_TASKS_SHARED_API System::String get_Value();
    /// <summary>
    /// Sets the value per unit of time for a time phased data period.
    /// </summary>
    /// <exception cref="TasksException"> When value is incorrect for specified <see cref="TimephasedDataType"></see> or have negative value.</exception>
    ASPOSE_TASKS_SHARED_API void set_Value(const System::String& value);
    /// <summary>
    /// Gets <see cref="TimeSpan"></see> instance which represents string value of this object.
    /// </summary>
    /// <returns>a time span representation of the object.</returns>
    ASPOSE_TASKS_SHARED_API System::TimeSpan get_ValueToDuration() const;
    /// <summary>
    /// Gets <see cref="double"></see> instance which represents string value of this object.
    /// </summary>
    /// <returns>a floating point representation of the object.</returns>
    ASPOSE_TASKS_SHARED_API double get_ValueToCost();
    /// <summary>
    /// Gets <see cref="double"></see> instance which represents string value of this object.
    /// </summary>
    /// <param name="value">a floating point representation of the object.</param>
    ASPOSE_TASKS_SHARED_API void set_ValueToCost(double value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API TimephasedData();
    
    /// <summary>
    ///  Creates and initializes a new instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for work-based time phased data.
    /// </summary>
    /// <param name="uid"> UID of the task. </param>
    /// <param name="start"> start date-time. </param>
    /// <param name="finish"> Finish date-time. </param>
    /// <param name="value"> Timespan value. </param>
    /// <param name="timeUnit"> Time unit type. </param>
    /// <param name="type"> Time-phased data type. </param>
    /// <returns>A instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for work-based time phased data.</returns>
    /// <exception cref="ArgumentException">If negative work value was specified.</exception>
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<TimephasedData> CreateWorkTimephased(int32_t uid, System::DateTime start, System::DateTime finish, System::TimeSpan value, TimeUnitType timeUnit, Aspose::Tasks::TimephasedDataType type);
    /// <summary>
    ///   Creates and initializes a new instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for cost-based time phased data.
    /// </summary>
    /// <param name="uid"> UID of the task. </param>
    /// <param name="start"> start date-time. </param>
    /// <param name="finish"> Finish date-time. </param>
    /// <param name="value"> Cost value. </param>
    /// <param name="timeUnit"> Time unit type. </param>
    /// <param name="type"> Time-phased data type. </param>
    /// <returns>A instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for cost-based time phased data.</returns>
    /// <exception cref="ArgumentException">If negative cost value was specified.</exception>
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<TimephasedData> CreateCostTimephased(int32_t uid, System::DateTime start, System::DateTime finish, double value, TimeUnitType timeUnit, Aspose::Tasks::TimephasedDataType type);
    /// <summary>
    ///   Creates and initializes a new instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for cost-based time phased data.
    /// </summary>
    /// <param name="uid"> UID of the task. </param>
    /// <param name="start"> start date-time. </param>
    /// <param name="finish"> Finish date-time. </param>
    /// <param name="value"> Cost value. </param>
    /// <param name="type"> Time-phased data type. </param>
    /// <returns>A instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for cost-based time phased data.</returns>
    /// <exception cref="ArgumentException">If negative cost value was specified.</exception>
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<TimephasedData> CreateCostTimephased(int32_t uid, System::DateTime start, System::DateTime finish, double value, Aspose::Tasks::TimephasedDataType type);
    /// <summary>
    ///   Creates and initializes a new instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for unit-based time phased data of an assignment of a material resource.
    /// </summary>
    /// <param name="uid"> UID of the task. </param>
    /// <param name="start"> Start date-time. </param>
    /// <param name="finish"> Finish date-time. </param>
    /// <param name="units"> Number of units. </param>
    /// <param name="type"> Time-phased data type. </param>
    /// <returns>A instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for cost-based time phased data.</returns>
    /// <exception cref="ArgumentException">If negative amount of units was specified.</exception>
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<TimephasedData> CreateUnitTimephased(int32_t uid, System::DateTime start, System::DateTime finish, double units, Aspose::Tasks::TimephasedDataType type);
    
protected:
 
    /// <summary>
    /// Gets <see cref="TimeSpan"></see> instance which represents string value of this object.
    /// </summary>
    /// <param name="value">a time span representation of the object.</param>
    ASPOSE_TASKS_SHARED_API void set_ValueToDuration(System::TimeSpan value);
    /// <summary>
    /// Gets a value indicating whether this instance is custom user time phase data instance.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsCustom() const;
    /// <summary>
    /// Sets a value indicating whether this instance is custom user time phase data instance.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_IsCustom(bool value);
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<TimephasedDataCollection>& get_Parent() const;
    ASPOSE_TASKS_SHARED_API void set_Parent(const System::SharedPtr<TimephasedDataCollection>& value);
    ASPOSE_TASKS_SHARED_API bool get_IsEmptyValue();
    
    ASPOSE_TASKS_SHARED_API TimephasedData(int32_t uid, Aspose::Tasks::TimephasedDataType type, const System::SharedPtr<TimephasedData>& originalTd);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TimephasedData, CODEPORTING_ARGS(int32_t uid, Aspose::Tasks::TimephasedDataType type, const System::SharedPtr<TimephasedData>& originalTd));
    
    /// <summary>
    ///  Initializes a new instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for work-based time phased data.
    /// </summary>
    /// <param name="uid"> UID of the task. </param>
    /// <param name="start"> start date-time. </param>
    /// <param name="finish"> Finish date-time. </param>
    /// <param name="value"> Timespan value. </param>
    /// <param name="timeUnit"> Time unit type. </param>
    /// <param name="type"> Time-phased data type. </param>
    ASPOSE_TASKS_SHARED_API TimephasedData(int32_t uid, System::DateTime start, System::DateTime finish, System::TimeSpan value, TimeUnitType timeUnit, Aspose::Tasks::TimephasedDataType type);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TimephasedData, CODEPORTING_ARGS(int32_t uid, System::DateTime start, System::DateTime finish, System::TimeSpan value, TimeUnitType timeUnit, Aspose::Tasks::TimephasedDataType type));
    
    /// <summary>
    /// Initializes a new instance of the <see cref="Aspose::Tasks::TimephasedData"></see> class for cost-based time phased data.
    /// </summary>
    /// <param name="uid"> UID of the task. </param>
    /// <param name="start"> start date-time. </param>
    /// <param name="finish"> Finish date-time. </param>
    /// <param name="value"> Cost value. </param>
    /// <param name="timeUnit"> Time unit type. </param>
    /// <param name="type"> Time-phased data type. </param>
    ASPOSE_TASKS_SHARED_API TimephasedData(int32_t uid, System::DateTime start, System::DateTime finish, double value, TimeUnitType timeUnit, Aspose::Tasks::TimephasedDataType type);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TimephasedData, CODEPORTING_ARGS(int32_t uid, System::DateTime start, System::DateTime finish, double value, TimeUnitType timeUnit, Aspose::Tasks::TimephasedDataType type));
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<TimephasedData> ChangeType(const System::SharedPtr<TimephasedData>& timephasedDataItem, Aspose::Tasks::TimephasedDataType type);
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<TimephasedData> ChangeValue(const System::SharedPtr<TimephasedData>& timephasedDataItem, System::TimeSpan newValue);
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    Aspose::Tasks::TimephasedDataType timephasedDataType;
    System::TimeSpan durationValue;
    System::DateTime start;
    System::DateTime finish;
    int32_t pr_Uid;
    TimeUnitType pr_Unit;
    bool pr_IsCustom;
    System::WeakPtr<TimephasedDataCollection> pr_Parent;
    
    System::String get_DebuggerDisplay();
    
    void OnChange();
    
};
 
} // namespace Tasks
} // namespace Aspose