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.
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.
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
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #include <HYDROData_Document.h>
24 HYDROData_Entity* copyObject( HYDROData_Entity* theObject );
25 Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject );
26 HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject );
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
38 class HYDROData_Document
41 #include <HYDROData_Document.h>
44 %ConvertToSubClassCode
45 if ( !Handle(HYDROData_Document)::DownCast( sipCpp ).IsNull() )
46 sipClass = sipClass_HYDROData_Document;
53 HYDROData_Entity* copyObject( HYDROData_Entity* theObject )
55 HYDROData_Entity* aRes = NULL;
56 if ( theObject == NULL )
59 switch( theObject->GetKind() )
63 aRes = new HYDROData_Image( *dynamic_cast<HYDROData_Image*>( theObject ) );
68 aRes = new HYDROData_Polyline3D( *dynamic_cast<HYDROData_Polyline3D*>( theObject ) );
73 aRes = new HYDROData_Bathymetry( *dynamic_cast<HYDROData_Bathymetry*>( theObject ) );
78 aRes = new HYDROData_AltitudeObject( *dynamic_cast<HYDROData_AltitudeObject*>( theObject ) );
81 case KIND_IMMERSIBLE_ZONE:
83 aRes = new HYDROData_ImmersibleZone( *dynamic_cast<HYDROData_ImmersibleZone*>( theObject ) );
88 aRes = new HYDROData_River( *dynamic_cast<HYDROData_River*>( theObject ) );
93 aRes = new HYDROData_Stream( *dynamic_cast<HYDROData_Stream*>( theObject ) );
98 aRes = new HYDROData_Confluence( *dynamic_cast<HYDROData_Confluence*>( theObject ) );
103 aRes = new HYDROData_Channel( *dynamic_cast<HYDROData_Channel*>( theObject ) );
108 aRes = new HYDROData_Obstacle( *dynamic_cast<HYDROData_Obstacle*>( theObject ) );
113 aRes = new HYDROData_Digue( *dynamic_cast<HYDROData_Digue*>( theObject ) );
118 aRes = new HYDROData_Profile( *dynamic_cast<HYDROData_Profile*>( theObject ) );
123 aRes = new HYDROData_ProfileUZ( *dynamic_cast<HYDROData_ProfileUZ*>( theObject ) );
126 case KIND_POLYLINEXY:
128 aRes = new HYDROData_PolylineXY( *dynamic_cast<HYDROData_PolylineXY*>( theObject ) );
131 case KIND_CALCULATION:
133 aRes = new HYDROData_CalculationCase( *dynamic_cast<HYDROData_CalculationCase*>( theObject ) );
138 aRes = new HYDROData_Region( *dynamic_cast<HYDROData_Region*>( theObject ) );
143 aRes = new HYDROData_Zone( *dynamic_cast<HYDROData_Zone*>( theObject ) );
146 case KIND_SHAPES_GROUP:
148 aRes = new HYDROData_ShapesGroup( *dynamic_cast<HYDROData_ShapesGroup*>( theObject ) );
151 case KIND_SPLITTED_GROUP:
153 aRes = new HYDROData_SplittedShapesGroup( *dynamic_cast<HYDROData_SplittedShapesGroup*>( theObject ) );
156 case KIND_OBSTACLE_ALTITUDE:
158 aRes = new HYDROData_ObstacleAltitude( *dynamic_cast<HYDROData_ObstacleAltitude*>( theObject ) );
161 case KIND_STREAM_ALTITUDE:
163 aRes = new HYDROData_StreamAltitude( *dynamic_cast<HYDROData_StreamAltitude*>( theObject ) );
171 Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject )
173 Handle(HYDROData_Entity) aRes = copyObject( theObject );
177 HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject )
179 HYDROData_Entity* aRes = NULL;
181 if ( !theObject.IsNull() )
182 aRes = copyObject( theObject.operator->() );
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)] ;
195 Handle(HYDROData_Document) aDocument;
197 Py_BEGIN_ALLOW_THREADS
198 aDocument = HYDROData_Document::Document( a0 );
201 if ( !aDocument.IsNull() )
202 sipRes = aDocument.operator->();
206 //! Returns true if data model contains document for this study
207 static bool HasDocument( const int theStudyID );
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 );
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 );
220 //! Removes document data
223 //! Starts a new operation (opens a tansaction)
224 void StartOperation();
226 //! Finishes the previously started operation (closes the transaction)
227 //void CommitOperation(
228 // const TCollection_ExtendedString& theName = TCollection_ExtendedString() );
230 //! Aborts the operation
231 void AbortOperation();
233 //! Returns true if operation has been started, but not yet finished or aborted
236 //! Returns true if document was modified (since creation/opening)
239 //! Returns True if there are available Undos
242 //! Returns a list of stored undo actions
243 //const TDF_DeltaList& GetUndos();
245 //! Clears a list of stored undo actions
248 //! Undoes last operation
251 //! Returns True if there are available Redos
254 //! Returns a list of stored undo actions
255 //const TDF_DeltaList& GetRedos();
257 //! Clears a list of stored undo actions
260 //! Redoes last operation
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)] ;
269 Handle(HYDROData_Entity) anObject;
270 Py_BEGIN_ALLOW_THREADS
271 anObject = sipSelfWasArg ? sipCpp->HYDROData_Document::CreateObject( a0 ) :
272 sipCpp->CreateObject( a0 );
275 sipRes = createPointer( anObject );
279 HYDROData_Entity FindObjectByName( const QString& theName,
280 const ObjectKind theKind = KIND_UNKNOWN )
281 [Handle_HYDROData_Entity (const QString&, const ObjectKind)] ;
284 Handle(HYDROData_Entity) anObject;
285 Py_BEGIN_ALLOW_THREADS
286 anObject = sipSelfWasArg ? sipCpp->HYDROData_Document::FindObjectByName( *a0, a1 ) :
287 sipCpp->FindObjectByName( *a0, a1 );
290 sipRes = createPointer( anObject );
294 HYDROData_SequenceOfObjects FindObjectsByNames( const QStringList& theNames,
295 const ObjectKind theKind = KIND_UNKNOWN );
297 void SetLocalCS( double, double );
299 //! Get the appropriate interpolator by the name.
300 HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
302 //! Get list of registered interpolator names.
303 NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
307 //! Creates new document: private because "Document" method must be used instead of direct creation.
308 HYDROData_Document();
310 //! Deletes all high-level data, managed this document
311 ~HYDROData_Document();