TaskCollection.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="TaskCollection.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 Calculations
{
class SummaryTaskCalculator;
} // namespace Calculations
namespace Connectivity
{
class MspTaskMapper;
class PmTaskMapper;
} // namespace Connectivity
namespace IO
{
namespace Html
{
class HtmlTaskTableReader;
} // namespace Html
namespace Mpx
{
class MpxReader;
} // namespace Mpx
namespace MSProject
{
class MppTaskTreeBuilder;
} // namespace MSProject
namespace PrimaveraXml
{
class P6XmlUtils;
class PrimaveraActivityNodeReader;
class PrimaveraProjectNodeReader;
} // namespace PrimaveraXml
namespace Pwa
{
namespace InternalApi
{
namespace Mapping
{
class ProjectTasksMapper;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
namespace Xer
{
class XerPrimaveraReader;
class XerProjectNormalizer;
} // namespace Xer
} // namespace IO
class PercentCompleteCalculator;
class Project;
class ProjectState;
class RecurringTaskBuilder;
class RecurringTaskParameters;
class SummaryTaskTotals;
class Task;
class TaskTreeBuilder;
namespace Util
{
class RemoveTask;
class TaskUtils;
} // namespace Util
namespace Visualization
{
class LegendItemsFlowLayoutBuilder;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IComparer;
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 TaskCollection : public System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::Task>>
{
    typedef TaskCollection ThisType;
    typedef System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::Task>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Calculations::SummaryTaskCalculator;
    friend class Aspose::Tasks::IO::PrimaveraXml::P6XmlUtils;
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraActivityNodeReader;
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraProjectNodeReader;
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::SummaryTaskTotals;
    friend class Aspose::Tasks::Task;
    friend class Aspose::Tasks::Connectivity::MspTaskMapper;
    friend class Aspose::Tasks::Connectivity::PmTaskMapper;
    friend class Aspose::Tasks::IO::Html::HtmlTaskTableReader;
    friend class Aspose::Tasks::IO::MSProject::MppTaskTreeBuilder;
    friend class Aspose::Tasks::IO::Mpx::MpxReader;
    friend class Aspose::Tasks::TaskTreeBuilder;
    friend class Aspose::Tasks::IO::Xer::XerPrimaveraReader;
    friend class Aspose::Tasks::IO::Xer::XerProjectNormalizer;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectTasksMapper;
    friend class Aspose::Tasks::ProjectState;
    friend class Aspose::Tasks::PercentCompleteCalculator;
    friend class Aspose::Tasks::RecurringTaskBuilder;
    friend class Aspose::Tasks::Util::RemoveTask;
    friend class Aspose::Tasks::Util::TaskUtils;
    friend class Aspose::Tasks::Visualization::LegendItemsFlowLayoutBuilder;
    
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<Task>>;
    /// 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 number of objects contained in the TaskCollection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Count() const override;
    /// <summary>
    /// Gets the parent project of the TaskCollection object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Project> get_ParentProject();
    /// <summary>
    /// Gets a value indicating whether this collection is read only.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsReadOnly() 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<Task> 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<Task> 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<Task>>> GetEnumerator() override;
    /// <summary>
    /// Add the specified task to the instance of the <see cref="TaskCollection"></see> class.
    /// If ParentProject.CalculationMode is None user should invoke Project.Recalculate() after using this method (It will reschedule all project tasks (start/finish dates, sets early/late dates) and calculate the dependent fields such as slacks, work and cost fields, ids and outline levels).
    /// If ParentProject.CalculationMode is Manual the method will calculate only task id, outline level and outline numbers automatically.
    /// If ParentProject.CalculationMode is Automatic the method reschedules all project's tasks automatically
    /// (start/finish dates, sets early/late dates, calculates slacks, work and cost fields, recalculates  ids and outline levels).
    /// </summary>
    /// <param name="item">the specified task which should be added to this task collection.</param>
    ASPOSE_TASKS_SHARED_API void Add(const System::SharedPtr<Task>& item) override;
    /// <summary>
    /// This is the stub implementation of IList's Insert
    /// method, that only throws NotSupportedException
    /// </summary>
    /// <param name="index">The index to insert at.</param>
    /// <param name="item">The item to insert.</param>
    ASPOSE_TASKS_SHARED_API void Insert(int32_t index, const System::SharedPtr<Task>& item) 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<Task>& item) override;
    /// <summary>
    /// Adds new task to project tasks collection on the same outline level of the last task.
    /// </summary>
    /// <returns>returns the newly added instance of the <see cref="Task"></see> class.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Task> Add();
    /// <summary>
    /// Adds a new task to children tasks collection.
    /// </summary>
    /// <param name="taskName">the specified task name.</param>
    /// <returns>returns the newly added instance of the <see cref="Task"></see> class.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Task> Add(const System::String& taskName);
    /// <summary>
    /// Adds a new recurring task to children tasks collection.
    /// </summary>
    /// <param name="taskName">the specified task name.</param>
    /// <param name="beforeTaskId">The specified id of a task before which a new task will be inserted.</param>
    /// <returns>returns a task which was inserted before a task with the specified id.</returns>
    /// <exception cref="ArgumentOutOfRangeException">ArgumentOutOfRangeException is thrown if the specified id is not a valid task id.</exception>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Task> Add(const System::String& taskName, int32_t beforeTaskId);
    /// <summary>
    /// Inserts a new task before a task with the specified id and on the same outline level.
    /// </summary>
    /// <param name="parameters">The parameters the specified parameters for creation of recurring task.</param>
    /// <returns>returns the newly added instance of the <see cref="Task"></see> class.</returns>
    /// <exception cref="ArgumentNullException">Thrown if the specified parameters are null.</exception>
    /// <exception cref="ArgumentException">Thrown if the specified parameters are invalid.</exception>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Task> Add(const System::SharedPtr<RecurringTaskParameters>& parameters);
    /// <summary>
    /// Converts the TaskCollection object to a list of <see cref="Task"></see> objects.
    /// </summary>
    /// <returns>returns a list which contains the <see cref="Task"></see> class instances of this collection.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Task>>> ToList();
    /// <summary>
    /// Returns a task with the specified Uid whose ancestor is parent task of this collection .
    /// </summary>
    /// <param name="uid">TaskEntity Uid.</param>
    /// <returns>returns the instance of <see cref="Task"></see> class with the specified uid whose ancestor is parent task of this collection.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Task> GetByUid(int32_t uid);
    /// <summary>
    /// Returns a task with the specified Id whose ancestor is parent task of this collection .
    /// </summary>
    /// <param name="id">TaskEntity Id</param>
    /// <returns>returns the instance of <see cref="Task"></see> class with the specified id whose ancestor is parent task of this collection.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Task> GetById(int32_t id);
    /// <summary>
    /// Checks if collection contains specified item.
    /// </summary>
    /// <param name="item">The item to check.</param>
    /// <returns>true, if collection contains an item, false otherwise.</returns>
    ASPOSE_TASKS_SHARED_API bool Contains(const System::SharedPtr<Task>& item) const override;
    /// 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:
 
    System::SharedPtr<SummaryTaskTotals> Totals;
    
    /// <summary>
    /// Gets the parent task of the collection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Task> get_ParentTask() const;
    
    ASPOSE_TASKS_SHARED_API TaskCollection(const System::SharedPtr<Task>& parentTask, bool isReadOnly, const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Task>>>& tasks);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TaskCollection, CODEPORTING_ARGS(const System::SharedPtr<Task>& parentTask, bool isReadOnly, const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Task>>>& tasks));
    
    ASPOSE_TASKS_SHARED_API TaskCollection(const System::SharedPtr<Task>& parentTask);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TaskCollection, CODEPORTING_ARGS(const System::SharedPtr<Task>& parentTask));
    
    ASPOSE_TASKS_SHARED_API TaskCollection(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Task>>>& tasks, const System::SharedPtr<Task>& parentTask);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TaskCollection, CODEPORTING_ARGS(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Task>>>& tasks, const System::SharedPtr<Task>& parentTask));
    ASPOSE_TASKS_SHARED_API void AddInternal(const System::SharedPtr<Task>& task);
    ASPOSE_TASKS_SHARED_API bool RemoveInternal(const System::SharedPtr<Task>& task);
    /// <summary>
    /// Recalculate uids of tasks (from 0).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void CalcTaskUids();
    ASPOSE_TASKS_SHARED_API void InsertInternal(int32_t index, const System::SharedPtr<Task>& item);
    ASPOSE_TASKS_SHARED_API void Sort(const System::SharedPtr<System::Collections::Generic::IComparer<System::SharedPtr<Task>>>& comparer);
    
    virtual ASPOSE_TASKS_SHARED_API ~TaskCollection();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::WeakPtr<Task> parentTask;
    bool isReadOnly;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Task>>> tasks;
    
    void RemoveAt(int32_t index) override;
    void Clear() override;
    void CopyTo(System::ArrayPtr<System::SharedPtr<Task>> array, int32_t arrayIndex) override;
    int32_t IndexOf(const System::SharedPtr<Task>& item) const override;
    void SetParentTaskToAutomatic();
    void Calculate(const System::SharedPtr<Task>& task);
    void AssignNewTaskId(const System::SharedPtr<Task>& addedTask);
    static bool IsLastTask(const System::SharedPtr<Task>& task);
    bool IsLastTaskInCollection(const System::SharedPtr<Task>& task);
    void Init();
    void UpdateEstimated(const System::SharedPtr<Task>& task);
    
};
 
} // namespace Tasks
} // namespace Aspose