src/HYDROPy/HYDROData_Document.sip

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 %ExportedHeaderCode
  20 #include <HYDROData_Document.h>
  21 %End
  22
  23 %ModuleHeaderCode
  24 HYDROData_Entity* copyObject( HYDROData_Entity* theObject );
  25 Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject );
  26 HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject );
  27 %End
  28
  29 enum Data_DocError {
  30   DocError_OK = 0, ///< success
  31   DocError_ResourcesProblem, ///< resources files are invalid or not found
  32   DocError_CanNotOpen, ///< can not open file for reading or writing
  33   DocError_InvalidVersion, ///< version of document is different than expected
  34   DocError_InvalidFormat, ///< format of the document is bad
  35   DocError_UnknownProblem ///< problem has unknown nature
  36 };
  37
  38 class HYDROData_Document
  39 {
  40 %TypeHeaderCode
  41 #include <HYDROData_Document.h>
  42 %End
  43
  44 %ConvertToSubClassCode
  45     if ( !Handle(HYDROData_Document)::DownCast( sipCpp ).IsNull() )
  46       sipClass = sipClass_HYDROData_Document;
  47     else
  48       sipClass = NULL;
  49 %End
  50
  51 %TypeCode
  52
  53   HYDROData_Entity* copyObject( HYDROData_Entity* theObject )
  54   {
  55     HYDROData_Entity* aRes = NULL;
  56     if ( theObject == NULL )
  57       return aRes;
  58
  59     switch( theObject->GetKind() )
  60     {
  61       case KIND_IMAGE:
  62       {
  63         aRes = new HYDROData_Image( *dynamic_cast<HYDROData_Image*>( theObject ) );
  64         break;
  65       }
  66       case KIND_POLYLINE:
  67       {
  68         aRes = new HYDROData_Polyline3D( *dynamic_cast<HYDROData_Polyline3D*>( theObject ) );
  69         break;
  70       }
  71       case KIND_BATHYMETRY:
  72       {
  73         aRes = new HYDROData_Bathymetry( *dynamic_cast<HYDROData_Bathymetry*>( theObject ) );
  74         break;
  75       }
  76       case KIND_ALTITUDE:
  77       {
  78         aRes = new HYDROData_AltitudeObject( *dynamic_cast<HYDROData_AltitudeObject*>( theObject ) );
  79         break;
  80       }
  81       case KIND_IMMERSIBLE_ZONE:
  82       {
  83         aRes = new HYDROData_ImmersibleZone( *dynamic_cast<HYDROData_ImmersibleZone*>( theObject ) );
  84         break;
  85       }
  86       case KIND_RIVER:
  87       {
  88         aRes = new HYDROData_River( *dynamic_cast<HYDROData_River*>( theObject ) );
  89         break;
  90       }
  91       case KIND_STREAM:
  92       {
  93         aRes = new HYDROData_Stream( *dynamic_cast<HYDROData_Stream*>( theObject ) );
  94         break;
  95       }
  96       case KIND_CONFLUENCE:
  97       {
  98         aRes = new HYDROData_Confluence( *dynamic_cast<HYDROData_Confluence*>( theObject ) );
  99         break;
 100       }
 101       case KIND_CHANNEL:
 102       {
 103         aRes = new HYDROData_Channel( *dynamic_cast<HYDROData_Channel*>( theObject ) );
 104         break;
 105       }
 106       case KIND_OBSTACLE:
 107       {
 108         aRes = new HYDROData_Obstacle( *dynamic_cast<HYDROData_Obstacle*>( theObject ) );
 109         break;
 110       }
 111       case KIND_DIGUE:
 112       {
 113         aRes = new HYDROData_Digue( *dynamic_cast<HYDROData_Digue*>( theObject ) );
 114         break;
 115       }
 116       case KIND_PROFILE:
 117       {
 118         aRes = new HYDROData_Profile( *dynamic_cast<HYDROData_Profile*>( theObject ) );
 119         break;
 120       }
 121       case KIND_PROFILEUZ:
 122       {
 123         aRes = new HYDROData_ProfileUZ( *dynamic_cast<HYDROData_ProfileUZ*>( theObject ) );
 124         break;
 125       }
 126       case KIND_POLYLINEXY:
 127       {
 128         aRes = new HYDROData_PolylineXY( *dynamic_cast<HYDROData_PolylineXY*>( theObject ) );
 129         break;
 130       }
 131       case KIND_CALCULATION:
 132       {
 133         aRes = new HYDROData_CalculationCase( *dynamic_cast<HYDROData_CalculationCase*>( theObject ) );
 134         break;
 135       }
 136       case KIND_REGION:
 137       {
 138         aRes = new HYDROData_Region( *dynamic_cast<HYDROData_Region*>( theObject ) );
 139         break;
 140       }
 141       case KIND_ZONE:
 142       {
 143         aRes = new HYDROData_Zone( *dynamic_cast<HYDROData_Zone*>( theObject ) );
 144         break;
 145       }
 146       case KIND_SHAPES_GROUP:
 147       {
 148         aRes = new HYDROData_ShapesGroup( *dynamic_cast<HYDROData_ShapesGroup*>( theObject ) );
 149         break;
 150       }
 151       case KIND_SPLITTED_GROUP:
 152       {
 153         aRes = new HYDROData_SplittedShapesGroup( *dynamic_cast<HYDROData_SplittedShapesGroup*>( theObject ) );
 154         break;
 155       }
 156       case KIND_OBSTACLE_ALTITUDE:
 157       {
 158         aRes = new HYDROData_ObstacleAltitude( *dynamic_cast<HYDROData_ObstacleAltitude*>( theObject ) );
 159         break;
 160       }
 161       case KIND_STREAM_ALTITUDE:
 162       {
 163         aRes = new HYDROData_StreamAltitude( *dynamic_cast<HYDROData_StreamAltitude*>( theObject ) );
 164         break;
 165       }
 166     }
 167
 168     return aRes;
 169   }
 170
 171   Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject )
 172   {
 173     Handle(HYDROData_Entity) aRes = copyObject( theObject );
 174     return aRes;
 175   }
 176
 177   HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject )
 178   {
 179     HYDROData_Entity* aRes = NULL;
 180
 181     if ( !theObject.IsNull() )
 182       aRes = copyObject( theObject.operator->() );
 183
 184     return aRes;
 185   }
 186
 187 %End
 188
 189 public:
 190
 191   //! Returns the existing document or creates new if it is not exist
 192   static HYDROData_Document Document( const int theStudyID ) [Handle_HYDROData_Document (const int)] ;
 193   %MethodCode
 194
 195     Handle(HYDROData_Document) aDocument;
 196
 197     Py_BEGIN_ALLOW_THREADS
 198     aDocument = HYDROData_Document::Document( a0 );
 199     Py_END_ALLOW_THREADS
 200
 201     if ( !aDocument.IsNull() )
 202       sipRes = aDocument.operator->();
 203
 204   %End
 205
 206   //! Returns true if data model contains document for this study
 207   static bool HasDocument( const int theStudyID );
 208
 209   //! Loads the OCAF document from the file.
 210   //! \param theFileName full name of the file to load
 211   //! \param theStudyID identifier of the SALOME study to associate with loaded file
 212   //! \returns error status (OK in case of success)
 213   static Data_DocError Load( const char* theFileName, const int theStudyID );
 214
 215   //! Saves the OCAF document to the file.
 216   //! \param theFileName full name of the file to store
 217   //! \returns error status (OK in case of success)
 218   Data_DocError Save( const char* theFileName );
 219
 220   //! Removes document data
 221   void Close();
 222
 223   //! Starts a new operation (opens a tansaction)
 224   void StartOperation();
 225
 226   //! Finishes the previously started operation (closes the transaction)
 227   //void CommitOperation(
 228   //  const TCollection_ExtendedString& theName = TCollection_ExtendedString() );
 229
 230   //! Aborts the operation
 231   void AbortOperation();
 232
 233   //! Returns true if operation has been started, but not yet finished or aborted
 234   bool IsOperation();
 235
 236   //! Returns true if document was modified (since creation/opening)
 237   bool IsModified();
 238
 239   //! Returns True if there are available Undos
 240   bool CanUndo();
 241
 242   //! Returns a list of stored undo actions
 243   //const TDF_DeltaList& GetUndos();
 244
 245   //! Clears a list of stored undo actions
 246   void ClearUndos();
 247
 248   //! Undoes last operation
 249   void Undo();
 250
 251   //! Returns True if there are available Redos
 252   bool CanRedo();
 253
 254   //! Returns a list of stored undo actions
 255   //const TDF_DeltaList& GetRedos();
 256
 257   //! Clears a list of stored undo actions
 258   void ClearRedos();
 259
 260   //! Redoes last operation
 261   void Redo();
 262
 263   //! Creates and locates in the document a new object
 264   //! \param theKind kind of the created object, can not be UNKNOWN
 265   //! \returns the created object
 266   HYDROData_Entity CreateObject( const ObjectKind theKind ) [Handle_HYDROData_Entity (const ObjectKind)] ;
 267   %MethodCode
 268
 269     Handle(HYDROData_Entity) anObject;
 270     Py_BEGIN_ALLOW_THREADS
 271     anObject =  sipSelfWasArg ? sipCpp->HYDROData_Document::CreateObject( a0 ) :
 272                                 sipCpp->CreateObject( a0 );
 273     Py_END_ALLOW_THREADS
 274
 275     sipRes = createPointer( anObject );
 276
 277   %End
 278
 279   HYDROData_Entity FindObjectByName( const QString&   theName,
 280                                      const ObjectKind theKind = KIND_UNKNOWN )
 281   [Handle_HYDROData_Entity (const QString&, const ObjectKind)] ;
 282   %MethodCode
 283
 284     Handle(HYDROData_Entity) anObject;
 285     Py_BEGIN_ALLOW_THREADS
 286     anObject =  sipSelfWasArg ? sipCpp->HYDROData_Document::FindObjectByName( *a0, a1 ) :
 287                                 sipCpp->FindObjectByName( *a0, a1 );
 288     Py_END_ALLOW_THREADS
 289
 290     sipRes = createPointer( anObject );
 291
 292   %End
 293
 294   HYDROData_SequenceOfObjects FindObjectsByNames( const QStringList& theNames,
 295                                                   const ObjectKind   theKind = KIND_UNKNOWN );
 296
 297   void SetLocalCS( double, double );
 298
 299   //! Get the appropriate interpolator by the name.
 300   HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
 301
 302   //! Get list of registered interpolator names.
 303   NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
 304
 305 protected:
 306
 307   //! Creates new document: private because "Document" method must be used instead of direct creation.
 308   HYDROData_Document();
 309
 310   //! Deletes all high-level data, managed this document
 311   ~HYDROData_Document();
 312
 313 };