[occt.git] / src / StdLDrivers / StdLDrivers_DocumentRetrievalDriver.hxx

// Copyright (c) 2015 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _StdLDrivers_DocumentRetrievalDriver_HeaderFile
#define _StdLDrivers_DocumentRetrievalDriver_HeaderFile

#include <PCDM_RetrievalDriver.hxx>
#include <Storage_Error.hxx>

class StdObjMgt_MapOfInstantiators;

//! retrieval driver of a Part document
class StdLDrivers_DocumentRetrievalDriver : public PCDM_RetrievalDriver
{
public:
  //! Create an empty TDocStd_Document.
  Standard_EXPORT virtual Handle(CDM_Document) CreateDocument() Standard_OVERRIDE;

  //! Retrieve the content of a file into a new document.
  Standard_EXPORT virtual void Read (const TCollection_ExtendedString& theFileName,
                                     const Handle(CDM_Document)&       theNewDocument,
                                     const Handle(CDM_Application)&    theApplication) Standard_OVERRIDE;

  //! Override pure virtual method (raises exception Standard_NotImplemented) 
  Standard_EXPORT virtual void Read (Standard_IStream&              theIStream,
                                     const Handle(Storage_Data)&    theStorageData,
                                     const Handle(CDM_Document)&    theDoc,
                                     const Handle(CDM_Application)& theApplication) Standard_OVERRIDE;

  DEFINE_STANDARD_RTTIEXT (StdLDrivers_DocumentRetrievalDriver, PCDM_RetrievalDriver)

private:
  //! Update the reader status and raise an exception appropriate for the given storage error.
  Standard_EXPORT Standard_Boolean RaiseOnStorageError (Storage_Error theError);

  //! Register types.
  Standard_EXPORT virtual void BindTypes (StdObjMgt_MapOfInstantiators& theMap);
};

#endif // _StdLDrivers_DocumentRetrievalDriver_HeaderFile
Commit	Line	Data
7ed7467d	1	// Copyright (c) 2015 OPEN CASCADE SAS
	2	//
	3	// This file is part of Open CASCADE Technology software library.
	4	//
	5	// This library is free software; you can redistribute it and/or modify it under
	6	// the terms of the GNU Lesser General Public License version 2.1 as published
	7	// by the Free Software Foundation, with special exception defined in the file
	8	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	9	// distribution for complete text of the license and disclaimer of any warranty.
	10	//
	11	// Alternatively, this file may be used under the terms of Open CASCADE
	12	// commercial license or contractual agreement.
	13
	14	#ifndef _StdLDrivers_DocumentRetrievalDriver_HeaderFile
	15	#define _StdLDrivers_DocumentRetrievalDriver_HeaderFile
	16
	17	#include <PCDM_RetrievalDriver.hxx>
	18	#include <Storage_Error.hxx>
	19
	20	class StdObjMgt_MapOfInstantiators;
	21
	22	//! retrieval driver of a Part document
	23	class StdLDrivers_DocumentRetrievalDriver : public PCDM_RetrievalDriver
	24	{
	25	public:
	26	//! Create an empty TDocStd_Document.
8bb8064e	27	Standard_EXPORT virtual Handle(CDM_Document) CreateDocument() Standard_OVERRIDE;
7ed7467d	28
	29	//! Retrieve the content of a file into a new document.
	30	Standard_EXPORT virtual void Read (const TCollection_ExtendedString& theFileName,
	31	const Handle(CDM_Document)& theNewDocument,
8bb8064e	32	const Handle(CDM_Application)& theApplication) Standard_OVERRIDE;
7ed7467d	33
201c2208	34	//! Override pure virtual method (raises exception Standard_NotImplemented)
	35	Standard_EXPORT virtual void Read (Standard_IStream& theIStream,
	36	const Handle(Storage_Data)& theStorageData,
	37	const Handle(CDM_Document)& theDoc,
	38	const Handle(CDM_Application)& theApplication) Standard_OVERRIDE;
	39
7ed7467d	40	DEFINE_STANDARD_RTTIEXT (StdLDrivers_DocumentRetrievalDriver, PCDM_RetrievalDriver)
	41
	42	private:
	43	//! Update the reader status and raise an exception appropriate for the given storage error.
	44	Standard_EXPORT Standard_Boolean RaiseOnStorageError (Storage_Error theError);
	45
	46	//! Register types.
	47	Standard_EXPORT virtual void BindTypes (StdObjMgt_MapOfInstantiators& theMap);
	48	};
	49
	50	#endif // _StdLDrivers_DocumentRetrievalDriver_HeaderFile