include/opencascade/DEBREP_Provider.hxx

0001 // Copyright (c) 2022 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _DEBREP_Provider_HeaderFile
0015 #define _DEBREP_Provider_HeaderFile
0016
0017 #include <DE_Provider.hxx>
0018
0019 //! The class to transfer BRep files.
0020 //! Reads and Writes any BRep files into/from OCCT.
0021 //! Each operation needs configuration node.
0022 //!
0023 //! Providers grouped by Vendor name and Format type.
0024 //! The Vendor name is "OCC"
0025 //! The Format type is "BREP"
0026 //! The import process is supported.
0027 //! The export process is supported.
0028 class DEBREP_Provider : public DE_Provider
0029 {
0030 public:
0031   DEFINE_STANDARD_RTTIEXT(DEBREP_Provider, DE_Provider)
0032
0033 public:
0034   //! Default constructor
0035   //! Configure translation process with global configuration
0036   Standard_EXPORT DEBREP_Provider();
0037
0038   //! Configure translation process
0039   //! @param[in] theNode object to init the DE_Provider
0040   Standard_EXPORT DEBREP_Provider(const Handle(DE_ConfigurationNode)& theNode);
0041
0042 public:
0043   //! Reads a CAD file, according internal configuration
0044   //! @param[in] thePath path to the import CAD file
0045   //! @param[out] theDocument document to save result
0046   //! @param[in] theWS current work session
0047   //! @param[in] theProgress progress indicator
0048   //! @return true if Read operation has ended correctly
0049   Standard_EXPORT virtual bool Read(
0050     const TCollection_AsciiString&  thePath,
0051     const Handle(TDocStd_Document)& theDocument,
0052     Handle(XSControl_WorkSession)&  theWS,
0053     const Message_ProgressRange&    theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0054
0055   //! Writes a CAD file, according internal configuration
0056   //! @param[in] thePath path to the export CAD file
0057   //! @param[out] theDocument document to export
0058   //! @param[in] theWS current work session
0059   //! @param[in] theProgress progress indicator
0060   //! @return true if Write operation has ended correctly
0061   Standard_EXPORT virtual bool Write(
0062     const TCollection_AsciiString&  thePath,
0063     const Handle(TDocStd_Document)& theDocument,
0064     Handle(XSControl_WorkSession)&  theWS,
0065     const Message_ProgressRange&    theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0066
0067   //! Reads a CAD file, according internal configuration
0068   //! @param[in] thePath path to the import CAD file
0069   //! @param[out] theDocument document to save result
0070   //! @param[in] theProgress progress indicator
0071   //! @return true if Read operation has ended correctly
0072   Standard_EXPORT virtual bool Read(
0073     const TCollection_AsciiString&  thePath,
0074     const Handle(TDocStd_Document)& theDocument,
0075     const Message_ProgressRange&    theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0076
0077   //! Writes a CAD file, according internal configuration
0078   //! @param[in] thePath path to the export CAD file
0079   //! @param[out] theDocument document to export
0080   //! @param[in] theProgress progress indicator
0081   //! @return true if Write operation has ended correctly
0082   Standard_EXPORT virtual bool Write(
0083     const TCollection_AsciiString&  thePath,
0084     const Handle(TDocStd_Document)& theDocument,
0085     const Message_ProgressRange&    theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0086
0087   //! Reads a CAD file, according internal configuration
0088   //! @param[in] thePath path to the import CAD file
0089   //! @param[out] theShape shape to save result
0090   //! @param[in] theWS current work session
0091   //! @param[in] theProgress progress indicator
0092   //! @return true if Read operation has ended correctly
0093   Standard_EXPORT virtual bool Read(
0094     const TCollection_AsciiString& thePath,
0095     TopoDS_Shape&                  theShape,
0096     Handle(XSControl_WorkSession)& theWS,
0097     const Message_ProgressRange&   theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0098
0099   //! Writes a CAD file, according internal configuration
0100   //! @param[in] thePath path to the export CAD file
0101   //! @param[out] theShape shape to export
0102   //! @param[in] theWS current work session
0103   //! @param[in] theProgress progress indicator
0104   //! @return true if Write operation has ended correctly
0105   Standard_EXPORT virtual bool Write(
0106     const TCollection_AsciiString& thePath,
0107     const TopoDS_Shape&            theShape,
0108     Handle(XSControl_WorkSession)& theWS,
0109     const Message_ProgressRange&   theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0110
0111   //! Reads a CAD file, according internal configuration
0112   //! @param[in] thePath path to the import CAD file
0113   //! @param[out] theShape shape to save result
0114   //! @param[in] theProgress progress indicator
0115   //! @return true if Read operation has ended correctly
0116   Standard_EXPORT virtual bool Read(
0117     const TCollection_AsciiString& thePath,
0118     TopoDS_Shape&                  theShape,
0119     const Message_ProgressRange&   theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0120
0121   //! Writes a CAD file, according internal configuration
0122   //! @param[in] thePath path to the export CAD file
0123   //! @param[out] theShape shape to export
0124   //! @param[in] theProgress progress indicator
0125   //! @return true if Write operation has ended correctly
0126   Standard_EXPORT virtual bool Write(
0127     const TCollection_AsciiString& thePath,
0128     const TopoDS_Shape&            theShape,
0129     const Message_ProgressRange&   theProgress = Message_ProgressRange()) Standard_OVERRIDE;
0130
0131 public:
0132   //! Gets CAD format name of associated provider
0133   //! @return provider CAD format
0134   Standard_EXPORT virtual TCollection_AsciiString GetFormat() const Standard_OVERRIDE;
0135
0136   //! Gets provider's vendor name of associated provider
0137   //! @return provider's vendor name
0138   Standard_EXPORT virtual TCollection_AsciiString GetVendor() const Standard_OVERRIDE;
0139 };
0140
0141 #endif // _DEBREP_Provider_HeaderFile