0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDataStd / TDataStd_RealArray.hxx
1 // Created on: 1999-06-16
2 // Created by: Sergey RUIN
3 // Copyright (c) 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_RealArray_HeaderFile
18 #define _TDataStd_RealArray_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TColStd_HArray1OfReal.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <TDF_Attribute.hxx>
26 #include <Standard_Integer.hxx>
27 #include <Standard_Real.hxx>
28 #include <Standard_OStream.hxx>
29 #include <Standard_GUID.hxx>
30
31 class TDataStd_DeltaOnModificationOfRealArray;
32 class Standard_GUID;
33 class TDF_Label;
34 class TDF_Attribute;
35 class TDF_RelocationTable;
36 class TDF_DeltaOnModification;
37
38
39 class TDataStd_RealArray;
40 DEFINE_STANDARD_HANDLE(TDataStd_RealArray, TDF_Attribute)
41
42 //! A framework for an attribute composed of a real number array.
43 class TDataStd_RealArray : public TDF_Attribute
44 {
45   friend class TDataStd_DeltaOnModificationOfRealArray;
46   DEFINE_STANDARD_RTTIEXT(TDataStd_RealArray, TDF_Attribute)
47 public:
48
49   //! class methods
50   //! =============
51   //! Returns the GUID for arrays of reals.
52   Standard_EXPORT static const Standard_GUID& GetID();
53   
54   //! Finds or creates on the <label> a real array attribute with
55   //! the specified <lower> and <upper> boundaries.
56   //! If <isDelta> == False, DefaultDeltaOnModification is used.
57   //! If <isDelta> == True, DeltaOnModification of the current attribute is used.
58   //! If attribute is already set, input parameter <isDelta> is refused and the found
59   //! attribute returned.
60   Standard_EXPORT static Handle(TDataStd_RealArray) Set (const TDF_Label& label, const Standard_Integer lower, const Standard_Integer upper, const Standard_Boolean isDelta = Standard_False);
61  
62   //! Finds, or creates, an RealArray attribute with explicit user defined <guid>.
63   //! The RealArray attribute  is  returned.
64   Standard_EXPORT static Handle(TDataStd_RealArray) Set (const TDF_Label& label, const Standard_GUID&   theGuid,
65                                                          const Standard_Integer lower, const Standard_Integer upper, 
66                                                          const Standard_Boolean isDelta = Standard_False);
67
68   //! Initialize the inner array with bounds from <lower> to <upper>
69   Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper);
70  
71   //! Sets the explicit GUID (user defined) for the attribute.
72   Standard_EXPORT void SetID( const Standard_GUID&  theGuid) Standard_OVERRIDE;
73
74   //! Sets default GUID for the attribute.
75   Standard_EXPORT void SetID() Standard_OVERRIDE;
76
77   //! Sets  the   <Index>th  element  of   the  array to <Value>
78   //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal  array.
79   Standard_EXPORT void SetValue (const Standard_Integer Index, const Standard_Real Value);
80   
81   //! Return the value of  the  <Index>th element of the array
82   Standard_EXPORT Standard_Real Value (const Standard_Integer Index) const;
83
84   Standard_Real operator () (const Standard_Integer Index) const
85   {
86     return Value(Index);
87   }
88   
89   //! Returns the lower boundary of the array.
90   Standard_EXPORT Standard_Integer Lower() const;
91   
92   //! Returns the upper boundary of the array.
93   Standard_EXPORT Standard_Integer Upper() const;
94   
95   //! Returns the number of elements of the array of reals
96   //! in terms of the number of elements it contains.
97   Standard_EXPORT Standard_Integer Length() const;
98   
99   //! Sets the inner array <myValue> of the RealArray attribute
100   //! to <newArray>. If value of <newArray> differs from <myValue>,
101   //! Backup performed and myValue refers to new instance of HArray1OfReal
102   //! that holds <newArray> values
103   //! If <isCheckItems> equal True each item of <newArray> will be checked with each
104   //! item of <myValue> for coincidence (to avoid backup).
105   Standard_EXPORT void ChangeArray (const Handle(TColStd_HArray1OfReal)& newArray, const Standard_Boolean isCheckItems = Standard_True);
106
107   //! Returns the handle of this array of reals.
108   const Handle(TColStd_HArray1OfReal)& Array() const { return myValue; }
109
110   Standard_Boolean GetDelta() const { return myIsDelta; }
111
112   //! for  internal  use  only!
113   void SetDelta (const Standard_Boolean isDelta) { myIsDelta = isDelta; }
114
115   Standard_EXPORT TDataStd_RealArray();
116   
117   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
118   
119   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
120   
121   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
122   
123   //! Note. Uses inside ChangeArray() method
124   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
125   
126   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
127   
128   //! Makes a DeltaOnModification between <me> and
129   //! <anOldAttribute>.
130   Standard_EXPORT virtual Handle(TDF_DeltaOnModification) DeltaOnModification (const Handle(TDF_Attribute)& anOldAttribute) const Standard_OVERRIDE;
131   
132   //! Dumps the content of me into the stream
133   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
134
135 private:
136
137   void RemoveArray() { myValue.Nullify(); }
138
139 private:
140
141   Handle(TColStd_HArray1OfReal) myValue;
142   Standard_Boolean myIsDelta;
143   Standard_GUID myID;
144
145 };
146
147 #endif // _TDataStd_RealArray_HeaderFile