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_BATHYMETRY:
  71       {
  72         aRes = new HYDROData_Bathymetry( *dynamic_cast<HYDROData_Bathymetry*>( theObject ) );
  73         break;
  74       }
  75       case KIND_IMMERSIBLE_ZONE:
  76       {
  77         aRes = new HYDROData_ImmersibleZone( *dynamic_cast<HYDROData_ImmersibleZone*>( theObject ) );
  78         break;
  79       }
  80       case KIND_PROFILEUZ:
  81       {
  82         aRes = new HYDROData_ProfileUZ( *dynamic_cast<HYDROData_ProfileUZ*>( theObject ) );
  83         break;
  84       }
  85       case KIND_POLYLINEXY:
  86       {
  87         aRes = new HYDROData_PolylineXY( *dynamic_cast<HYDROData_PolylineXY*>( theObject ) );
  88         break;
  89       }
  90       case KIND_CALCULATION:
  91       {
  92         aRes = new HYDROData_CalculationCase( *dynamic_cast<HYDROData_CalculationCase*>( theObject ) );
  93         break;
  94       }
  95       case KIND_OBSTACLE:
  96       {
  97         aRes = new HYDROData_Obstacle( *dynamic_cast<HYDROData_Obstacle*>( theObject ) );
  98         break;
  99       }
 100       case KIND_REGION:
 101       {
 102         aRes = new HYDROData_Region( *dynamic_cast<HYDROData_Region*>( theObject ) );
 103         break;
 104       }
 105       case KIND_ZONE:
 106       {
 107         aRes = new HYDROData_Zone( *dynamic_cast<HYDROData_Zone*>( theObject ) );
 108         break;
 109       }
 110     }
 111
 112     return aRes;
 113   }
 114
 115   Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject )
 116   {
 117     Handle(HYDROData_Entity) aRes = copyObject( theObject );
 118     return aRes;
 119   }
 120
 121   HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject )
 122   {
 123     HYDROData_Entity* aRes = NULL;
 124
 125     if ( !theObject.IsNull() )
 126       aRes = copyObject( theObject.operator->() );
 127
 128     return aRes;
 129   }
 130
 131 %End
 132
 133 public:
 134
 135   //! Returns the existing document or creates new if it is not exist
 136   static HYDROData_Document Document( const int theStudyID ) [Handle_HYDROData_Document (const int)] ;
 137   %MethodCode
 138
 139     Handle(HYDROData_Document) aDocument;
 140
 141     Py_BEGIN_ALLOW_THREADS
 142     aDocument = HYDROData_Document::Document( a0 );
 143     Py_END_ALLOW_THREADS
 144
 145     if ( !aDocument.IsNull() )
 146       sipRes = aDocument.operator->();
 147
 148   %End
 149
 150   //! Returns true if data model contains document for this study
 151   static bool HasDocument( const int theStudyID );
 152
 153   //! Loads the OCAF document from the file.
 154   //! \param theFileName full name of the file to load
 155   //! \param theStudyID identifier of the SALOME study to associate with loaded file
 156   //! \returns error status (OK in case of success)
 157   static Data_DocError Load( const char* theFileName, const int theStudyID );
 158
 159   //! Saves the OCAF document to the file.
 160   //! \param theFileName full name of the file to store
 161   //! \returns error status (OK in case of success)
 162   Data_DocError Save( const char* theFileName );
 163
 164   //! Removes document data
 165   void Close();
 166
 167   //! Starts a new operation (opens a tansaction)
 168   void StartOperation();
 169
 170   //! Finishes the previously started operation (closes the transaction)
 171   //void CommitOperation(
 172   //  const TCollection_ExtendedString& theName = TCollection_ExtendedString() );
 173
 174   //! Aborts the operation
 175   void AbortOperation();
 176
 177   //! Returns true if operation has been started, but not yet finished or aborted
 178   bool IsOperation();
 179
 180   //! Returns true if document was modified (since creation/opening)
 181   bool IsModified();
 182
 183   //! Returns True if there are available Undos
 184   bool CanUndo();
 185
 186   //! Returns a list of stored undo actions
 187   //const TDF_DeltaList& GetUndos();
 188
 189   //! Clears a list of stored undo actions
 190   void ClearUndos();
 191
 192   //! Undoes last operation
 193   void Undo();
 194
 195   //! Returns True if there are available Redos
 196   bool CanRedo();
 197
 198   //! Returns a list of stored undo actions
 199   //const TDF_DeltaList& GetRedos();
 200
 201   //! Clears a list of stored undo actions
 202   void ClearRedos();
 203
 204   //! Redoes last operation
 205   void Redo();
 206
 207   //! Creates and locates in the document a new object
 208   //! \param theKind kind of the created object, can not be UNKNOWN
 209   //! \returns the created object
 210   HYDROData_Entity CreateObject( const ObjectKind theKind ) [Handle_HYDROData_Entity (const ObjectKind)] ;
 211   %MethodCode
 212
 213     Handle(HYDROData_Entity) anObject;
 214     Py_BEGIN_ALLOW_THREADS
 215     anObject =  sipSelfWasArg ? sipCpp->HYDROData_Document::CreateObject( a0 ) :
 216                                 sipCpp->CreateObject( a0 );
 217     Py_END_ALLOW_THREADS
 218
 219     sipRes = createPointer( anObject );
 220
 221   %End
 222
 223 protected:
 224
 225   //! Creates new document: private because "Document" method must be used instead of direct creation.
 226   HYDROData_Document();
 227
 228   //! Deletes all high-level data, managed this document
 229   ~HYDROData_Document();
 230
 231 };