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

#include "PrcUserData.h"
#include "PrcFileStructureExactGeometry.h"
#include "PrcBase.h"

SMARTPTR(OdPrcFileStructureGeometry);

/** \details 
Class implements file structure geometry. 
File structure geometry contains exact geometry and user defined data. 

<group PRC_Files_Structures_Assemblies>
*/
class PRC_TOOLKIT OdPrcFileStructureGeometry : public OdPrcBase
{
public:
  //DOM-IGNORE-BEGIN
  ODPRC_DECLARE_MEMBERS_PRCBASE(OdPrcFileStructureGeometry);
  //DOM-IGNORE-END

  /** \details 
  Requests the <link OdPrcFileStructureExactGeometry, exact geometry> from the file structure geometry.
  \returns A reference to the <link OdPrcFileStructureExactGeometry, OdPrcFileStructureExactGeometry> object that contains exact geometry data.
  \remarks
  The method returns the <link OdPrcFileStructureExactGeometry, exact geometry> via a reference; 
  therefore, the returned <link OdPrcFileStructureExactGeometry, OdPrcFileStructureExactGeometry> object can be modified, and any modification affects the file structure object. 
  It means that the object returned by the method can be used to set new exact geometry of the file structure.
  */
  OdPrcFileStructureExactGeometry &fileStructureExactGeometry();
  
  /** \details 
  Requests the <link OdPrcFileStructureExactGeometry, exact geometry> from the file structure geometry.
  \returns A constant reference to the <link OdPrcFileStructureExactGeometry, OdPrcFileStructureExactGeometry> object that contains exact geometry data.
  \remarks 
  Call this method if you want to restrict any modification of the <link OdPrcFileStructureExactGeometry, exact geometry> of the file structure object.
  */
  const OdPrcFileStructureExactGeometry &fileStructureExactGeometry() const;
  
  /** \details 
  Requests the current user-defined data of the file structure geometry.
  \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 OdPrcFileStructureGeometry, OdPrcFileStructureGeometry> object, 
  call another <link OdPrcFileStructureGeometry::userData@const, userData()> method that returns a constant reference. 
  */
  OdPrcUserData &userData();
  
  /** \details 
  Requests the current user-defined data of the file structure geometry.
  \returns An <link OdPrcUserData, OdPrcUserData> object that contains the user-defined data.
  */
  const OdPrcUserData &userData() const;
};

#endif // _PRCFILESTRUCTUREGEOMETRY_INCLUDED_