src/IGESBasic/IGESBasic_GeneralModule.cdl

   1 -- Created on: 1993-05-10
   2 -- Created by: Christian CAILLET
   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 GeneralModule  from IGESBasic     inherits  GeneralModule  from IGESData
  18
  19     ---Purpose : Definition of General Services for IGESBasic (specific part)
  20     --           This Services comprise : Shared & Implied Lists, Copy, Check
  21
  22 uses OStream,
  23      Check, ShareTool, EntityIterator, CopyTool,
  24      IGESEntity, DirChecker
  25
  26 is
  27
  28     Create returns GeneralModule from IGESBasic;
  29     ---Purpose : Creates a GeneralModule from IGESBasic and puts it into GeneralLib
  30
  31     OwnSharedCase  (me; CN : Integer; ent : IGESEntity;
  32                     iter : in out EntityIterator);
  33     ---Purpose : Lists the Entities shared by a given IGESEntity <ent>, from
  34     --           its specific parameters : specific for each type
  35
  36     DirChecker (me; CN : Integer; ent : IGESEntity) returns DirChecker;
  37     ---Purpose : Returns a DirChecker, specific for each type of Entity
  38     --           (identified by its Case Number) : this DirChecker defines
  39     --           constraints which must be respected by the DirectoryPart
  40
  41     OwnCheckCase (me; CN : Integer; ent : IGESEntity; shares : ShareTool;
  42                   ach    : in out Check);
  43     ---Purpose : Performs Specific Semantic Check for each type of Entity
  44
  45
  46     NewVoid (me; CN : Integer; entto : out Transient)
  47         returns Boolean;
  48     ---Purpose : Specific creation of a new void entity
  49
  50     OwnCopyCase (me; CN : Integer;
  51                  entfrom : IGESEntity; entto : IGESEntity;
  52                  TC : in out CopyTool);
  53     ---Purpose : Copies parameters which are specific of each Type of Entity
  54
  55     CategoryNumber (me; CN : Integer; ent : Transient; shares : ShareTool)
  56         returns Integer  is redefined;
  57     ---Purpose : Returns a category number which characterizes an entity
  58     --           Structure for Groups, Figures & Co
  59     --           Description for External Refs
  60     --           Auxiliary for other
  61
  62 end GeneralModule;