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 <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
0025 #include <TopAbs_ShapeEnum.hxx>
0026 #include <Standard_Boolean.hxx>
0027 #include <TopTools_ListOfShape.hxx>
0028 class TopoDS_Shape;
0029
0030 //! Encapsulation of IndexedDataMapOfShapeListOfShape.
0031 class ChFiDS_Map
0032 {
0033 public:
0034   DEFINE_STANDARD_ALLOC
0035
0036   //! Create an empty Map
0037   Standard_EXPORT ChFiDS_Map();
0038
0039   //! Fills the map with the subshapes of type T1 as keys
0040   //! and the list of ancestors  of type T2 as items.
0041   Standard_EXPORT void Fill(const TopoDS_Shape&    S,
0042                             const TopAbs_ShapeEnum T1,
0043                             const TopAbs_ShapeEnum T2);
0044
0045   Standard_EXPORT Standard_Boolean Contains(const TopoDS_Shape& S) const;
0046
0047   Standard_EXPORT const TopTools_ListOfShape& FindFromKey(const TopoDS_Shape& S) const;
0048
0049   const TopTools_ListOfShape& operator()(const TopoDS_Shape& S) const { return FindFromKey(S); }
0050
0051   Standard_EXPORT const TopTools_ListOfShape& FindFromIndex(const Standard_Integer I) const;
0052
0053   const TopTools_ListOfShape& operator()(const Standard_Integer I) const
0054   {
0055     return FindFromIndex(I);
0056   }
0057
0058 protected:
0059 private:
0060   TopTools_IndexedDataMapOfShapeListOfShape myMap;
0061 };
0062
0063 #endif // _ChFiDS_Map_HeaderFile