0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDF / TDF_Data.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_Data_HeaderFile
17 #define _TDF_Data_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TDF_LabelNodePtr.hxx>
23 #include <Standard_Integer.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <TColStd_ListOfInteger.hxx>
26 #include <TDF_HAllocator.hxx>
27 #include <Standard_Transient.hxx>
28 #include <TDF_Label.hxx>
29 #include <Standard_OStream.hxx>
30 class Standard_NoMoreObject;
31 class TDF_Transaction;
32 class TDF_LabelNode;
33 class TDF_Delta;
34 class TDF_Label;
35
36
37 class TDF_Data;
38 DEFINE_STANDARD_HANDLE(TDF_Data, Standard_Transient)
39
40 //! This class is used to manipulate a complete
41 //! independant, self sufficient data structure and
42 //! its services:
43 //!
44 //! Access to the root label;
45 //!
46 //! Opens, aborts, commits a transaction;
47 //!
48 //! Generation and use of Delta, depending on the time.
49 //! This class uses a special allocator
50 //! (see LabelNodeAllocator() method)
51 //! for more efficient allocation of
52 //! objects in memory.
53 class TDF_Data : public Standard_Transient
54 {
55
56 public:
57
58   
59   //! A new and empty Data structure.
60   Standard_EXPORT TDF_Data();
61   
62   //! Returns the root label of the Data structure.
63     const TDF_Label Root() const;
64   
65   //! Returns the current transaction number.
66   Standard_Integer Transaction() const;
67   
68   //! Returns the current tick. It is incremented each Commit.
69     Standard_Integer Time() const;
70   
71   //! Returns true if <aDelta> is applicable HERE and NOW.
72   Standard_EXPORT Standard_Boolean IsApplicable (const Handle(TDF_Delta)& aDelta) const;
73   
74   //! Apply <aDelta> to undo a set of attribute
75   //! modifications.
76   //!
77   //! Optionnal <withDelta> set to True indiquates a
78   //! Delta Set must be generated. (See above)
79   Standard_EXPORT Handle(TDF_Delta) Undo (const Handle(TDF_Delta)& aDelta, const Standard_Boolean withDelta = Standard_False);
80   
81   Standard_EXPORT void Destroy();
82 ~TDF_Data()
83 {
84   Destroy();
85 }
86   
87   //! Returns the undo mode status.
88     Standard_Boolean NotUndoMode() const;
89   
90   //! Dumps the Data on <aStream>.
91     Standard_EXPORT Standard_OStream& Dump (Standard_OStream& anOS) const;
92 Standard_OStream& operator<< (Standard_OStream& anOS) const
93 {
94   return Dump(anOS);
95 }
96   
97   //! Sets modification mode.
98     void AllowModification (const Standard_Boolean isAllowed);
99   
100   //! returns modification mode.
101     Standard_Boolean IsModificationAllowed() const;
102   
103   //! Returns TDF_HAllocator, which is an
104   //! incremental allocator used by
105   //! TDF_LabelNode.
106   //! This allocator is used to
107   //! manage TDF_LabelNode objects,
108   //! but it can also be used for
109   //! allocating memory to
110   //! application-specific data (be
111   //! careful because this
112   //! allocator does not release
113   //! the memory).
114   //! The benefits of this
115   //! allocation scheme are
116   //! noticeable when dealing with
117   //! large OCAF documents, due to:
118   //! 1.    Very quick allocation of
119   //! objects (memory heap is not
120   //! used, the algorithm that
121   //! replaces it is very simple).
122   //! 2.    Very quick destruction of
123   //! objects (memory is released not
124   //! by destructors of TDF_LabelNode,
125   //! but rather by the destructor of
126   //! TDF_Data).
127   //! 3.  TDF_LabelNode objects do not
128   //! fragmentize the memory; they are
129   //! kept compactly in a number of
130   //! arrays of 16K each.
131   //! 4.    Swapping is reduced on large
132   //! data, because each document now
133   //! occupies a smaller number of
134   //! memory pages.
135     const TDF_HAllocator& LabelNodeAllocator() const;
136
137   //! Dumps the content of me into the stream
138   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
139
140 friend class TDF_Transaction;
141 friend class TDF_LabelNode;
142
143
144   DEFINE_STANDARD_RTTIEXT(TDF_Data,Standard_Transient)
145
146 protected:
147
148
149
150
151 private:
152
153   //! Fixes order of Attributes' Deltas to perform undo/redo without exceptions:
154   //! puts OnRemoval deltas to the end of the list.
155   void FixOrder(const Handle(TDF_Delta)& theDelta);
156   
157   //! Increments the transaction number and returns it.
158   Standard_EXPORT Standard_Integer OpenTransaction();
159   
160   //! Decrements the transaction number and commits the
161   //! modifications.
162   //!
163   //! Raises if there is no current transaction.
164   //!
165   //! Optionnal <withDelta> set to True indiquates a
166   //! Delta must be generated.
167   Standard_EXPORT Handle(TDF_Delta) CommitTransaction (const Standard_Boolean withDelta = Standard_False);
168   
169   //! Decrements the transaction number and commits the
170   //! modifications until AND including the transaction
171   //! <untilTransaction>.
172   Standard_EXPORT Handle(TDF_Delta) CommitUntilTransaction (const Standard_Integer untilTransaction, const Standard_Boolean withDelta = Standard_False);
173   
174   //! Decrements the transaction number and forgets the
175   //! modifications.
176   //!
177   //! Raises if there is no current transaction.
178   Standard_EXPORT void AbortTransaction();
179   
180   //! Decrements the transaction number and forgets the
181   //! modifications until AND including the transaction
182   //! <untilTransaction>.
183   Standard_EXPORT void AbortUntilTransaction (const Standard_Integer untilTransaction);
184   
185   //! Decrements the transaction number and commits the
186   //! modifications. Used to implement the recursif
187   //! commit process. The returned boolean says how many
188   //! attributes (new, modified or deleted) has been
189   //! committed from the previous transaction into the
190   //! current one.
191   Standard_EXPORT Standard_Integer CommitTransaction (const TDF_Label& aLabel, const Handle(TDF_Delta)& aDelta, const Standard_Boolean withDelta);
192
193   TDF_LabelNodePtr myRoot;
194   Standard_Integer myTransaction;
195   Standard_Integer myNbTouchedAtt;
196   Standard_Boolean myNotUndoMode;
197   Standard_Integer myTime;
198   TColStd_ListOfInteger myTimes;
199   TDF_HAllocator myLabelNodeAllocator;
200   Standard_Boolean myAllowModification;
201
202
203 };
204
205
206 #include <TDF_Data.lxx>
207
208
209
210
211
212 #endif // _TDF_Data_HeaderFile