include/opencascade/IFSelect.hxx

0001 // Created on: 1992-09-21
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-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 _IFSelect_HeaderFile
0018 #define _IFSelect_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Boolean.hxx>
0025 class IFSelect_WorkSession;
0026
0027 //! Gives tools to manage Selecting a group of Entities
0028 //! processed by an Interface, for instance to divide up an
0029 //! original Model (from a File) to several smaller ones
0030 //! They use description of an Interface Model as a graph
0031 //!
0032 //! Remark that this corresponds to the description of a
0033 //! "scenario" of sharing out a File. Parts of this Scenario
0034 //! are intended to be permanently stored. IFSelect provides
0035 //! the Transient, active counterparts (to run the Scenario).
0036 //! But a permanent one (either as Persistent Objects or as
0037 //! interpretable Text) must be provided elsewhere.
0038 class IFSelect
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   //! Saves the state of a WorkSession from IFSelect, by using a
0044   //! SessionFile from IFSelect. Returns True if Done, False in
0045   //! case of Error on Writing. <file> gives the name of the File
0046   //! to be produced (this avoids to export the class SessionFile).
0047   Standard_EXPORT static Standard_Boolean SaveSession(const Handle(IFSelect_WorkSession)& WS,
0048                                                       const Standard_CString              file);
0049
0050   //! Restore the state of a WorkSession from IFSelect, by using a
0051   //! SessionFile from IFSelect. Returns True if Done, False in
0052   //! case of Error on Writing. <file> gives the name of the File
0053   //! to be used (this avoids to export the class SessionFile).
0054   Standard_EXPORT static Standard_Boolean RestoreSession(const Handle(IFSelect_WorkSession)& WS,
0055                                                          const Standard_CString              file);
0056 };
0057
0058 #endif // _IFSelect_HeaderFile