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 ) );
135 Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject )
137 Handle(HYDROData_Entity) aRes = copyObject( theObject );
141 HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject )
143 HYDROData_Entity* aRes = NULL;
145 if ( !theObject.IsNull() )
146 aRes = copyObject( theObject.operator->() );
155 //! Returns the existing document or creates new if it is not exist
156 static HYDROData_Document Document( const int theStudyID ) [Handle_HYDROData_Document (const int)] ;
159 Handle(HYDROData_Document) aDocument;
161 Py_BEGIN_ALLOW_THREADS
162 aDocument = HYDROData_Document::Document( a0 );
165 if ( !aDocument.IsNull() )
166 sipRes = aDocument.operator->();
170 //! Returns true if data model contains document for this study
171 static bool HasDocument( const int theStudyID );
173 //! Loads the OCAF document from the file.
174 //! \param theFileName full name of the file to load
175 //! \param theStudyID identifier of the SALOME study to associate with loaded file
176 //! \returns error status (OK in case of success)
177 static Data_DocError Load( const char* theFileName, const int theStudyID );
179 //! Saves the OCAF document to the file.
180 //! \param theFileName full name of the file to store
181 //! \returns error status (OK in case of success)
182 Data_DocError Save( const char* theFileName );
184 //! Removes document data
187 //! Starts a new operation (opens a tansaction)
188 void StartOperation();
190 //! Finishes the previously started operation (closes the transaction)
191 //void CommitOperation(
192 // const TCollection_ExtendedString& theName = TCollection_ExtendedString() );
194 //! Aborts the operation
195 void AbortOperation();
197 //! Returns true if operation has been started, but not yet finished or aborted
200 //! Returns true if document was modified (since creation/opening)
203 //! Returns True if there are available Undos
206 //! Returns a list of stored undo actions
207 //const TDF_DeltaList& GetUndos();
209 //! Clears a list of stored undo actions
212 //! Undoes last operation
215 //! Returns True if there are available Redos
218 //! Returns a list of stored undo actions
219 //const TDF_DeltaList& GetRedos();
221 //! Clears a list of stored undo actions
224 //! Redoes last operation
227 //! Creates and locates in the document a new object
228 //! \param theKind kind of the created object, can not be UNKNOWN
229 //! \returns the created object
230 HYDROData_Entity CreateObject( const ObjectKind theKind ) [Handle_HYDROData_Entity (const ObjectKind)] ;
233 Handle(HYDROData_Entity) anObject;
234 Py_BEGIN_ALLOW_THREADS
235 anObject = sipSelfWasArg ? sipCpp->HYDROData_Document::CreateObject( a0 ) :
236 sipCpp->CreateObject( a0 );
239 sipRes = createPointer( anObject );
245 //! Creates new document: private because "Document" method must be used instead of direct creation.
246 HYDROData_Document();
248 //! Deletes all high-level data, managed this document
249 ~HYDROData_Document();