0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDataStd / TDataStd_Current.hxx
1 // Created on: 1999-08-02
2 // Created by: Denis PASCAL
3 // Copyright (c) 1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _TDataStd_Current_HeaderFile
18 #define _TDataStd_Current_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TDF_Label.hxx>
24 #include <TDF_Attribute.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_OStream.hxx>
27 class Standard_GUID;
28 class TDF_Label;
29 class TDF_Attribute;
30 class TDF_RelocationTable;
31
32
33 class TDataStd_Current;
34 DEFINE_STANDARD_HANDLE(TDataStd_Current, TDF_Attribute)
35
36 //! this attribute,  located at root label,  manage an
37 //! access to a current label.
38 class TDataStd_Current : public TDF_Attribute
39 {
40
41 public:
42
43   
44   //! class methods
45   //! =============
46   Standard_EXPORT static const Standard_GUID& GetID();
47   
48   //! Set <L> as current of <L> Framework.
49   Standard_EXPORT static void Set (const TDF_Label& L);
50   
51   //! returns current of <acces> Framework. raise if (!Has)
52   Standard_EXPORT static TDF_Label Get (const TDF_Label& acces);
53   
54   //! returns True if a  current label is managed in <acces>
55   //! Framework.
56   //! class methods
57   //! =============
58   Standard_EXPORT static Standard_Boolean Has (const TDF_Label& acces);
59   
60   Standard_EXPORT TDataStd_Current();
61   
62   Standard_EXPORT void SetLabel (const TDF_Label& current);
63   
64   Standard_EXPORT TDF_Label GetLabel() const;
65   
66   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
67   
68   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
69   
70   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
71   
72   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
73   
74   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
75   
76   //! Dumps the content of me into the stream
77   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
78
79
80
81
82   DEFINE_STANDARD_RTTIEXT(TDataStd_Current,TDF_Attribute)
83
84 protected:
85
86
87
88
89 private:
90
91
92   TDF_Label myLabel;
93
94
95 };
96
97
98
99
100
101
102
103 #endif // _TDataStd_Current_HeaderFile