src/TDataStd/TDataStd_ReferenceList.cdl

   1 -- Created on: 2007-05-29
   2 -- Created by: Vlad Romashko
   3 -- Copyright (c) 2007-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 class ReferenceList from TDataStd inherits Attribute from TDF
  17
  18     ---Purpose: Contains a list of references.
  19
  20 uses
  21
  22     Attribute from TDF,
  23     GUID from Standard,
  24     Label from TDF,
  25     DataSet from TDF,
  26     RelocationTable from TDF,
  27     LabelList from TDF
  28
  29 is
  30
  31     ---Purpose: Static methods
  32     --          ==============
  33
  34     GetID (myclass)
  35     ---C++: return const &
  36     ---Purpose: Returns the ID of the list of references (labels) attribute.
  37     returns GUID from Standard;
  38
  39     Set (myclass; label : Label from TDF)
  40     ---Purpose: Finds or creates a list of reference values (labels) attribute.
  41     returns ReferenceList from TDataStd;
  42
  43
  44     ---Category: ReferenceList methods
  45     --           =====================
  46
  47     Create
  48     returns ReferenceList from TDataStd;
  49
  50     IsEmpty (me)
  51     returns Boolean from Standard;
  52
  53     Extent (me)
  54     returns Integer from Standard;
  55
  56     Prepend (me : mutable;
  57              value : Label from TDF);
  58
  59     Append (me : mutable;
  60             value : Label from TDF);
  61
  62     InsertBefore (me : mutable;
  63                   value : Label from TDF;
  64                   before_value : Label from TDF)
  65     ---Purpose: Inserts the <value> before the first meet of <before_value>.
  66     returns Boolean from Standard;
  67
  68     InsertAfter (me : mutable;
  69                  value : Label from TDF;
  70                  after_value : Label from TDF)
  71     ---Purpose: Inserts the <value> after the first meet of <after_value>.
  72     returns Boolean from Standard;
  73
  74     Remove (me : mutable;
  75             value : Label from TDF)
  76     ---Purpose: Removes the first meet of the <value>.
  77     returns Boolean from Standard;
  78
  79     Clear (me : mutable);
  80
  81     First (me)
  82     ---C++: return const &
  83     returns Label from TDF;
  84
  85     Last (me)
  86     ---C++: return const &
  87     returns Label from TDF;
  88
  89     List (me)
  90     ---C++: return const &
  91     returns LabelList from TDF;
  92
  93
  94     ---Category: Methodes of TDF_Attribute
  95     --           =========================
  96
  97     ID (me)
  98     ---C++: return const &
  99     returns GUID from Standard;
 100
 101     Restore (me: mutable; With : Attribute from TDF);
 102
 103     NewEmpty (me)
 104     returns Attribute from TDF;
 105
 106     Paste (me; Into : Attribute from TDF;
 107                RT   : RelocationTable from TDF);
 108
 109     References (me; DS : DataSet from TDF)
 110     is redefined;
 111
 112     Dump(me; anOS : in out OStream from Standard)
 113     returns OStream from Standard
 114     is redefined;
 115     ---C++: return &
 116
 117
 118 fields
 119
 120     myList : LabelList from TDF;
 121
 122
 123 end ReferenceList;