src/StepFile/StepFile_Read.hxx

   1 // Created on: 1991-08-30
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1991-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 #ifndef StepFile_Read_HeaderFile
  18 #define StepFile_Read_HeaderFile
  19
  20 #include <Standard_CString.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <iostream>
  24
  25 class StepData_StepModel;
  26 class StepData_Protocol;
  27
  28 //! Prints the error message
  29 //! @param theErrorMessage - error message for output
  30 //! @param theFail - if true output as a fail info, else output as a trace info ( log )
  31 void StepFile_Interrupt(Standard_CString theErrorMessage,
  32                         const Standard_Boolean theIsFail = Standard_True);
  33
  34 //! Working function reading STEP file or stream.
  35 //! @param theName - name of the file or stream
  36 //! @param theIStream - pointer to stream to read; if null, file theName will be opened
  37 //! @param theModel - STEP model
  38 //! @param theProtocol - STEP protocol object
  39 //! @return 0 on success, -1 if stream fails, 1 in case of parsing error
  40 Standard_EXPORT Standard_Integer StepFile_Read (const char* theName,
  41                                                 std::istream* theIStream,
  42                                                 const Handle(StepData_StepModel)& theModel,
  43                                                 const Handle(StepData_Protocol)& theProtocol);
  44
  45 #endif