src/IGESGraph/IGESGraph_DefinitionLevel.cdl

   1 -- Created on: 1993-01-09
   2 -- Created by: CKY / Contract Toubro-Larsen ( TCD )
   3 -- Copyright (c) 1993-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 DefinitionLevel from IGESGraph  inherits LevelListEntity
  18
  19         ---Purpose: defines IGESDefinitionLevel, Type <406> Form <1>
  20         --          in package IGESGraph
  21         --
  22         --          Indicates the no. of levels on which an entity is
  23         --          defined
  24
  25 uses
  26
  27         IGESEntity       from IGESData,
  28         HArray1OfInteger from TColStd
  29
  30 raises OutOfRange
  31
  32 is
  33
  34         Create returns DefinitionLevel;
  35
  36         -- Specific Methods pertaining to the class
  37
  38         Init (me              : mutable;
  39               allLevelNumbers : HArray1OfInteger);
  40         ---Purpose : This method is used to set the fields of the class
  41         --           DefinitionLevel
  42         --       - allLevelNumbers : Values of Level Numbers
  43
  44         NbPropertyValues (me) returns Integer;
  45         ---Purpose : returns the number of property values in <me>
  46
  47         NbLevelNumbers (me) returns Integer;
  48         ---Purpose : Must return the count of levels (== NbPropertyValues)
  49
  50         LevelNumber (me; LevelIndex : Integer) returns Integer
  51         raises OutOfRange;
  52         ---Purpose : returns the Level Number of <me> indicated by <LevelIndex>
  53         -- raises an exception if LevelIndex is <= 0 or
  54         -- LevelIndex > NbPropertyValues
  55
  56 fields
  57
  58 --
  59 -- Class    : IGESGraph_DefinitionLevel
  60 --
  61 -- Purpose  : Declaration of the variables specific to a Definition Level.
  62 --
  63 -- Reminder : A Definition Level is defined by :
  64 --              - Level Numbers
  65
  66         theLevelNumbers : HArray1OfInteger;
  67
  68 end DefinitionLevel;