src/StepData/StepData_FieldListD.cdl

   1 -- Created on: 1997-04-01
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1997-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class FieldListD  from StepData    inherits FieldList  from StepData
  18
  19     ---Purpose : Describes a list of fields, in a general way
  20     --           This basic class is for a null size list
  21     --           Subclasses are for 1, N (fixed) or Dynamic sizes
  22
  23 uses Field from StepData, HArray1OfField from StepData
  24
  25 raises OutOfRange
  26
  27 is
  28
  29     Create (nb : Integer) returns FieldListD;
  30     ---Purpose : Creates a FieldListD of <nb> Fields
  31
  32     SetNb  (me : in out; nb : Integer);
  33     ---Purpose : Sets a new count of Fields. Former contents are lost
  34
  35     NbFields (me) returns Integer  is redefined;
  36     ---Purpose : Returns the count of fields. Here, returns starting <nb>
  37
  38     Field  (me; num : Integer) returns Field
  39     ---Purpose : Returns the field n0 <num> between 1 and NbFields (read only)
  40         raises OutOfRange
  41     --           Error if <num> out of range
  42         is redefined;
  43     ---C++ : return const &
  44
  45     CField (me : in out; num : Integer) returns Field
  46     ---Purpose : Returns the field n0 <num> between 1 and NbFields, in order to
  47     --           modify its content
  48         raises OutOfRange
  49     --           Error if <num> out of range
  50         is redefined;
  51     ---C++ : return &
  52
  53     Destroy (me: in out) is virtual;
  54     ---C++ : alias "Standard_EXPORT virtual ~StepData_FieldListD() { Destroy(); }"
  55
  56
  57 fields
  58
  59     thefields : HArray1OfField;
  60
  61 end FieldListD;