CalendarCollection.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="CalendarCollection.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
{
class Calendar;
namespace Connectivity
{
class MpdReader;
class MspDbReader;
class PrimaveraDbReader;
} // namespace Connectivity
class IdGenerator;
namespace IO
{
namespace Html
{
class HtmlCalendarTableReader;
} // namespace Html
namespace Mpx
{
class MpxReader;
} // namespace Mpx
namespace MSProject
{
class Mpp12CalendarWriter;
class MPP12Reader;
class MPP14Reader;
class Mpp9CalendarWriter;
class MPP9Reader;
class MPPProjectPropsReader;
class MPPReader;
} // namespace MSProject
namespace PrimaveraXml
{
class PrimaveraReader;
} // namespace PrimaveraXml
namespace Pwa
{
namespace InternalApi
{
namespace Mapping
{
class CalendarToRawValuesMapper;
class ProjectCalendarsMapper;
class ProjectResourcesMapper;
class ProjectRootMapper;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
namespace Xer
{
class XerPrimaveraReader;
class XerProjectNormalizer;
} // namespace Xer
namespace Xml
{
class XmlReader;
} // namespace Xml
} // namespace IO
class Project;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename, typename> class IDictionary;
template <typename> class IEnumerable;
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="Calendar"></see> objects.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS CalendarCollection : public System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::Calendar>>
{
    typedef CalendarCollection ThisType;
    typedef System::Collections::Generic::IList<System::SharedPtr<Aspose::Tasks::Calendar>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraReader;
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::CalendarToRawValuesMapper;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectRootMapper;
    friend class Aspose::Tasks::Connectivity::MpdReader;
    friend class Aspose::Tasks::Connectivity::MspDbReader;
    friend class Aspose::Tasks::Connectivity::PrimaveraDbReader;
    friend class Aspose::Tasks::IO::Html::HtmlCalendarTableReader;
    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::MPP9Reader;
    friend class Aspose::Tasks::IO::MSProject::MPPProjectPropsReader;
    friend class Aspose::Tasks::IO::MSProject::Mpp12CalendarWriter;
    friend class Aspose::Tasks::IO::MSProject::Mpp9CalendarWriter;
    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::ProjectCalendarsMapper;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectResourcesMapper;
    friend class Aspose::Tasks::IO::Xml::XmlReader;
    
public:
 
    /// <summary>
    /// Gets the number of objects contained in this <see cref="CalendarCollection"></see> object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Count() const 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<Calendar>>> GetEnumerator() override;
    /// <summary>
    /// Adds a new base calendar to this CalendarCollection object and returns added calendar.
    /// </summary>
    /// <param name="name">Calendar name.</param>
    /// <returns>Added <see cref="Calendar"></see> object.</returns>
    /// <exception cref="ArgumentException">Thrown when calendar name is null.</exception>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Calendar> Add(const System::String& name);
    /// <summary>
    /// Adds a new calendar with specified base calendar to this CalendarCollection object and returns added calendar.
    /// </summary>
    /// <param name="name">Specified name.</param>
    /// <param name="baseCalendar">Specified base calendar.</param>
    /// <returns>Added <see cref="Calendar"></see> object.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Calendar> Add(const System::String& name, const System::SharedPtr<Calendar>& baseCalendar);
    /// <summary>
    /// Converts the CalendarCollection object to a list of <see cref="Calendar"></see> objects.
    /// </summary>
    /// <returns>List of <see cref="Calendar"></see> objects.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Calendar>>> ToList();
    /// <summary>
    /// Returns a calendar with the specified UID.
    /// </summary>
    /// <param name="uid">UID of a calendar.</param>
    /// <returns>Calendar with a specified UID.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Calendar> GetByUid(int32_t uid);
    /// <summary>
    /// Returns a calendar with the specified name.
    /// </summary>
    /// <param name="name">Name of a calendar.</param>
    /// <returns>If found returns calendar with a specified name else returns null.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Calendar> GetByName(const System::String& name);
    /// <summary>
    /// Removes Calendar from Project CalendarCollection.
    /// </summary>
    /// <param name="item">The calendar to remove.</param>
    /// <exception cref="InvalidOperationException">Thrown when calendar cannot be removed.</exception>
    /// <returns>If removed returns true, else returns false.</returns>
    ASPOSE_TASKS_SHARED_API bool Remove(const System::SharedPtr<Calendar>& item) override;
    
protected:
 
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Project>& get_ParentProject() const;
    
    ASPOSE_TASKS_SHARED_API CalendarCollection(const System::SharedPtr<Project>& parentProject);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(CalendarCollection, CODEPORTING_ARGS(const System::SharedPtr<Project>& parentProject));
    
    ASPOSE_TASKS_SHARED_API CalendarCollection(const System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Calendar>>>& calendars, const System::SharedPtr<Project>& parentProject);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(CalendarCollection, CODEPORTING_ARGS(const System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Calendar>>>& calendars, const System::SharedPtr<Project>& parentProject));
    /// <summary>
    /// Returns a calendar with the specified <see cref="System::Guid"></see>.
    /// </summary>
    /// <param name="calendarGuid">The globally unique identifier of a calendar.</param>
    /// <returns>Calendar with a specified globally unique identifier.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Calendar> GetByGuid(const System::String& calendarGuid);
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::IDictionary<int32_t, System::SharedPtr<Calendar>>> AsDictionary();
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Calendar>>> GetCalendarsToWrite();
    ASPOSE_TASKS_SHARED_API void AddInternal(const System::SharedPtr<Calendar>& calendar);
    
    virtual ASPOSE_TASKS_SHARED_API ~CalendarCollection();
    
    #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::IList<System::SharedPtr<Calendar>>> calendars;
    System::SharedPtr<IdGenerator> uidGenerator;
    System::SharedPtr<Calendar> zeroResourceCalendar;
    System::WeakPtr<Project> pr_ParentProject;
    
    ASPOSE_TASKS_SHARED_API void set_ParentProject(const System::SharedPtr<Project>& value);
    bool get_IsReadOnly() const override;
    
    System::SharedPtr<Calendar> idx_get(int32_t index) const override;
    void idx_set(int32_t index, System::SharedPtr<Calendar> value) override;
    
    void Add(const System::SharedPtr<Calendar>& item) override;
    void Insert(int32_t index, const System::SharedPtr<Calendar>& item) override;
    void Clear() override;
    bool Contains(const System::SharedPtr<Calendar>& item) const override;
    void CopyTo(System::ArrayPtr<System::SharedPtr<Calendar>> array, int32_t arrayIndex) override;
    int32_t IndexOf(const System::SharedPtr<Calendar>& item) const override;
    void RemoveAt(int32_t index) override;
    int32_t OrderByUid(const System::SharedPtr<Calendar>& x, const System::SharedPtr<Calendar>& y);
    void SetCalendars(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Calendar>>>& list, const System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<Calendar>>>& innerCollection);
    void Init(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Calendar>>>& list, const System::SharedPtr<Project>& inParentProject);
    void PrepareToRemove(const System::SharedPtr<Calendar>& item);
    System::SharedPtr<Calendar> ValidateItem(const System::SharedPtr<Calendar>& item);
    
};
 
} // namespace Tasks
} // namespace Aspose