0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / IFSelect / IFSelect.hxx
diff --git a/src/IFSelect/IFSelect.hxx b/src/IFSelect/IFSelect.hxx
new file mode 100644 (file)
index 0000000..81f9166
--- /dev/null
@@ -0,0 +1,238 @@
+// Created on: 1992-09-21
+// Created by: Christian CAILLET
+// Copyright (c) 1992-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 _IFSelect_HeaderFile
+#define _IFSelect_HeaderFile
+
+#include <Standard.hxx>
+#include <Standard_DefineAlloc.hxx>
+#include <Standard_Handle.hxx>
+
+#include <Standard_Boolean.hxx>
+#include <Standard_CString.hxx>
+class IFSelect_WorkSession;
+class IFSelect_Signature;
+class IFSelect_SignMultiple;
+class IFSelect_SignType;
+class IFSelect_SignCategory;
+class IFSelect_SignValidity;
+class IFSelect_SignAncestor;
+class IFSelect_ShareOut;
+class IFSelect_AppliedModifiers;
+class IFSelect_ShareOutResult;
+class IFSelect_PacketList;
+class IFSelect_Dispatch;
+class IFSelect_DispGlobal;
+class IFSelect_DispPerOne;
+class IFSelect_DispPerCount;
+class IFSelect_DispPerSignature;
+class IFSelect_DispPerFiles;
+class IFSelect_SelectionIterator;
+class IFSelect_Selection;
+class IFSelect_SelectBase;
+class IFSelect_SelectModelRoots;
+class IFSelect_SelectModelEntities;
+class IFSelect_SelectEntityNumber;
+class IFSelect_SelectPointed;
+class IFSelect_SelectCombine;
+class IFSelect_SelectUnion;
+class IFSelect_SelectIntersection;
+class IFSelect_SelectControl;
+class IFSelect_SelectDiff;
+class IFSelect_SelectDeduct;
+class IFSelect_SelectShared;
+class IFSelect_SelectSharing;
+class IFSelect_SelectAnyList;
+class IFSelect_SelectInList;
+class IFSelect_SelectSuite;
+class IFSelect_SelectExtract;
+class IFSelect_SelectUnknownEntities;
+class IFSelect_SelectErrorEntities;
+class IFSelect_SelectIncorrectEntities;
+class IFSelect_SelectRoots;
+class IFSelect_SelectRootComps;
+class IFSelect_SelectRange;
+class IFSelect_SelectAnyType;
+class IFSelect_SelectType;
+class IFSelect_SelectSignature;
+class IFSelect_SelectFlag;
+class IFSelect_SelectSent;
+class IFSelect_SelectExplore;
+class IFSelect_SelectSignedShared;
+class IFSelect_SelectSignedSharing;
+class IFSelect_IntParam;
+class IFSelect_SignatureList;
+class IFSelect_CheckCounter;
+class IFSelect_SignCounter;
+class IFSelect_GraphCounter;
+class IFSelect_Editor;
+class IFSelect_ParamEditor;
+class IFSelect_EditForm;
+class IFSelect_ListEditor;
+class IFSelect_ContextModif;
+class IFSelect_ContextWrite;
+class IFSelect_Transformer;
+class IFSelect_TransformStandard;
+class IFSelect_ModelCopier;
+class IFSelect_GeneralModifier;
+class IFSelect_Modifier;
+class IFSelect_ModifReorder;
+class IFSelect_ModifEditForm;
+class IFSelect_FileModifier;
+class IFSelect_ModelModifier;
+class IFSelect_WorkSession;
+class IFSelect_WorkLibrary;
+class IFSelect_SessionFile;
+class IFSelect_SessionDumper;
+class IFSelect_BasicDumper;
+class IFSelect_Activator;
+class IFSelect_SessionPilot;
+class IFSelect_Act;
+class IFSelect_Functions;
+
+
+//! Gives tools to manage Selecting a group of Entities
+//! processed by an Interface, for instance to divide up an
+//! original Model (from a File) to several smaller ones
+//! They use description of an Interface Model as a graph
+//!
+//! Remark that this corresponds to the description of a
+//! "scenario" of sharing out a File. Parts of this Scenario
+//! are intended to be permanently stored. IFSelect provides
+//! the Transient, active counterparts (to run the Scenario).
+//! But a permanent one (either as Persistent Objects or as
+//! interpretable Text) must be provided elsewhere.
+class IFSelect 
+{
+public:
+
+  DEFINE_STANDARD_ALLOC
+
+  
+  //! Saves the state of a WorkSession from IFSelect, by using a
+  //! SessionFile from IFSelect. Returns True if Done, False in
+  //! case of Error on Writing. <file> gives the name of the File
+  //! to be produced (this avoids to export the class SessionFile).
+  Standard_EXPORT static Standard_Boolean SaveSession (const Handle(IFSelect_WorkSession)& WS, const Standard_CString file);
+  
+  //! Restore the state of a WorkSession from IFSelect, by using a
+  //! SessionFile from IFSelect. Returns True if Done, False in
+  //! case of Error on Writing. <file> gives the name of the File
+  //! to be used (this avoids to export the class SessionFile).
+  Standard_EXPORT static Standard_Boolean RestoreSession (const Handle(IFSelect_WorkSession)& WS, const Standard_CString file);
+
+
+
+
+protected:
+
+
+
+
+
+private:
+
+
+
+
+friend class IFSelect_Signature;
+friend class IFSelect_SignMultiple;
+friend class IFSelect_SignType;
+friend class IFSelect_SignCategory;
+friend class IFSelect_SignValidity;
+friend class IFSelect_SignAncestor;
+friend class IFSelect_ShareOut;
+friend class IFSelect_AppliedModifiers;
+friend class IFSelect_ShareOutResult;
+friend class IFSelect_PacketList;
+friend class IFSelect_Dispatch;
+friend class IFSelect_DispGlobal;
+friend class IFSelect_DispPerOne;
+friend class IFSelect_DispPerCount;
+friend class IFSelect_DispPerSignature;
+friend class IFSelect_DispPerFiles;
+friend class IFSelect_SelectionIterator;
+friend class IFSelect_Selection;
+friend class IFSelect_SelectBase;
+friend class IFSelect_SelectModelRoots;
+friend class IFSelect_SelectModelEntities;
+friend class IFSelect_SelectEntityNumber;
+friend class IFSelect_SelectPointed;
+friend class IFSelect_SelectCombine;
+friend class IFSelect_SelectUnion;
+friend class IFSelect_SelectIntersection;
+friend class IFSelect_SelectControl;
+friend class IFSelect_SelectDiff;
+friend class IFSelect_SelectDeduct;
+friend class IFSelect_SelectShared;
+friend class IFSelect_SelectSharing;
+friend class IFSelect_SelectAnyList;
+friend class IFSelect_SelectInList;
+friend class IFSelect_SelectSuite;
+friend class IFSelect_SelectExtract;
+friend class IFSelect_SelectUnknownEntities;
+friend class IFSelect_SelectErrorEntities;
+friend class IFSelect_SelectIncorrectEntities;
+friend class IFSelect_SelectRoots;
+friend class IFSelect_SelectRootComps;
+friend class IFSelect_SelectRange;
+friend class IFSelect_SelectAnyType;
+friend class IFSelect_SelectType;
+friend class IFSelect_SelectSignature;
+friend class IFSelect_SelectFlag;
+friend class IFSelect_SelectSent;
+friend class IFSelect_SelectExplore;
+friend class IFSelect_SelectSignedShared;
+friend class IFSelect_SelectSignedSharing;
+friend class IFSelect_IntParam;
+friend class IFSelect_SignatureList;
+friend class IFSelect_CheckCounter;
+friend class IFSelect_SignCounter;
+friend class IFSelect_GraphCounter;
+friend class IFSelect_Editor;
+friend class IFSelect_ParamEditor;
+friend class IFSelect_EditForm;
+friend class IFSelect_ListEditor;
+friend class IFSelect_ContextModif;
+friend class IFSelect_ContextWrite;
+friend class IFSelect_Transformer;
+friend class IFSelect_TransformStandard;
+friend class IFSelect_ModelCopier;
+friend class IFSelect_GeneralModifier;
+friend class IFSelect_Modifier;
+friend class IFSelect_ModifReorder;
+friend class IFSelect_ModifEditForm;
+friend class IFSelect_FileModifier;
+friend class IFSelect_ModelModifier;
+friend class IFSelect_WorkSession;
+friend class IFSelect_WorkLibrary;
+friend class IFSelect_SessionFile;
+friend class IFSelect_SessionDumper;
+friend class IFSelect_BasicDumper;
+friend class IFSelect_Activator;
+friend class IFSelect_SessionPilot;
+friend class IFSelect_Act;
+friend class IFSelect_Functions;
+
+};
+
+
+
+
+
+
+
+#endif // _IFSelect_HeaderFile