Duration.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="Duration.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
// ReSharper disable StringLiteralTypo
 
#include <system/timespan.h>
#include <system/object_ext.h>
#include <system/iequatable.h>
#include <system/array.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace Calculations
{
class ResourceAssignmentCalculator;
class ResourceAssignmentPeakCalculator;
class TaskEarlyLateDatesCalculator;
class TaskProgressCalculator;
class TaskStatusCalculator;
class TaskWorkCalculator;
} // namespace Calculations
namespace Connectivity
{
class DbTypeConverter;
class MpdAssignmentMapper;
class MpdTaskMapper;
class MspAssignmentMapper;
class MspDbTypeConverter;
class MspTaskBaseLineMapper;
class MspTaskMapper;
class PmDbTypeConverter;
} // namespace Connectivity
class ExtendedAttribute;
namespace IO
{
namespace Html
{
class HtmlReadingUtils;
class HtmlResourceAssignmentTableReader;
class HtmlTaskBaseLineTableReader;
class HtmlTaskTableReader;
} // namespace Html
namespace Mpx
{
class MpxUtils;
} // namespace Mpx
namespace MSProject
{
class CustomFieldTypeReader;
class ExtendedAttributeValueConverter;
template <typename, typename> class FieldItem;
class GanttBarStyleCalculator;
class MPP12OutlineCodeDefinitionReader;
class MPP14OutlineCodeDefinitionReader;
class MPP14ResourceAssignmentWriter;
class MPP14TaskReader;
class MPP9ExtendedAttributeDefinitionReader;
class MPPRecurringInfoReader;
} // namespace MSProject
namespace PrimaveraXml
{
class P6XmlUtils;
class PrimaveraActivityNodeReader;
class PrimaveraAssignmentsNodeReader;
} // namespace PrimaveraXml
namespace Pwa
{
namespace InternalApi
{
class ExtendedAttributeValueReader;
namespace Mapping
{
class AssignmentDurationPropertyMapper;
class BaseDurationPropertyMapper;
template <typename> class ProjectCoreEntityMapperBase;
class ProjectTasksMapper;
class TaskDurationPropertyMapper;
class TaskLinkEntityMapper;
} // namespace Mapping
class PropertyValueReader;
} // namespace InternalApi
} // namespace Pwa
namespace Xer
{
class XerAssignmentReader;
class XerRecordValueReader;
} // namespace Xer
namespace Xml
{
class ExtendedAttributeNodeReader;
class OutlineCodeDefinitionReader;
class ResourceAssignmentNodeReader;
class ResourceAssignmentNodeWriter;
class TaskNodeReader;
class TaskNodeWriter;
} // namespace Xml
} // namespace IO
namespace Leveling
{
class ResourceLeveler;
} // namespace Leveling
class OutlineValue;
class PercentCompleteCalculator;
class ProjDurValue;
class Project;
class ProjectState;
class ProjectWorkUpdater;
class ResourceAssignment;
namespace RiskAnalysis
{
class RndDurationAlgorithm;
} // namespace RiskAnalysis
namespace Rollup
{
class DurationExtendedAttributeComparer;
} // namespace Rollup
namespace Saving
{
class MpxSavingUtils;
class MpxWriter;
} // namespace Saving
class Task;
class TaskPlanner;
class TaskPlannerAssignmentManager;
class TimephasedDataMaker;
enum class TimeUnitType : int8_t;
namespace Util
{
namespace Fields
{
class RscFieldToValue;
class TaskFieldToValue;
} // namespace Fields
class PrimaveraTasksProcessor;
} // namespace Util
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Globalization
{
class CultureInfo;
} // namespace Globalization
class IFormatProvider;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents duration in a project.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS Duration : public System::IEquatable<Aspose::Tasks::Duration>, public System::Details::BoxableObjectBase
{
    typedef Duration ThisType;
    typedef System::IEquatable<Aspose::Tasks::Duration> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Calculations::TaskEarlyLateDatesCalculator;
    friend class Aspose::Tasks::Calculations::ResourceAssignmentCalculator;
    friend class Aspose::Tasks::Calculations::ResourceAssignmentPeakCalculator;
    friend class Aspose::Tasks::Calculations::TaskProgressCalculator;
    friend class Aspose::Tasks::Calculations::TaskStatusCalculator;
    friend class Aspose::Tasks::Calculations::TaskWorkCalculator;
    friend class Aspose::Tasks::IO::MSProject::GanttBarStyleCalculator;
    friend class Aspose::Tasks::IO::PrimaveraXml::P6XmlUtils;
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraActivityNodeReader;
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraAssignmentsNodeReader;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::BaseDurationPropertyMapper;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::AssignmentDurationPropertyMapper;
    friend class Aspose::Tasks::IO::Xer::XerRecordValueReader;
    friend class Aspose::Tasks::Leveling::ResourceLeveler;
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::ResourceAssignment;
    friend class Aspose::Tasks::Task;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::TaskDurationPropertyMapper;
    friend class Aspose::Tasks::ExtendedAttribute;
    friend class Aspose::Tasks::ProjDurValue;
    friend class Aspose::Tasks::Connectivity::DbTypeConverter;
    friend class Aspose::Tasks::Connectivity::MpdAssignmentMapper;
    friend class Aspose::Tasks::Connectivity::MspDbTypeConverter;
    friend class Aspose::Tasks::Connectivity::MpdTaskMapper;
    friend class Aspose::Tasks::Connectivity::MspAssignmentMapper;
    friend class Aspose::Tasks::Connectivity::MspTaskBaseLineMapper;
    friend class Aspose::Tasks::Connectivity::MspTaskMapper;
    friend class Aspose::Tasks::Connectivity::PmDbTypeConverter;
    friend class Aspose::Tasks::IO::Html::HtmlReadingUtils;
    friend class Aspose::Tasks::IO::Html::HtmlResourceAssignmentTableReader;
    friend class Aspose::Tasks::IO::Html::HtmlTaskBaseLineTableReader;
    friend class Aspose::Tasks::IO::Html::HtmlTaskTableReader;
    friend class Aspose::Tasks::IO::MSProject::CustomFieldTypeReader;
    friend class Aspose::Tasks::IO::MSProject::ExtendedAttributeValueConverter;
    template<typename FT0, typename FT1> friend class Aspose::Tasks::IO::MSProject::FieldItem;
    template<typename FT0, typename FT1> friend class Aspose::Tasks::IO::MSProject::FieldItem;
    friend class Aspose::Tasks::IO::MSProject::MPP12OutlineCodeDefinitionReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14OutlineCodeDefinitionReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14TaskReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14ResourceAssignmentWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP9ExtendedAttributeDefinitionReader;
    friend class Aspose::Tasks::IO::MSProject::MPPRecurringInfoReader;
    friend class Aspose::Tasks::IO::Mpx::MpxUtils;
    friend class Aspose::Tasks::IO::Xer::XerAssignmentReader;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::ExtendedAttributeValueReader;
    template<typename FT0> friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectCoreEntityMapperBase;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectTasksMapper;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::TaskLinkEntityMapper;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::PropertyValueReader;
    friend class Aspose::Tasks::IO::Xml::ExtendedAttributeNodeReader;
    friend class Aspose::Tasks::IO::Xml::OutlineCodeDefinitionReader;
    friend class Aspose::Tasks::IO::Xml::ResourceAssignmentNodeReader;
    friend class Aspose::Tasks::IO::Xml::ResourceAssignmentNodeWriter;
    friend class Aspose::Tasks::IO::Xml::TaskNodeReader;
    friend class Aspose::Tasks::IO::Xml::TaskNodeWriter;
    friend class Aspose::Tasks::OutlineValue;
    friend class Aspose::Tasks::ProjectState;
    friend class Aspose::Tasks::TaskPlannerAssignmentManager;
    friend class Aspose::Tasks::TaskPlanner;
    friend class Aspose::Tasks::PercentCompleteCalculator;
    friend class Aspose::Tasks::ProjectWorkUpdater;
    friend class Aspose::Tasks::RiskAnalysis::RndDurationAlgorithm;
    friend class Aspose::Tasks::Rollup::DurationExtendedAttributeComparer;
    friend class Aspose::Tasks::Saving::MpxSavingUtils;
    friend class Aspose::Tasks::Saving::MpxWriter;
    friend class Aspose::Tasks::TimephasedDataMaker;
    friend class Aspose::Tasks::Util::Fields::RscFieldToValue;
    friend class Aspose::Tasks::Util::Fields::TaskFieldToValue;
    friend class Aspose::Tasks::Util::PrimaveraTasksProcessor;
    friend ASPOSE_TASKS_SHARED_API bool operator ==(Duration a, Duration b);
    friend ASPOSE_TASKS_SHARED_API bool operator !=(Duration a, Duration b);
    
public:
 
    /// <summary>
    /// Gets <see cref="TimeSpan"></see> instance of this Duration object.
    /// <value>The TimeSpan instance of this Duration object.</value>
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::TimeSpan get_TimeSpan() const;
    /// <summary>
    /// Gets time unit type for this object.
    /// <value>The time unit type of this Duration instance.</value>
    /// </summary>
    ASPOSE_TASKS_SHARED_API TimeUnitType get_TimeUnit() const;
    /// <summary>
    /// Gets a value indicating whether time unit is estimated.
    /// <value>The flag which determines whether this Duration instance is estimated.</value>
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsEstimated() const;
    /// <summary>
    /// Gets a value indicating whether time unit is elapsed.
    /// <value>The flag which determines whether this Duration instance is elapsed.</value>
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsElapsed() const;
    
    /// <summary>
    /// Converts the specified string to the instance of <see cref="Duration"></see> struct.
    /// </summary>
    /// <param name="p">the specified instance of <see cref="Project"></see> class to convert duration for.</param>
    /// <param name="value">the specified string to convert.</param>
    /// <returns>Returns the converted instance of <see cref="Duration"></see> struct.</returns>
    static ASPOSE_TASKS_SHARED_API Duration Parse(const System::SharedPtr<Project>& p, const System::String& value);
    /// <summary>
    /// Parses duration string in format "PT--H--M--S--".
    /// </summary>
    /// <param name="value">the specified string to parse.</param>
    /// <returns>returns parsed instance of the <see cref="TimeSpan"></see> struct.</returns>
    static ASPOSE_TASKS_SHARED_API System::TimeSpan ParseTimeSpan(const System::String& value);
    /// <summary>
    /// Converts Duration object to <see cref="double"></see> value.
    /// </summary>
    /// <returns>Converted value.</returns>
    ASPOSE_TASKS_SHARED_API double ToDouble();
    /// <summary>
    /// Converts Duration object to another duration with specified time units.
    /// </summary>
    /// <param name="timeUnitType">the specified time unit type.</param>
    /// <returns>returns new duration with the specified unit type.</returns>
    ASPOSE_TASKS_SHARED_API Duration Convert(TimeUnitType timeUnitType);
    /// <summary>
    /// Adds specified duration to this duration.
    /// </summary>
    /// <param name="d">specified <see cref="Duration"></see> to add to this instance.</param>
    /// <returns>New duration object that represents the value of this instance plus the specified duration value.</returns>
    ASPOSE_TASKS_SHARED_API Duration Add(Duration d);
    /// <summary>
    /// Adds specified double value to this duration.
    /// </summary>
    /// <param name="val">the specified <see cref="double"></see> value to add to this instance.</param>
    /// <returns>New duration object that represents the value of this instance plus the specified duration value.</returns>
    ASPOSE_TASKS_SHARED_API Duration Add(double val);
    /// <summary>
    /// Subtracts specified duration from this duration instance.
    /// </summary>
    /// <param name="d">the specified <see cref="Duration"></see> instance to subtract from this instance.</param>
    /// <returns>New duration object that represents the value of this instance minus the specified duration value.</returns>
    ASPOSE_TASKS_SHARED_API Duration Subtract(Duration d);
    /// <summary>
    /// Subtracts specified double value from this duration instance.
    /// </summary>
    /// <param name="val">specified <see cref="double"></see> value to subtract from this instance.</param>
    /// <returns>New duration object that represents the value of this instance minus the specified duration value.</returns>
    ASPOSE_TASKS_SHARED_API Duration Subtract(double val);
    /// <summary>
    /// Returns a value indicating whether this instance is equal to a specified object.
    /// </summary>
    /// <param name="other">The object to compare with this instance.</param>
    /// <returns>Returns <b>True</b> if other Duration instance has the same TimeSpan and TimeUnit values as this instance; otherwise, <b>false</b>.</returns>
    ASPOSE_TASKS_SHARED_API bool Equals(Duration other) override;
    /// <summary>
    /// Returns a value indicating whether this instance is equal to a specified object.
    /// </summary>
    /// <param name="obj">The object to compare with this instance.</param>
    /// <returns><b>True</b> if the specified object is a Duration that has the same TimeSpan and TimeUnit values as this instance; otherwise, <b>false</b>.</returns>
    ASPOSE_TASKS_SHARED_API bool Equals(System::SharedPtr<System::Object> obj) override;
    /// <summary>
    /// Returns a hash code value for this object.
    /// </summary>
    /// <returns>returns a hash code value for this duration instance.</returns>
    ASPOSE_TASKS_SHARED_API int32_t GetHashCode() const override;
    
    ASPOSE_TASKS_SHARED_API Duration();
    
    /// <summary>
    /// Returns a string representation of this instance.
    /// </summary>
    /// <returns>a string representation of this instance.</returns>
    ASPOSE_TASKS_SHARED_API System::String ToString() const override;
    
protected:
 
    ASPOSE_TASKS_SHARED_API double get_TotalMinutes();
    ASPOSE_TASKS_SHARED_API bool get_IsZeroDuration();
    
    /// <summary>
    /// Initializes a new instance of the <see cref="Duration"></see> struct with a specified TimeSpan value and TimeUnitType.
    /// </summary>
    /// <param name="project">the specified instance of the <see cref="Project"></see> to get settings from.</param>
    /// <param name="timeSpan">the specified <see cref="TimeSpan"></see></param>
    /// <param name="timeUnit">the specified <see cref="TimeUnit"></see></param>
    ASPOSE_TASKS_SHARED_API Duration(const System::SharedPtr<Project>& project, System::TimeSpan timeSpan, TimeUnitType timeUnit);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Duration, CODEPORTING_ARGS(const System::SharedPtr<Project>& project, System::TimeSpan timeSpan, TimeUnitType timeUnit));
    
    /// <summary>
    /// Initializes a new instance of the <see cref="Duration"></see> struct with a specified double value and TimeUnitType.
    /// </summary>
    /// <param name="project">the specified instance of the <see cref="Project"></see> to get settings from.</param>
    /// <param name="d">the specified double value.</param>
    /// <param name="timeUnit">the specified <see cref="TimeUnit"></see></param>
    /// <param name="setUndefinedTimeUnit">The flag to set undefined value.</param>
    ASPOSE_TASKS_SHARED_API Duration(const System::SharedPtr<Project>& project, double d, TimeUnitType timeUnit, bool setUndefinedTimeUnit);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Duration, CODEPORTING_ARGS(const System::SharedPtr<Project>& project, double d, TimeUnitType timeUnit, bool setUndefinedTimeUnit));
    
    /// <summary>
    /// Initializes a new instance of the <see cref="Duration"></see> struct with a specified double value and TimeUnitType.
    /// </summary>
    /// <param name="project">the specified instance of the <see cref="Project"></see> to get settings from.</param>
    /// <param name="d">the specified double value.</param>
    /// <param name="timeUnit">the specified <see cref="TimeUnit"></see></param>
    ASPOSE_TASKS_SHARED_API Duration(const System::SharedPtr<Project>& project, double d, TimeUnitType timeUnit);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Duration, CODEPORTING_ARGS(const System::SharedPtr<Project>& project, double d, TimeUnitType timeUnit));
    ASPOSE_TASKS_SHARED_API System::String ToString(const System::SharedPtr<System::Globalization::CultureInfo>& cultureInfo);
    /// <summary>
    /// Converts the specified string to the instance of <see cref="Duration"></see> struct.
    /// </summary>
    /// <param name="p">the specified instance of <see cref="Project"></see> class to convert duration for.</param>
    /// <param name="value">the specified string to convert.</param>
    /// <param name="formatProvider">An object that supplies culture-specific formatting information about <paramref name="value"></paramref>.</param>
    /// <returns>Returns the converted instance of <see cref="Duration"></see> struct.</returns>
    static ASPOSE_TASKS_SHARED_API Duration Parse(const System::SharedPtr<Project>& p, System::String value, const System::SharedPtr<System::IFormatProvider>& formatProvider);
    /// <summary>
    /// Returns total minutes multiplied by 10.
    /// </summary>
    /// <returns>Total minutes multiplied by 10.</returns>
    ASPOSE_TASKS_SHARED_API int32_t ToInt();
    /// <summary>
    /// Converts integer value to duration instance and returns converted duration instance.
    /// </summary>
    /// <param name="project">the specified project.</param>
    /// <param name="i">the specified integer value.</param>
    /// <returns>returns converted duration instance.</returns>
    static ASPOSE_TASKS_SHARED_API Duration FromInt(const System::SharedPtr<Project>& project, int32_t i);
    /// <summary>
    /// Converts integer value to duration instance with the specified time units.
    /// </summary>
    /// <param name="project">the specified project.</param>
    /// <param name="i">the specified integer value.</param>
    /// <param name="timeUnit">the specified time unit type.</param>
    /// <returns>returns converted duration instance.</returns>
    static ASPOSE_TASKS_SHARED_API Duration FromInt(const System::SharedPtr<Project>& project, int32_t i, TimeUnitType timeUnit);
    /// <summary>
    /// Returns this instance as variance.
    /// </summary>
    /// <returns>returns this instance as variance.</returns>
    ASPOSE_TASKS_SHARED_API double ToVariance();
    /// <summary>
    /// Converts variance to duration instance.
    /// </summary>
    /// <param name="project">the specified project.</param>
    /// <param name="variance">the specified variance.</param>
    /// <returns>returns duration instance which was converted from variance.</returns>
    static ASPOSE_TASKS_SHARED_API Duration FromVariance(const System::SharedPtr<Project>& project, double variance);
    /// <summary>
    /// Converts TimeSpan instance to duration instance with day time units.
    /// </summary>
    /// <param name="project">the specified project for the instance of the <see cref="Duration"></see> class.</param>
    /// <param name="timeSpan">the specified TimeSpan instance.</param>
    /// <param name="type">the specified TimeUnitType instance.</param>
    /// <returns>returns converted duration instance with day time units.</returns>
    static ASPOSE_TASKS_SHARED_API Duration FromTimeSpan(const System::SharedPtr<Project>& project, System::TimeSpan timeSpan, TimeUnitType type);
    static ASPOSE_TASKS_SHARED_API Duration ChangeTimeUnit(Duration duration, TimeUnitType timeUnit);
    static ASPOSE_TASKS_SHARED_API Duration ChangeTimeSpan(Duration duration, System::TimeSpan timeSpan);
    static ASPOSE_TASKS_SHARED_API Duration Add(Duration duration, System::TimeSpan timeSpan);
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::WeakPtr<Project> project;
    System::TimeSpan pr_TimeSpan;
    
    /// <summary>
    /// Gets <see cref="TimeSpan"></see> instance of this Duration object.
    /// <value>The TimeSpan instance of this Duration object.</value>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_TimeSpan(System::TimeSpan value);
    
    TimeUnitType pr_TimeUnit;
    
    /// <summary>
    /// Gets time unit type for this object.
    /// <value>The time unit type of this Duration instance.</value>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_TimeUnit(TimeUnitType value);
    
    static System::ArrayPtr<System::String>& DurationLabels();
    System::String ToString_NonConst();
    static TimeUnitType GetTimeUnitType(const System::String& str);
    static TimeUnitType ParseAsPercent(const System::String& s);
    static bool TryParseAsDate(const System::String& s, TimeUnitType& type);
    static TimeUnitType SelectWithModifier(bool isEstimated, bool isElapsed, TimeUnitType both, TimeUnitType estimated, TimeUnitType elapsed, TimeUnitType withoutModifiers);
    static System::String GetUnit(System::String s, bool& isEstimated, bool& isElapsed);
    static bool IsMinute(const System::String& unit);
    static bool IsHour(const System::String& unit);
    static bool IsDay(const System::String& s);
    static bool IsWeek(const System::String& s);
    static bool IsMonth(const System::String& unit);
    static bool IsYear(const System::String& unit);
    System::String GetDurationUnit(const System::String& dur, const System::String& abbr, bool addSpaceBeforeLabel) const;
    bool GetAddSpaceBeforeLabel();
    
};
 
ASPOSE_TASKS_SHARED_API bool operator ==(Duration a, Duration b);
ASPOSE_TASKS_SHARED_API bool operator !=(Duration a, Duration b);
 
} // namespace Tasks
} // namespace Aspose
 
namespace System { template<> struct IsBoxable<Aspose::Tasks::Duration> : std::true_type {}; }