src/GEOM/GEOM_Engine.hxx

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 //
  20
  21 #ifndef _GEOM_Engine_HXX_
  22 #define _GEOM_Engine_HXX_
  23
  24 #include "GEOM_Application.hxx"
  25 #include "GEOM_Object.hxx"
  26 #include "GEOM_DataMapOfAsciiStringTransient.hxx"
  27
  28 #include <Interface_DataMapOfIntegerTransient.hxx>
  29 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
  30 #include <TDocStd_Document.hxx>
  31 #include <TColStd_HArray1OfInteger.hxx>
  32 #include <TColStd_HSequenceOfAsciiString.hxx>
  33 #include <TDF_Label.hxx>
  34
  35 #include <map>
  36 #include <vector>
  37
  38 struct TVariable{
  39   TCollection_AsciiString myVariable;
  40   bool isVariable;
  41
  42   TVariable(const TCollection_AsciiString& theVariable, bool theFlag = true):
  43     myVariable(theVariable),
  44     isVariable(theFlag){}
  45 };
  46
  47 typedef std::map<TCollection_AsciiString, std::vector<TVariable> > TVariablesList;
  48
  49 class GEOM_Engine
  50 {
  51  public:
  52   Standard_EXPORT GEOM_Engine();
  53   Standard_EXPORT virtual ~GEOM_Engine();
  54
  55   //Retuns the engine
  56   Standard_EXPORT static GEOM_Engine* GetEngine();
  57
  58   //Returns the OCAF document by its ID, if document doesn't exists it will be created
  59   Standard_EXPORT Handle(TDocStd_Document) GetDocument(int theDocID);
  60
  61   //Returns the ID of the given OCAF document
  62   Standard_EXPORT int GetDocID(Handle(TDocStd_Document) theDocument);
  63
  64   //Returns the OCAF appliaction
  65   Standard_EXPORT Handle(TDocStd_Application) GetApplication() { return _OCAFApp; }
  66
  67   //Returns a pointer to GEOM_Object defined by a document and the entry
  68   Standard_EXPORT Handle(GEOM_Object) GetObject(int theDocID, char* theEntry);
  69
  70   //Adds a new object of the type theType in the OCAF document
  71   Standard_EXPORT Handle(GEOM_Object) AddObject(int theDocID, int theType);
  72
  73   //Removes the object from the OCAF document
  74   Standard_EXPORT bool RemoveObject(Handle(GEOM_Object) theObject);
  75
  76   //Saves the OCAF document with ID = theDocID with file with name theFileName
  77   Standard_EXPORT bool Save(int theDocID, char* theFileName);
  78
  79   //Loads the OCAF document into the application and assigns to it an ID = theDocID
  80   Standard_EXPORT bool Load(int theDocID, char* theFileName);
  81
  82   //Closes the document with ID =  theDocID
  83   Standard_EXPORT void Close(int theDocID);
  84
  85   //Sets the number of Undos (default value = 10)
  86   Standard_EXPORT void SetUndoLimit(int theLimit) { _UndoLimit = theLimit; }
  87
  88   //Applies an Undo to document with ID = theDocID
  89   Standard_EXPORT void Undo(int theDocID);
  90
  91   //Applies an Redo to document with ID = theDocID
  92   Standard_EXPORT void Redo(int theDocID);
  93
  94   //Adds a new sub shape object of the MainShape object
  95   Standard_EXPORT Handle(GEOM_Object) AddSubShape(Handle(GEOM_Object) theMainShape,
  96                                   Handle(TColStd_HArray1OfInteger) theIndices,
  97                                   bool isStandaloneOperation = false);
  98
  99   Standard_EXPORT TCollection_AsciiString DumpPython(int theDocID,
 100                                      Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
 101                                      TVariablesList theVariables,
 102                                      bool isPublished,
 103                                      bool& aValidScript);
 104
 105   Standard_EXPORT const char* GetDumpName (const char* theStudyEntry) const;
 106
 107   Standard_EXPORT Handle(TColStd_HSequenceOfAsciiString) GetAllDumpNames() const;
 108
 109  protected:
 110   Standard_EXPORT static void SetEngine(GEOM_Engine* theEngine);
 111
 112  private:
 113
 114   Handle(GEOM_Application)  _OCAFApp;
 115   Interface_DataMapOfIntegerTransient _mapIDDocument;
 116   int _UndoLimit;
 117   GEOM_DataMapOfAsciiStringTransient _objects;
 118
 119   Resource_DataMapOfAsciiStringAsciiString _studyEntry2NameMap;
 120
 121   TDF_Label _lastCleared;
 122 };
 123
 124 #endif