42cf5bc1 |
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 | class TDataStd_DeltaOnModificationOfRealArray; |
30 | class Standard_GUID; |
31 | class TDF_Label; |
32 | class TDF_Attribute; |
33 | class TDF_RelocationTable; |
34 | class TDF_DeltaOnModification; |
35 | |
36 | |
37 | class TDataStd_RealArray; |
38 | DEFINE_STANDARD_HANDLE(TDataStd_RealArray, TDF_Attribute) |
39 | |
40 | //! A framework for an attribute composed of a real number array. |
41 | class TDataStd_RealArray : public TDF_Attribute |
42 | { |
7c1a9a46 |
43 | friend class TDataStd_DeltaOnModificationOfRealArray; |
44 | DEFINE_STANDARD_RTTIEXT(TDataStd_RealArray, TDF_Attribute) |
42cf5bc1 |
45 | public: |
46 | |
42cf5bc1 |
47 | //! class methods |
48 | //! ============= |
49 | //! Returns the GUID for arrays of reals. |
50 | Standard_EXPORT static const Standard_GUID& GetID(); |
51 | |
52 | //! Finds or creates on the <label> a real array attribute with |
53 | //! the specified <lower> and <upper> boundaries. |
54 | //! If <isDelta> == False, DefaultDeltaOnModification is used. |
55 | //! If <isDelta> == True, DeltaOnModification of the current attribute is used. |
56 | //! If attribute is already set, input parameter <isDelta> is refused and the found |
57 | //! attribute returned. |
58 | 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); |
59 | |
60 | //! Initialize the inner array with bounds from <lower> to <upper> |
61 | Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper); |
62 | |
63 | //! Sets the <Index>th element of the array to <Value> |
64 | //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal array. |
65 | Standard_EXPORT void SetValue (const Standard_Integer Index, const Standard_Real Value); |
66 | |
67 | //! Return the value of the <Index>th element of the array |
68 | Standard_EXPORT Standard_Real Value (const Standard_Integer Index) const; |
69 | Standard_Real operator () (const Standard_Integer Index) const |
70 | { |
71 | return Value(Index); |
72 | } |
73 | |
74 | //! Returns the lower boundary of the array. |
75 | Standard_EXPORT Standard_Integer Lower() const; |
76 | |
77 | //! Returns the upper boundary of the array. |
78 | Standard_EXPORT Standard_Integer Upper() const; |
79 | |
80 | //! Returns the number of elements of the array of reals |
81 | //! in terms of the number of elements it contains. |
82 | Standard_EXPORT Standard_Integer Length() const; |
83 | |
84 | //! Sets the inner array <myValue> of the RealArray attribute |
85 | //! to <newArray>. If value of <newArray> differs from <myValue>, |
86 | //! Backup performed and myValue refers to new instance of HArray1OfReal |
87 | //! that holds <newArray> values |
88 | //! If <isCheckItems> equal True each item of <newArray> will be checked with each |
89 | //! item of <myValue> for coincidence (to avoid backup). |
90 | Standard_EXPORT void ChangeArray (const Handle(TColStd_HArray1OfReal)& newArray, const Standard_Boolean isCheckItems = Standard_True); |
7c1a9a46 |
91 | |
42cf5bc1 |
92 | //! Returns the handle of this array of reals. |
7c1a9a46 |
93 | const Handle(TColStd_HArray1OfReal)& Array() const { return myValue; } |
94 | |
95 | Standard_Boolean GetDelta() const { return myIsDelta; } |
96 | |
42cf5bc1 |
97 | //! for internal use only! |
7c1a9a46 |
98 | void SetDelta (const Standard_Boolean isDelta) { myIsDelta = isDelta; } |
99 | |
42cf5bc1 |
100 | Standard_EXPORT TDataStd_RealArray(); |
101 | |
79104795 |
102 | Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE; |
42cf5bc1 |
103 | |
79104795 |
104 | Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE; |
42cf5bc1 |
105 | |
79104795 |
106 | Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE; |
42cf5bc1 |
107 | |
108 | //! Note. Uses inside ChangeArray() method |
79104795 |
109 | Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE; |
42cf5bc1 |
110 | |
111 | Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE; |
112 | |
113 | //! Makes a DeltaOnModification between <me> and |
114 | //! <anOldAttribute>. |
115 | Standard_EXPORT virtual Handle(TDF_DeltaOnModification) DeltaOnModification (const Handle(TDF_Attribute)& anOldAttribute) const Standard_OVERRIDE; |
116 | |
7c1a9a46 |
117 | private: |
42cf5bc1 |
118 | |
7c1a9a46 |
119 | void RemoveArray() { myValue.Nullify(); } |
42cf5bc1 |
120 | |
121 | private: |
122 | |
42cf5bc1 |
123 | Handle(TColStd_HArray1OfReal) myValue; |
124 | Standard_Boolean myIsDelta; |
125 | |
42cf5bc1 |
126 | }; |
127 | |
42cf5bc1 |
128 | #endif // _TDataStd_RealArray_HeaderFile |