src/IGESSelect/IGESSelect_WorkLibrary.cdl

   1 -- Created on: 1994-06-03
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1994-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 WorkLibrary  from IGESSelect  inherits WorkLibrary  from IFSelect
  18
  19     ---Purpose : Performs Read and Write an IGES File with an IGES Model
  20
  21 uses CString, Transient,
  22      InterfaceModel, Protocol from Interface, CheckIterator, ContextWrite,
  23      Messenger from Message,
  24      Protocol from IGESData
  25
  26 is
  27
  28     Create (modefnes : Boolean = Standard_False)
  29         returns WorkLibrary from IGESSelect;
  30     ---Purpose : Creates a IGES WorkLibrary
  31     --           If <modefnes> is given as True, it will work for FNES
  32
  33     ReadFile (me; name : CString;
  34               model    : out InterfaceModel;
  35               protocol : Protocol from Interface)
  36           returns Integer;
  37     ---Purpose : Reads a IGES File and returns a IGES Model (into <mod>),
  38     --           or lets <mod> "Null" in case of Error
  39     --           Returns 0 if OK, 1 if Read Error, -1 if File not opened
  40
  41     WriteFile (me; ctx : in out ContextWrite)  returns Boolean;
  42     ---Purpose : Writes a File from a IGES Model (brought by <ctx>)
  43     --           Returns False (and writes no file) if <ctx> is not for IGES
  44
  45     DefineProtocol (myclass) returns Protocol from IGESData;
  46     ---Purpose : Defines a protocol to be adequate for IGES
  47     --           (encompasses ALL the IGES norm including IGESSolid, IGESAppli)
  48
  49     DumpEntity (me;
  50                model    : InterfaceModel;
  51                protocol : Protocol from Interface;
  52                entity   : Transient;
  53                S        : Messenger from Message;
  54                level    : Integer);
  55     ---Purpose : Dumps an IGES Entity with an IGES Dumper. <level> is the one
  56     --           used by IGESDumper.
  57
  58 fields
  59
  60     themodefnes : Boolean;
  61
  62 end WorkLibrary;