0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDF / TDF_Reference.hxx
1 // Created on: 2000-03-01
2 // Created by: Denis PASCAL
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 _TDF_Reference_HeaderFile
17 #define _TDF_Reference_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TDF_Label.hxx>
23 #include <TDF_Attribute.hxx>
24 #include <Standard_OStream.hxx>
25 class Standard_GUID;
26 class TDF_Label;
27 class TDF_Attribute;
28 class TDF_RelocationTable;
29 class TDF_DataSet;
30
31
32 class TDF_Reference;
33 DEFINE_STANDARD_HANDLE(TDF_Reference, TDF_Attribute)
34
35 //! This  attribute is  used to  store in the  framework a
36 //! reference to an other label.
37 class TDF_Reference : public TDF_Attribute
38 {
39
40 public:
41
42   
43   Standard_EXPORT static const Standard_GUID& GetID();
44   
45   Standard_EXPORT static Handle(TDF_Reference) Set (const TDF_Label& I, const TDF_Label& Origin);
46   
47   Standard_EXPORT void Set (const TDF_Label& Origin);
48   
49   Standard_EXPORT TDF_Label Get() const;
50   
51   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
52   
53   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
54   
55   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
56   
57   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
58   
59   Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& DS) const Standard_OVERRIDE;
60   
61   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
62   
63   Standard_EXPORT TDF_Reference();
64
65   //! Dumps the content of me into the stream
66   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
67
68
69
70
71   DEFINE_STANDARD_RTTIEXT(TDF_Reference,TDF_Attribute)
72
73 protected:
74
75
76
77
78 private:
79
80
81   TDF_Label myOrigin;
82
83
84 };
85
86
87
88
89
90
91
92 #endif // _TDF_Reference_HeaderFile