ExtendedAttributeCollection.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ExtendedAttributeCollection.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/collections/icomparer.h>
#include <system/array.h>
#include <cstdint>

#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"

namespace Aspose
{
namespace Tasks
{
class ExtendedAttribute;
class IExtendedAttributeParent;
namespace IO
{
namespace Mpx
{
class MpxUtils;
} // namespace Mpx
namespace Xml
{
class ResourceAssignmentNodeReader;
class ResourceAssignmentNodeWriter;
class ResourceNodeReader;
class TaskNodeReader;
} // namespace Xml
} // namespace IO
class Resource;
class ResourceAssignment;
namespace Rollup
{
class AverageFirstSublevelRollupCalculator;
class AverageRollupCalculator;
class MinMaxRollupCalculator;
template <typename> class RollupCalculatorBase;
} // namespace Rollup
class Task;
namespace Util
{
class CalculatedExtendedAttributeUtils;
class EnsureExtendedAttribute;
namespace Fields
{
class FieldHelperInternal;
} // namespace Fields
} // namespace Util
namespace Visualization
{
template <typename> class FieldToColumnText;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IEnumerator;
} // namespace Generic
} // namespace Collections
} // namespace System

namespace Aspose {

namespace Tasks {

/// <summary>
/// Represents a collection of <see cref="ExtendedAttribute"></see> objects.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ExtendedAttributeCollection : public System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::ExtendedAttribute>>
{
    typedef ExtendedAttributeCollection ThisType;
    typedef System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::ExtendedAttribute>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Resource;
    friend class Aspose::Tasks::ResourceAssignment;
    friend class Aspose::Tasks::Task;
    friend class Aspose::Tasks::IO::Mpx::MpxUtils;
    friend class Aspose::Tasks::IO::Xml::ResourceAssignmentNodeReader;
    friend class Aspose::Tasks::IO::Xml::ResourceAssignmentNodeWriter;
    friend class Aspose::Tasks::IO::Xml::ResourceNodeReader;
    friend class Aspose::Tasks::IO::Xml::TaskNodeReader;
    friend class Aspose::Tasks::Rollup::AverageFirstSublevelRollupCalculator;
    friend class Aspose::Tasks::Rollup::AverageRollupCalculator;
    template<typename FT0> friend class Aspose::Tasks::Rollup::RollupCalculatorBase;
    friend class Aspose::Tasks::Rollup::MinMaxRollupCalculator;
    friend class Aspose::Tasks::Util::CalculatedExtendedAttributeUtils;
    friend class Aspose::Tasks::Util::EnsureExtendedAttribute;
    friend class Aspose::Tasks::Util::Fields::FieldHelperInternal;
    template<typename FT0> friend class Aspose::Tasks::Visualization::FieldToColumnText;
    
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<ExtendedAttribute>>;
    /// 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;
    
private:

    class FieldIdComparer final : public System::Collections::Generic::IComparer<System::SharedPtr<Aspose::Tasks::ExtendedAttribute>>
    {
        typedef FieldIdComparer ThisType;
        typedef System::Collections::Generic::IComparer<System::SharedPtr<Aspose::Tasks::ExtendedAttribute>> BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        RTTI_INFO_DECL();
        
    public:
    
        /// <summary>Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.</summary>
        /// <param name="x">The first object to compare.</param>
        /// <param name="y">The second object to compare.</param>
        /// <returns>A signed integer that indicates the relative values of <paramref name="x" ></paramref> and <paramref name="y" ></paramref>, as shown in the following table.Value Meaning Less than zero
        /// <paramref name="x" ></paramref> is less than <paramref name="y" ></paramref>.Zero
        /// <paramref name="x" ></paramref> equals <paramref name="y" ></paramref>.Greater than zero
        /// <paramref name="x" ></paramref> is greater than <paramref name="y" ></paramref>.</returns>
        int32_t Compare(const System::SharedPtr<ExtendedAttribute>& x, const System::SharedPtr<ExtendedAttribute>& y) const override;
        
    };
    
    
public:

    /// <summary>
    /// Gets the number of elements contained in this collection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Count() const override;
    /// <summary>
    /// Gets a value indicating whether this collection is read-only; otherwise, false.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsReadOnly() const override;
    
    /// <summary>
    /// Gets 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<ExtendedAttribute> 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<ExtendedAttribute> 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<ExtendedAttribute>>> GetEnumerator() override;
    /// <summary>
    /// Adds the specified item to this collection.
    /// </summary>
    /// <param name="item">the specified item to add to this collection.</param>
    ASPOSE_TASKS_SHARED_API void Add(const System::SharedPtr<ExtendedAttribute>& item) override;
    /// <summary>
    /// Removes all items from this collection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void Clear() override;
    /// <summary>
    /// Returns true if the specified item is found in this collection; otherwise, false.
    /// </summary>
    /// <param name="item">the specified item to find.</param>
    /// <returns>true if the specified item is found in this collection; otherwise, false.</returns>
    ASPOSE_TASKS_SHARED_API bool Contains(const System::SharedPtr<ExtendedAttribute>& item) const override;
    /// <summary>
    /// Copies the elements of this collection to the specified array, starting at the specified array index.
    /// </summary>
    /// <param name="array">the specified one-dimensional array to copy elements to</param>
    /// <param name="arrayIndex">the zero-based index of the specified array at which copying begins.</param>
    ASPOSE_TASKS_SHARED_API void CopyTo(System::ArrayPtr<System::SharedPtr<ExtendedAttribute>> array, int32_t arrayIndex) override;
    /// <summary>
    /// Removes the first occurrence of a specific object from this collection.
    /// </summary>
    /// <param name="item">the specified object to remove.</param>
    /// <returns>true if the specified object was successfully removed from this collection; otherwise, false.</returns>
    ASPOSE_TASKS_SHARED_API bool Remove(const System::SharedPtr<ExtendedAttribute>& item) override;
    /// <summary>
    /// Determines the index of the specified item in this collection.
    /// </summary>
    /// <param name="item">the specified item to locate in this collection.</param>
    /// <returns>the index of the specified item if found; otherwise, -1.</returns>
    ASPOSE_TASKS_SHARED_API int32_t IndexOf(const System::SharedPtr<ExtendedAttribute>& item) const override;
    /// <summary>
    /// Inserts the specified item at the specified index.
    /// </summary>
    /// <param name="index">the specified zero-based index at which the item should be inserted.</param>
    /// <param name="item">the specified item to insert to this collection.</param>
    ASPOSE_TASKS_SHARED_API void Insert(int32_t index, const System::SharedPtr<ExtendedAttribute>& item) override;
    /// <summary>
    /// Removes an item at the specified index.
    /// </summary>
    /// <param name="index">the specified zero-based index to remove an item at.</param>
    ASPOSE_TASKS_SHARED_API void RemoveAt(int32_t index) 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:

    ASPOSE_TASKS_SHARED_API ExtendedAttributeCollection(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<ExtendedAttribute>>>& extendedAttributes, const System::SharedPtr<IExtendedAttributeParent>& parent);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ExtendedAttributeCollection, CODEPORTING_ARGS(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<ExtendedAttribute>>>& extendedAttributes, const System::SharedPtr<IExtendedAttributeParent>& parent));
    
    ASPOSE_TASKS_SHARED_API ExtendedAttributeCollection(const System::SharedPtr<IExtendedAttributeParent>& parent);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ExtendedAttributeCollection, CODEPORTING_ARGS(const System::SharedPtr<IExtendedAttributeParent>& parent));
    ASPOSE_TASKS_SHARED_API void Sort();
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ExtendedAttribute> GetByFieldId(int32_t fieldId);
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ExtendedAttribute> GetByFieldId(const System::String& fieldId);
    ASPOSE_TASKS_SHARED_API void SetCapacity(int32_t capacity);
    
    virtual ASPOSE_TASKS_SHARED_API ~ExtendedAttributeCollection();
    
    #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<ExtendedAttribute>>> extendedAttributes;
    System::WeakPtr<IExtendedAttributeParent> parent;
    
    void Init();
    
};

} // namespace Tasks
} // namespace Aspose