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

#include "StepCore.h"
#include "StepBuildOptions.h"
#include "daiStepFile.h"
#include "daiStepModelContext.h"
#include "StepCompound.h"
#include "StepGeomModule.h"
#include "StepUnitConverter.h"
#include "StepEntityResolver.h"

namespace OdStep
{
  class OdStepCache;
}

class STEPCORE_EXPORT OdAPFile : public OdStepFile
{
public:

  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdAPFile);
  //DOM-IGNORE-END
  
  /** \details
    Default constructor for the OdAPFile class.
  */
  OdAPFile();
  
  /** \details
    Destructor for the OdAPFile class.
  */
  ~OdAPFile();

  /** \details
  Performs an attempt the compose object for an entity instance, if application instance doesn't have associated compound object.
  If application instance already has associated compound, it will be returned by this method.
  \param id [in] An <link OdDAIObjectId, identifier> of an object to compose.
  \returns A smart pointer to the attached compound object.
  */
  virtual OdDAI::OdCompoundPtr getCompound(const OdDAIObjectId& id) override;

  /** \details
  Retrieves the current model's unit converter.
  \returns An instance of the <exref target="https://docs.opendesign.com/step_api_cpp/OdDAI__OdUnitConverter.html>OdUnitConverter</exref> class that represents the current model's unit converter.
  */
  OdDAI::OdUnitConverterPtr getUnitConverter() override;

  /** \details
  Sets convertible unit from current <OdDAI::Model, Model> class.
  \returns eOk if initialization operation was successful; otherwise the method returns an appropriate error code.
  */
  OdResult initializeUnitConverter() override;

  /** \details
  Sets convertible unit from unit context entity.
  \param unitContextId [in] An identifier of the unit context object.
  \returns eOk if initialization operation was successful; otherwise the method returns an appropriate error code.
  */
  OdResult initializeUnitConverter(const OdDAIObjectId& unitContextId);

  /** \details
  Retrieves the model's root instances.
  \returns The identifiers of the root instances of the model.
  */
  const OdDAIObjectIds getRootIds() override;

  /** \details
  Retrieves the model's draughting_model instances.
  \returns The identifiers of the draughting_model instances of the model.
  */
  OdDAIObjectIds getDraughtingModels() const;

  /** \details
  Retrieves the model's product instances.
  \returns The identifiers of all product instances of the model.
  */
  OdDAIObjectIds getProducts() const;

  /** \details
  Retrieves the model's constructive_geometry_representation instances.
  \returns The identifiers of the constructive_geometry_representation instances of the model.
  */
  OdDAIObjectIds getConstructiveGeometryRepresentations() const;

  /** \details
  Retrieves the model's shape_aspect_occurrence instances.
  \returns The identifiers of the shape_aspect_occurrence instances of the model.
  */
  OdDAIObjectIds getShapeAspectOccurrences() const;

  /** \details
  Retrieves the model's reinforcement_orientation_basis instances.
  \returns The identifiers of the reinforcement_orientation_basis instances of the model.
  */
  OdDAIObjectIds getReinforcementOrientationBasis() const;

  /** \details
  Retrieves the model's instances for draw.
  \returns The identifiers of the drawing instances of the model.
  */
  OdDAIObjectIds getDrawableIds() const;

  /** \details
  Retrieves an array of user defined properties associated with PRODUCT instance provided.
  
  \param product [in] Pointer to an application instance representing a product instance.
  \returns The identifiers of user defined properties (property_definition instances) for product within the model.
  */
  OdDAIObjectIds getUserDefinedPropertiesForProduct(OdDAI::ApplicationInstance *product) const;

  /** \details
  Retrieves an array of representation pairs for the products within STEP model.
  First representation in pair is default, second is alternative for the same product.
  \returns An array of representation id pairs for the same product. If there are no products with alternative representations in the model, the array is empty.
  \remarks
  Some products has two variants of graphical representation classes. By default, both representations stored in rootIds array.
  If you need one representation per product, you can remove duplicate representations using a combination of <link  OdStepModelContext::setHiddenObjectsIds, setHiddenObjectsIds> and <link OdStepFile::recalcRootIds, recalcRootIds>.
  */
  OdArray<std::pair<OdDAIObjectId, OdDAIObjectId> > findProductsRepresentationPairs();

  /** \details
  Retrieves the current geometrical extents of the model.
  \param extents [out] A placeholder for the current geometry extents object to be returned to a calling subroutine.
  \returns eOk if the current extents were successfully returned; otherwise, the method returns an appropriate error code.
  \remarks
  The method returns the model extents only if the model was created by calling the setGeomResource() method.
  The method accepts an instance of the OdGeExtents3d class, fills it with the data about the model's extents and
  returns it to a calling subroutine.
  */
  OdResult getGeomExtents(OdGeExtents3d& extents) const;
  //DOM-IGNORE-BEGIN
  OdStep::OdStepCache* getCachedData();
  //DOM-IGNORE-END
protected:

  /** \details
  Method is called just after file reading has ended.
  \returns eOk if operation successfully done; otherwise, the method returns an appropriate error code.
  */
  virtual OdResult onReadFileEnd() override;

private:

  OdResult setGeomResource();

  std::map<OdDAIObjectId, OdDAI::OdCompoundPtr> m_openCompounds;
  OdStep::OdStepGeomModulePtr m_pGeom;
  OdStepEntResolver* m_pEntResolver = nullptr;
  OdDAI::OdUnitConverterPtr m_pConverter;
  OdSharedPtr<OdStep::OdStepCache> m_pGeomCache;
  mutable std::map<OdAnsiString, OdDAIObjectIds> m_subRepresentationArrays;
  mutable OdGeExtents3d m_extents;

  friend class OdStepDevFile;
};

/** \details
A data type that represents a smart pointer to an <exref target="https://docs.opendesign.com/step_api_cpp/OdStepFile.html>OdStepFile</exref> object.
*/
typedef OdSmartPtr<OdAPFile> OdAPFilePtr;

#endif // _STEP_AP_FILE_H