include/opencascade/TDataStd_RealArray.hxx

0001 // Created on: 1999-06-16
0002 // Created by: Sergey RUIN
0003 // Copyright (c) 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_RealArray_HeaderFile
0018 #define _TDataStd_RealArray_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <TColStd_HArray1OfReal.hxx>
0023 #include <TDF_Attribute.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <Standard_Real.hxx>
0026 #include <Standard_OStream.hxx>
0027 #include <Standard_GUID.hxx>
0028
0029 class TDF_Label;
0030 class TDF_RelocationTable;
0031 class TDF_DeltaOnModification;
0032
0033
0034 class TDataStd_RealArray;
0035 DEFINE_STANDARD_HANDLE(TDataStd_RealArray, TDF_Attribute)
0036
0037 //! A framework for an attribute composed of a real number array.
0038 class TDataStd_RealArray : public TDF_Attribute
0039 {
0040   friend class TDataStd_DeltaOnModificationOfRealArray;
0041   DEFINE_STANDARD_RTTIEXT(TDataStd_RealArray, TDF_Attribute)
0042 public:
0043
0044   //! class methods
0045   //! =============
0046   //! Returns the GUID for arrays of reals.
0047   Standard_EXPORT static const Standard_GUID& GetID();
0048
0049   //! Finds or creates on the <label> a real array attribute with
0050   //! the specified <lower> and <upper> boundaries.
0051   //! If <isDelta> == False, DefaultDeltaOnModification is used.
0052   //! If <isDelta> == True, DeltaOnModification of the current attribute is used.
0053   //! If attribute is already set, input parameter <isDelta> is refused and the found
0054   //! attribute returned.
0055   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);
0056
0057   //! Finds, or creates, an RealArray attribute with explicit user defined <guid>.
0058   //! The RealArray attribute  is  returned.
0059   Standard_EXPORT static Handle(TDataStd_RealArray) Set (const TDF_Label& label, const Standard_GUID&   theGuid,
0060                                                          const Standard_Integer lower, const Standard_Integer upper,
0061                                                          const Standard_Boolean isDelta = Standard_False);
0062
0063   //! Initialize the inner array with bounds from <lower> to <upper>
0064   Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper);
0065
0066   //! Sets the explicit GUID (user defined) for the attribute.
0067   Standard_EXPORT void SetID( const Standard_GUID&  theGuid) Standard_OVERRIDE;
0068
0069   //! Sets default GUID for the attribute.
0070   Standard_EXPORT void SetID() Standard_OVERRIDE;
0071
0072   //! Sets  the   <Index>th  element  of   the  array to <Value>
0073   //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal  array.
0074   Standard_EXPORT void SetValue (const Standard_Integer Index, const Standard_Real Value);
0075
0076   //! Return the value of  the  <Index>th element of the array
0077   Standard_EXPORT Standard_Real Value (const Standard_Integer Index) const;
0078
0079   Standard_Real operator () (const Standard_Integer Index) const
0080   {
0081     return Value(Index);
0082   }
0083
0084   //! Returns the lower boundary of the array.
0085   Standard_EXPORT Standard_Integer Lower() const;
0086
0087   //! Returns the upper boundary of the array.
0088   Standard_EXPORT Standard_Integer Upper() const;
0089
0090   //! Returns the number of elements of the array of reals
0091   //! in terms of the number of elements it contains.
0092   Standard_EXPORT Standard_Integer Length() const;
0093
0094   //! Sets the inner array <myValue> of the RealArray attribute
0095   //! to <newArray>. If value of <newArray> differs from <myValue>,
0096   //! Backup performed and myValue refers to new instance of HArray1OfReal
0097   //! that holds <newArray> values
0098   //! If <isCheckItems> equal True each item of <newArray> will be checked with each
0099   //! item of <myValue> for coincidence (to avoid backup).
0100   Standard_EXPORT void ChangeArray (const Handle(TColStd_HArray1OfReal)& newArray, const Standard_Boolean isCheckItems = Standard_True);
0101
0102   //! Returns the handle of this array of reals.
0103   const Handle(TColStd_HArray1OfReal)& Array() const { return myValue; }
0104
0105   Standard_Boolean GetDelta() const { return myIsDelta; }
0106
0107   //! for  internal  use  only!
0108   void SetDelta (const Standard_Boolean isDelta) { myIsDelta = isDelta; }
0109
0110   Standard_EXPORT TDataStd_RealArray();
0111
0112   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0113
0114   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0115
0116   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0117
0118   //! Note. Uses inside ChangeArray() method
0119   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0120
0121   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0122
0123   //! Makes a DeltaOnModification between <me> and
0124   //! <anOldAttribute>.
0125   Standard_EXPORT virtual Handle(TDF_DeltaOnModification) DeltaOnModification (const Handle(TDF_Attribute)& anOldAttribute) const Standard_OVERRIDE;
0126
0127   //! Dumps the content of me into the stream
0128   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0129
0130 private:
0131
0132   void RemoveArray() { myValue.Nullify(); }
0133
0134 private:
0135
0136   Handle(TColStd_HArray1OfReal) myValue;
0137   Standard_Boolean myIsDelta;
0138   Standard_GUID myID;
0139
0140 };
0141
0142 #endif // _TDataStd_RealArray_HeaderFile