-// Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2020 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
*/
*/
typedef string SalomeReference;
+//! List of file names
+ typedef sequence<string> ListOfFileNames;
//! List of modification dates of a study
typedef sequence<string> ListOfDates ;
//! An unbounded sequence of strings
*/
SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
+
/*! \brief Definition of the instance to the %SComponent
Defines the instance to the %SComponent.
\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.
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;
/*! \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 Check if study can be opened
+
+ Tries to open and read given url.
+ \param aStudyUrl The path to the study
+*/
+ boolean CanOpen (in URLPath aStudyUrl);
+
/*! \brief Saving the study in a file (or files).
Saves a study.
\param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
*/
boolean Save(in boolean theMultiFile, in boolean theASCII) raises(StudyInvalidReference);
-
+
/*! \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 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.
*/
boolean SaveAs(in URLPath aUrl, // if the file already exists
in boolean theMultiFile, // overwrite (as option)
- in boolean theASCII)
- raises(StudyInvalidReference);
+ in boolean theASCII)
+ raises(StudyInvalidReference);
/*!
Returns True, if the given %SObject can be copied to the clipboard.
*/
in boolean isPublished,
in boolean isMultiFile) raises(StudyInvalidReference);
+/*! \brief Returns the folder of the python script which is currently dumped.
+*/
+ string GetDumpPath();
+
/*! \brief Get an AttributeParameter used to store common parameters for given %theSavePoint.
\param theID identifies a common parameters set (Example: "Interface Applicative")
Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
*/
boolean AppendTo(in SObject theFather, in SObject theObject);
+/*!
+ Return index of a child among father children
+*/
+ long GetIndexInFather(in SObject theFather, in SObject theObject);
/*!
Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
*/
<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>
