RateCollection.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="RateCollection.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/collections/idictionary.h>
#include <system/array.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/Enums/RateType.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class AutoRecalculationState;
namespace Calculations
{
class RateByDateEnumeratorBase;
} // namespace Calculations
namespace Connectivity
{
class MpdReader;
class MpdResourceRateMapper;
class PmResourceRateMapper;
} // namespace Connectivity
namespace IO
{
namespace MSProject
{
class MPPResourceReader;
} // namespace MSProject
namespace PrimaveraXml
{
class PrimaveraResourceRateNodeReader;
} // namespace PrimaveraXml
namespace Xer
{
class XerResourceRateReader;
class XerUtils;
} // namespace Xer
namespace Xml
{
class RateNodeReader;
class ResourceNodeReader;
} // namespace Xml
} // namespace IO
class Rate;
class RateByDateCollection;
class Resource;
class ResourceAssignment;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class ICollection;
template <typename> class IEnumerable;
template <typename> class IEnumerator;
template <typename, typename> class KeyValuePair;
template <typename> class List;
} // namespace Generic
} // namespace Collections
class DateTime;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a collection which contains <see cref="Rate"></see> objects.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS RateCollection : public System::Collections::Generic::IDictionary<Aspose::Tasks::RateType, System::SharedPtr<Aspose::Tasks::RateByDateCollection>>
{
    typedef RateCollection ThisType;
    typedef System::Collections::Generic::IDictionary<Aspose::Tasks::RateType, System::SharedPtr<Aspose::Tasks::RateByDateCollection>> 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::Resource;
    friend class Aspose::Tasks::ResourceAssignment;
    friend class Aspose::Tasks::Connectivity::MpdReader;
    friend class Aspose::Tasks::Connectivity::MpdResourceRateMapper;
    friend class Aspose::Tasks::Connectivity::PmResourceRateMapper;
    friend class Aspose::Tasks::IO::MSProject::MPPResourceReader;
    friend class Aspose::Tasks::IO::Xer::XerResourceRateReader;
    friend class Aspose::Tasks::IO::Xer::XerUtils;
    friend class Aspose::Tasks::IO::Xml::RateNodeReader;
    friend class Aspose::Tasks::IO::Xml::ResourceNodeReader;
    friend class Aspose::Tasks::AutoRecalculationState;
    
public:
 
    /// <summary>
    ///  Gets the number of elements contained in the RateCollection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Count() const override;
    /// <summary>
    /// Gets a value indicating whether this collection is read only.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsReadOnly() const override;
    /// <summary>
    /// Gets the parent <see cref="Resource"></see> object for this collection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Resource> get_ParentResource() const;
    
    /// <summary>
    /// Returns the element at the specified index.
    /// </summary>
    /// <param name="key">The zero-based index of the element to get or set.</param>
    /// <returns>the element at the specified index.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<RateByDateCollection> idx_get(const RateType& key) const override;
    /// <summary>
    /// Sets the element at the specified index.
    /// </summary>
    /// <param name="key">The zero-based index of the element to get or set.</param>
    /// <param name="value">the element at the specified index.</param>
    ASPOSE_TASKS_SHARED_API void idx_set(const RateType& key, System::SharedPtr<RateByDateCollection> value) override;
    
    /// <summary>
    /// Adds a new <see cref="Rate"></see> instance to this collection.
    /// </summary>
    /// <param name="ratesFrom">The date the new rate comes into effect.</param>
    /// <returns>Added <see cref="Rate"></see> instance.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> Add(System::DateTime ratesFrom);
    /// <summary>
    /// Adds a new <see cref="Rate"></see> instance to this collection.
    /// </summary>
    /// <param name="ratesFrom">The date the new rate comes into effect.</param>
    /// <param name="type">The rate table to add into.</param>
    /// <returns>Added <see cref="Rate"></see> instance.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> Add(System::DateTime ratesFrom, RateType type);
    /// <summary>
    /// Removes Rate instance from this collection.
    /// </summary>
    /// <param name="item">The item to remove.</param>
    /// <returns>true if the specified Rate was removed successfully; otherwise, false.</returns>
    ASPOSE_TASKS_SHARED_API bool Remove(const System::SharedPtr<Rate>& item);
    /// <summary>
    /// Converts the <see cref="RateCollection"></see> object to a list of <see cref="Rate"></see> objects.
    /// </summary>
    /// <returns>List of <see cref="Rate"></see> objects.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Rate>>> ToList() const;
    /// <summary>
    /// Converts the <see cref="RateCollection"></see> object to a list of <see cref="Rate"></see> objects filtered by specified <see cref="RateType"></see> type.
    /// </summary>
    /// <param name="type">The type to filter on.</param>
    /// <returns>a list of <see cref="Rate"></see> objects.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Rate>>> ToList(RateType type) const;
    
protected:
 
    ASPOSE_TASKS_SHARED_API RateCollection(const System::SharedPtr<Resource>& rsc);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(RateCollection, CODEPORTING_ARGS(const System::SharedPtr<Resource>& rsc));
    
    ASPOSE_TASKS_SHARED_API RateCollection(const System::SharedPtr<Resource>& rsc, const System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Rate>>>& rates);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(RateCollection, CODEPORTING_ARGS(const System::SharedPtr<Resource>& rsc, const System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Rate>>>& rates));
    ASPOSE_TASKS_SHARED_API void AddRange(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Rate>>>& rateCollection);
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> Add(const System::SharedPtr<Rate>& rate);
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> CreateRate();
    ASPOSE_TASKS_SHARED_API void SetAsMaterial();
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Rate> GetFirstOrDefault(RateType rateType);
    /// <summary>
    /// Converts the <see cref="RateCollection"></see> object to a list of <see cref="Rate"></see> objects filtered by specified <see cref="RateType"></see> type.
    /// </summary>
    /// <param name="type">The type to filter on.</param>
    /// <returns>a list of <see cref="Rate"></see> objects.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<RateByDateCollection> GetByType(RateType type);
    
    virtual ASPOSE_TASKS_SHARED_API ~RateCollection();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    static System::DateTime& RatesFromMin();
    
    System::SharedPtr<System::Collections::Generic::IDictionary<RateType, System::SharedPtr<RateByDateCollection>>> rates;
    System::WeakPtr<Resource> parentResource;
    
    /// <inheritdoc/>
    System::SharedPtr<System::Collections::Generic::ICollection<RateType>> get_Keys() const override;
    /// <inheritdoc/>
    System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<RateByDateCollection>>> get_Values() const override;
    
    /// <summary>
    /// Returns an enumerator for this collection.
    /// </summary>
    /// <returns>an enumerator for this collection.</returns>
    System::SharedPtr<System::Collections::Generic::IEnumerator<System::Collections::Generic::KeyValuePair<RateType, System::SharedPtr<RateByDateCollection>>>> GetEnumerator() override;
    /// <inheritdoc/>
    void Add(const System::Collections::Generic::KeyValuePair<RateType, System::SharedPtr<RateByDateCollection>>& item) override;
    /// <inheritdoc/>
    void Clear() override;
    /// <inheritdoc/>
    bool Contains(const System::Collections::Generic::KeyValuePair<RateType, System::SharedPtr<RateByDateCollection>>& item) const override;
    /// <inheritdoc/>
    void CopyTo(System::ArrayPtr<System::Collections::Generic::KeyValuePair<RateType, System::SharedPtr<RateByDateCollection>>> array, int32_t arrayIndex) override;
    /// <inheritdoc/>
    bool Remove(const System::Collections::Generic::KeyValuePair<RateType, System::SharedPtr<RateByDateCollection>>& item) override;
    /// <inheritdoc/>
    bool ContainsKey(const RateType& key) const override;
    /// <inheritdoc/>
    void Add(const RateType& key, const System::SharedPtr<RateByDateCollection>& value) override;
    /// <inheritdoc/>
    bool Remove(const RateType& key) override;
    /// <inheritdoc/>
    bool TryGetValue(const RateType& key, System::SharedPtr<RateByDateCollection>& value) const override;
    System::SharedPtr<Rate> GetLast(RateType type);
    
};
 
} // namespace Tasks
} // namespace Aspose