ResourceAssignmentCollection.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ResourceAssignmentCollection.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/collections/ilist.h>
#include <system/array.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace Connectivity
{
class MpdReader;
class MspDbReader;
class PrimaveraDbReader;
} // namespace Connectivity
class IdGenerator;
namespace IO
{
namespace Html
{
class HtmlResourceAssignmentTableReader;
} // namespace Html
namespace MSProject
{
class MPP12Reader;
class MPP12TaskWriter;
class MPP14Reader;
class MPP9Reader;
} // namespace MSProject
namespace PrimaveraXml
{
class PrimaveraProjectNodeReader;
} // namespace PrimaveraXml
namespace Pwa
{
namespace InternalApi
{
namespace Mapping
{
class ProjectAssignmentsMapper;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
namespace Xer
{
class XerPrimaveraReader;
class XerProjectNormalizer;
} // namespace Xer
namespace Xml
{
class XmlReader;
} // namespace Xml
} // namespace IO
class Project;
class Resource;
class ResourceAssignment;
class ResourceCollection;
namespace Scheduling
{
class FromFinishScheduler;
class FromStartScheduler;
} // namespace Scheduling
class Task;
class TaskPlanner;
namespace Visualization
{
class ApsResourceUsageBuilder;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename, typename> class IDictionary;
template <typename> class IEnumerable;
template <typename> class IEnumerator;
template <typename> class List;
} // namespace Generic
} // namespace Collections
class Decimal;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a collection of <see cref="ResourceAssignment"></see> objects.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ResourceAssignmentCollection : public System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::ResourceAssignment>>
{
    typedef ResourceAssignmentCollection ThisType;
    typedef System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::ResourceAssignment>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraProjectNodeReader;
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::Resource;
    friend class Aspose::Tasks::ResourceAssignment;
    friend class Aspose::Tasks::Task;
    friend class Aspose::Tasks::Connectivity::MpdReader;
    friend class Aspose::Tasks::Connectivity::MspDbReader;
    friend class Aspose::Tasks::Connectivity::PrimaveraDbReader;
    friend class Aspose::Tasks::IO::Html::HtmlResourceAssignmentTableReader;
    friend class Aspose::Tasks::IO::MSProject::MPP12Reader;
    friend class Aspose::Tasks::IO::MSProject::MPP14Reader;
    friend class Aspose::Tasks::IO::MSProject::MPP9Reader;
    friend class Aspose::Tasks::IO::MSProject::MPP12TaskWriter;
    friend class Aspose::Tasks::IO::Xer::XerPrimaveraReader;
    friend class Aspose::Tasks::IO::Xer::XerProjectNormalizer;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectAssignmentsMapper;
    friend class Aspose::Tasks::IO::Xml::XmlReader;
    friend class Aspose::Tasks::TaskPlanner;
    friend class Aspose::Tasks::ResourceCollection;
    friend class Aspose::Tasks::Scheduling::FromFinishScheduler;
    friend class Aspose::Tasks::Scheduling::FromStartScheduler;
    friend class Aspose::Tasks::Visualization::ApsResourceUsageBuilder;
    
public:
 
    /// <summary>
    /// Gets the parent project of the ResourceAssignmentCollection object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Project> get_ParentProject() const;
    /// <summary>
    /// Gets a value indicating whether this collection is read only.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsReadOnly() const override;
    /// <summary>
    /// Gets the number of objects contained in the ResourceAssignmentCollection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Count() const override;
    
    /// <summary>
    /// Returns the element at the specified index.
    /// </summary>
    /// <param name="index">The zero-based index of the element to get.</param>
    /// <returns>the element at the specified index.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ResourceAssignment> idx_get(int32_t index) const override;
    /// <summary>
    /// Returns the element at the specified index.
    /// </summary>
    /// <param name="index">The zero-based index of the element to get.</param>
    /// <param name="value">the element at the specified index.</param>
    ASPOSE_TASKS_SHARED_API void idx_set(int32_t index, System::SharedPtr<ResourceAssignment> value) override;
    
    /// <summary>
    /// Returns an enumerator for this collection.
    /// </summary>
    /// <returns>an enumerator for this collection.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<ResourceAssignment>>> GetEnumerator() override;
    /// <summary>
    /// Converts the ResourceAssignmentCollection object to a list of <see cref="ResourceAssignment"></see> objects.
    /// </summary>
    /// <returns>List of <see cref="ResourceAssignment"></see> objects.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<ResourceAssignment>>> ToList();
    /// <summary>
    /// Adds new assignment to the ResourceAssignmentCollection.
    /// </summary>
    /// <param name="task">A task to be assigned.</param>
    /// <param name="resource">A resource to be assigned.</param>
    /// <param name="units">The number of units for a new assignment.</param>
    /// <returns>Added assignment.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ResourceAssignment> Add(const System::SharedPtr<Task>& task, const System::SharedPtr<Resource>& resource, double units);
    /// <summary>
    /// Adds new assignment to the ResourceAssignmentCollection.
    /// </summary>
    /// <param name="task">A task to be assigned.</param>
    /// <param name="resource">A cost resource to be assigned.</param>
    /// <param name="cost">The cost for a new assignment.</param>
    /// <returns>Added assignment.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ResourceAssignment> Add(const System::SharedPtr<Task>& task, const System::SharedPtr<Resource>& resource, System::Decimal cost);
    /// <summary>
    /// Adds new assignment to the ResourceAssignmentCollection.
    /// </summary>
    /// <param name="task">A task to be assigned.</param>
    /// <param name="resource">A resource to be assigned.</param>
    /// <returns>Added assignment.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ResourceAssignment> Add(const System::SharedPtr<Task>& task, const System::SharedPtr<Resource>& resource);
    /// <summary>
    /// Returns an assignment with the specified uid.
    /// </summary>
    /// <param name="uid">The specified uid.</param>
    /// <remarks>O(1) complexity.</remarks>
    /// <returns>ResourceAssignment with the specified uid if present; otherwise, null.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ResourceAssignment> GetByUid(int32_t uid);
    /// <summary>
    /// Removes specified assignment from collection, if it is not read-only,
    /// otherwise throws NotSupportedException.
    /// </summary>
    /// <param name="item">The assignment to remove.</param>
    /// <returns>true, if specified item was removed, false otherwise.</returns>
    ASPOSE_TASKS_SHARED_API bool Remove(const System::SharedPtr<ResourceAssignment>& item) override;
    /// <summary>
    /// Removes assignment at specified index, if collection is not read-only,
    /// otherwise throws NotSupportedException.
    /// </summary>
    /// <param name="index">Zero-based index.</param>
    ASPOSE_TASKS_SHARED_API void RemoveAt(int32_t index) override;
    /// <summary>
    /// This is the stub implementation of ICollection's Add method, that only throws NotSupportedException
    /// </summary>
    /// <param name="item">The item to remove.</param>
    ASPOSE_TASKS_SHARED_API void Add(const System::SharedPtr<ResourceAssignment>& item) override;
    
protected:
 
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ResourceAssignment> get_First();
    
    ASPOSE_TASKS_SHARED_API ResourceAssignmentCollection(const System::SharedPtr<Project>& parentProject, bool isReadOnly);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ResourceAssignmentCollection, CODEPORTING_ARGS(const System::SharedPtr<Project>& parentProject, bool isReadOnly));
    
    ASPOSE_TASKS_SHARED_API ResourceAssignmentCollection(const System::SharedPtr<Project>& parentProject);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ResourceAssignmentCollection, CODEPORTING_ARGS(const System::SharedPtr<Project>& parentProject));
    
    ASPOSE_TASKS_SHARED_API ResourceAssignmentCollection(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<ResourceAssignment>>>& assignments, const System::SharedPtr<Project>& parentProject);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ResourceAssignmentCollection, CODEPORTING_ARGS(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<ResourceAssignment>>>& assignments, const System::SharedPtr<Project>& parentProject));
    
    ASPOSE_TASKS_SHARED_API ResourceAssignmentCollection(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<ResourceAssignment>>>& assignments, const System::SharedPtr<Project>& parentProject, bool isReadOnly);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ResourceAssignmentCollection, CODEPORTING_ARGS(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<ResourceAssignment>>>& assignments, const System::SharedPtr<Project>& parentProject, bool isReadOnly));
    /// <summary>
    /// Recalculate unique identifiers of assignments from 1 up to assignment collection length - 1.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void CalcResourceAssignmentUids();
    ASPOSE_TASKS_SHARED_API void AddInternal(const System::SharedPtr<ResourceAssignment>& assn);
    ASPOSE_TASKS_SHARED_API bool RemoveInternal(const System::SharedPtr<ResourceAssignment>& assn, bool rebuildIndex = true);
    ASPOSE_TASKS_SHARED_API void RemoveInternal(const System::SharedPtr<System::Collections::Generic::IList<int32_t>>& indexes);
    
    virtual ASPOSE_TASKS_SHARED_API ~ResourceAssignmentCollection();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<ResourceAssignment>>> assignments;
    System::SharedPtr<System::Collections::Generic::IDictionary<System::SharedPtr<ResourceAssignment>, System::SharedPtr<ResourceAssignment>>> assnMap;
    System::SharedPtr<System::Collections::Generic::IDictionary<int32_t, int32_t>> lookupIndex;
    System::WeakPtr<Project> parentProject;
    bool isReadOnly;
    System::SharedPtr<IdGenerator> uidGenerator;
    
    void Clear() override;
    bool Contains(const System::SharedPtr<ResourceAssignment>& item) const override;
    void CopyTo(System::ArrayPtr<System::SharedPtr<ResourceAssignment>> array, int32_t arrayIndex) override;
    int32_t IndexOf(const System::SharedPtr<ResourceAssignment>& item) const override;
    void Insert(int32_t index, const System::SharedPtr<ResourceAssignment>& item) override;
    void RebuildAssnLookupIndex();
    void Init(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<ResourceAssignment>>>& assignmentCollection);
    
};
 
} // namespace Tasks
} // namespace Aspose