EIC code displayed by LXR master/​include/​opencascade/​STEPCAFControl_Provider.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:05:05

 // Copyright (c) 2022 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 _STEPCAFControl_Provider_HeaderFile
 #define _STEPCAFControl_Provider_HeaderFile
 
 #include <DE_Provider.hxx>
 #include <STEPCAFControl_ConfigurationNode.hxx>
 
 //! The class to transfer STEP files.
 //! Reads and Writes any STEP files into/from OCCT.
 //! Each operation needs configuration node.
 //!
 //! Providers grouped by Vendor name and Format type.
 //! The Vendor name is "OCC"
 //! The Format type is "STEP"
 //! The import process is supported.
 //! The export process is supported.
 class STEPCAFControl_Provider : public DE_Provider
 {
 public:
   DEFINE_STANDARD_RTTIEXT(STEPCAFControl_Provider, DE_Provider)
 
 public:
 
   //! Default constructor
   //! Configure translation process with global configuration
   Standard_EXPORT STEPCAFControl_Provider();
 
   //! Configure translation process
   //! @param[in] theNode object to copy
   Standard_EXPORT STEPCAFControl_Provider(const Handle(DE_ConfigurationNode)& theNode);
 
 public:
 
   //! Reads a CAD file, according internal configuration
   //! @param[in] thePath path to the import CAD file
   //! @param[out] theDocument document to save result
   //! @param[in] theWS current work session
   //! @param theProgress[in] progress indicator
   //! @return true if Read operation has ended correctly
   Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
                                     const Handle(TDocStd_Document)& theDocument,
                                     Handle(XSControl_WorkSession)& theWS,
                                     const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
 
   //! Writes a CAD file, according internal configuration
   //! @param[in] thePath path to the export CAD file
   //! @param[out] theDocument document to export
   //! @param[in] theWS current work session
   //! @param theProgress[in] progress indicator
   //! @return true if Write operation has ended correctly
   Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
                                      const Handle(TDocStd_Document)& theDocument,
                                      Handle(XSControl_WorkSession)& theWS,
                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
 
   //! Reads a CAD file, according internal configuration
   //! @param[in] thePath path to the import CAD file
   //! @param[out] theDocument document to save result
   //! @param theProgress[in] progress indicator
   //! @return true if Read operation has ended correctly
   Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
                                     const Handle(TDocStd_Document)& theDocument,
                                     const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
 
   //! Writes a CAD file, according internal configuration
   //! @param[in] thePath path to the export CAD file
   //! @param[out] theDocument document to export
   //! @param theProgress[in] progress indicator
   //! @return true if Write operation has ended correctly
   Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
                                      const Handle(TDocStd_Document)& theDocument,
                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
 
   //! Reads a CAD file, according internal configuration
   //! @param[in] thePath path to the import CAD file
   //! @param[out] theShape shape to save result
   //! @param[in] theWS current work session
   //! @param theProgress[in] progress indicator
   //! @return true if Read operation has ended correctly
   Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
                                     TopoDS_Shape& theShape,
                                     Handle(XSControl_WorkSession)& theWS,
                                     const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
 
   //! Writes a CAD file, according internal configuration
   //! @param[in] thePath path to the export CAD file
   //! @param[out] theShape shape to export
   //! @param[in] theWS current work session
   //! @param theProgress[in] progress indicator
   //! @return true if Write operation has ended correctly
   Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
                                      const TopoDS_Shape& theShape,
                                      Handle(XSControl_WorkSession)& theWS,
                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
 
   //! Reads a CAD file, according internal configuration
   //! @param[in] thePath path to the import CAD file
   //! @param[out] theShape shape to save result
   //! @param theProgress[in] progress indicator
   //! @return true if Read operation has ended correctly
   Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
                                     TopoDS_Shape& theShape,
                                     const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
 
   //! Writes a CAD file, according internal configuration
   //! @param[in] thePath path to the export CAD file
   //! @param[out] theShape shape to export
   //! @param theProgress[in] progress indicator
   //! @return true if Write operation has ended correctly
   Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
                                      const TopoDS_Shape& theShape,
                                      const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
 
 public:
 
   //! Gets CAD format name of associated provider
   //! @return provider CAD format
   Standard_EXPORT virtual TCollection_AsciiString GetFormat() const Standard_OVERRIDE;
 
   //! Gets provider's vendor name of associated provider
   //! @return provider's vendor name
   Standard_EXPORT virtual TCollection_AsciiString GetVendor() const Standard_OVERRIDE;
 
  private:
 
   //! Personizes work session with current format.
   //! Creates new temporary session if current session is null
   //! @param[in] theWS current work session
   void personizeWS(Handle(XSControl_WorkSession)& theWS);
 
 };
 
 #endif // _STEPCAFControl_Provider_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team