src/TDataStd/TDataStd_IntegerList.cdl

   1 -- Created on: 2007-05-29
   2 -- Created by: Vlad Romashko
   3 -- Copyright (c) 2007-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21 class IntegerList from TDataStd inherits Attribute from TDF
  22
  23     ---Purpose: Contains a list of integers.
  24
  25 uses
  26
  27     Attribute from TDF,
  28     GUID from Standard,
  29     Label from TDF,
  30     RelocationTable from TDF,
  31     ListOfInteger from TColStd
  32
  33 is
  34
  35     ---Purpose: Static methods
  36     --          ==============
  37
  38     GetID (myclass)
  39     ---C++: return const &
  40     ---Purpose: Returns the ID of the list of integer attribute.
  41     returns GUID from Standard;
  42
  43     Set (myclass; label : Label from TDF)
  44     ---Purpose: Finds or creates a list of integer values attribute.
  45     returns IntegerList from TDataStd;
  46
  47
  48     ---Category: IntegerList methods
  49     --           ===================
  50
  51     Create
  52     returns mutable IntegerList from TDataStd;
  53
  54     IsEmpty (me)
  55     returns Boolean from Standard;
  56
  57     Extent (me)
  58     returns Integer from Standard;
  59
  60     Prepend (me : mutable;
  61              value : Integer from Standard);
  62
  63     Append (me : mutable;
  64             value : Integer from Standard);
  65
  66     InsertBefore (me : mutable;
  67                   value : Integer from Standard;
  68                   before_value : Integer from Standard)
  69     ---Purpose: Inserts the <value> before the first meet of <before_value>.
  70     returns Boolean from Standard;
  71
  72     InsertAfter (me : mutable;
  73                  value : Integer from Standard;
  74                  after_value : Integer from Standard)
  75     ---Purpose: Inserts the <value> after the first meet of <after_value>.
  76     returns Boolean from Standard;
  77
  78     Remove (me : mutable;
  79             value : Integer from Standard)
  80     ---Purpose: Removes the first meet of the <value>.
  81     returns Boolean from Standard;
  82
  83     Clear (me : mutable);
  84
  85     First (me)
  86     returns Integer from Standard;
  87
  88     Last (me)
  89     returns Integer from Standard;
  90
  91     List (me)
  92     ---C++: return const &
  93     returns ListOfInteger from TColStd;
  94
  95     ---Category: Methodes of TDF_Attribute
  96     --           =========================
  97
  98     ID (me)
  99     ---C++: return const &
 100     returns GUID from Standard;
 101
 102     Restore (me: mutable; With : Attribute from TDF);
 103
 104     NewEmpty (me)
 105     returns mutable Attribute from TDF;
 106
 107     Paste (me; Into : mutable Attribute from TDF;
 108                RT   : mutable RelocationTable from TDF);
 109
 110     Dump(me; anOS : in out OStream from Standard)
 111     returns OStream from Standard
 112     is redefined;
 113     ---C++: return &
 114
 115
 116 fields
 117
 118     myList : ListOfInteger from TColStd;
 119
 120
 121 end IntegerList;