src/TDataStd/TDataStd_Real.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_Real_HeaderFile
  18 #define _TDataStd_Real_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <TDataStd_RealEnum.hxx>
  25 #include <TDF_Attribute.hxx>
  26 #include <Standard_Boolean.hxx>
  27 #include <Standard_OStream.hxx>
  28 #include <Standard_GUID.hxx>
  29
  30 class TDF_Label;
  31 class TDF_Attribute;
  32 class TDF_RelocationTable;
  33
  34
  35 class TDataStd_Real;
  36 DEFINE_STANDARD_HANDLE(TDataStd_Real, TDF_Attribute)
  37
  38 //! The basis to define a real number attribute.
  39 class TDataStd_Real : public TDF_Attribute
  40 {
  41
  42 public:
  43
  44
  45   //! class methods
  46   //! =============
  47   //! Returns the default GUID for real numbers.
  48   Standard_EXPORT static const Standard_GUID& GetID();
  49
  50   //! Finds, or creates, a Real attribute with default GUID and sets <value>.
  51   //! The Real attribute  is  returned. The  Real  dimension is Scalar by default.
  52   //! Use SetDimension to overwrite.
  53   //! Real methods
  54   //! ============
  55   Standard_EXPORT static Handle(TDataStd_Real) Set (const TDF_Label& label, const Standard_Real value);
  56
  57   //! Finds, or creates, a Real attribute with explicit GUID and sets <value>.
  58   //! The Real attribute  is  returned.
  59   //! Real methods
  60   //! ============
  61   Standard_EXPORT static Handle(TDataStd_Real) Set (const TDF_Label& label, const Standard_GUID& guid,
  62                                     const Standard_Real value);
  63
  64   Standard_EXPORT TDataStd_Real();
  65
  66   //! Obsolete method that will be removed in next versions.
  67   //! This field is not supported in the persistence mechanism.
  68   Standard_DEPRECATED("TDataStd_Real::SetDimension() is deprecated. Please avoid usage of this method.")
  69   Standard_EXPORT void SetDimension (const TDataStd_RealEnum DIM);
  70
  71   //! Obsolete method that will be removed in next versions.
  72   //! This field is not supported in the persistence mechanism.
  73   Standard_DEPRECATED("TDataStd_Real::GetDimension() is deprecated. Please avoid usage of this method.")
  74   Standard_EXPORT TDataStd_RealEnum GetDimension() const;
  75
  76
  77   //! Sets the real number V.
  78   Standard_EXPORT void Set (const Standard_Real V);
  79
  80   //! Sets the explicit GUID for the attribute.
  81   Standard_EXPORT void SetID (const Standard_GUID& guid) Standard_OVERRIDE;
  82
  83   //! Sets default GUID for the attribute.
  84   Standard_EXPORT void SetID() Standard_OVERRIDE;
  85
  86   //! Returns the real number value contained in the attribute.
  87   Standard_EXPORT Standard_Real Get() const;
  88
  89   //! Returns True if there is a reference on the same label
  90   Standard_EXPORT Standard_Boolean IsCaptured() const;
  91
  92   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  93
  94   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
  95
  96   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  97
  98   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  99
 100   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
 101
 102
 103
 104
 105   DEFINE_STANDARD_RTTIEXT(TDataStd_Real,TDF_Attribute)
 106
 107 protected:
 108
 109
 110
 111
 112 private:
 113
 114
 115   Standard_Real myValue;
 116   //! An obsolete field that will be removed in next versions.
 117   TDataStd_RealEnum myDimension;
 118   Standard_GUID myID;
 119
 120 };
 121
 122
 123
 124
 125
 126
 127
 128 #endif // _TDataStd_Real_HeaderFile