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

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

 // Created on: 1996-03-13
 // Created by: Christian CAILLET
 // Copyright (c) 1996-1999 Matra Datavision
 // Copyright (c) 1999-2014 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 _XSControl_TransferWriter_HeaderFile
 #define _XSControl_TransferWriter_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_Type.hxx>
 
 #include <Standard_Transient.hxx>
 #include <IFSelect_ReturnStatus.hxx>
 #include <Transfer_FinderProcess.hxx>
 class XSControl_Controller;
 class Interface_InterfaceModel;
 class TopoDS_Shape;
 class Interface_CheckIterator;
 
 
 class XSControl_TransferWriter;
 DEFINE_STANDARD_HANDLE(XSControl_TransferWriter, Standard_Transient)
 
 //! TransferWriter gives help to control transfer to write a file
 //! after having converted data from Cascade/Imagine
 //!
 //! It works with a Controller (which itself can work with an
 //! Actor to Write) and a FinderProcess. It records results and
 //! checks
 class XSControl_TransferWriter : public Standard_Transient
 {
  public:
   
   //! Creates a TransferWriter, empty, ready to run
   //! with an empty FinderProcess (but no controller, etc)
   XSControl_TransferWriter()
   : myTransferWriter(new Transfer_FinderProcess),
     myTransferMode(0)
   {}
   
   //! Returns the FinderProcess itself
   const Handle(Transfer_FinderProcess) & FinderProcess() const
   { return myTransferWriter; }
   
   //! Sets a new FinderProcess and forgets the former one
   void SetFinderProcess (const Handle(Transfer_FinderProcess)& theFP)
   { myTransferWriter = theFP; }
 
   //! Returns the currently used Controller
   const Handle(XSControl_Controller) & Controller() const
   { return myController; }
   
   //! Sets a new Controller, also sets a new FinderProcess
   void SetController (const Handle(XSControl_Controller)& theCtl)
   {
     myController = theCtl;
     Clear(-1);
   }
   
   //! Clears recorded data according a mode
   //! 0 clears FinderProcess (results, checks)
   //! -1 create a new FinderProcess
   Standard_EXPORT void Clear (const Standard_Integer theMode);
   
   //! Returns the current Transfer Mode (an Integer)
   //! It will be interpreted by the Controller to run Transfers
   //! This call form could be later replaced by more specific ones
   //! (parameters suited for each norm / transfer case)
   Standard_Integer TransferMode() const
   { return myTransferMode; }
 
   //! Changes the Transfer Mode
   void SetTransferMode (const Standard_Integer theMode)
   { myTransferMode = theMode; }
 
   //! Prints statistics on current Trace File, according what,mode
   //! See PrintStatsProcess for details
   Standard_EXPORT void PrintStats (const Standard_Integer theWhat, const Standard_Integer theMode = 0) const;
   
   //! Tells if a transient object (from an application) is a valid
   //! candidate for a transfer to a model
   //! Asks the Controller (RecognizeWriteTransient)
   //! If <obj> is a HShape, calls RecognizeShape
   Standard_EXPORT Standard_Boolean RecognizeTransient (const Handle(Standard_Transient)& theObj);
   
   //! Transfers a Transient object (from an application) to a model
   //! of current norm, according to the last call to SetTransferMode
   //! Works by calling the Controller
   //! Returns status : =0 if OK, >0 if error during transfer, <0 if
   //! transfer badly initialised
   Standard_EXPORT IFSelect_ReturnStatus TransferWriteTransient
                    (const Handle(Interface_InterfaceModel)& theModel,
                     const Handle(Standard_Transient)& theObj,
                     const Message_ProgressRange& theProgress = Message_ProgressRange());
   
   //! Tells if a Shape is valid for a transfer to a model
   //! Asks the Controller (RecognizeWriteShape)
   Standard_EXPORT Standard_Boolean RecognizeShape (const TopoDS_Shape& theShape);
   
   //! Transfers a Shape from CasCade to a model of current norm,
   //! according to the last call to SetTransferMode
   //! Works by calling the Controller
   //! Returns status : =0 if OK, >0 if error during transfer, <0 if
   //! transfer badly initialised
   Standard_EXPORT IFSelect_ReturnStatus TransferWriteShape
                    (const Handle(Interface_InterfaceModel)& theModel,
                     const TopoDS_Shape& theShape,
                     const Message_ProgressRange& theProgress = Message_ProgressRange());
   
   //! Returns the check-list of last transfer (write), i.e. the
   //! check-list currently recorded in the FinderProcess
   Standard_EXPORT Interface_CheckIterator CheckList() const;
   
   //! Returns the check-list of last transfer (write), but tries
   //! to bind to each check, the resulting entity in the model
   //! instead of keeping the original Mapper, whenever known
   Standard_EXPORT Interface_CheckIterator ResultCheckList (const Handle(Interface_InterfaceModel)& theModel) const;
 
   DEFINE_STANDARD_RTTIEXT(XSControl_TransferWriter,Standard_Transient)
 
  private:
 
   Handle(XSControl_Controller) myController;
   Handle(Transfer_FinderProcess) myTransferWriter;
   Standard_Integer myTransferMode;
 };
 
 #endif // _XSControl_TransferWriter_HeaderFile

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