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