[occt.git] / src / STEPConstruct / STEPConstruct_PointHasher.hxx

// Created on: 2003-01-15
// Created by: data exchange team
// Copyright (c) 2003-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _STEPConstruct_PointHasher_HeaderFile
#define _STEPConstruct_PointHasher_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <Standard_Integer.hxx>
#include <Standard_Boolean.hxx>
class gp_Pnt;


class STEPConstruct_PointHasher 
{
public:

  DEFINE_STANDARD_ALLOC

  //! Computes a hash code for the point, in the range [1, theUpperBound]
  //! @param thePoint the point which hash code is to be computed
  //! @param theUpperBound the upper bound of the range a computing hash code must be within
  //! @return a computed hash code, in the range [1, theUpperBound]
  static Standard_Integer HashCode (const gp_Pnt& thePoint, const Standard_Integer theUpperBound);

  //! Returns True  when the two  keys are the same. Two
  //! same  keys  must   have  the  same  hashcode,  the
  //! contrary is not necessary.
  Standard_EXPORT static Standard_Boolean IsEqual (const gp_Pnt& Point1, const gp_Pnt& Point2);


protected:


private:


};


#include <STEPConstruct_PointHasher.lxx>


#endif // _STEPConstruct_PointHasher_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 2003-01-15
	2	// Created by: data exchange team
	3	// Copyright (c) 2003-2014 OPEN CASCADE SAS
	4	//
	5	// This file is part of Open CASCADE Technology software library.
	6	//
	7	// This library is free software; you can redistribute it and/or modify it under
	8	// the terms of the GNU Lesser General Public License version 2.1 as published
	9	// by the Free Software Foundation, with special exception defined in the file
	10	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	11	// distribution for complete text of the license and disclaimer of any warranty.
	12	//
	13	// Alternatively, this file may be used under the terms of Open CASCADE
	14	// commercial license or contractual agreement.
	15
	16	#ifndef _STEPConstruct_PointHasher_HeaderFile
	17	#define _STEPConstruct_PointHasher_HeaderFile
	18
	19	#include <Standard.hxx>
	20	#include <Standard_DefineAlloc.hxx>
	21	#include <Standard_Handle.hxx>
	22
	23	#include <Standard_Integer.hxx>
	24	#include <Standard_Boolean.hxx>
	25	class gp_Pnt;
	26
	27
	28
	29	class STEPConstruct_PointHasher
	30	{
	31	public:
	32
	33	DEFINE_STANDARD_ALLOC
	34
2b2be3fb	35	//! Computes a hash code for the point, in the range [1, theUpperBound]
	36	//! @param thePoint the point which hash code is to be computed
	37	//! @param theUpperBound the upper bound of the range a computing hash code must be within
	38	//! @return a computed hash code, in the range [1, theUpperBound]
	39	static Standard_Integer HashCode (const gp_Pnt& thePoint, const Standard_Integer theUpperBound);
	40
42cf5bc1	41	//! Returns True when the two keys are the same. Two
	42	//! same keys must have the same hashcode, the
	43	//! contrary is not necessary.
	44	Standard_EXPORT static Standard_Boolean IsEqual (const gp_Pnt& Point1, const gp_Pnt& Point2);
	45
	46
	47
	48
	49	protected:
	50
	51
	52
	53
	54
	55	private:
	56
	57
	58
	59
	60
	61	};
	62
	63
	64	#include <STEPConstruct_PointHasher.lxx>
	65
	66
	67
	68
	69
	70	#endif // _STEPConstruct_PointHasher_HeaderFile