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   //! class methods
0042   //! =============
0043   //! Returns the GUID of the attribute.
0044   Standard_EXPORT static const Standard_GUID& GetID();
0045
0046   //! Finds or creates an integer map attribute on the given label.
0047   //! If <isDelta> == False, DefaultDeltaOnModification is used.
0048   //! If <isDelta> == True, DeltaOnModification of the current attribute is used.
0049   //! If attribute is already set, input parameter <isDelta> is refused and the found
0050   //! attribute returned.
0051   //! Attribute methods
0052   //! ===================
0053   Standard_EXPORT static Handle(TDataStd_IntPackedMap) Set(
0054     const TDF_Label&       label,
0055     const Standard_Boolean isDelta = Standard_False);
0056
0057   Standard_EXPORT TDataStd_IntPackedMap();
0058
0059   Standard_EXPORT Standard_Boolean ChangeMap(const Handle(TColStd_HPackedMapOfInteger)& theMap);
0060
0061   Standard_EXPORT Standard_Boolean ChangeMap(const TColStd_PackedMapOfInteger& theMap);
0062
0063   const TColStd_PackedMapOfInteger& GetMap() const { return myMap->Map(); }
0064
0065   const Handle(TColStd_HPackedMapOfInteger)& GetHMap() const { return myMap; }
0066
0067   Standard_EXPORT Standard_Boolean Clear();
0068
0069   Standard_EXPORT Standard_Boolean Add(const Standard_Integer theKey);
0070
0071   Standard_EXPORT Standard_Boolean Remove(const Standard_Integer theKey);
0072
0073   Standard_EXPORT Standard_Boolean Contains(const Standard_Integer theKey) const;
0074
0075   Standard_Integer Extent() const { return myMap->Map().Extent(); }
0076
0077   Standard_Boolean IsEmpty() const { return myMap->Map().IsEmpty(); }
0078
0079   Standard_Boolean GetDelta() const { return myIsDelta; }
0080
0081   //! for  internal  use  only!
0082   void SetDelta(const Standard_Boolean isDelta) { myIsDelta = isDelta; }
0083
0084   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0085
0086   Standard_EXPORT void Restore(const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
0087
0088   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0089
0090   Standard_EXPORT void Paste(const Handle(TDF_Attribute)&       into,
0091                              const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0092
0093   Standard_EXPORT virtual Standard_OStream& Dump(Standard_OStream& anOS) const Standard_OVERRIDE;
0094
0095   //! Makes a DeltaOnModification between <me> and
0096   //! <anOldAttribute>.
0097   Standard_EXPORT virtual Handle(TDF_DeltaOnModification) DeltaOnModification(
0098     const Handle(TDF_Attribute)& anOldAttribute) const Standard_OVERRIDE;
0099
0100   //! Dumps the content of me into the stream
0101   Standard_EXPORT virtual void DumpJson(Standard_OStream& theOStream,
0102                                         Standard_Integer  theDepth = -1) const Standard_OVERRIDE;
0103
0104 private:
0105   void RemoveMap() { myMap.Nullify(); }
0106
0107 private:
0108   Handle(TColStd_HPackedMapOfInteger) myMap;
0109   Standard_Boolean                    myIsDelta;
0110 };
0111
0112 #endif // _TDataStd_IntPackedMap_HeaderFile