src/TDataStd/TDataStd_BooleanArray.cdl

   1 -- File:        TDataStd_BooleanArray.cdl
   2 -- Created:     May 29 11:40:00 2007
   3 -- Author:      Vlad Romashko
   4 --              <vladislav.romashko@opencascade.com>
   5 -- Copyright:   Open CASCADE
   6
   7 class BooleanArray from TDataStd inherits Attribute from TDF
   8
   9     ---Purpose: An array of boolean values.
  10
  11 uses
  12
  13     Attribute       from TDF,
  14     GUID            from Standard,
  15     Label           from TDF,
  16     RelocationTable from TDF,
  17     HArray1OfByte   from TColStd
  18
  19 is
  20
  21     ---Purpose: Static methods
  22     --          ==============
  23
  24     GetID (myclass)
  25     ---C++: return const &
  26     ---Purpose: Returns an ID for array.
  27     returns GUID from Standard;
  28
  29     Set (myclass;
  30          label : Label from TDF;
  31          lower, upper : Integer from Standard)
  32     ---Purpose: Finds or creates an attribute with the array.
  33     returns BooleanArray from TDataStd;
  34
  35
  36     ---Category: BooleanArray methods
  37     --           ====================
  38
  39     Init (me : mutable;
  40           lower, upper : Integer from Standard);
  41     ---Purpose: Initialize the inner array with bounds from <lower> to <upper>
  42
  43     SetValue (me : mutable;
  44               index :Integer from Standard;
  45               value : Boolean from Standard);
  46     ---Purpose: Sets the <Index>th element of the array to <Value>
  47
  48     Value (me;
  49            Index : Integer from Standard)
  50     ---Purpose: Return the value of the <Index>th element of the array.
  51     ---C++: alias operator ()
  52     returns Boolean from Standard;
  53
  54     Lower (me)
  55     ---Purpose: Returns the lower boundary of the array.
  56     returns Integer from Standard;
  57
  58     Upper (me)
  59     ---Purpose: Returns the upper boundary of the array.
  60     returns Integer from Standard;
  61
  62     Length (me)
  63     ---Purpose: Returns the number of elements in the array.
  64     returns Integer from Standard;
  65
  66
  67     ---Category: Advanced area
  68     --           =============
  69
  70     InternalArray (me)
  71     ---C++: return const &
  72     returns HArray1OfByte from TColStd;
  73
  74     SetInternalArray (me : mutable;
  75                       values : HArray1OfByte from TColStd);
  76
  77
  78     ---Category: Methodes of TDF_Attribute
  79     --           =========================
  80     Create
  81     returns mutable BooleanArray from TDataStd;
  82
  83     ID (me)
  84     ---C++: return const &
  85     returns GUID from Standard;
  86
  87     Restore (me: mutable;
  88              with : Attribute from TDF);
  89
  90     NewEmpty (me)
  91     returns mutable Attribute from TDF;
  92
  93     Paste (me; into : mutable Attribute from TDF;
  94                RT   : mutable RelocationTable from TDF);
  95
  96     Dump (me;
  97           OS : in out OStream from Standard)
  98     returns OStream from Standard
  99     is redefined;
 100     ---C++: return &
 101
 102
 103 fields
 104
 105     myValues : HArray1OfByte from TColStd;
 106     myLower  : Integer from Standard;
 107     myUpper  : Integer from Standard;
 108
 109
 110 end BooleanArray;