///////////////////////////////////////////////////////////////////////////////
// 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 _PRCREFERENCESOFPRODUCTOCCURRENCE_INCLUDED_
#define _PRCREFERENCESOFPRODUCTOCCURRENCE_INCLUDED_ 
 

#include "PrcUniqueId.h"
#include "PrcObjectId.h"

class OdPrcFile;

/** \details 
<group PRC_Miscellaneous_Classes> 

Class implements functionality for operating with references of a product occurrence. 
*/
class PRC_TOOLKIT OdPrcReferencesOfProductOccurrence
{
private:
  OdPrcObjectIdArray m_son_occurrences; // Sons : Array of pointers to the son product occurrences.
  OdPrcObjectId      m_externalDataID;  // ExternalData : Pointer to the corresponding external product occurrence. Can be NULL. 
  OdPrcObjectId      m_prototypeID;     // ProductPrototype : Pointer to the corresponding product occurrence prototype. Can be NULL.
  OdPrcObjectId      m_partID;          // PartDefinition : Pointer to the corresponding part definition. Can be NULL.

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

  /** \details
  Requests the child product occurrences of the <link OdPrcReferencesOfProductOccurrence, referenced product occurrence>. 
  \returns An <link OdPrcObjectIdArray, array of PRC object identifiers> that refer to the child product occurrences.
  \remarks 
  The <link OdPrcObjectIdArray, array of identifiers> is returned via a reference, and therefore any modification of the returned array causes the list of child product occurrences to be changed as well.
  To restrict modifications of the <link OdPrcObjectIdArray, array of identifiers> outside the <link OdPrcReferencesOfProductOccurrence, OdPrcReferencesOfProductOccurrence> object, 
  call another <link OdPrcReferencesOfProductOccurrence::getSonProductOccurrences@const, getSonProductOccurrences()> method that returns a constant reference.
  */
  OdPrcObjectIdArray& getSonProductOccurrences();

  /** \details
  Requests the child product occurrences of the <link OdPrcReferencesOfProductOccurrence, referenced product occurrence>. 
  \returns An <link OdPrcObjectIdArray, array of PRC object identifiers> that refer to the child product occurrences.
  */
  const OdPrcObjectIdArray& getSonProductOccurrences() const;

  /** \details
  Sets a new product occurrence prototype.

  \param prototypeID [in] An identifier of a new product occurrence prototype.
  */
  void setPrototype (const OdPrcObjectId &prototypeID);

  /** \details
  Requests the prototype of the <link OdPrcReferencesOfProductOccurrence, referenced product occurrence>. 
  \returns An <link OdPrcObjectId, identifier> that refers to the <link OdPrcReferencesOfProductOccurrence, referenced product occurrence> prototype.
  */
  OdPrcObjectId getPrototypeID() const;

  /** \details
  Clears the product occurrence prototype.
  */
  void clearPrototype();

  /** \details
  Requests the current external data from the <link OdPrcReferencesOfProductOccurrence, referenced product occurrence>.
  \returns An <link OdPrcObjectId, identifier> that refers to the current external data.
  */
  OdPrcObjectId getExternalDataID() const;

  /** \details
  Sets the new product occurrence's external data.

  \param externalDataID [in] An identifier of new external data to be set.
  */
  void setExternalData (const OdPrcObjectId &externalDataID);

  /** \details
  Clears the product occurrence's external data.
  */
  void clearExternalData();

  /** \details
  Sets a new corresponding part definition.

  \param partID [in] An identifier of a new corresponding part definition to be set.
  */
  void setCorrespondingPartDefinition (const OdPrcObjectId &partID);

  /** \details
  Requests the corresponding <link OdPrcPartDefinition, part definition>.
  \returns An <link OdPrcObjectId, identifier> that refers to the corresponding <link OdPrcPartDefinition, part definition>.
  */
  OdPrcObjectId getCorrespondingPartDefinition() const;

  /** \details
  Clears the part definition.
  */
  void clearPartDefinition();

  /** \details
  Checks if the product occurrence is in the same file structure as its prototype.

  \param uuid [in] A PRC unique identifier of the referencing product occurrence.
  
  \returns A boolean value that is equal to true if the product occurrence is in the same file structure as the prototype; otherwise, the method returns false.
  */
  bool isPrototypeInTheSameFileStructure (const OdPrcUniqueId &uuid) const;

  /** \details
  Checks if the product occurrence is in the same file structure as its external data.

  \param uuid [in] A PRC unique identifier of the referencing product occurrence.
  
  \returns A boolean value that is equal to true if the product occurrence is in the same file structure as the prototype; otherwise, the method returns false.
  */
  bool isExternalDataInTheSameFileStructure (const OdPrcUniqueId &uuid) const;
};

#endif // _PRCREFERENCESOFPRODUCTOCCURRENCE_INCLUDED_