/////////////////////////////////////////////////////////////////////////////// 
// 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_ENTITY_RESOLVER_H
#define _STEP_ENTITY_RESOLVER_H

#include "StepBuildOptions.h"
#include "StepCompound.h"

class OdStepFile;

/** \details
An abstract class that provides an interface for the model's entity resolving functionality.
An entity resolver resolves the underlying application instance data into the corresponding compound object (in most cases) that can later be used and vectorized.
or into other objects such as points, matrices, vectors, etc.
\sa
<exref target="https://docs.opendesign.com/tifc_api_cpp/ifc_object_model.html">STEP Object Model</exref>.
*/
class STEPCORE_EXPORT OdStepEntResolver
{
  //DOM-IGNORE-BEGIN
protected:

  OdStepFile* m_pFile;

  void assignEntity(OdStep::OdStepCompound* compound, const OdDAI::ApplicationInstance* inst) const;
  //DOM-IGNORE-END

public:

  /** \details
  Creates a new entity resolver with default parameters.
  */
  OdStepEntResolver()
    : m_pFile(nullptr)
  {}

  /** \details
  Destroys the entity resolver object.
  */
  virtual ~OdStepEntResolver() {};

  /** \details
  Sets a new model to the entity resolver object.
  \param file [in] A raw pointer to the model's content object to be set.
  */
  void setFile(OdStepFile* file) { m_pFile = file; };

  /** \details
  Resolves the model's entity.
  \param inst     [in] A pointer to the entity instance to be resolved.
  \returns Returns true if the entity was successfully resolved; otherwise, the method returns false.
  */
  virtual OdStep::OdStepCompoundPtr resolve(const OdDAI::ApplicationInstance* inst) const = 0;
};

#endif // _STEP_ENTITY_RESOLVER_H