///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a license
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#ifndef _PRCMARKUPS_INCLUDED_
#define _PRCMARKUPS_INCLUDED_ 
 

#include "PrcMarkupLinkedItem.h"
#include "PrcMarkupLeader.h"
#include "PrcMarkup.h"
#include "PrcAnnotationEntity.h"

class OdPrcCompressedFiler;

/** \details 
The class stores and handles complex data about markups (related annotation entities, markups, leaders, and linked items).
<group PRC_Markup_Classes> 
*/
class PRC_TOOLKIT OdPrcMarkups
{
private:
  OdPrcObjectIdArray m_annotation_entities;
  OdPrcObjectIdArray m_markups; //OdPrcMarkupPtr
  OdPrcObjectIdArray m_leaders; // OdPrcMarkupLeaderPtr
  OdPrcObjectIdArray m_linked_item; // OdPrcMarkupLinkedItemPtr

public:
  //DOM-IGNORE-BEGIN
  PRC_DECLARE_CIO(OdPrcMarkups)
  //DOM-IGNORE-END

  /** \details
  Requests the current array of annotation entities.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the annotation entities.
  \remarks 
  The <link OdPrcObjectIdArray, array of identifiers> is returned via a reference, and therefore any modification of the returned array causes the array of annotation entities to be changed as well.
  To restrict modifications of the <link OdPrcObjectIdArray, array of identifiers> outside the <link OdPrcMarkups, OdPrcMarkups> object, 
  call another <link OdPrcMarkups::annotationEntities@const, annotationEntities()> method that returns a constant reference.
  */
  OdPrcObjectIdArray &annotationEntities();
  
  /** \details
  Requests the current array of annotation entities.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the annotation entities.
  */
  const OdPrcObjectIdArray &annotationEntities() const;
  
  /** \details
  Requests the current array of <link OdPrcMarkup, markups>.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the <link OdPrcMarkup, markups>.
  \remarks 
  The <link OdPrcObjectIdArray, array of identifiers> is returned via a reference, and therefore any modification of the returned array causes the array of <link OdPrcMarkup, markups> to be changed as well.
  To restrict modifications of the <link OdPrcObjectIdArray, array of identifiers> outside the <link OdPrcMarkups, OdPrcMarkups> object, 
  call another <link OdPrcMarkups::markups@const, markups()> method that returns a constant reference.
  */
  OdPrcObjectIdArray &markups();
  
  /** \details
  Requests the current array of <link OdPrcMarkup, markups>.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the <link OdPrcMarkup, markups>.
  */
  const OdPrcObjectIdArray &markups() const;
  
  /** \details
  Requests the current array of leaders.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the leader objects.
  \remarks 
  The <link OdPrcObjectIdArray, array of identifiers> is returned via a reference, and therefore any modification of the returned array causes the array of leaders to be changed as well.
  To restrict modifications of the <link OdPrcObjectIdArray, array of identifiers> outside the <link OdPrcMarkups, OdPrcMarkups> object, 
  call another <link OdPrcMarkups::leaders@const, leaders()> method that returns a constant reference.
  */
  OdPrcObjectIdArray &leaders();
  
  /** \details
  Requests the current array of leaders.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the leader objects.
  */
  const OdPrcObjectIdArray &leaders() const;
  
  /** \details
  Requests the current array of linked items.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the linked items.
  \remarks 
  The <link OdPrcObjectIdArray, array of identifiers> is returned via a reference, and therefore any modification of the returned array causes the array of linked items to be changed as well.
  To restrict modifications of the <link OdPrcObjectIdArray, array of identifiers> outside the <link OdPrcMarkups, OdPrcMarkups> object, 
  call another <link OdPrcMarkups::linkedItem@const, linkedItem()> method that returns a constant reference.
  */
  OdPrcObjectIdArray &linkedItem();
  
  /** \details
  Requests the current array of linked items.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the linked items.
  */
  const OdPrcObjectIdArray &linkedItem() const;
};

/** \details 
A data type that represents an <exref target="https://docs.opendesign.com/tkernel/OdArray@classT@classA.html">array</exref> 
of <link OdPrcMarkups, OdPrcMarkups> objects.
*/
typedef OdArray<OdPrcMarkups> OdPrcMarkupsArray;

#endif // _PRCMARKUPS_INCLUDED_