include/opencascade/TDataStd_Real.hxx

0001 // Created on: 1997-02-06
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TDataStd_Real_HeaderFile
0018 #define _TDataStd_Real_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Real.hxx>
0023 #include <TDataStd_RealEnum.hxx>
0024 #include <TDF_DerivedAttribute.hxx>
0025 #include <Standard_OStream.hxx>
0026 #include <Standard_GUID.hxx>
0027
0028 class TDF_Label;
0029 class TDF_RelocationTable;
0030
0031
0032 class TDataStd_Real;
0033 DEFINE_STANDARD_HANDLE(TDataStd_Real, TDF_Attribute)
0034
0035 //! The basis to define a real number attribute.
0036 class TDataStd_Real : public TDF_Attribute
0037 {
0038
0039 public:
0040
0041
0042   //! class methods
0043   //! =============
0044   //! Returns the default GUID for real numbers.
0045   Standard_EXPORT static const Standard_GUID& GetID();
0046
0047   //! Finds, or creates, a Real attribute with default GUID and sets <value>.
0048   //! The Real attribute  is  returned. The  Real  dimension is Scalar by default.
0049   //! Use SetDimension to overwrite.
0050   //! Real methods
0051   //! ============
0052   Standard_EXPORT static Handle(TDataStd_Real) Set (const TDF_Label& label, const Standard_Real value);
0053
0054   //! Finds, or creates, a Real attribute with explicit GUID and sets <value>.
0055   //! The Real attribute  is  returned.
0056   //! Real methods
0057   //! ============
0058   Standard_EXPORT static Handle(TDataStd_Real) Set (const TDF_Label& label, const Standard_GUID& guid,
0059                                 const Standard_Real value);
0060
0061   Standard_EXPORT TDataStd_Real();
0062
0063   //! Obsolete method that will be removed in next versions.
0064   //! This field is not supported in the persistence mechanism.
0065   Standard_DEPRECATED("TDataStd_Real::SetDimension() is deprecated. Please avoid usage of this method.")
0066   Standard_EXPORT void SetDimension (const TDataStd_RealEnum DIM);
0067
0068   //! Obsolete method that will be removed in next versions.
0069   //! This field is not supported in the persistence mechanism.
0070   Standard_DEPRECATED("TDataStd_Real::GetDimension() is deprecated. Please avoid usage of this method.")
0071   Standard_EXPORT TDataStd_RealEnum GetDimension() const;
0072
0073
0074   //! Sets the real number V.
0075   Standard_EXPORT void Set (const Standard_Real V);
0076
0077   //! Sets the explicit GUID for the attribute.
0078   Standard_EXPORT void SetID (const Standard_GUID& guid) Standard_OVERRIDE;
0079
0080   //! Sets default GUID for the attribute.
0081   Standard_EXPORT void SetID() Standard_OVERRIDE;
0082
0083   //! Returns the real number value contained in the attribute.
0084   Standard_EXPORT Standard_Real Get() const;
0085
0086   //! Returns True if there is a reference on the same label
0087   Standard_EXPORT Standard_Boolean IsCaptured() const;
0088
0089   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0090
0091   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0092
0093   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0094
0095   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0096
0097   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0098
0099   //! Dumps the content of me into the stream
0100   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0101
0102
0103
0104
0105   DEFINE_STANDARD_RTTIEXT(TDataStd_Real,TDF_Attribute)
0106
0107 protected:
0108
0109   Standard_Real myValue;
0110   //! An obsolete field that will be removed in next versions.
0111   TDataStd_RealEnum myDimension;
0112   Standard_GUID myID;
0113 };
0114
0115
0116
0117
0118
0119
0120
0121 #endif // _TDataStd_Real_HeaderFile