0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / XCAFDoc / XCAFDoc_ShapeMapTool.hxx
1 // Created on: 2003-08-29
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 _XCAFDoc_ShapeMapTool_HeaderFile
17 #define _XCAFDoc_ShapeMapTool_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TopTools_IndexedMapOfShape.hxx>
23 #include <TDF_Attribute.hxx>
24 #include <Standard_Boolean.hxx>
25 class Standard_GUID;
26 class TDF_Label;
27 class TopoDS_Shape;
28 class TDF_Attribute;
29 class TDF_RelocationTable;
30
31
32 class XCAFDoc_ShapeMapTool;
33 DEFINE_STANDARD_HANDLE(XCAFDoc_ShapeMapTool, TDF_Attribute)
34
35 //! attribute containing map of sub shapes
36 class XCAFDoc_ShapeMapTool : public TDF_Attribute
37 {
38
39 public:
40
41   
42   Standard_EXPORT static const Standard_GUID& GetID();
43   
44   //! Create (if not exist) ShapeTool from XCAFDoc on <L>.
45   Standard_EXPORT static Handle(XCAFDoc_ShapeMapTool) Set (const TDF_Label& L);
46   
47   //! Creates an empty tool
48   Standard_EXPORT XCAFDoc_ShapeMapTool();
49   
50   //! Checks whether shape <sub> is subshape of shape stored on
51   //! label shapeL
52   Standard_EXPORT Standard_Boolean IsSubShape (const TopoDS_Shape& sub) const;
53   
54   //! Sets representation (TopoDS_Shape) for top-level shape
55   Standard_EXPORT void SetShape (const TopoDS_Shape& S);
56   
57   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
58   
59   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
60   
61   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
62   
63   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
64   
65   Standard_EXPORT const TopTools_IndexedMapOfShape& GetMap() const;
66   
67   //! Dumps the content of me into the stream
68   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
69
70
71
72
73   DEFINE_STANDARD_RTTIEXT(XCAFDoc_ShapeMapTool,TDF_Attribute)
74
75 protected:
76
77
78
79
80 private:
81
82
83   TopTools_IndexedMapOfShape myMap;
84
85
86 };
87
88
89
90
91
92
93
94 #endif // _XCAFDoc_ShapeMapTool_HeaderFile