include/opencascade/TDataStd_IntPackedMap.hxx

0001 // Created on: 2007-07-31
0002 // Created by: Sergey ZARITCHNY
0003 // Copyright (c) 2007-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _TDataStd_IntPackedMap_HeaderFile
0017 #define _TDataStd_IntPackedMap_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <Standard_Boolean.hxx>
0022 #include <TDF_Attribute.hxx>
0023 #include <TColStd_HPackedMapOfInteger.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <Standard_OStream.hxx>
0026
0027 class Standard_GUID;
0028 class TDF_Label;
0029 class TDF_RelocationTable;
0030 class TDF_DeltaOnModification;
0031
0032 class TDataStd_IntPackedMap;
0033 DEFINE_STANDARD_HANDLE(TDataStd_IntPackedMap, TDF_Attribute)
0034
0035 //! Attribute for storing TColStd_PackedMapOfInteger
0036 class TDataStd_IntPackedMap : public TDF_Attribute
0037 {
0038   friend class TDataStd_DeltaOnModificationOfIntPackedMap;
0039   DEFINE_STANDARD_RTTIEXT(TDataStd_IntPackedMap, TDF_Attribute)
0040 public:
0041
0042   //! class methods
0043   //! =============
0044   //! Returns the GUID of the attribute.
0045   Standard_EXPORT static const Standard_GUID& GetID();
0046
0047   //! Finds or creates an integer map attribute on the given label.
0048   //! If <isDelta> == False, DefaultDeltaOnModification is used.
0049   //! If <isDelta> == True, DeltaOnModification of the current attribute is used.
0050   //! If attribute is already set, input parameter <isDelta> is refused and the found
0051   //! attribute returned.
0052   //! Attribute methods
0053   //! ===================
0054   Standard_EXPORT static Handle(TDataStd_IntPackedMap) Set (const TDF_Label& label, const Standard_Boolean isDelta = Standard_False);
0055
0056   Standard_EXPORT TDataStd_IntPackedMap();
0057
0058   Standard_EXPORT Standard_Boolean ChangeMap (const Handle(TColStd_HPackedMapOfInteger)& theMap);
0059
0060   Standard_EXPORT Standard_Boolean ChangeMap (const TColStd_PackedMapOfInteger& theMap);
0061
0062   const TColStd_PackedMapOfInteger& GetMap() const { return  myMap->Map(); }
0063
0064   const Handle(TColStd_HPackedMapOfInteger)& GetHMap() const { return myMap; }
0065
0066   Standard_EXPORT Standard_Boolean Clear();
0067
0068   Standard_EXPORT Standard_Boolean Add (const Standard_Integer theKey);
0069
0070   Standard_EXPORT Standard_Boolean Remove (const Standard_Integer theKey);
0071
0072   Standard_EXPORT Standard_Boolean Contains (const Standard_Integer theKey) const;
0073
0074   Standard_Integer Extent() const { return myMap->Map().Extent(); }
0075
0076   Standard_Boolean IsEmpty() const { return myMap->Map().IsEmpty(); }
0077
0078   Standard_Boolean GetDelta() const { return myIsDelta; }
0079
0080   //! for  internal  use  only!
0081   void SetDelta (const Standard_Boolean isDelta) { myIsDelta = isDelta; }
0082
0083   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0084
0085   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
0086
0087   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0088
0089   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0090
0091   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0092
0093   //! Makes a DeltaOnModification between <me> and
0094   //! <anOldAttribute>.
0095   Standard_EXPORT virtual Handle(TDF_DeltaOnModification) DeltaOnModification (const Handle(TDF_Attribute)& anOldAttribute) const Standard_OVERRIDE;
0096
0097   //! Dumps the content of me into the stream
0098   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0099
0100 private:
0101
0102   void RemoveMap() { myMap.Nullify(); }
0103
0104 private:
0105
0106   Handle(TColStd_HPackedMapOfInteger) myMap;
0107   Standard_Boolean myIsDelta;
0108
0109 };
0110
0111 #endif // _TDataStd_IntPackedMap_HeaderFile