AvailabilityPeriodCollection.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="AvailabilityPeriodCollection.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
{
class AvailabilityPeriod;
namespace Calculations
{
class ResourceOverAllocationCalculator;
} // namespace Calculations
namespace IO
{
namespace MSProject
{
class MppAvailabilityWriter;
} // namespace MSProject
namespace Xml
{
class ResourceNodeReader;
} // namespace Xml
} // namespace IO
class Resource;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IEnumerator;
} // namespace Generic
} // namespace Collections
class DateTime;
} // namespace System

namespace Aspose {

namespace Tasks {

/// <summary>
/// Represents a collection which contains <see cref="AvailabilityPeriod"></see> objects.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS AvailabilityPeriodCollection : public System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::AvailabilityPeriod>>
{
    typedef AvailabilityPeriodCollection ThisType;
    typedef System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::AvailabilityPeriod>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Calculations::ResourceOverAllocationCalculator;
    friend class Aspose::Tasks::IO::MSProject::MppAvailabilityWriter;
    friend class Aspose::Tasks::Resource;
    friend class Aspose::Tasks::IO::Xml::ResourceNodeReader;
    
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<AvailabilityPeriod>>;
    /// 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 <see cref="Resource"></see> for this object.
    /// <returns>Parent <see cref="Resource"></see> object for this collection.</returns>
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Resource> get_ParentResource() const;
    /// <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>
    /// 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<AvailabilityPeriod> 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<AvailabilityPeriod> 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<AvailabilityPeriod>>> 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<AvailabilityPeriod>& 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<AvailabilityPeriod>& 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<AvailabilityPeriod>> 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<AvailabilityPeriod>& 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<AvailabilityPeriod>& 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<AvailabilityPeriod>& 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 AvailabilityPeriodCollection(const System::SharedPtr<Resource>& parentRsc);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(AvailabilityPeriodCollection, CODEPORTING_ARGS(const System::SharedPtr<Resource>& parentRsc));
    
    ASPOSE_TASKS_SHARED_API AvailabilityPeriodCollection(const System::SharedPtr<Resource>& parentRsc, const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<AvailabilityPeriod>>>& periods);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(AvailabilityPeriodCollection, CODEPORTING_ARGS(const System::SharedPtr<Resource>& parentRsc, const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<AvailabilityPeriod>>>& periods));
    ASPOSE_TASKS_SHARED_API double GetMinAvailability(System::DateTime intervalStart, System::DateTime intervalEnd);
    ASPOSE_TASKS_SHARED_API void Sort();
    
    virtual ASPOSE_TASKS_SHARED_API ~AvailabilityPeriodCollection();
    
    #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<AvailabilityPeriod>>> periods;
    System::WeakPtr<Resource> resource;
    
    static int32_t Compare(const System::SharedPtr<AvailabilityPeriod>& period1, const System::SharedPtr<AvailabilityPeriod>& period2);
    
};

} // namespace Tasks
} // namespace Aspose