src/TDataStd/TDataStd_RealArray.cdl

   1 -- File:        TDataStd_RealArray.cdl
   2 -- Created:     Wed Jun 16 17:04:48 1999
   3 -- Author:      Sergey RUIN
   4 ---Copyright:    Matra Datavision 1999
   5
   6
   7 class RealArray from TDataStd inherits Attribute from TDF
   8
   9         ---Purpose: A framework for an attribute composed of a real number array.
  10
  11 uses
  12      HArray1OfReal            from TColStd,
  13      GUID                     from Standard,
  14      Attribute                from TDF,
  15      Label                    from TDF,
  16      DeltaOnModification      from TDF,
  17      RelocationTable          from TDF
  18
  19 is
  20
  21     ---Purpose: class methods
  22     --          =============
  23
  24     GetID (myclass)
  25         ---C++: return const &
  26         ---Purpose: Returns the GUID for arrays of reals.
  27     returns GUID from Standard;
  28
  29     Set (myclass; label : Label from TDF; lower, upper : Integer from Standard;
  30                   isDelta : Boolean from Standard = Standard_False)
  31         ---Purpose: Finds or creates on the <label> a real array attribute
  32         -- with the specified <lower> and <upper> boundaries.
  33         -- If attribute is already set, all input parameters are refused and the found
  34         -- attribute is returned.
  35     returns RealArray from TDataStd;
  36
  37
  38     ---Category: RealArray methods
  39     --          ===============
  40
  41     Init(me : mutable; lower, upper : Integer from Standard);
  42     ---Purpose: Initialize the inner array with bounds from <lower> to <upper>
  43
  44     SetValue (me : mutable; Index :Integer from Standard; Value : Real from Standard);
  45     ---Purpose: Sets  the   <Index>th  element  of   the  array to <Value>
  46
  47     Value (me; Index : Integer from Standard)
  48     ---Purpose: Return the value of  the  <Index>th element of the array
  49     --
  50     ---C++: alias operator ()
  51     returns Real from Standard;
  52
  53     Lower (me) returns Integer from Standard;
  54     ---Purpose:  Returns the lower boundary of the array.
  55
  56     Upper (me) returns Integer from Standard;
  57     ---Purpose: Returns the upper boundary of the array.
  58
  59     Length (me) returns Integer from Standard;
  60     ---Purpose: Returns the number of elements of the array of reals
  61     --    in terms of the number of elements it contains.
  62
  63     ChangeArray(me : mutable; newArray : HArray1OfReal from TColStd;
  64                               isCheckItems : Boolean = Standard_True);
  65         ---Purpose: Sets the inner array <myValue> of the RealArray attribute
  66         -- to <newArray>. If value of <newArray> differs from <myValue>,
  67         -- Backup performed and myValue refers to new instance of HArray1OfReal
  68         -- that holds <newArray> values
  69         -- If <isCheckItems> equal True each item of <newArray> will be checked with each
  70         -- item of <myValue> for coincidence (to avoid backup).
  71
  72     Array(me) returns HArray1OfReal from TColStd;
  73     ---Purpose: Returns the handle of this array of reals.
  74     ---C++: inline
  75     ---C++: return const
  76
  77     GetDelta(me) returns Boolean from Standard;
  78     ---C++: inline
  79
  80     SetDelta(me : mutable; isDelta : Boolean from Standard);
  81     ---C++: inline
  82     ---Purpose: for  internal  use  only!
  83
  84     RemoveArray(me  : mutable) is private;
  85     ---C++: inline
  86
  87     ---Category: methodes of TDF_Attribute
  88     --           =========================
  89     Create
  90     returns mutable RealArray from TDataStd;
  91
  92     ID (me)
  93         ---C++: return const &
  94     returns GUID from Standard;
  95
  96     Restore (me: mutable; With : Attribute from TDF);
  97
  98     NewEmpty (me)
  99     returns mutable Attribute from TDF;
 100
 101     Paste (me; Into : mutable Attribute from TDF;
 102                RT   : mutable RelocationTable from TDF);
 103     ---Purpose: Note. Uses inside ChangeArray() method
 104
 105     Dump(me; anOS : in out OStream from Standard)
 106         returns OStream from Standard
 107         is redefined;
 108         ---C++: return &
 109
 110     ---Category: methods to be added for using in DeltaOnModification
 111     --           =====================================================
 112     DeltaOnModification(me; anOldAttribute : Attribute from TDF)
 113         returns DeltaOnModification from TDF
 114         ---Purpose : Makes a DeltaOnModification between <me> and
 115         --         <anOldAttribute>.
 116         is redefined virtual;
 117 fields
 118
 119     myValue : HArray1OfReal from TColStd;
 120     myIsDelta : Boolean from Standard;
 121
 122 friends
 123
 124     class DeltaOnModificationOfRealArray from TDataStd
 125
 126 end RealArray;