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_Polyline( *dynamic_cast<HYDROData_Polyline*>( theObject ) );
77 aRes = new HYDROData_Bathymetry( *dynamic_cast<HYDROData_Bathymetry*>( theObject ) );
80 case KIND_IMMERSIBLE_ZONE:
82 aRes = new HYDROData_ImmersibleZone( *dynamic_cast<HYDROData_ImmersibleZone*>( theObject ) );
85 case KIND_CALCULATION:
87 aRes = new HYDROData_CalculationCase( *dynamic_cast<HYDROData_CalculationCase*>( theObject ) );
92 aRes = new HYDROData_Region( *dynamic_cast<HYDROData_Region*>( theObject ) );
97 aRes = new HYDROData_Zone( *dynamic_cast<HYDROData_Zone*>( theObject ) );
105 Handle(HYDROData_Entity) createHandle( HYDROData_Entity* theObject )
107 Handle(HYDROData_Entity) aRes = copyObject( theObject );
111 HYDROData_Entity* createPointer( const Handle(HYDROData_Entity)& theObject )
113 HYDROData_Entity* aRes = NULL;
115 if ( !theObject.IsNull() )
116 aRes = copyObject( theObject.operator->() );
125 //! Returns the existing document or creates new if it is not exist
126 static HYDROData_Document Document( const int theStudyID ) [Handle_HYDROData_Document (const int)] ;
129 Handle(HYDROData_Document) aDocument;
131 Py_BEGIN_ALLOW_THREADS
132 aDocument = HYDROData_Document::Document( a0 );
135 if ( !aDocument.IsNull() )
136 sipRes = aDocument.operator->();
140 //! Returns true if data model contains document for this study
141 static bool HasDocument( const int theStudyID );
143 //! Loads the OCAF document from the file.
144 //! \param theFileName full name of the file to load
145 //! \param theStudyID identifier of the SALOME study to associate with loaded file
146 //! \returns error status (OK in case of success)
147 static Data_DocError Load( const char* theFileName, const int theStudyID );
149 //! Saves the OCAF document to the file.
150 //! \param theFileName full name of the file to store
151 //! \returns error status (OK in case of success)
152 Data_DocError Save( const char* theFileName );
154 //! Removes document data
157 //! Starts a new operation (opens a tansaction)
158 void StartOperation();
160 //! Finishes the previously started operation (closes the transaction)
161 //void CommitOperation(
162 // const TCollection_ExtendedString& theName = TCollection_ExtendedString() );
164 //! Aborts the operation
165 void AbortOperation();
167 //! Returns true if operation has been started, but not yet finished or aborted
170 //! Returns true if document was modified (since creation/opening)
173 //! Returns True if there are available Undos
176 //! Returns a list of stored undo actions
177 //const TDF_DeltaList& GetUndos();
179 //! Clears a list of stored undo actions
182 //! Undoes last operation
185 //! Returns True if there are available Redos
188 //! Returns a list of stored undo actions
189 //const TDF_DeltaList& GetRedos();
191 //! Clears a list of stored undo actions
194 //! Redoes last operation
197 //! Creates and locates in the document a new object
198 //! \param theKind kind of the created object, can not be UNKNOWN
199 //! \returns the created object
200 HYDROData_Entity CreateObject( const ObjectKind theKind ) [Handle_HYDROData_Entity (const ObjectKind)] ;
203 Handle(HYDROData_Entity) anObject;
204 Py_BEGIN_ALLOW_THREADS
205 anObject = sipSelfWasArg ? sipCpp->HYDROData_Document::CreateObject( a0 ) :
206 sipCpp->CreateObject( a0 );
209 sipRes = createPointer( anObject );
215 //! Creates new document: private because "Document" method must be used instead of direct creation.
216 HYDROData_Document();
218 //! Deletes all high-level data, managed this document
219 ~HYDROData_Document();