//  SMESH SMESH : implementaion of SMESH idl descriptions
//
//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
// 
//  This library is free software; you can redistribute it and/or 
//  modify it under the terms of the GNU Lesser General Public 
//  License as published by the Free Software Foundation; either 
//  version 2.1 of the License. 
// 
//  This library is distributed in the hope that it will be useful, 
//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
//  Lesser General Public License for more details. 
// 
//  You should have received a copy of the GNU Lesser General Public 
//  License along with this library; if not, write to the Free Software 
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
// 
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
//
//
//  File   : SMESH_Algo.hxx
//  Author : Paul RASCLE, EDF
//  Module : SMESH
//  $Header$

#ifndef _SMESH_ALGO_HXX_
#define _SMESH_ALGO_HXX_

#include "SMESH_Hypothesis.hxx"

#include <TopoDS_Shape.hxx>
#include <TopoDS_Edge.hxx>
#include <gp_XY.hxx>

#include <string>
#include <vector>
#include <list>
#include <map>

class SMESH_Gen;
class SMESH_Mesh;
class SMESH_HypoFilter;
class TopoDS_Face;
class TopoDS_Shape;
class SMESHDS_Mesh;
class SMDS_MeshNode;

class SMESH_Algo:public SMESH_Hypothesis
{
  public:
	SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
	  virtual ~ SMESH_Algo();

	const std::vector < std::string > &GetCompatibleHypothesis();
	virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
                                     const TopoDS_Shape& aShape,
                                     SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;

	virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;

	virtual const std::list <const SMESHDS_Hypothesis *> &
		GetUsedHypothesis(SMESH_Mesh &         aMesh,
                                  const TopoDS_Shape & aShape,
                                  const bool           ignoreAuxiliary=true);

	const list <const SMESHDS_Hypothesis *> &
		GetAppliedHypothesis(SMESH_Mesh &         aMesh,
                                     const TopoDS_Shape & aShape,
                                     const bool           ignoreAuxiliary=true);

	static double EdgeLength(const TopoDS_Edge & E);


  /*!
   * \brief Make filter recognize only compatible hypotheses
    * \param theFilter - the filter to initialize
    * \param ignoreAuxiliary - make filter ignore compatible auxiliary hypotheses
    * \retval bool - true if the algo has compatible hypotheses
   */
  bool InitCompatibleHypoFilter( SMESH_HypoFilter & theFilter,
                                 const bool         ignoreAuxiliary) const;

  /*!
   * \brief Fill vector of node parameters on geometrical edge, including vertex nodes
    * \param theMesh - The mesh containing nodes
    * \param theEdge - The geometrical edge of interest
    * \param theParams - The resulting vector of sorted node parameters
    * \retval bool - false if not all parameters are OK
   */
  static bool GetNodeParamOnEdge(const SMESHDS_Mesh*     theMesh,
                                 const TopoDS_Edge&      theEdge,
                                 std::vector< double > & theParams);

  //static bool GetSegmentLengths();

  /*!
   * \brief Find out elements orientation on a geometrical face
   * \param theFace - The face correctly oriented in the shape being meshed
   * \param theMeshDS - The mesh data structure
   * \retval bool - true if the face normal and the normal of first element
   *                in the correspoding submesh point in different directions
   */
  static bool IsReversedSubMesh (const TopoDS_Face&  theFace,
                                 SMESHDS_Mesh*       theMeshDS);

  /*!
   * \brief Initialize my parameter values by the mesh built on the geometry
    * \param theMesh - the built mesh
    * \param theShape - the geometry of interest
    * \retval bool - true if parameter values have been successfully defined
    *
    * Just return false as the algorithm does not hold parameters values
   */
  virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);

 public:
        // algo features

        // SMESH_Hypothesis::GetDim();
        // 1 - dimention of target mesh

        bool OnlyUnaryInput() const { return _onlyUnaryInput; }
        // 2 - is collection of tesselatable shapes inacceptable as input;
        // "collection" means a shape containing shapes of dim equal
        // to GetDim().
        // Algo which can process a collection shape should expect
        // an input temporary shape that is neither MainShape nor
        // its child.
        
        bool NeedDescretBoundary() const { return _requireDescretBoundary; }
        // 3 - is a Dim-1 mesh prerequisite

 protected:
        bool _onlyUnaryInput;
        bool _requireDescretBoundary;
        std::vector<std::string> _compatibleHypothesis;
        std::list<const SMESHDS_Hypothesis *> _appliedHypList;
        std::list<const SMESHDS_Hypothesis *> _usedHypList;

  // quadratic mesh creation required
  bool _quadraticMesh;
};

#endif