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

#include "PrcBase.h"
SMARTPTR(OdPrcFileStructureInternalData);

/** \details
The class represents an implementation of internal data of a .prc file structure.
The internal data of the file structure contains an identifier of the root product occurrence and the current available unique index for assigning entities that can be referenced within the file structure.

<group PRC_Files_Structures_Assemblies>
*/
class PRC_TOOLKIT OdPrcFileStructureInternalData : public OdPrcBase
{
  friend class OdPrcFileStructure;

  void setNextAvailableIndex(OdUInt32 value); // for internal usage

public:
  //DOM-IGNORE-BEGIN
  ODPRC_DECLARE_MEMBERS_PRCBASE(OdPrcFileStructureInternalData)
  //DOM-IGNORE-END
  
  /** \details 
  Sets a new root product occurrence identifier for the file structure.
  
  \param root_product_occurrence_ID [in] A new root product occurrence identifier to be set.
  */
  void setRootProductOccurrence (const OdPrcObjectId &root_product_occurrence_ID);

  /** \details 
  Requests the current root product occurrence identifier for the file structure.
  \returns An <link OdPrcObjectId, OdPrcObjectId> object that represents the identifier of the root product occurrence.
  */
  OdPrcObjectId getRootProductOccurrenceID (void) const;

  /** \details 
  Requests the current user-defined data from the file structure.
  \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 OdPrcFileStructureInternalData, OdPrcFileStructureInternalData> object, 
  call another <link OdPrcFileStructureInternalData::userData@const, userData()> method that returns a constant reference.
  */
  OdPrcUserData & userData();

  /** \details
  Requests the current user-defined data from the file structure.
  \returns An <link OdPrcUserData, OdPrcUserData> object that contains the user-defined data.
  */
  const OdPrcUserData & userData() const;
};

#endif // _PRCFILESTRUCTUREINTERNALDATA_INCLUDED_