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-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 class FieldListD  from StepData    inherits FieldList  from StepData
  24
  25     ---Purpose : Describes a list of fields, in a general way
  26     --           This basic class is for a null size list
  27     --           Subclasses are for 1, N (fixed) or Dynamic sizes
  28
  29 uses Field from StepData, HArray1OfField from StepData
  30
  31 raises OutOfRange
  32
  33 is
  34
  35     Create (nb : Integer) returns FieldListD;
  36     ---Purpose : Creates a FieldListD of <nb> Fields
  37
  38     SetNb  (me : in out; nb : Integer);
  39     ---Purpose : Sets a new count of Fields. Former contents are lost
  40
  41     NbFields (me) returns Integer  is redefined;
  42     ---Purpose : Returns the count of fields. Here, returns starting <nb>
  43
  44     Field  (me; num : Integer) returns Field
  45     ---Purpose : Returns the field n0 <num> between 1 and NbFields (read only)
  46         raises OutOfRange
  47     --           Error if <num> out of range
  48         is redefined;
  49     ---C++ : return const &
  50
  51     CField (me : in out; num : Integer) returns Field
  52     ---Purpose : Returns the field n0 <num> between 1 and NbFields, in order to
  53     --           modify its content
  54         raises OutOfRange
  55     --           Error if <num> out of range
  56         is redefined;
  57     ---C++ : return &
  58
  59     Destroy (me: in out) is virtual;
  60     ---C++ : alias "Standard_EXPORT virtual ~StepData_FieldListD() { Destroy(); }"
  61
  62
  63 fields
  64
  65     thefields : HArray1OfField;
  66
  67 end FieldListD;