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

#include "StepCore.h"
#include "StepBuildOptions.h"
#include "daiStepFile.h"
#include "StepGeomModule.h"
#include "StepEntityResolver.h"

/** \details
  This class represents a CIS/2 file.
*/
class STEPCORE_EXPORT OdCis2File : public OdStepFile
{
public:

  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdCis2File);
  //DOM-IGNORE-END

  /** \details
    Default constructor for the OdCis2File class.
  */
  OdCis2File();
  
  /** \details
    Destructor for the OdCis2File class.
  */
  ~OdCis2File();

  virtual OdDAI::OdCompoundPtr getCompound(const OdDAIObjectId& id) override;

  /** \details
  Retrieves the current model context of the file object.
  \returns An instance of the <exref target="https://docs.opendesign.com/step_api_cpp/OdStep__OdStepModelContext.html>OdStepModelContext</exref> class.
  */
  OdStepModelContext getContext() const;

  /** \details
  Sets a new model context for the STEP file object.
  \param context [in] An instance of the <exref target="https://docs.opendesign.com/step_api_cpp/OdStep__OdStepModelContext.html>OdStepModelContext</exref> class to be set as the model context object.
  */
  void setContext(const OdStepModelContext& context);

  /** \details
  Sets geometrical context selection to build a geometrical representation for selected geometrical contexts.
  Only selected contexts will be composed and drawn.
  \param contexts [in] A set of <exref target="https://docs.opendesign.com/step_api_cpp/OdDAIObjectId.html>identifiers of SDAI objects</exref>, which represent the context selection.
  \returns eOk if the new context selection was successfully set; otherwise, the method returns an appropriate error code.
  */
  OdResult setContextSelection(const OdDAIObjectIds& contexts);

  /** \details
  Determines whether an instance of the IfcGeometricRepresentationContext class is selected to build the geometry.
  \param idCtx [in] Object ID of geometric context to test.
  \returns true if an IfcGeometricRepresentationContext object is selected; otherwise, the method returns false.
  */
  bool getContextSelected(const OdDAIObjectId& idCtx) const;

  /** \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
  Retrieves the model's root instances.
  \returns The identifiers of the root instances of the model.
  */
  const OdDAIObjectIds getRootIds() override;

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;
  OdDAIObjectIds m_selContexts;
  OdStep::OdStepGeomModulePtr m_pGeom;
  OdStepEntResolver* m_pEntResolver = nullptr;
  OdDAI::OdUnitConverterPtr m_pConverter;
};

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

#endif // _CIS2_FILE_H