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

#include "PrcUnit.h"
#include "PrcUserData.h"
#include "PrcBase.h"
#include "PrcProductOccurrence.h"

SMARTPTR(OdPrcModelFileData);
class OdPrcFile;

/** \details 
A data type that represents a reference to an <link OdPrcProductOccurrence, OdPrcProductOccurrence> object.
The <link OdPrcProductOccurrence, OdPrcProductOccurrence> object is referenced via its <link OdPrcObjectId, identifier>. 
*/
typedef OdPrcObjectId OdPrcProductOccurrenceReference;

/** \details 
A data type that represents an <exref target="https://docs.opendesign.com/tkernel/OdArray@classT@classA.html">array</exref> 
of references to <link OdPrcProductOccurrence, OdPrcProductOccurrence> objects.
The <link OdPrcProductOccurrence, OdPrcProductOccurrence> objects are referenced via their <link OdPrcObjectId, identifiers>.
*/
typedef OdArray<OdPrcProductOccurrenceReference> OdPrcProductOccurrenceReferenceArray;

/** \details 
This class stores and operates information about data imported from a CAD file.
<group PRC_Files_Structures_Assemblies> 

*/
class PRC_TOOLKIT OdPrcModelFileData : public OdPrcBase
{
  friend class OdPrcFile;

public:
  //DOM-IGNORE-BEGIN
  ODPRC_DECLARE_MEMBERS_PRCBASE(OdPrcModelFileData);
  //DOM-IGNORE-END

  /** \details
  Requests the current <link OdPrcUnit, unit> used within the model.
  \returns An <link OdPrcUnit, OdPrcUnit> object. 
  \remarks
  The method returns the <link OdPrcUnit, unit> via a reference, and therefore any modification of the returned object causes the <link OdPrcUnit, unit> 
  for the <link OdPrcModelFileData, model file data> to be changed.
  To restrict any modifications of the <link OdPrcUnit, unit> outside the <link OdPrcModelFileData, OdPrcModelFileData> object, 
  call another <link OdPrcModelFileData::unit@const, unit()> method that returns a constant reference.
  */
  OdPrcUnit &unit();
  
  /** \details
  Requests the current <link OdPrcUnit, unit> used within the model.
  \returns An <link OdPrcUnit, OdPrcUnit> object. 
  */
  const OdPrcUnit &unit() const;
  
  /** \details 
  Requests the current user-defined data associated with the model file data.
  \returns An <link OdPrcUserData, OdPrcUserData> object that contains the user-defined data.
  \remarks 
  User data is returned as a reference to an <link OdPrcUserData, OdPrcUserData> object, and therefore it can be used to set new user data.
  To restrict modifications of the user data outside the <link OdPrcModelFileData, OdPrcModelFileData> object, 
  call another <link OdPrcModelFileData::userData@const, userData()> method that returns a constant reference.
  */
  OdPrcUserData &userData();
  
  /** \details
  Requests the current user-defined data associated with the model file data.
  \returns An <link OdPrcUserData, OdPrcUserData> object that contains the user-defined data.
  */
  const OdPrcUserData &userData() const;

  /** \details
  Clears the current list of <link OdPrcProductOccurrence, product occurrences>.
  */
  void clearRoots(void);

  /** \details
  Adds a new start root <link OdPrcProductOccurrence, occurrence> to the end of the list of occurrences.

  \param pPO [in] A new start root <link OdPrcProductOccurrence, occurrence> to be set.
  */
  void addStartRootOccurrence(const OdPrcProductOccurrence &pPO);

  /** \details
  Requests the current list of <link OdPrcProductOccurrence, product occurrences>.
  \returns An <link OdPrcProductOccurrenceReferenceArray, array> of identifiers that refer to <link OdPrcProductOccurrence, occurrences>.
  \remarks
  The method returns the <link OdPrcProductOccurrenceReferenceArray, array> via a reference, and therefore any modification of the returned <link OdPrcProductOccurrenceReferenceArray, array> 
  causes the list of <link OdPrcProductOccurrence, product occurrences> to be changed.
  To restrict any modifications of the <link OdPrcProductOccurrenceReferenceArray, array> outside the <link OdPrcModelFileData, OdPrcModelFileData> object, 
  call another <link OdPrcModelFileData::getStartRootOccurrences@const, getStartRootOccurrences()> method that returns a constant reference.
  */
  OdPrcProductOccurrenceReferenceArray& getStartRootOccurrences(void);

  /** \details
  Requests the current list of <link OdPrcProductOccurrence, product occurrences>.
  \returns An <link OdPrcProductOccurrenceReferenceArray, array> of identifiers that refer to <link OdPrcProductOccurrence, occurrences>.
  */
  const OdPrcProductOccurrenceReferenceArray& getStartRootOccurrences(void) const;

protected:
  virtual bool subWorldDraw (OdGiWorldDraw * pWd) const;
  virtual OdUInt32 subSetAttributes (OdGiDrawableTraits * traits) const;
};

#endif // _PRCMODELFILEDATA_INCLUDED_