src/TDataStd/TDataStd_Integer.hxx

   1 // Created on: 1997-02-06
   2 // Created by: Denis PASCAL
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _TDataStd_Integer_HeaderFile
  18 #define _TDataStd_Integer_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <TDF_Attribute.hxx>
  25 #include <Standard_Boolean.hxx>
  26 #include <Standard_OStream.hxx>
  27 #include <Standard_GUID.hxx>
  28
  29 class Standard_GUID;
  30 class TDF_Label;
  31 class TDF_Attribute;
  32 class TDF_RelocationTable;
  33
  34
  35 class TDataStd_Integer;
  36 DEFINE_STANDARD_HANDLE(TDataStd_Integer, TDF_Attribute)
  37
  38 //! The basis to define an integer attribute.
  39 class TDataStd_Integer : public TDF_Attribute
  40 {
  41
  42 public:
  43
  44
  45   //! class methods
  46   //! =============
  47   //! Returns the GUID for integers.
  48   Standard_EXPORT static const Standard_GUID& GetID();
  49
  50   //! Finds, or creates, an Integer attribute and sets <value>
  51   //! the Integer  attribute is returned.
  52   Standard_EXPORT static Handle(TDataStd_Integer) Set (const TDF_Label& label, const Standard_Integer value);
  53
  54   //! Finds, or creates, an Integer attribute with explicit user defined <guid> and sets <value>.
  55   //! The Integer attribute  is  returned.
  56   Standard_EXPORT static Handle(TDataStd_Integer) Set (const TDF_Label& label, const Standard_GUID& guid,
  57                                     const Standard_Integer value);
  58
  59   //! Integer methods
  60   //! ===============
  61   Standard_EXPORT void Set (const Standard_Integer V);
  62
  63   //! Sets the explicit GUID (user defined) for the attribute.
  64   Standard_EXPORT void SetID (const Standard_GUID& guid);
  65
  66   //! Returns the integer value contained in the attribute.
  67   Standard_EXPORT Standard_Integer Get() const;
  68
  69   //! Returns True if there is a reference on the same label
  70   Standard_EXPORT Standard_Boolean IsCaptured() const;
  71
  72   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  73
  74   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
  75
  76   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  77
  78   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  79
  80   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  81
  82   Standard_EXPORT TDataStd_Integer();
  83
  84
  85
  86
  87   DEFINE_STANDARD_RTTIEXT(TDataStd_Integer,TDF_Attribute)
  88
  89 protected:
  90
  91
  92
  93
  94 private:
  95
  96
  97   Standard_Integer myValue;
  98   Standard_GUID myID;
  99
 100 };
 101
 102
 103
 104
 105
 106
 107
 108 #endif // _TDataStd_Integer_HeaderFile