0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / XCAFDoc / XCAFDoc_Location.hxx
1 // Created on: 2000-08-15
2 // Created by: data exchange team
3 // Copyright (c) 2000-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_Location_HeaderFile
17 #define _XCAFDoc_Location_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TopLoc_Location.hxx>
23 #include <TDF_Attribute.hxx>
24 class Standard_GUID;
25 class TDF_Label;
26 class TopLoc_Location;
27 class TDF_Attribute;
28 class TDF_RelocationTable;
29
30
31 class XCAFDoc_Location;
32 DEFINE_STANDARD_HANDLE(XCAFDoc_Location, TDF_Attribute)
33
34 //! attribute to store TopLoc_Location
35 class XCAFDoc_Location : public TDF_Attribute
36 {
37
38 public:
39
40   
41   //! class methods
42   //! =============
43   Standard_EXPORT XCAFDoc_Location();
44   
45   Standard_EXPORT static const Standard_GUID& GetID();
46   
47   //! Find, or create, a Location attribute and set it's value
48   //! the Location attribute is returned.
49   //! Location methods
50   //! ===============
51   Standard_EXPORT static Handle(XCAFDoc_Location) Set (const TDF_Label& label, const TopLoc_Location& Loc);
52   
53   Standard_EXPORT void Set (const TopLoc_Location& Loc);
54   
55   //! Returns True if there is a reference on the same label
56   Standard_EXPORT const TopLoc_Location& Get() const;
57   
58   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
59   
60   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
61   
62   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
63   
64   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
65   
66   //! Dumps the content of me into the stream
67   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
68
69
70
71
72   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Location,TDF_Attribute)
73
74 protected:
75
76
77
78
79 private:
80
81
82   TopLoc_Location myLocation;
83
84
85 };
86
87
88
89
90
91
92
93 #endif // _XCAFDoc_Location_HeaderFile