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
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _TDataStd_Real_HeaderFile
18 #define _TDataStd_Real_HeaderFile
20 #include <Standard.hxx>
22 #include <Standard_Real.hxx>
23 #include <TDataStd_RealEnum.hxx>
24 #include <TDF_DerivedAttribute.hxx>
25 #include <Standard_OStream.hxx>
26 #include <Standard_GUID.hxx>
29 class TDF_RelocationTable;
33 DEFINE_STANDARD_HANDLE(TDataStd_Real, TDF_Attribute)
35 //! The basis to define a real number attribute.
36 class TDataStd_Real : public TDF_Attribute
44 //! Returns the default GUID for real numbers.
45 Standard_EXPORT static const Standard_GUID& GetID();
47 //! Finds, or creates, a Real attribute with default GUID and sets <value>.
48 //! The Real attribute is returned. The Real dimension is Scalar by default.
49 //! Use SetDimension to overwrite.
52 Standard_EXPORT static Handle(TDataStd_Real) Set (const TDF_Label& label, const Standard_Real value);
54 //! Finds, or creates, a Real attribute with explicit GUID and sets <value>.
55 //! The Real attribute is returned.
58 Standard_EXPORT static Handle(TDataStd_Real) Set (const TDF_Label& label, const Standard_GUID& guid,
59 const Standard_Real value);
61 Standard_EXPORT TDataStd_Real();
63 //! Obsolete method that will be removed in next versions.
64 //! This field is not supported in the persistence mechanism.
65 Standard_DEPRECATED("TDataStd_Real::SetDimension() is deprecated. Please avoid usage of this method.")
66 Standard_EXPORT void SetDimension (const TDataStd_RealEnum DIM);
68 //! Obsolete method that will be removed in next versions.
69 //! This field is not supported in the persistence mechanism.
70 Standard_DEPRECATED("TDataStd_Real::GetDimension() is deprecated. Please avoid usage of this method.")
71 Standard_EXPORT TDataStd_RealEnum GetDimension() const;
74 //! Sets the real number V.
75 Standard_EXPORT void Set (const Standard_Real V);
77 //! Sets the explicit GUID for the attribute.
78 Standard_EXPORT void SetID (const Standard_GUID& guid) Standard_OVERRIDE;
80 //! Sets default GUID for the attribute.
81 Standard_EXPORT void SetID() Standard_OVERRIDE;
83 //! Returns the real number value contained in the attribute.
84 Standard_EXPORT Standard_Real Get() const;
86 //! Returns True if there is a reference on the same label
87 Standard_EXPORT Standard_Boolean IsCaptured() const;
89 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
91 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
93 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
95 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
97 Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
99 //! Dumps the content of me into the stream
100 Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
105 DEFINE_STANDARD_RTTIEXT(TDataStd_Real,TDF_Attribute)
109 Standard_Real myValue;
110 //! An obsolete field that will be removed in next versions.
111 TDataStd_RealEnum myDimension;
121 #endif // _TDataStd_Real_HeaderFile