projects / occt.git / blame
| Commit | Line | Data |
|---|---|---|
| 7fd59977 | 1 | -- File: TDataStd_ReferenceArray.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 ReferenceArray from TDataStd inherits Attribute from TDF | |
| 8 | ||
| 9 | ---Purpose: Contains an array of references to the labels. | |
| 10 | ||
| 11 | uses | |
| 12 | ||
| 13 | Attribute from TDF, | |
| 14 | GUID from Standard, | |
| 15 | Label from TDF, | |
| 16 | DataSet from TDF, | |
| 17 | RelocationTable from TDF, | |
| 18 | HLabelArray1 from TDataStd | |
| 19 | ||
| 20 | is | |
| 21 | ||
| 22 | ---Purpose: Static methods | |
| 23 | -- ============== | |
| 24 | ||
| 25 | GetID (myclass) | |
| 26 | ---C++: return const & | |
| 27 | ---Purpose: Returns the ID of the array of references (labels) attribute. | |
| 28 | returns GUID from Standard; | |
| 29 | ||
| 30 | Set (myclass; | |
| 31 | label : Label from TDF; | |
| 32 | lower, upper : Integer from Standard) | |
| 33 | ---Purpose: Finds or creates an array of reference values (labels) attribute. | |
| 34 | returns ReferenceArray from TDataStd; | |
| 35 | ||
| 36 | ||
| 37 | ---Category: ReferenceArray methods | |
| 38 | -- ====================== | |
| 39 | ||
| 40 | Init (me : mutable; | |
| 41 | lower, upper : Integer from Standard); | |
| 42 | ---Purpose: Initialize the inner array with bounds from <lower> to <upper> | |
| 43 | ||
| 44 | SetValue (me : mutable; | |
| 45 | index :Integer from Standard; | |
| 46 | value : Label from TDF); | |
| 47 | ---Purpose: Sets the <Index>th element of the array to <Value> | |
| 48 | ||
| 49 | Value (me; | |
| 50 | Index : Integer from Standard) | |
| 51 | ---Purpose: Returns the value of the <Index>th element of the array. | |
| 52 | ---C++: alias operator () | |
| 53 | returns Label from TDF; | |
| 54 | ||
| 55 | Lower (me) | |
| 56 | ---Purpose: Returns the lower boundary of the array. | |
| 57 | returns Integer from Standard; | |
| 58 | ||
| 59 | Upper (me) | |
| 60 | ---Purpose: Returns the upper boundary of the array. | |
| 61 | returns Integer from Standard; | |
| 62 | ||
| 63 | Length (me) | |
| 64 | ---Purpose: Returns the number of elements in the array. | |
| 65 | returns Integer from Standard; | |
| 66 | ||
| 67 | ||
| 68 | ---Category: Advanced area | |
| 69 | -- ============= | |
| 70 | ||
| 71 | InternalArray (me) | |
| 72 | ---C++: return const & | |
| 73 | returns HLabelArray1 from TDataStd; | |
| 74 | ||
| 75 | SetInternalArray (me : mutable; | |
| a855b7eb S |
76 | values : HLabelArray1 from TDataStd; |
| 77 | isCheckItems : Boolean = Standard_True); | |
| 7fd59977 | 78 | |
| 79 | ||
| 80 | ---Category: Methodes of TDF_Attribute | |
| 81 | -- ========================= | |
| 82 | ||
| 83 | Create | |
| 84 | returns mutable ReferenceArray from TDataStd; | |
| 85 | ||
| 86 | ID (me) | |
| 87 | ---C++: return const & | |
| 88 | returns GUID from Standard; | |
| 89 | ||
| 90 | Restore (me: mutable; With : Attribute from TDF); | |
| 91 | ||
| 92 | NewEmpty (me) | |
| 93 | returns mutable Attribute from TDF; | |
| 94 | ||
| 95 | Paste (me; Into : mutable Attribute from TDF; | |
| 96 | RT : mutable RelocationTable from TDF); | |
| 97 | ||
| 98 | References (me; DS : DataSet from TDF) | |
| 99 | is redefined; | |
| 100 | ||
| 101 | Dump(me; anOS : in out OStream from Standard) | |
| 102 | returns OStream from Standard | |
| 103 | is redefined; | |
| 104 | ---C++: return & | |
| 105 | ||
| 106 | ||
| 107 | fields | |
| 108 | ||
| 109 | myArray : HLabelArray1 from TDataStd; | |
| 110 | ||
| 111 | ||
| 112 | end ReferenceArray; |