EIC code displayed by LXR master/​include/​opencascade/​TDF_Data.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-09-28 09:21:56

 // Created by: DAUTRY Philippe
 // Copyright (c) 1997-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _TDF_Data_HeaderFile
 #define _TDF_Data_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_Type.hxx>
 
 #include <TDF_LabelNodePtr.hxx>
 #include <Standard_Integer.hxx>
 #include <NCollection_List.hxx>
 #include <TDF_HAllocator.hxx>
 #include <Standard_Transient.hxx>
 #include <TDF_Label.hxx>
 #include <Standard_OStream.hxx>
 #include <NCollection_DataMap.hxx>
 class TDF_Delta;
 class TDF_Label;
 
 //! This class is used to manipulate a complete independent,
 //! self sufficient data structure and its services:
 //!
 //! Access to the root label;
 //!
 //! Opens, aborts, commits a transaction;
 //!
 //! Generation and use of Delta, depending on the time.
 //! This class uses a special allocator
 //! (see LabelNodeAllocator() method)
 //! for more efficient allocation of objects in memory.
 class TDF_Data : public Standard_Transient
 {
 
 public:
   //! A new and empty Data structure.
   Standard_EXPORT TDF_Data();
 
   //! Returns the root label of the Data structure.
   const TDF_Label Root() const;
 
   //! Returns the current transaction number.
   int Transaction() const;
 
   //! Returns the current tick. It is incremented each Commit.
   int Time() const;
 
   //! Returns true if <aDelta> is applicable HERE and NOW.
   Standard_EXPORT bool IsApplicable(const occ::handle<TDF_Delta>& aDelta) const;
 
   //! Apply <aDelta> to undo a set of attribute modifications.
   //!
   //! Optional <withDelta> set to True indicates a
   //! Delta Set must be generated. (See above)
   Standard_EXPORT occ::handle<TDF_Delta> Undo(const occ::handle<TDF_Delta>& aDelta,
                                               const bool                    withDelta = false);
 
   Standard_EXPORT void Destroy();
 
   ~TDF_Data() override { Destroy(); }
 
   //! Returns the undo mode status.
   bool NotUndoMode() const;
 
   //! Dumps the Data on <aStream>.
   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const;
 
   Standard_OStream& operator<<(Standard_OStream& anOS) const { return Dump(anOS); }
 
   //! Sets modification mode.
   void AllowModification(const bool isAllowed);
 
   //! returns modification mode.
   bool IsModificationAllowed() const;
 
   //! Initializes a mechanism for fast access to the labels by their entries.
   //! The fast access is useful for large documents and often access to the labels
   //! via entries. Internally, a table of entry - label is created,
   //! which allows to obtain a label by its entry in a very fast way.
   //! If the mechanism is turned off, the internal table is cleaned.
   //! New labels are added to the table, if the mechanism is on
   //! (no need to re-initialize the mechanism).
   Standard_EXPORT void SetAccessByEntries(const bool aSet);
 
   //! Returns a status of mechanism for fast access to the labels via entries.
   bool IsAccessByEntries() const { return myAccessByEntries; }
 
   //! Returns a label by an entry.
   //! Returns false, if such a label doesn't exist
   //! or mechanism for fast access to the label by entry is not initialized.
   bool GetLabel(const TCollection_AsciiString& anEntry, TDF_Label& aLabel)
   {
     return myAccessByEntriesTable.Find(anEntry, aLabel);
   }
 
   //! An internal method. It is used internally on creation of new labels.
   //! It adds a new label into internal table for fast access to the labels by entry.
   Standard_EXPORT void RegisterLabel(const TDF_Label& aLabel);
 
   //! Returns TDF_HAllocator, which is an
   //! incremental allocator used by
   //! TDF_LabelNode.
   //! This allocator is used to
   //! manage TDF_LabelNode objects,
   //! but it can also be used for
   //! allocating memory to
   //! application-specific data (be
   //! careful because this
   //! allocator does not release
   //! the memory).
   //! The benefits of this
   //! allocation scheme are
   //! noticeable when dealing with
   //! large OCAF documents, due to:
   //! 1.    Very quick allocation of
   //! objects (memory heap is not
   //! used, the algorithm that
   //! replaces it is very simple).
   //! 2.    Very quick destruction of
   //! objects (memory is released not
   //! by destructors of TDF_LabelNode,
   //! but rather by the destructor of
   //! TDF_Data).
   //! 3.  TDF_LabelNode objects do not
   //! fragmentize the memory; they are
   //! kept compactly in a number of
   //! arrays of 16K each.
   //! 4.    Swapping is reduced on large
   //! data, because each document now
   //! occupies a smaller number of
   //! memory pages.
   const TDF_HAllocator& LabelNodeAllocator() const;
 
   //! Dumps the content of me into the stream
   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const;
 
   friend class TDF_Transaction;
   friend class TDF_LabelNode;
 
   DEFINE_STANDARD_RTTIEXT(TDF_Data, Standard_Transient)
 
 private:
   //! Fixes order of Attributes' Deltas to perform undo/redo without exceptions:
   //! puts OnRemoval deltas to the end of the list.
   void FixOrder(const occ::handle<TDF_Delta>& theDelta);
 
   //! Increments the transaction number and returns it.
   Standard_EXPORT int OpenTransaction();
 
   //! Decrements the transaction number and commits the
   //! modifications.
   //!
   //! Raises if there is no current transaction.
   //!
   //! Optional <withDelta> set to True indicates a
   //! Delta must be generated.
   Standard_EXPORT occ::handle<TDF_Delta> CommitTransaction(const bool withDelta = false);
 
   //! Decrements the transaction number and commits the
   //! modifications until AND including the transaction
   //! <untilTransaction>.
   Standard_EXPORT occ::handle<TDF_Delta> CommitUntilTransaction(const int  untilTransaction,
                                                                 const bool withDelta = false);
 
   //! Decrements the transaction number and forgets the
   //! modifications.
   //!
   //! Raises if there is no current transaction.
   Standard_EXPORT void AbortTransaction();
 
   //! Decrements the transaction number and forgets the
   //! modifications until AND including the transaction
   //! <untilTransaction>.
   Standard_EXPORT void AbortUntilTransaction(const int untilTransaction);
 
   //! Decrements the transaction number and commits the
   //! modifications. Used to implement the recursif
   //! commit process. The returned boolean says how many
   //! attributes (new, modified or deleted) has been
   //! committed from the previous transaction into the
   //! current one.
   Standard_EXPORT int CommitTransaction(const TDF_Label&              aLabel,
                                         const occ::handle<TDF_Delta>& aDelta,
                                         const bool                    withDelta);
 
   TDF_LabelNodePtr                                        myRoot;
   int                                                     myTransaction;
   int                                                     myNbTouchedAtt;
   bool                                                    myNotUndoMode;
   int                                                     myTime;
   NCollection_List<int>                                   myTimes;
   TDF_HAllocator                                          myLabelNodeAllocator;
   bool                                                    myAllowModification;
   bool                                                    myAccessByEntries;
   NCollection_DataMap<TCollection_AsciiString, TDF_Label> myAccessByEntriesTable;
 };
 
 #include <TDF_Data.lxx>
 
 #endif // _TDF_Data_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team