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