0028714: Dimension of TDataStd_Real is not serialized to document
[occt.git] / src / TDataStd / TDataStd_Real.hxx
CommitLineData
42cf5bc1 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>
fa53efef 28#include <Standard_GUID.hxx>
29
42cf5bc1 30class TDF_Label;
31class TDF_Attribute;
32class TDF_RelocationTable;
33
34
35class TDataStd_Real;
36DEFINE_STANDARD_HANDLE(TDataStd_Real, TDF_Attribute)
37
38//! The basis to define a real number attribute.
39class TDataStd_Real : public TDF_Attribute
40{
41
42public:
43
44
45 //! class methods
46 //! =============
fa53efef 47 //! Returns the default GUID for real numbers.
42cf5bc1 48 Standard_EXPORT static const Standard_GUID& GetID();
49
fa53efef 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.
42cf5bc1 53 //! Real methods
54 //! ============
55 Standard_EXPORT static Handle(TDataStd_Real) Set (const TDF_Label& label, const Standard_Real value);
56
fa53efef 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
42cf5bc1 64 Standard_EXPORT TDataStd_Real();
65
58e5d30e 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.")
42cf5bc1 69 Standard_EXPORT void SetDimension (const TDataStd_RealEnum DIM);
70
58e5d30e 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.")
42cf5bc1 74 Standard_EXPORT TDataStd_RealEnum GetDimension() const;
75
76
fa53efef 77 //! Sets the real number V.
42cf5bc1 78 Standard_EXPORT void Set (const Standard_Real V);
79
fa53efef 80 //! Sets the explicit GUID for the attribute.
5a1271c8 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;
42cf5bc1 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
79104795 92 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
42cf5bc1 93
79104795 94 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
42cf5bc1 95
79104795 96 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
42cf5bc1 97
79104795 98 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
42cf5bc1 99
100 Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
101
102
103
104
92efcf78 105 DEFINE_STANDARD_RTTIEXT(TDataStd_Real,TDF_Attribute)
42cf5bc1 106
107protected:
108
109
110
111
112private:
113
114
115 Standard_Real myValue;
58e5d30e 116 //! An obsolete field that will be removed in next versions.
42cf5bc1 117 TDataStd_RealEnum myDimension;
fa53efef 118 Standard_GUID myID;
42cf5bc1 119
120};
121
122
123
124
125
126
127
128#endif // _TDataStd_Real_HeaderFile