include/opencascade/ChFiDS_Map.hxx

0001 // Created on: 1993-10-22
0002 // Created by: Laurent BOURESCHE
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _ChFiDS_Map_HeaderFile
0018 #define _ChFiDS_Map_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopoDS_Shape.hxx>
0025 #include <NCollection_List.hxx>
0026 #include <TopTools_ShapeMapHasher.hxx>
0027 #include <NCollection_IndexedDataMap.hxx>
0028 #include <TopAbs_ShapeEnum.hxx>
0029 #include <Standard_Boolean.hxx>
0030 class TopoDS_Shape;
0031
0032 //! Encapsulation of IndexedDataMapOfShapeListOfShape.
0033 class ChFiDS_Map
0034 {
0035 public:
0036   DEFINE_STANDARD_ALLOC
0037
0038   //! Create an empty Map
0039   Standard_EXPORT ChFiDS_Map();
0040
0041   //! Fills the map with the subshapes of type T1 as keys
0042   //! and the list of ancestors of type T2 as items.
0043   Standard_EXPORT void Fill(const TopoDS_Shape&    S,
0044                             const TopAbs_ShapeEnum T1,
0045                             const TopAbs_ShapeEnum T2);
0046
0047   Standard_EXPORT bool Contains(const TopoDS_Shape& S) const;
0048
0049   Standard_EXPORT const NCollection_List<TopoDS_Shape>& FindFromKey(const TopoDS_Shape& S) const;
0050
0051   const NCollection_List<TopoDS_Shape>& operator()(const TopoDS_Shape& S) const
0052   {
0053     return FindFromKey(S);
0054   }
0055
0056   Standard_EXPORT const NCollection_List<TopoDS_Shape>& FindFromIndex(const int I) const;
0057
0058   const NCollection_List<TopoDS_Shape>& operator()(const int I) const { return FindFromIndex(I); }
0059
0060 private:
0061   NCollection_IndexedDataMap<TopoDS_Shape, NCollection_List<TopoDS_Shape>, TopTools_ShapeMapHasher>
0062     myMap;
0063 };
0064
0065 #endif // _ChFiDS_Map_HeaderFile