src/HYDROPy/HYDROData_Document.sip

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 %ExportedHeaderCode
  24 #include <HYDROData_Document.h>
  25 %End
  26
  27 %ModuleHeaderCode
  28 HYDROData_Entity* copyObject( HYDROData_Entity* theObject );
  29 Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject );
  30 HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject );
  31 %End
  32
  33 enum Data_DocError {
  34   DocError_OK = 0, ///< success
  35   DocError_ResourcesProblem, ///< resources files are invalid or not found
  36   DocError_CanNotOpen, ///< can not open file for reading or writing
  37   DocError_InvalidVersion, ///< version of document is different than expected
  38   DocError_InvalidFormat, ///< format of the document is bad
  39   DocError_UnknownProblem ///< problem has unknown nature
  40 };
  41
  42 class HYDROData_Document
  43 {
  44 %TypeHeaderCode
  45 #include <HYDROData_Document.h>
  46 %End
  47
  48 %ConvertToSubClassCode
  49     if ( !Handle(HYDROData_Document)::DownCast( sipCpp ).IsNull() )
  50       sipClass = sipClass_HYDROData_Document;
  51     else
  52       sipClass = NULL;
  53 %End
  54
  55 %TypeCode
  56
  57   HYDROData_Entity* copyObject( HYDROData_Entity* theObject )
  58   {
  59     HYDROData_Entity* aRes = NULL;
  60     if ( theObject == NULL )
  61       return aRes;
  62
  63     switch( theObject->GetKind() )
  64     {
  65       case KIND_IMAGE:
  66       {
  67         aRes = new HYDROData_Image( *dynamic_cast<HYDROData_Image*>( theObject ) );
  68         break;
  69       }
  70       case KIND_POLYLINE:
  71       {
  72         aRes = new HYDROData_Polyline( *dynamic_cast<HYDROData_Polyline*>( theObject ) );
  73         break;
  74       }
  75       case KIND_BATHYMETRY:
  76       {
  77         aRes = new HYDROData_Bathymetry( *dynamic_cast<HYDROData_Bathymetry*>( theObject ) );
  78         break;
  79       }
  80       case KIND_IMMERSIBLE_ZONE:
  81       {
  82         aRes = new HYDROData_ImmersibleZone( *dynamic_cast<HYDROData_ImmersibleZone*>( theObject ) );
  83         break;
  84       }
  85       case KIND_CALCULATION:
  86       {
  87         aRes = new HYDROData_Calculation( *dynamic_cast<HYDROData_Calculation*>( theObject ) );
  88         break;
  89       }
  90       case KIND_REGION:
  91       {
  92         aRes = new HYDROData_Region( *dynamic_cast<HYDROData_Region*>( theObject ) );
  93         break;
  94       }
  95       case KIND_ZONE:
  96       {
  97         aRes = new HYDROData_Zone( *dynamic_cast<HYDROData_Zone*>( theObject ) );
  98         break;
  99       }
 100     }
 101
 102     return aRes;
 103   }
 104
 105   Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject )
 106   {
 107     Handle(HYDROData_Entity) aRes = copyObject( theObject );
 108     return aRes;
 109   }
 110
 111   HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject )
 112   {
 113     HYDROData_Entity* aRes = NULL;
 114
 115     if ( !theObject.IsNull() )
 116       aRes = copyObject( theObject.operator->() );
 117
 118     return aRes;
 119   }
 120
 121 %End
 122
 123 public:
 124
 125   //! Returns the existing document or creates new if it is not exist
 126   static HYDROData_Document Document( const int theStudyID ) [Handle_HYDROData_Document (const int)] ;
 127   %MethodCode
 128
 129     Handle(HYDROData_Document) aDocument;
 130
 131     Py_BEGIN_ALLOW_THREADS
 132     aDocument = HYDROData_Document::Document( a0 );
 133     Py_END_ALLOW_THREADS
 134
 135     if ( !aDocument.IsNull() )
 136       sipRes = aDocument.operator->();
 137
 138   %End
 139
 140   //! Returns true if data model contains document for this study
 141   static bool HasDocument( const int theStudyID );
 142
 143   //! Loads the OCAF document from the file.
 144   //! \param theFileName full name of the file to load
 145   //! \param theStudyID identifier of the SALOME study to associate with loaded file
 146   //! \returns error status (OK in case of success)
 147   static Data_DocError Load( const char* theFileName, const int theStudyID );
 148
 149   //! Saves the OCAF document to the file.
 150   //! \param theFileName full name of the file to store
 151   //! \returns error status (OK in case of success)
 152   Data_DocError Save( const char* theFileName );
 153
 154   //! Removes document data
 155   void Close();
 156
 157   //! Starts a new operation (opens a tansaction)
 158   void StartOperation();
 159
 160   //! Finishes the previously started operation (closes the transaction)
 161   //void CommitOperation(
 162   //  const TCollection_ExtendedString& theName = TCollection_ExtendedString() );
 163
 164   //! Aborts the operation
 165   void AbortOperation();
 166
 167   //! Returns true if operation has been started, but not yet finished or aborted
 168   bool IsOperation();
 169
 170   //! Returns true if document was modified (since creation/opening)
 171   bool IsModified();
 172
 173   //! Returns True if there are available Undos
 174   bool CanUndo();
 175
 176   //! Returns a list of stored undo actions
 177   //const TDF_DeltaList& GetUndos();
 178
 179   //! Clears a list of stored undo actions
 180   void ClearUndos();
 181
 182   //! Undoes last operation
 183   void Undo();
 184
 185   //! Returns True if there are available Redos
 186   bool CanRedo();
 187
 188   //! Returns a list of stored undo actions
 189   //const TDF_DeltaList& GetRedos();
 190
 191   //! Clears a list of stored undo actions
 192   void ClearRedos();
 193
 194   //! Redoes last operation
 195   void Redo();
 196
 197   //! Creates and locates in the document a new object
 198   //! \param theKind kind of the created object, can not be UNKNOWN
 199   //! \returns the created object
 200   HYDROData_Entity CreateObject( const ObjectKind theKind ) [Handle_HYDROData_Entity (const ObjectKind)] ;
 201   %MethodCode
 202
 203     Handle(HYDROData_Entity) anObject;
 204     Py_BEGIN_ALLOW_THREADS
 205     anObject =  sipSelfWasArg ? sipCpp->HYDROData_Document::CreateObject( a0 ) :
 206                                 sipCpp->CreateObject( a0 );
 207     Py_END_ALLOW_THREADS
 208
 209     sipRes = createPointer( anObject );
 210
 211   %End
 212
 213 protected:
 214
 215   //! Creates new document: private because "Document" method must be used instead of direct creation.
 216   HYDROData_Document();
 217
 218   //! Deletes all high-level data, managed this document
 219   ~HYDROData_Document();
 220
 221 };