include/opencascade/STEPControl_Controller.hxx

0001 // Created on: 1995-02-20
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1995-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 _STEPControl_Controller_HeaderFile
0018 #define _STEPControl_Controller_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <XSControl_Controller.hxx>
0024 #include <IFSelect_ReturnStatus.hxx>
0025 #include <Standard_Integer.hxx>
0026 class Interface_InterfaceModel;
0027 class XSControl_WorkSession;
0028 class TopoDS_Shape;
0029 class Transfer_FinderProcess;
0030
0031
0032 class STEPControl_Controller;
0033 DEFINE_STANDARD_HANDLE(STEPControl_Controller, XSControl_Controller)
0034
0035 //! defines basic controller for STEP processor
0036 class STEPControl_Controller : public XSControl_Controller
0037 {
0038
0039 public:
0040
0041
0042   //! Initializes the use of STEP Norm (the first time) and
0043   //! returns a Controller
0044   Standard_EXPORT STEPControl_Controller();
0045
0046   //! Creates a new empty Model ready to receive data of the Norm.
0047   //! It is taken from STEP Template Model
0048   Standard_EXPORT Handle(Interface_InterfaceModel) NewModel() const Standard_OVERRIDE;
0049
0050   //! Returns the Actor for Read attached to the pair (norm,appli)
0051   Standard_EXPORT Handle(Transfer_ActorOfTransientProcess) ActorRead(const Handle(Interface_InterfaceModel)& theModel) const Standard_OVERRIDE;
0052
0053   Standard_EXPORT virtual void Customise (Handle(XSControl_WorkSession)& WS) Standard_OVERRIDE;
0054
0055   //! Takes one Shape and transfers it to the InterfaceModel
0056   //! (already created by NewModel for instance)
0057   //! <modeshape> is to be interpreted by each kind of XstepAdaptor
0058   //! Returns a status : 0 OK  1 No result  2 Fail  -1 bad modeshape
0059   //! -2 bad model (requires a StepModel)
0060   //! modeshape : 1 Facetted BRep, 2 Shell, 3 Manifold Solid
0061   Standard_EXPORT virtual IFSelect_ReturnStatus TransferWriteShape
0062                    (const TopoDS_Shape& shape,
0063                     const Handle(Transfer_FinderProcess)& FP,
0064                     const Handle(Interface_InterfaceModel)& model,
0065                     const Standard_Integer modetrans = 0,
0066                     const Message_ProgressRange& theProgress = Message_ProgressRange()) const Standard_OVERRIDE;
0067
0068   //! Standard Initialisation. It creates a Controller for STEP
0069   //! and records it to various names, available to select it later
0070   //! Returns True when done, False if could not be done
0071   Standard_EXPORT static Standard_Boolean Init();
0072
0073
0074
0075
0076   DEFINE_STANDARD_RTTIEXT(STEPControl_Controller,XSControl_Controller)
0077
0078 protected:
0079
0080
0081
0082
0083 private:
0084
0085
0086
0087
0088 };
0089
0090
0091
0092
0093
0094
0095
0096 #endif // _STEPControl_Controller_HeaderFile