1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 #include <HYDROData_Document.h>
28 HYDROData_Entity* copyObject( HYDROData_Entity* theObject );
29 Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject );
30 HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject );
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
42 class HYDROData_Document
45 #include <HYDROData_Document.h>
48 %ConvertToSubClassCode
49 if ( !Handle(HYDROData_Document)::DownCast( sipCpp ).IsNull() )
50 sipClass = sipClass_HYDROData_Document;
57 HYDROData_Entity* copyObject( HYDROData_Entity* theObject )
59 HYDROData_Entity* aRes = NULL;
60 if ( theObject == NULL )
63 switch( theObject->GetKind() )
67 aRes = new HYDROData_Image( *dynamic_cast<HYDROData_Image*>( theObject ) );
72 aRes = new HYDROData_Bathymetry( *dynamic_cast<HYDROData_Bathymetry*>( theObject ) );
75 /* case KIND_ALTITUDE:
77 aRes = new HYDROData_AltitudeObject( *dynamic_cast<HYDROData_AltitudeObject*>( theObject ) );
80 case KIND_OBSTACLE_ALTITUDE:
82 aRes = new HYDROData_ObstacleAltitude( *dynamic_cast<HYDROData_ObstacleAltitude*>( theObject ) );
85 case KIND_IMMERSIBLE_ZONE:
87 aRes = new HYDROData_ImmersibleZone( *dynamic_cast<HYDROData_ImmersibleZone*>( theObject ) );
92 aRes = new HYDROData_Polyline3D( *dynamic_cast<HYDROData_Polyline3D*>( theObject ) );
97 aRes = new HYDROData_Profile( *dynamic_cast<HYDROData_Profile*>( theObject ) );
102 aRes = new HYDROData_ProfileUZ( *dynamic_cast<HYDROData_ProfileUZ*>( theObject ) );
105 case KIND_POLYLINEXY:
107 aRes = new HYDROData_PolylineXY( *dynamic_cast<HYDROData_PolylineXY*>( theObject ) );
110 case KIND_CALCULATION:
112 aRes = new HYDROData_CalculationCase( *dynamic_cast<HYDROData_CalculationCase*>( theObject ) );
117 aRes = new HYDROData_Obstacle( *dynamic_cast<HYDROData_Obstacle*>( theObject ) );
122 aRes = new HYDROData_Region( *dynamic_cast<HYDROData_Region*>( theObject ) );
127 aRes = new HYDROData_Zone( *dynamic_cast<HYDROData_Zone*>( theObject ) );
132 aRes = new HYDROData_Channel( *dynamic_cast<HYDROData_Channel*>( theObject ) );
140 Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject )
142 Handle(HYDROData_Entity) aRes = copyObject( theObject );
146 HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject )
148 HYDROData_Entity* aRes = NULL;
150 if ( !theObject.IsNull() )
151 aRes = copyObject( theObject.operator->() );
160 //! Returns the existing document or creates new if it is not exist
161 static HYDROData_Document Document( const int theStudyID ) [Handle_HYDROData_Document (const int)] ;
164 Handle(HYDROData_Document) aDocument;
166 Py_BEGIN_ALLOW_THREADS
167 aDocument = HYDROData_Document::Document( a0 );
170 if ( !aDocument.IsNull() )
171 sipRes = aDocument.operator->();
175 //! Returns true if data model contains document for this study
176 static bool HasDocument( const int theStudyID );
178 //! Loads the OCAF document from the file.
179 //! \param theFileName full name of the file to load
180 //! \param theStudyID identifier of the SALOME study to associate with loaded file
181 //! \returns error status (OK in case of success)
182 static Data_DocError Load( const char* theFileName, const int theStudyID );
184 //! Saves the OCAF document to the file.
185 //! \param theFileName full name of the file to store
186 //! \returns error status (OK in case of success)
187 Data_DocError Save( const char* theFileName );
189 //! Removes document data
192 //! Starts a new operation (opens a tansaction)
193 void StartOperation();
195 //! Finishes the previously started operation (closes the transaction)
196 //void CommitOperation(
197 // const TCollection_ExtendedString& theName = TCollection_ExtendedString() );
199 //! Aborts the operation
200 void AbortOperation();
202 //! Returns true if operation has been started, but not yet finished or aborted
205 //! Returns true if document was modified (since creation/opening)
208 //! Returns True if there are available Undos
211 //! Returns a list of stored undo actions
212 //const TDF_DeltaList& GetUndos();
214 //! Clears a list of stored undo actions
217 //! Undoes last operation
220 //! Returns True if there are available Redos
223 //! Returns a list of stored undo actions
224 //const TDF_DeltaList& GetRedos();
226 //! Clears a list of stored undo actions
229 //! Redoes last operation
232 //! Creates and locates in the document a new object
233 //! \param theKind kind of the created object, can not be UNKNOWN
234 //! \returns the created object
235 HYDROData_Entity CreateObject( const ObjectKind theKind ) [Handle_HYDROData_Entity (const ObjectKind)] ;
238 Handle(HYDROData_Entity) anObject;
239 Py_BEGIN_ALLOW_THREADS
240 anObject = sipSelfWasArg ? sipCpp->HYDROData_Document::CreateObject( a0 ) :
241 sipCpp->CreateObject( a0 );
244 sipRes = createPointer( anObject );
250 //! Creates new document: private because "Document" method must be used instead of direct creation.
251 HYDROData_Document();
253 //! Deletes all high-level data, managed this document
254 ~HYDROData_Document();