-// Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2019 CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
{
/*! \brief Name of the file in which the %Study is saved.
*/
- typedef string URLPath;
+ typedef wstring URLPath;
/*! \brief Main identifier of an object in %SALOME application
*/
*/
SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
+
/*! \brief Definition of the instance to the %SComponent
Defines the instance to the %SComponent.
void RemoveReference(in SObject anObject) ;
-/*!
- Adds a directory in the %Study.
- \param theName String parameter defining the name of the directory.
-
-<em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
-
-*/
- void AddDirectory(in string theName) raises(LockProtection);
-
/*! \brief Identification of the %SObject's substructure.
Identification of the %SObject's substructure by GUID.
\param anObject The %SObject which will be identified
\param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
*/
-
- void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
+ void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
/*!
Searches for a definite %SObject with a definite GUID and returns True if it finds it.
Returns True if at this moment there is a command under execution.
*/
boolean HasOpenCommand();
-/*! \brief Cancelation of the command
+/*! \brief Cancellation of the command
Cancels all actions declared within the command.
//! Invalid study reference
exception StudyInvalidReference {};
-//! Invalid study context
- exception StudyInvalidContext {};
//! Invalid study component
exception StudyInvalidComponent {};
//! Invalid directory of the %study exception
exception StudyNameError {};
//! Invalid study comment
exception StudyCommentError {};
-
+
/*!
Determines whether the server has already been loaded or not.
*/
This is equivalent to the methods setName() & getName()
*/
- readonly attribute string Name; // equivalent to getName()
+ attribute wstring Name; // equivalent to getName()
+
+/*! \brief Indicate the file where the %study has been saved
+*/
//! Sequence containing %SObjects
typedef sequence<SObject> ListOfSObject;
//! Get the persistent reference to the %Study.
PersistentReference GetPersistentReference() raises(StudyInvalidReference);
-//! Get a transient reference to the %Study.
- SalomeReference GetTransientReference() raises(StudyInvalidReference);
/*! \brief indicate whether the %Study is empty
*/
string GetObjectPath(in Object theObject) raises(StudyInvalidReference);
-/*! \brief Set the context of the %Study.
-
- \param thePath String parameter defining the context of the study.
-
-<em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
-*/
- void SetContext(in string thePath) raises (StudyInvalidReference, StudyInvalidContext);
-/*! \brief Get the context of the %Study.
-
-<em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
-*/
- string GetContext() raises (StudyInvalidReference, StudyInvalidContext);
-/*! \brief Get a list of names of objects corresponding to the context.
-
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetObjectNames(in string theContext) raises (StudyInvalidReference, StudyInvalidContext);
-/*! \brief Get a list of names of directories and subdirectories corresponding to the context.
-
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetDirectoryNames(in string theContext) raises (StudyInvalidReference, StudyInvalidContext);
-/*! \brief Get a list of names of Files corresponding to the context.
-
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetFileNames(in string theContext) raises (StudyInvalidReference, StudyInvalidContext);
-/*! \brief Get a list of names of Components corresponding to the context.
-
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetComponentNames(in string theContext) raises(StudyInvalidReference);
/*! \brief Create a new iterator of child levels of the given %SObject.
\param aSO The given %SObject
/*! \brief Indicate the file where the %study has been saved
*/
- attribute string URL;
+ attribute wstring URL;
/*! \brief List of %SObjects
/*! \brief Get a new %UseCaseBuilder.
*/
UseCaseBuilder GetUseCaseBuilder() raises(StudyInvalidReference);
-
+
/*! \brief Clear a study object
*/
void Clear() raises(StudyInvalidReference);
/*! \brief Initialization a study object
*/
void Init() raises(StudyInvalidReference);
-
+
/*! \brief Open a study by url
Reads and activates the structure of the study %Objects.
\param aStudyUrl The path to the study
*/
boolean Open (in URLPath aStudyUrl) raises (SALOME::SALOME_Exception);
-
-/*! \brief Saving the study in a HDF file (or files).
+
+/*! \brief Saving the study in a file (or files).
Saves a study.
\param theMultiFile If this parameter is True the study will be saved in several files.
+ \param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
*/
- boolean Save(in boolean theMultiFile) raises(StudyInvalidReference);
-
-/*! \brief Saving a study in a ASCII file (or files).
+ boolean Save(in boolean theMultiFile, in boolean theASCII) raises(StudyInvalidReference);
- Saves a study in an ASCII format file (or files).
- \param theMultiFile If this parameter is True the study will be saved in several files.
-*/
- boolean SaveASCII(in boolean theMultiFile) raises(StudyInvalidReference);
-/*! \brief Saving the study in a specified HDF file (or files).
+/*! \brief Saving the study in a specified file (or files).
Saves the study in a specified file (or files).
- \param aUrl The path to the definite file in whcih the study will be saved
- \param aStudy The study which will be saved
+ \param aUrl The path to the definite file in which the study will be saved
\param theMultiFile If this parameter is True the study will be saved in several files.
+ \param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean SaveAs(in URLPath aUrl, // if the file already exists
- in boolean theMultiFile) // overwrite (as option)
- raises(StudyInvalidReference);
-/*! \brief Saving the study in a specified ASCII file (or files).
-
- Saves the study in a specified ASCII file (or files).
-
- \param aUrl The path to the definite file in whcih the study will be saved
- \param aStudy The study which will be saved
- \param theMultiFile If this parameter is True the study will be saved in several files.
-*/
- boolean SaveAsASCII(in URLPath aUrl, // if the file already exists
- in boolean theMultiFile) // overwrite (as option)
- raises(StudyInvalidReference);
+ in boolean theMultiFile, // overwrite (as option)
+ in boolean theASCII)
+ raises(StudyInvalidReference);
/*!
Returns True, if the given %SObject can be copied to the clipboard.
*/
*/
ListOfAttributes GetAllAttributes();
-/*! Gets the study of a given %SObject.
- \return The study containing the given %SObject.
-*/
- Study GetStudy();
-
/*! Gets the CORBA object by its own IOR attribute.
Returns nil, if can't.
\return The CORBA object of the %SObject.
<ul>
<li> publishing in the study of the objects created by a definite component
<li> saving/loading of the data created by a definite component. These methods are called when loading/saving a study containing the data created by a definite component.
- <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
+ <li> transforming of the transient references into persistent references (or vice versa) of the SObjects when saving (or loading) a study
<li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
</ul>
