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

File indexing completed on 2025-01-18 10:05:22

 // Created on: 2007-03-16
 // Created by: Michael SAZONOV
 // Copyright (c) 2007-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.
 
 // The original implementation Copyright: (C) RINA S.p.A
 
 #ifndef TObj_TIntSparseArray_HeaderFile
 #define TObj_TIntSparseArray_HeaderFile
 
 
 #include <NCollection_SparseArray.hxx>
 #include <TDF_Label.hxx>
 
 typedef NCollection_SparseArray<Standard_Integer> TObj_TIntSparseArray_VecOfData;
 typedef NCollection_SparseArray<Standard_Integer> TObj_TIntSparseArray_MapOfData;
 
 class Standard_GUID;
 
 /**
  * OCAF Attribute to store a set of positive integer values in the OCAF tree.
  * Each value is identified by ID (positive integer).
  * The supporting underlying data structure is NCollection_SparseArray of integers.
  */
 
 class TObj_TIntSparseArray : public TDF_Attribute
 {
  public:
 
   //! Empty constructor
   Standard_EXPORT TObj_TIntSparseArray();
 
   //! This method is used in implementation of ID()
   static Standard_EXPORT const Standard_GUID& GetID();
 
   //! Returns the ID of this attribute.
   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
 
   //! Creates TObj_TIntSparseArray attribute on given label.
   static Standard_EXPORT Handle(TObj_TIntSparseArray) Set
                             (const TDF_Label& theLabel);
 
  public:
   //! Methods for access to data
 
   //! Returns the number of stored values in the set
   Standard_Size Size() const
   { return myVector.Size(); }
 
   typedef TObj_TIntSparseArray_VecOfData::ConstIterator Iterator;
 
   //! Returns iterator on objects contained in the set
   Iterator GetIterator() const { return Iterator(myVector); }
 
   //! Returns true if the value with the given ID is present.
   Standard_Boolean HasValue (const Standard_Size theId) const
   { return myVector.HasValue(theId); }
 
   //! Returns the value by its ID.
   //! Raises an exception if no value is stored with this ID
   Standard_Integer Value (const Standard_Size theId) const
   { return myVector.Value(theId); }
 
   //! Sets the value with the given ID.
   //! Raises an exception if theId is not positive
   Standard_EXPORT void SetValue (const Standard_Size theId,
                                  const Standard_Integer theValue);
 
   //! Unsets the value with the given ID.
   //! Raises an exception if theId is not positive
   Standard_EXPORT void UnsetValue(const Standard_Size theId);
 
   //! Clears the set
   Standard_EXPORT void Clear ();
 
  public:
   //! Redefined OCAF abstract methods
 
   //! Returns an new empty TObj_TIntSparseArray attribute. It is used by the
   //! copy algorithm.
   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
 
   //! Moves this delta into a new other attribute.
   Standard_EXPORT Handle(TDF_Attribute) BackupCopy() const Standard_OVERRIDE;
 
   //! Restores the set using info saved in backup attribute theDelta.
   Standard_EXPORT void Restore(const Handle(TDF_Attribute)& theDelta) Standard_OVERRIDE;
 
   //! This method is used when copying an attribute from a source structure
   //! into a target structure.
   Standard_EXPORT void Paste(const Handle(TDF_Attribute)&       theInto,
                              const Handle(TDF_RelocationTable)& theRT) const Standard_OVERRIDE;
 
   //! It is called just before Commit or Abort transaction
   //! and does Backup() to create a delta
   Standard_EXPORT void BeforeCommitTransaction() Standard_OVERRIDE;
 
   //! Applies theDelta to this.
   Standard_EXPORT void DeltaOnModification
                         (const Handle(TDF_DeltaOnModification)& theDelta) Standard_OVERRIDE;
 
   //! Clears my modification delta; called after application of theDelta
   Standard_EXPORT Standard_Boolean AfterUndo
                         (const Handle(TDF_AttributeDelta)& theDelta,
                          const Standard_Boolean toForce) Standard_OVERRIDE;
 
  public:
   //! Methods to handle the modification delta
 
   //! Sets the flag pointing to the necessity to maintain a modification delta.
   //! It is called by the retrieval driver
   void SetDoBackup (const Standard_Boolean toDo)
   { myDoBackup = toDo; }
 
   void ClearDelta ()
   { myOldMap.Clear(); }
 
  private:
   //! Internal constant to recognize items in the backup array
   //! correspondent to absent values
   enum
   {
     AbsentValue = -1
   };
 
   //! backup one value
   void backupValue (const Standard_Size theId,
                     const Standard_Integer theCurrValue,
                     const Standard_Integer theNewValue);
 
   TObj_TIntSparseArray_VecOfData myVector;
   TObj_TIntSparseArray_MapOfData myOldMap;
   Standard_Boolean               myDoBackup;
 
  public:
   //! CASCADE RTTI
   DEFINE_STANDARD_RTTIEXT(TObj_TIntSparseArray,TDF_Attribute)
 };
 
 //! Define handle class for TObj_TIntSparseArray
 DEFINE_STANDARD_HANDLE(TObj_TIntSparseArray,TDF_Attribute)
 
 #endif
 
 #ifdef _MSC_VER
 #pragma once
 #endif

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