include/opencascade/PCDM_ReaderStatus.hxx

0001 // Created on: 1997-08-01
0002 // Created by: Jean-Louis Frenkel
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _PCDM_ReaderStatus_HeaderFile
0018 #define _PCDM_ReaderStatus_HeaderFile
0019
0020 //! Status of reading of a document.
0021 //! The following values are accessible:
0022 //! - PCDM_RS_OK: the document was successfully read;
0023 //! - PCDM_RS_NoDriver: driver is not found for the defined file format;
0024 //! - PCDM_RS_UnknownFileDriver: check of the file failed (file doesn't exist, for example);
0025 //! - PCDM_RS_OpenError: attempt to open the file failed;
0026 //! - PCDM_RS_NoVersion: document version of the file is out of scope;
0027 //! - PCDM_RS_NoSchema: NOT USED;
0028 //! - PCDM_RS_NoDocument: document is empty (failed to be read correctly);
0029 //! - PCDM_RS_ExtensionFailure: NOT USED;
0030 //! - PCDM_RS_WrongStreamMode: file is not open for reading (a mistaken mode);
0031 //! - PCDM_RS_FormatFailure: mistake in document data structure;
0032 //! - PCDM_RS_TypeFailure: data type is unknown;
0033 //! - PCDM_RS_TypeNotFoundInSchema: data type is not found in schema (STD file format);
0034 //! - PCDM_RS_UnrecognizedFileFormat: document data structure is wrong (binary file format);
0035 //! - PCDM_RS_MakeFailure: conversion of data from persistent to transient attributes failed (XML file format);
0036 //! - PCDM_RS_PermissionDenied: file can't be opened because permission is denied;
0037 //! - PCDM_RS_DriverFailure: something went wrong (a general mistake of reading of a document);
0038 //! - PCDM_RS_AlreadyRetrievedAndModified: document is already retrieved and modified in current session;
0039 //! - PCDM_RS_AlreadyRetrieved: document is already in current session (already retrieved);
0040 //! - PCDM_RS_UnknownDocument: file doesn't exist on disk;
0041 //! - PCDM_RS_WrongResource: wrong resource file (.RetrievalPlugin);
0042 //! - PCDM_RS_ReaderException: no shape section in the document file (binary file format);
0043 //! - PCDM_RS_NoModel: NOT USED;
0044 //! - PCDM_RS_UserBreak: user stopped reading of the document;
0045 enum PCDM_ReaderStatus
0046 {
0047 PCDM_RS_OK,                          //!< Success
0048 PCDM_RS_NoDriver,                    //!< No driver for file format
0049 PCDM_RS_UnknownFileDriver,           //!< File is bad
0050 PCDM_RS_OpenError,                   //!< Can't open file
0051 PCDM_RS_NoVersion,                   //!< Unknown document version
0052 PCDM_RS_NoSchema,                    //!< NOT USED
0053 PCDM_RS_NoDocument,                  //!< Document is empty
0054 PCDM_RS_ExtensionFailure,            //!< NOT USED
0055 PCDM_RS_WrongStreamMode,             //!< Open mode is mistaken
0056 PCDM_RS_FormatFailure,               //!< Document data structure is wrong
0057 PCDM_RS_TypeFailure,                 //!< Data type is unknown
0058 PCDM_RS_TypeNotFoundInSchema,        //!< Data type is not found in schema
0059 PCDM_RS_UnrecognizedFileFormat,      //!< Document data structure is wrong
0060 PCDM_RS_MakeFailure,                 //!< Conversion of data failed
0061 PCDM_RS_PermissionDenied,            //!< Permission denied to open file
0062 PCDM_RS_DriverFailure,               //!< General mistake of reading
0063 PCDM_RS_AlreadyRetrievedAndModified, //!< Document is already retrieved and modified
0064 PCDM_RS_AlreadyRetrieved,            //!< Document is already retrieved
0065 PCDM_RS_UnknownDocument,             //!< File doesn't exist
0066 PCDM_RS_WrongResource,               //!< Wrong resource file
0067 PCDM_RS_ReaderException,             //!< Wrong data structure
0068 PCDM_RS_NoModel,                     //!< NOT USED
0069 PCDM_RS_UserBreak                    //!< User interrupted reading
0070 };
0071
0072 #endif // _PCDM_ReaderStatus_HeaderFile