TaskLinkCollection.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="TaskLinkCollection.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------

#include <system/collections/list.h>
#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 MpdTaskLinkMapper;
class MspTaskLinksMapper;
class PmTaskRelationMapper;
} // namespace Connectivity
class Duration;
namespace IO
{
namespace Html
{
class HtmlTaskTableReader;
} // namespace Html
namespace Mpx
{
class MpxReader;
} // namespace Mpx
namespace MSProject
{
class MPP12Reader;
class MPP14Reader;
class MPP9Reader;
} // namespace MSProject
namespace PrimaveraXml
{
class PrimaveraRelationshipNodeReader;
} // namespace PrimaveraXml
namespace Pwa
{
namespace InternalApi
{
namespace Mapping
{
class TaskLinkEntityMapper;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
namespace Xer
{
class XerRelationReader;
} // namespace Xer
namespace Xml
{
class TaskLinksNodeReader;
} // namespace Xml
} // namespace IO
class Project;
class Task;
class TaskLink;
enum class TaskLinkType;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IComparer;
template <typename> class IEnumerable;
template <typename> class IEnumerator;
} // namespace Generic
} // namespace Collections
} // namespace System

namespace Aspose {

namespace Tasks {

/// <summary>
/// Represents a collection of <see cref="Task"></see> objects.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS TaskLinkCollection : public System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::TaskLink>>
{
    typedef TaskLinkCollection ThisType;
    typedef System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::TaskLink>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraRelationshipNodeReader;
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::Task;
    friend class Aspose::Tasks::Connectivity::MpdTaskLinkMapper;
    friend class Aspose::Tasks::Connectivity::MspTaskLinksMapper;
    friend class Aspose::Tasks::Connectivity::PmTaskRelationMapper;
    friend class Aspose::Tasks::IO::Html::HtmlTaskTableReader;
    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::Mpx::MpxReader;
    friend class Aspose::Tasks::IO::Xer::XerRelationReader;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::TaskLinkEntityMapper;
    friend class Aspose::Tasks::IO::Xml::TaskLinksNodeReader;
    
public:
    /// A collection type whose iterator types is used as iterator types in the current collection.
    using iterator_holder_type = System::Collections::Generic::List<System::SharedPtr<TaskLink>>;
    /// Iterator type.
    using iterator = typename iterator_holder_type::iterator;
    /// Const iterator type.
    using const_iterator = typename iterator_holder_type::const_iterator;
    /// Virtualized element type.
    using virtualized_iterator_element = typename iterator_holder_type::virtualized_iterator_element;
    /// Virtualized type.
    using virtualized_iterator = typename iterator_holder_type::virtualized_iterator;
    
public:

    /// <summary>
    /// Gets the parent project of the ResourceAssignmentCollection object.
    /// <returns>parent <see cref="Project"></see> for this object.</returns>
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Project> get_ParentProject() const;
    /// <summary>
    /// Gets the number of objects contained in this <see cref="TaskLinkCollection"></see> object.
    /// </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 or set.</param>
    /// <returns>the element at the specified index.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<TaskLink> idx_get(int32_t index) const override;
    /// <summary>
    /// Sets the element at the specified index.
    /// </summary>
    /// <param name="index">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(int32_t index, System::SharedPtr<TaskLink> 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<TaskLink>>> GetEnumerator() override;
    /// <summary>
    /// Returns an instance of Finish-Start <see cref="TaskLink"></see> which has been added to the TaskLinkCollection object.
    /// </summary>
    /// <param name="pred">Predecessor task.</param>
    /// <param name="succ">Successor task.</param>
    /// <returns>a task link instance which has been added to this object.</returns>
    /// <exception cref="ArgumentNullException">If any of input tasks is equal to null then <see cref="ArgumentNullException"></see> will be thrown.</exception>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<TaskLink> Add(const System::SharedPtr<Task>& pred, const System::SharedPtr<Task>& succ);
    /// <summary>
    /// Returns an instance of <see cref="TaskLink"></see> which has been added to the TaskLinkCollection object.
    /// </summary>
    /// <param name="pred">Predecessor task.</param>
    /// <param name="succ">Successor task.</param>
    /// <param name="linkType">Link type <see cref="TaskLinkType"></see> </param>
    /// <returns>a task link instance which has been added to this object.</returns>
    /// <exception cref="ArgumentNullException">If any of input tasks is equal to null then <see cref="ArgumentNullException"></see> will be thrown.</exception>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<TaskLink> Add(const System::SharedPtr<Task>& pred, const System::SharedPtr<Task>& succ, TaskLinkType linkType);
    /// <summary>
    /// Returns an instance of <see cref="TaskLink"></see> which has been added to the TaskLinkCollection object.
    /// </summary>
    /// <param name="pred">Predecessor task.</param>
    /// <param name="succ">Successor task.</param>
    /// <param name="linkType">Link type <see cref="TaskLinkType"></see> </param>
    /// <param name="lag">Link lag <see cref="Duration"></see>.</param>
    /// <returns>a task link which has been added to this object.</returns>
    /// <exception cref="ArgumentNullException">If any of input tasks is equal to null then <see cref="ArgumentNullException"></see> will be thrown.</exception>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<TaskLink> Add(const System::SharedPtr<Task>& pred, const System::SharedPtr<Task>& succ, TaskLinkType linkType, Duration lag);
    /// <summary>
    /// This is the stub implementation of ICollection's Add method, that only throws NotSupportedException
    /// </summary>
    /// <param name="item">The item to add.</param>
    ASPOSE_TASKS_SHARED_API void Add(const System::SharedPtr<TaskLink>& item) override;
    /// <summary>
    /// Removes task link from a project.
    /// </summary>
    /// <param name="item">TaskLink to remove.</param>
    /// <returns>removed TaskLink.</returns>
    ASPOSE_TASKS_SHARED_API bool Remove(const System::SharedPtr<TaskLink>& item) override;
    /// <summary>
    /// Converts the TaskLinkCollection object to a list of <see cref="TaskLink"></see> objects.
    /// </summary>
    /// <returns>List of <see cref="TaskLink"></see> objects.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<TaskLink>>> ToList();
    /// Gets iterator pointing to the first element (if any) of the collection.
    /// @return An iterator pointing to the first element (if any) of the collection
    ASPOSE_TASKS_SHARED_API iterator begin() noexcept;
    /// Gets iterator pointing right after the last element (if any) of the collection.
    /// @return An iterator pointing right after the last element (if any) of the collection
    ASPOSE_TASKS_SHARED_API iterator end() noexcept;
    /// Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection.
    /// @return An iterator pointing to the first element (if any) of the const-qualified instance of the collection
    ASPOSE_TASKS_SHARED_API const_iterator begin() const noexcept;
    /// Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection.
    /// @return An iterator pointing right after the last element (if any) of the const-qualified instance of the collection
    ASPOSE_TASKS_SHARED_API const_iterator end() const noexcept;
    /// Gets iterator pointing to the first const-qualified element (if any) of the collection.
    /// @return An iterator pointing to the first const-qualified element (if any) of the collection
    ASPOSE_TASKS_SHARED_API const_iterator cbegin() const noexcept;
    /// Gets iterator pointing right after the last const-qualified element (if any) of the collection.
    /// @return An iterator pointing right after the last const-qualified element (if any) of the collection
    ASPOSE_TASKS_SHARED_API const_iterator cend() const noexcept;
    /// Gets iterator pointing to the first element (if any) of the collection.
    /// @return An iterator pointing to the first element (if any) of the collection
    /// Provides iterator implementation to container's first element.
    /// @return Newly-created iterator object.
    ASPOSE_TASKS_SHARED_API virtualized_iterator* virtualizeBeginIterator() override;
    /// Gets iterator pointing right after the last element (if any) of the collection.
    /// @return An iterator pointing right after the last element (if any) of the collection
    /// Provides iterator implementation to container's end.
    /// @return Newly-created iterator object.
    ASPOSE_TASKS_SHARED_API virtualized_iterator* virtualizeEndIterator() override;
    /// Gets iterator pointing to the first element (if any)of the const-qualified instance of the collection.
    /// @return An iterator pointing to the first element (if any)of the const-qualified instance of the collection
    /// Provides const iterator implementation to container's first element.
    /// @return Newly-created iterator object.
    ASPOSE_TASKS_SHARED_API virtualized_iterator* virtualizeBeginConstIterator() const override;
    /// Gets iterator pointing right after the last element (if any)of the const-qualified instance of the collection.
    /// @return An iterator pointing right after the last element (if any)of the const-qualified instance of the collection
    /// Provides const iterator implementation to container's end.
    /// @return Newly-created iterator object.
    ASPOSE_TASKS_SHARED_API virtualized_iterator* virtualizeEndConstIterator() const override;
    
protected:

    ASPOSE_TASKS_SHARED_API TaskLinkCollection(const System::SharedPtr<Project>& parentProject);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TaskLinkCollection, CODEPORTING_ARGS(const System::SharedPtr<Project>& parentProject));
    
    ASPOSE_TASKS_SHARED_API TaskLinkCollection(const System::SharedPtr<Project>& parentProject, const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<TaskLink>>>& links);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TaskLinkCollection, CODEPORTING_ARGS(const System::SharedPtr<Project>& parentProject, const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<TaskLink>>>& links));
    ASPOSE_TASKS_SHARED_API void AddInternal(const System::SharedPtr<TaskLink>& link);
    ASPOSE_TASKS_SHARED_API void Sort(const System::SharedPtr<System::Collections::Generic::IComparer<System::SharedPtr<TaskLink>>>& comparer);
    
    virtual ASPOSE_TASKS_SHARED_API ~TaskLinkCollection();
    
    #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::List<System::SharedPtr<TaskLink>>> links;
    System::WeakPtr<Project> parentProject;
    
    bool get_IsReadOnly() const override;
    
    void Clear() override;
    bool Contains(const System::SharedPtr<TaskLink>& item) const override;
    void CopyTo(System::ArrayPtr<System::SharedPtr<TaskLink>> array, int32_t arrayIndex) override;
    int32_t IndexOf(const System::SharedPtr<TaskLink>& item) const override;
    void Insert(int32_t index, const System::SharedPtr<TaskLink>& item) override;
    void RemoveAt(int32_t index) override;
    /// <summary>
    /// Add a task link to a project.
    /// </summary>
    /// <param name="link">TaskLink to add.</param>
    bool AddTaskLink(const System::SharedPtr<TaskLink>& link);
    
};

} // namespace Tasks
} // namespace Aspose