0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDF / TDF_AttributeDelta.hxx
1 // Created by: DAUTRY Philippe
2 // Copyright (c) 1997-1999 Matra Datavision
3 // Copyright (c) 1999-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_AttributeDelta_HeaderFile
17 #define _TDF_AttributeDelta_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TDF_Label.hxx>
23 #include <Standard_Transient.hxx>
24 #include <Standard_OStream.hxx>
25 class TDF_Attribute;
26 class TDF_Label;
27 class Standard_GUID;
28
29
30 class TDF_AttributeDelta;
31 DEFINE_STANDARD_HANDLE(TDF_AttributeDelta, Standard_Transient)
32
33 //! This class discribes the services we need to
34 //! implement Delta and Undo/Redo services.
35 //!
36 //! AttributeDeltas are applied in an unpredictable
37 //! order. But by the redefinition of the method
38 //! IsNowApplicable, a condition can be verified
39 //! before application. If the AttributeDelta is not
40 //! yet applicable, it is put at the end of the
41 //! AttributeDelta list, to be treated later. If a
42 //! dead lock if found on the list, the
43 //! AttributeDeltas are forced to be applied in an
44 //! unpredictable order.
45 class TDF_AttributeDelta : public Standard_Transient
46 {
47
48 public:
49
50   
51   //! Applies the delta to the attribute.
52   Standard_EXPORT virtual void Apply() = 0;
53   
54   //! Returns the label concerned by <me>.
55   Standard_EXPORT TDF_Label Label() const;
56   
57   //! Returns the reference attribute.
58   Standard_EXPORT Handle(TDF_Attribute) Attribute() const;
59   
60   //! Returns the ID of the attribute concerned by <me>.
61   Standard_EXPORT Standard_GUID ID() const;
62   
63   //! Dumps the contents.
64   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& OS) const;
65 Standard_OStream& operator<< (Standard_OStream& OS) const
66 {
67   return Dump(OS);
68 }
69
70   //! Dumps the content of me into the stream
71   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
72
73
74
75
76   DEFINE_STANDARD_RTTIEXT(TDF_AttributeDelta,Standard_Transient)
77
78 protected:
79
80   
81   Standard_EXPORT TDF_AttributeDelta(const Handle(TDF_Attribute)& anAttribute);
82
83
84
85 private:
86
87
88   Handle(TDF_Attribute) myAttribute;
89   TDF_Label myLabel;
90
91
92 };
93
94
95
96
97
98
99
100 #endif // _TDF_AttributeDelta_HeaderFile