Rate.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="Rate.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/object.h>
#include <system/decimal.h>
#include <system/date_time.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace Calculations
{
class RateByDateEnumeratorBase;
} // namespace Calculations
namespace Connectivity
{
class MpdResourceRateMapper;
} // namespace Connectivity
namespace IO
{
namespace MSProject
{
template <typename, typename> class FieldItem;
class MPP14ResourceAssignmentWriter;
} // namespace MSProject
namespace PrimaveraXml
{
class PrimaveraResourceRateNodeReader;
class PrimaveraRoleRateNodeReader;
} // namespace PrimaveraXml
namespace Xer
{
class XerResourceRateReader;
class XerUtils;
} // namespace Xer
} // namespace IO
class RateByDateCollection;
class RateCollection;
enum class RateFormatType;
enum class RateType;
class ResourceAssignment;
namespace Util
{
class RateHelper;
} // namespace Util
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a definition of a time period and rates applicable for a resource during that period.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS Rate : public System::Object
{
    typedef Rate ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Calculations::RateByDateEnumeratorBase;
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraResourceRateNodeReader;
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraRoleRateNodeReader;
    friend class Aspose::Tasks::ResourceAssignment;
    friend class Aspose::Tasks::Util::RateHelper;
    friend class Aspose::Tasks::Connectivity::MpdResourceRateMapper;
    template<typename FT0, typename FT1> friend class Aspose::Tasks::IO::MSProject::FieldItem;
    friend class Aspose::Tasks::IO::MSProject::MPP14ResourceAssignmentWriter;
    friend class Aspose::Tasks::IO::Xer::XerResourceRateReader;
    friend class Aspose::Tasks::IO::Xer::XerUtils;
    friend class Aspose::Tasks::RateByDateCollection;
    friend class Aspose::Tasks::RateCollection;
    
private:
 
    enum class UpdateType
    {
        StandardRate,
        StandardRateFormat,
        OvertimeRate,
        OvertimeRateFormat,
        CostPerUse
    };
    
    
public:
 
    /// <summary>
    /// Gets the date when a rate becomes effective.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_RatesFrom() const;
    /// <summary>
    /// Sets the date when a rate becomes effective.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RatesFrom(System::DateTime value);
    /// <summary>
    /// Gets the last date when a rate is effective.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_RatesTo() const;
    /// <summary>
    /// Sets the last date when a rate is effective.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RatesTo(System::DateTime value);
    /// <summary>
    /// Gets the unique identifier of a rate table for a resource.
    /// </summary>
    ASPOSE_TASKS_SHARED_API RateType get_RateTable() const;
    /// <summary>
    /// Sets the unique identifier of a rate table for a resource.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RateTable(RateType value);
    /// <summary>
    /// Gets the standard rate per hour for a resource.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Decimal get_StandardRate() const;
    /// <summary>
    /// Sets the standard rate per hour for a resource.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StandardRate(System::Decimal value);
    /// <summary>
    /// Gets the units used by Microsoft Project to display the standard rate.
    /// </summary>
    ASPOSE_TASKS_SHARED_API RateFormatType get_StandardRateFormat() const;
    /// <summary>
    /// Sets the units used by Microsoft Project to display the standard rate.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StandardRateFormat(RateFormatType value);
    /// <summary>
    /// Gets the overtime rate per hour for a resource.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Decimal get_OvertimeRate() const;
    /// <summary>
    /// Sets the overtime rate per hour for a resource.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_OvertimeRate(System::Decimal value);
    /// <summary>
    /// Gets the units used by Microsoft Project to display the overtime rate.
    /// </summary>
    ASPOSE_TASKS_SHARED_API RateFormatType get_OvertimeRateFormat() const;
    /// <summary>
    /// Sets the units used by Microsoft Project to display the overtime rate.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_OvertimeRateFormat(RateFormatType value);
    /// <summary>
    /// Gets the cost per use of a resource. This value retrieved from the current date if a rate table exists for a resource.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Decimal get_CostPerUse() const;
    /// <summary>
    /// Sets the cost per use of a resource. This value retrieved from the current date if a rate table exists for a resource.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_CostPerUse(System::Decimal value);
    
protected:
 
    static ASPOSE_TASKS_SHARED_API System::DateTime& MinDate();
    static ASPOSE_TASKS_SHARED_API System::DateTime& MaxDate();
    
    ASPOSE_TASKS_SHARED_API System::SharedPtr<RateCollection> get_ParentCollection() const;
    ASPOSE_TASKS_SHARED_API void set_ParentCollection(const System::SharedPtr<RateCollection>& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="Rate"></see> class. 
    /// </summary>
    ASPOSE_TASKS_SHARED_API Rate();
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Rate, CODEPORTING_ARGS());
    
    /// <summary>Initializes a new instance of the <see cref="Rate"></see> class.</summary>
    ASPOSE_TASKS_SHARED_API Rate(System::Decimal standardRate, System::DateTime ratesFrom);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Rate, CODEPORTING_ARGS(System::Decimal standardRate, System::DateTime ratesFrom));
    
    /// <summary>Initializes a new instance of the <see cref="Rate"></see> class.</summary>
    ASPOSE_TASKS_SHARED_API Rate(RateType type);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Rate, CODEPORTING_ARGS(RateType type));
    
    /// <summary>Initializes a new instance of the <see cref="Rate"></see> class.</summary>
    ASPOSE_TASKS_SHARED_API Rate(System::Decimal standardRate);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Rate, CODEPORTING_ARGS(System::Decimal standardRate));
    
    /// <summary>Initializes a new instance of the <see cref="Rate"></see> class.</summary>
    ASPOSE_TASKS_SHARED_API Rate(System::DateTime from);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Rate, CODEPORTING_ARGS(System::DateTime from));
    ASPOSE_TASKS_SHARED_API void ConvertToMaterial();
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> GetDefaultRate(const System::SharedPtr<RateCollection>& collection, RateType type);
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> GetDefaultRate(RateType rateTable);
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> CreateRate(System::Decimal stdRate);
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> GetRateEffectiveOnDate(const System::SharedPtr<RateCollection>& rateCollection, RateType rateType, System::DateTime date);
    
    virtual ASPOSE_TASKS_SHARED_API ~Rate();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::Decimal standardRate;
    RateFormatType standardRateFormat;
    System::Decimal overtimeRate;
    RateFormatType overtimeRateFormat;
    System::WeakPtr<RateCollection> parentCollection;
    System::Decimal costPerUse;
    System::DateTime pr_RatesFrom;
    System::DateTime pr_RatesTo;
    RateType pr_RateTable;
    
    bool get_IsDefault();
    
    /// <summary>Initializes a new instance of the <see cref="Rate"></see> class.</summary>
    Rate(RateFormatType type);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Rate, CODEPORTING_ARGS(RateFormatType type));
    bool IsEffectiveOnDate(System::DateTime date);
    void UpdateResourceValue(Rate::UpdateType type);
    
};
 
} // namespace Tasks
} // namespace Aspose