ResourceCollection.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ResourceCollection.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 HtmlResourceTableReader;
} // namespace Html
namespace Mpx
{
class MpxReader;
} // namespace Mpx
namespace MSProject
{
class MPP12Reader;
class MPP14Reader;
class MPP9Reader;
class MPPReader;
class MPPWriter;
} // namespace MSProject
namespace PrimaveraXml
{
class PrimaveraReader;
} // namespace PrimaveraXml
namespace Pwa
{
namespace InternalApi
{
namespace Mapping
{
class ProjectResourcesMapper;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
namespace Xer
{
class XerPrimaveraReader;
class XerProjectNormalizer;
} // namespace Xer
namespace Xml
{
class XmlReader;
} // namespace Xml
} // namespace IO
namespace Leveling
{
class LevelingAlgorithm;
} // namespace Leveling
class Project;
class Resource;
namespace Saving
{
class TemplateProjectLoader;
class XerResourceTable;
} // namespace Saving
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IComparer;
template <typename, typename> class IDictionary;
template <typename> class IEnumerator;
template <typename> class List;
} // namespace Generic
} // namespace Collections
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a collection of <see cref="Resource"></see> objects.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ResourceCollection : public System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::Resource>>
{
    typedef ResourceCollection ThisType;
    typedef System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::Resource>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraReader;
    friend class Aspose::Tasks::Leveling::LevelingAlgorithm;
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::Resource;
    friend class Aspose::Tasks::Saving::TemplateProjectLoader;
    friend class Aspose::Tasks::Connectivity::MpdReader;
    friend class Aspose::Tasks::Connectivity::MspDbReader;
    friend class Aspose::Tasks::Connectivity::PrimaveraDbReader;
    friend class Aspose::Tasks::IO::Html::HtmlResourceTableReader;
    friend class Aspose::Tasks::IO::MSProject::MPP12Reader;
    friend class Aspose::Tasks::IO::MSProject::MPPReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14Reader;
    friend class Aspose::Tasks::IO::MSProject::MPPWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP9Reader;
    friend class Aspose::Tasks::IO::Mpx::MpxReader;
    friend class Aspose::Tasks::IO::Xer::XerPrimaveraReader;
    friend class Aspose::Tasks::IO::Xer::XerProjectNormalizer;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectResourcesMapper;
    friend class Aspose::Tasks::IO::Xml::XmlReader;
    friend class Aspose::Tasks::Saving::XerResourceTable;
    
public:
 
    /// <summary>
    ///  Gets the number of elements contained in the ResourceCollection.
    /// <remarks>Read-only <see cref="int32_t"></see>.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Count() const override;
    /// <summary>
    /// Gets the parent project of the ResourceCollection object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Project> get_ParentProject() const;
    
    /// <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<Resource> 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<Resource> 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<Resource>>> GetEnumerator() override;
    /// <summary>
    /// Adds new resource at the last position of a project resources collection.
    /// </summary>
    /// <returns>Added resource.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Resource> Add();
    /// <summary>
    /// Adds new resource at the last position of a project resources collection.
    /// </summary>
    /// <param name="resourceName">Name of a resource.</param>
    /// <returns>Added resource.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Resource> Add(const System::String& resourceName);
    /// <summary>
    /// Adds new resource at the specified position of a project resources collection.
    /// </summary>
    /// <param name="resourceName">Name of a resource.</param>
    /// <param name="beforeResourceId">Position of the previous resource in a project resources collection.</param>
    /// <returns>Added resource.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Resource> Add(const System::String& resourceName, int32_t beforeResourceId);
    /// <summary>
    /// Converts the ResourceCollection object to a list of <see cref="Resource"></see> objects.
    /// </summary>
    /// <returns>List of <see cref="Resource"></see> objects.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Resource>>> ToList();
    /// <summary>
    /// Returns a resource with the specified id.
    /// </summary>
    /// <param name="id">The specified id.</param>
    /// <remarks>O(1) complexity.</remarks>
    /// <returns>Resource with the specified id if present; otherwise, null.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Resource> GetById(int32_t id);
    /// <summary>
    /// Returns a resource with the specified Uid.
    /// </summary>
    /// <param name="uid">The specified uid.</param>
    /// <remarks>O(1) complexity.</remarks>
    /// <returns>Resource with the specified uid if present; otherwise, null.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Resource> GetByUid(int32_t uid);
    /// <summary>
    /// Direct clearing is not supported, this method just throw NotSupportedException.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void Clear() override;
    /// <summary>
    /// This is the stub implementation of ICollection's Remove
    /// method, that only throws NotSupportedException
    /// </summary>
    /// <param name="item">the item to remove.</param>
    /// <returns><c>true</c> if the item was removed; <c>false</c> otherwise.</returns>
    ASPOSE_TASKS_SHARED_API bool Remove(const System::SharedPtr<Resource>& item) override;
    
protected:
 
    ASPOSE_TASKS_SHARED_API ResourceCollection(const System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Resource>>>& resources, const System::SharedPtr<Project>& parentProject);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ResourceCollection, CODEPORTING_ARGS(const System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Resource>>>& resources, const System::SharedPtr<Project>& parentProject));
    
    ASPOSE_TASKS_SHARED_API ResourceCollection(const System::SharedPtr<Project>& parentProject);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ResourceCollection, CODEPORTING_ARGS(const System::SharedPtr<Project>& parentProject));
    ASPOSE_TASKS_SHARED_API void AddRootResource();
    /// <summary>
    /// Initializes id and uid and then adds resource at the end of a project resources collection.
    /// </summary>
    /// <param name="resource">Resource to be added</param>
    ASPOSE_TASKS_SHARED_API void InitUidAndIdThenAdd(const System::SharedPtr<Resource>& resource);
    ASPOSE_TASKS_SHARED_API bool RemoveInternal(const System::SharedPtr<Resource>& resource);
    /// <summary>
    /// Recalculate Ids of resources.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void CalcResourceIds();
    /// <summary>
    /// Recalculate Uids of resources from 1 up to resources collection length - 1.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void CalcResourceUids();
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Resource>>> GetValidResources();
    ASPOSE_TASKS_SHARED_API void Sort(const System::SharedPtr<System::Collections::Generic::IComparer<System::SharedPtr<Resource>>>& comparer);
    ASPOSE_TASKS_SHARED_API void ClearInternal();
    ASPOSE_TASKS_SHARED_API void ResetCache();
    
    virtual ASPOSE_TASKS_SHARED_API ~ResourceCollection();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::WeakPtr<Project> parentProject;
    System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Resource>>> resources;
    System::SharedPtr<System::Collections::Generic::IDictionary<int32_t, System::SharedPtr<Resource>>> idLookup;
    System::SharedPtr<System::Collections::Generic::IDictionary<int32_t, System::SharedPtr<Resource>>> uidLookup;
    System::SharedPtr<IdGenerator> idGenerator;
    System::SharedPtr<IdGenerator> uidGenerator;
    
    bool get_IsReadOnly() const override;
    
    void Add(const System::SharedPtr<Resource>& item) override;
    bool Contains(const System::SharedPtr<Resource>& item) const override;
    void CopyTo(System::ArrayPtr<System::SharedPtr<Resource>> array, int32_t arrayIndex) override;
    int32_t IndexOf(const System::SharedPtr<Resource>& item) const override;
    void Insert(int32_t index, const System::SharedPtr<Resource>& item) override;
    void RemoveAt(int32_t index) override;
    void AddResourceCalendar(const System::SharedPtr<Resource>& resource);
    bool ContainsRootResource();
    void Init();
    void CalcResourceIds(int32_t startId);
    void InitParentAndAssignments();
    void InitIdLookup();
    void InitUidLookup();
    
};
 
} // namespace Tasks
} // namespace Aspose