| 7fd59977 |
1 | -- File: TDocStd_XLinkRoot.cdl |
| 2 | -- ------------------------ |
| 3 | -- Author: DAUTRY Philippe |
| 4 | -- <fid@fox.paris1.matra-dtv.fr> |
| 5 | ---Copyright: MATRA DATAVISION 1997 |
| 6 | |
| 7 | ---Version: 0.0 |
| 8 | ---History: Version Date Purpose |
| 9 | -- 0.0 Aug 27 1997 Creation |
| 10 | |
| 11 | |
| 12 | private class XLinkRoot from TDocStd inherits Attribute from TDF |
| 13 | |
| 14 | ---Purpose: This attribute is the root of all external |
| 15 | -- references contained in a Data from TDF. Only one |
| 16 | -- instance of this class is added to the TDF_Data |
| 17 | -- root label. Starting from this attribute all the |
| 18 | -- Reference are linked together, to be found |
| 19 | -- easely. |
| 20 | |
| 21 | uses |
| 22 | |
| 23 | GUID from Standard, |
| 24 | Data from TDF, |
| 25 | RelocationTable from TDF, |
| 26 | XLink from TDocStd, |
| 27 | XLinkPtr from TDocStd |
| 28 | |
| 29 | -- raises |
| 30 | |
| 31 | is |
| 32 | |
| 33 | -- CLASS methods. |
| 34 | -- -------------- |
| 35 | |
| 36 | GetID(myclass) returns GUID from Standard; |
| 37 | ---Purpose: Returns the ID: 2a96b61d-ec8b-11d0-bee7-080009dc3333 |
| 38 | -- |
| 39 | ---C++: return const & |
| 40 | |
| 41 | Set(myclass; aDF : Data from TDF) |
| 42 | returns XLinkRoot from TDocStd; |
| 43 | ---Purpose: Sets an empty XLinkRoot to Root or gets the |
| 44 | -- existing one. Only one attribute per TDF_Data. |
| 45 | |
| 46 | Insert(myclass; anXLinkPtr : XLinkPtr from TDocStd); |
| 47 | ---Purpose: Inserts <anXLinkPtr> at the beginning of the XLink chain. |
| 48 | |
| 49 | Remove(myclass; anXLinkPtr : XLinkPtr from TDocStd); |
| 50 | ---Purpose: Removes <anXLinkPtr> from the XLink chain, if it exists. |
| 51 | |
| 52 | -- Basic methods. |
| 53 | -- -------------- |
| 54 | |
| 55 | Create |
| 56 | returns mutable XLinkRoot from TDocStd |
| 57 | is private; |
| 58 | ---Purpose: Initializes fields. |
| 59 | |
| 60 | -- Information access. |
| 61 | -- ------------------- |
| 62 | |
| 63 | ID(me) returns GUID from Standard |
| 64 | is redefined static; |
| 65 | ---Purpose: Returns the ID of the attribute. |
| 66 | -- |
| 67 | ---C++: return const & |
| 68 | |
| 69 | BackupCopy(me) returns mutable Attribute from TDF |
| 70 | is redefined static; |
| 71 | ---Purpose: Returns a null handle. |
| 72 | |
| 73 | Restore(me: mutable; |
| 74 | anAttribute : Attribute from TDF) |
| 75 | is redefined static; |
| 76 | ---Purpose: Does nothing. |
| 77 | |
| 78 | |
| 79 | First(me : mutable; anXLinkPtr : XLinkPtr from TDocStd) |
| 80 | is private; |
| 81 | ---Purpose: Sets the field <myFirst> with <anXLinkPtr>. |
| 82 | -- |
| 83 | ---C++: inline |
| 84 | |
| 85 | First(me) |
| 86 | returns XLinkPtr from TDocStd |
| 87 | is private; |
| 88 | ---Purpose: Returns the contents of the field <myFirst>. |
| 89 | -- |
| 90 | ---C++: inline |
| 91 | |
| 92 | |
| 93 | -- Copy use methods |
| 94 | -- ---------------- |
| 95 | |
| 96 | NewEmpty(me) |
| 97 | returns mutable Attribute from TDF |
| 98 | is redefined static; |
| 99 | ---Purpose: Returns a null handle. |
| 100 | |
| 101 | Paste(me; |
| 102 | intoAttribute : mutable Attribute from TDF; |
| 103 | aRelocationTable : mutable RelocationTable from TDF) |
| 104 | is redefined static; |
| 105 | ---Purpose: Does nothing. |
| 106 | |
| 107 | -- Miscelleaneous |
| 108 | -- -------------- |
| 109 | |
| 110 | |
| 111 | Dump(me; anOS : in out OStream from Standard) |
| 112 | returns OStream from Standard |
| 113 | is redefined static; |
| 114 | ---Purpose: Dumps the attribute on <aStream>. |
| 115 | ---C++ : return & |
| 116 | |
| 117 | |
| 118 | fields |
| 119 | |
| 120 | myFirst : XLinkPtr from TDocStd; |
| 121 | |
| 122 | friends |
| 123 | |
| 124 | class XLinkIterator from TDocStd |
| 125 | |
| 126 | end XLinkRoot; |
projects / occt.git / blame