-// Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-//
-// This library is free software; you can redistribute it and/or
-// modify it under the terms of the GNU Lesser General Public
-// License as published by the Free Software Foundation; either
-// version 2.1 of the License.
-//
-// This library is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-// Lesser General Public License for more details.
-//
-// You should have received a copy of the GNU Lesser General Public
-// License along with this library; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-//
-// See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
+// 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
//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
// File : SALOMEDS.idl
// Author : Yves FRICAUD
-// $Header$
-
-/*! \mainpage
- \image html Application-About.png
-
-*/
-/*! \page page1 Mapping of IDL definitions to Python language.
-\section Intro Introduction
-%SALOME PRO is a distributed client/server application using the Common Object Request Broker Architecture (CORBA).
-CORBA architecture uses the Interface Definition Language (IDL), which specifies interfaces between CORBA objects. So with help of IDL
-CORBA's language independence is ensured . Because interfaces described in IDL can be mapped to the most of currently used programming languages, CORBA applications and components are thus
-independent of the language(s) used to implement them. In other words, a client written in C++ can communicate with a server written in Java, which in turn can communicate with
-another server written in COBOL, and so forth.
-
-One important thing to remember about IDL is that it is not an implementation language. That is, applications can't be written in IDL. The sole purpose of IDL is to define interfaces;
-providing implementations for these interfaces is performed using some other language.
-
-This page contains an abridged reference manual for mapping of IDL definitions to Python language. It will be useful for Python programmers who are not familiar
-with IDL language. All examples are taken from %SALOME PRO source files.
-The complete version of Python Language Mapping Specification can be found <A HREF="http://www.omg.org">here.</A>
-
-<BR><STRONG>CONTENTS:</STRONG>
-- \ref subsection1
-- \ref subsection2
-- \ref subsection3
-- \ref subsection4
-- \ref subsection5
-- \ref subsection6
-- \ref subsection7
-
-\subsection subsection1 Using Scoped Names
-
-Python implements a module concept that is similar to the IDL scoping mechanisms,
-except that it does not allow for nested modules. In addition, Python requires each
-object to be implemented in a module; globally visible objects are not supported.
-
-Because of these constraints, scoped names are translated into Python using the
-following rules:
-
-\95 An IDL module mapped into a Python module. Modules containing modules are
-mapped to packages (i.e., directories with an <STRONG>__init__</STRONG> module containing all
-definitions excluding the nested modules). An implementation can chose to map toplevel
-definitions (including the module CORBA) to modules in an implementationdefined
-package, to allow concurrent installations of different CORBA runtime
-libraries. In that case, the implementation must provide additional modules so that
-toplevel modules can be used without importing them from a package.
-
-\95 For all other scopes, a Python class is introduced that contains all the definitions
-inside this scope.
-
-\95 Other global definitions (except modules) appear in a module whose name is
-implementation dependent. Implementations are encouraged to use the name of the
-IDL file when defining the name of that module.
-
-For instance,
-
-\verbatim
-module SALOMEDS {
- interface StudyManager {
- void Close(in Study aStudy);
- };
-};
-\endverbatim
+//
+/*! \file SALOMEDS.idl \brief This file contains a set of interfaces used for creation, management
+ and modification of the %Study
+*/
-would introduce a module SALOMEDS.py, which contains the following definitions:
+#ifndef _SALOMEDS_IDL_
+#define _SALOMEDS_IDL_
-\verbatim
-# module SALOMEDS.py
-class StudyManager:
- def _Close(self,aStudy):
- pass #interfaces are discussed later
-\endverbatim
+#include "SALOME_Exception.idl"
+#include "SALOME_GenericObj.idl"
-To avoid conflicts, IDL names that are also Python identifiers are prefixed with an underscore (\91_\92).
+/*! \brief
+ This package contains the interfaces used for creation, management
+ and modification of the %Study
+*/
+module SALOMEDS
+{
+/*! \brief Name of the file in which the %Study is saved.
+*/
+ typedef wstring URLPath;
-\subsection subsection2 Mapping for Template and Array Types
+/*! \brief Main identifier of an object in %SALOME application
+*/
+ typedef string ID;
-Both the bounded and the unbounded string type of IDL are mapped to the Python
-string type. Wide strings are represented by an implementation-defined type with the
-following properties:
+/*! \brief While saving the data, IOR is transformed into persistent reference
+*/
+ typedef string PersistentReference;
-\95 For the wide string X and the integer n, X[n] returns the nth character, which is a
-wide string of length 1.
+/*! \brief IOR of the study in %SALOME application
+*/
+ typedef string SalomeReference;
-\95 len(X) returns the number of characters of wide string X.
+//! List of file names
+ typedef sequence<string> ListOfFileNames;
+//! List of modification dates of a study
+ typedef sequence<string> ListOfDates ;
+//! An unbounded sequence of strings
+ typedef sequence<string> ListOfStrings ;
+//! An unbounded sequence of sequence of strings
+ typedef sequence<ListOfStrings> ListOfListOfStrings ;
+//! A byte stream which is used for binary data transfer between different components
+ typedef sequence<octet> TMPFile;
-\95 CORBA.wstr(c) returns a wide character with the code point c in an
-implementation-defined encoding.
+ // Reference to other objects is treated with function AddReference
+ // and ReferencedObject
+ // All other type of attributes defined in AttributeType enum are
+ // treated with AddAdttribute and GetAttribute
+ // The difference is made because Reference attribute don't contain
+ // strings but reference to ID of other objects
-\95 X+Y returns the concatenation of wide strings X and Y.
+ interface GenericAttribute;
+ interface Study;
+ interface StudyBuilder;
+ interface SObject;
+ interface SComponent;
+ interface SComponentIterator;
+ interface ChildIterator;
+ interface Driver;
+ interface AttributeStudyProperties;
+ interface AttributeParameter;
+ interface UseCaseIterator;
+ interface UseCaseBuilder;
-\95 CORBA.word(CORBA.wstr(c)) == c
+ interface Observer
+ {
+ oneway void notifyObserverID(in string theID, in long event);
+ };
-The sequence template is mapped to sequence objects (e.g., tuples or lists).
-Applications should not assume that values of a sequence type are mutable. Sequences
-and arrays of octets and characters are mapped to the string type for efficiency reasons.
-For example, given the IDL definitions
+//! List of attributes of %SObjects
+ typedef sequence<GenericAttribute> ListOfAttributes;
-\verbatim
-module SALOMEDS {
- typedef sequence <string> StringSeq;
-
- interface AttributeTableOfInteger : GenericAttribute {
+//! Exception indicating that this feature hasn't been implemented in %SALOME application.
+ exception NotImplemented {};
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
- };
-};
-\endverbatim
+ //==========================================================================
+/*! \brief %Study Builder Interface
-a client could invoke the operation
+ The purpose of the Builder is to add and/or remove objects and attributes.
+ A %StudyBuilder is linked to a %Study. A
+ command management is provided for the undo/redo functionalities.
+ \note
+ <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
+ item's position in the tree-type structure of the browser. In general it has the following
+ form: <TT>0:2:1:1</TT>
+*/
+ //==========================================================================
-\verbatim
-print My_AttributeTableOfInteger.SetRowTitles(["X","F"])
-\endverbatim
+ interface StudyBuilder
+ {
+/*! \brief %LockProtection Exception
-Array types are mapped like sequence templates. The application in this example also expects an
-IncorrectArgumentLength exception if it passes sequences that violate the bounds constraint or
-arrays of wrong size.
+ This exception is raised while attempting to modify a locked %study.
+*/
+ exception LockProtection {};
+/*! \brief Creation of a new %SComponent.
-Another example with arrays. The following IDL definition
+ Creates a new %SComponent
+ \param ComponentDataType Data type of the %SComponent which will be created.
-\verbatim
-module SALOMEDS {
- typedef sequence<GenericAttribute> ListOfAttributes;
- interface SObject {
- ListOfAttributes GetAllAttributes();
- };
-};
-\endverbatim
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
-is equal to
+*/
+ SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
-\verbatim
-import SALOMEDS
+/*! \brief Definition of the instance to the %SComponent
-attributes=[]
-
-attributes = My_SObject.GetAllAttributes()
+ Defines the instance to the %SComponent.
+*/
+ void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
-length = len(attributes)
+/*! \brief Deletion of a %SComponent
-print "Attributes number = ", length
-print attributes
-\endverbatim
+ Removes a %SComponent.
+*/
+ void RemoveComponent(in SComponent aComponent) raises(LockProtection);
-\subsection subsection3 Mapping for Objects and Operations
+/*! \brief Creation of a new %SObject
-A CORBA object reference is represented as a Python object at run-time. This object
-provides all the operations that are available on the interface of the object. Although
-this specification does not mandate the use of classes for stub objects, the following
-discussion uses classes to indicate the interface.
+ Creates a new %SObject under a definite father %SObject.
-The nil object is represented by <STRONG>None</STRONG>.
+ \param theFatherObject The father %SObject under which this one should be created.
+ \return New %SObject
-If an operation expects parameters of the IDL Object type, any Python object
-representing an object reference might be passed as actual argument.
+<em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
-If an operation expects a parameter of an abstract interface, either an object
-implementing that interface, or a value supporting this interface may be passed as
-actual argument. The semantics of abstract values then define whether the argument is
-passed by value or by reference.
+*/
-Operations of an interface map to methods available on the object references.
-Parameters with a parameter attribute of <STRONG>in</STRONG> or <STRONG>inout</STRONG>
-are passed from left to right tothe method, skipping <STRONG>out</STRONG> parameters.
-The return value of a method depends on the number of <STRONG>out</STRONG> parameters
-and the return type. If the operation returns a value, this
-value forms the first <VAR>result value</VAR>. All <STRONG>inout</STRONG> or <STRONG>out</STRONG>
-parameters form consecutive <VAR>result values</VAR>. The method result depends then on the number
-of <VAR>result values</VAR>:
+ SObject NewObject (in SObject theFatherObject) raises(LockProtection);
-\95 If there is no <VAR>result value</VAR>, the method returns None.
+/*! \brief Creation of a new %SObject with a definite %tag
-\95 If there is exactly one <VAR>result value</VAR>, it is returned as a single value.
+ Creates a new %SObject with a definite %tag.
-\95 If there is more than one <VAR>result value</VAR>, all of them are packed into a tuple, and this
-tuple is returned.
+ \param atag Long value corresponding to the tag of the new %SObject.
+ \return New %SObject
-Assuming the IDL definition
+*/
+ SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
+/*! \brief Deletion of the %SObject
-\verbatim
-module SALOMEDS{
- interface StudyBuilder{
- boolean FindAttribute ( in SObject anObject,
- out GenericAttribute anAttribute,
- in string aTypeOfAttribute );
- };
-};
-\endverbatim
-
-a client could write
-
-\verbatim
-from SALOMEDS import StudyBuilder;
-my_StudyBuilder=...
-
- res,A=my_StudyBuilder.FindAttribute(Sobj, "AttributeSequenceOfReal")
-\endverbatim
-
-In this example <STRONG>A</STRONG> corresponds to the return value <STRONG>anAttribute</STRONG> and
-<STRONG>res</STRONG> to the <STRONG>boolean</STRONG> return value.
-
-If an interface defines an <STRONG>attribute name</STRONG>, for example, the attribute is mapped into an
-operation <STRONG>_get_name</STRONG>. If the attribute is not <STRONG>readonly</STRONG>, there is an
-additional operation <STRONG>_set_name</STRONG>.
-
-The IDL definition
-
-\verbatim
-module SALOMEDS{
- interface Study{
- attribute string Name;
- };
-};
-\endverbatim
-
-is equal to the following
-
-\verbatim
-from SALOMEDS import Study
-My_Study=...
- Name=My_Study._get_name();
- Name=My_Study._set_name();
-\endverbatim
-
-\subsection subsection4 Narrowing Object References
-
-Python objects returned from CORBA operations or pseudo-operations (such as
-string_to_object) might have a dynamic type, which is more specific than the
-static type as defined in the operation signature.
-
-Since there is no efficient and reliable way of automatically creating the most specific
-type, explicit narrowing is necessary. To narrow an object reference <STRONG>A</STRONG> to an interface
-class <STRONG>AttributeSequenceOfReal</STRONG>, the client can use the following operation
-
-\verbatim
-A = A._narrow(SALOMEDS.AttributeSequenceOfReal)
-\endverbatim
-
-\subsection subsection5 Mapping for Exceptions
-
-An IDL exception is translated into a Python class derived from
-CORBA.UserException. System exceptions are derived from CORBA.SystemException.
-Both base classes are derived from CORBA.Exception. The parameters of the
-exception are mapped in the same way as the fields of a struct definition. When
-raising an exception, a new instance of the class is created; the constructor
-expects the exception parameters. For example, the definition
-
-\verbatim
-module SALOMEDS{
- interface StudyBuilder{
- exception LockProtection {};
- void CommitCommand() raises(LockProtection);
- };
-};
-\endverbatim
-
-could be used caught as
-
-\verbatim
-from SALOMEDS import StudyBuilder;
-my_StudyBuilder=...
-try:
- my_StudyBuilder.CommitCommand();
-except StudyBuilder.LockProtection,value:
- print "Error! Study is locked for modifications"
-\endverbatim
-
-
-\subsection subsection6 Mapping for Enumeration Types
-
-An enumeration is mapped into a number of constant objects in the name space where
-the enumeration is defined. An application may only test for equivalence of two
-enumeration values, and not assume that they behave like numbers.
-For example, the definition
-
-\verbatim
-module VISU {
- interface PrsObject{
-
- enum PrsObjType{ TCURVE, TTABLE, TMESH, TCONTAINER,
- TSCALARMAP, TISOSURFACE, TDEFORMEDSHAPE,
- TCUTPLANES, TVECTORS };
- };
-};
-\endverbatim
+ Removes a %SObject from the %StudyBuilder.
-introduces the objects
+ \param anObject The %SObject to be deleted.
+*/
+ void RemoveObject (in SObject anObject) raises(LockProtection);
+/*! \brief Deletion of the %SObject with all his child objects.
-\verbatim
-from VISU import PrsObject
-VISU.PrsObjType.TCURVE,VISU.PrsObjType.TTABLE,VISU.PrsObjType.TMESH,VISU.PrsObjType.TCONTAINER,
-VISU.PrsObjType.TSCALARMAP,VISU.PrsObjType.TISOSURFACE,VISU.PrsObjType.TDEFORMEDSHAPE,VISU.PrsObjType.TCUTPLANES,
-VISU.PrsObjType.TVECTORS
-\endverbatim
+ Removes the %SObject with all his child objects.
-\subsection subsection7 Mapping for Structured Types
+ \param anObject The %SObject to be deleted with all child objects.
+*/
+ void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
-An IDL struct definition is mapped into a Python class or type. For each field in the
-struct, there is a corresponding attribute in the class with the same name as the field.
-The constructor of the class expects the field values, from left to right.
-For example, the IDL definition
+/*!
+ Loads a %SComponent.
-\verbatim
-struct SDate {
- short Second;
- short Minute;
- short Hour;
- short Day;
- short Month;
- short Year;
- };
-\endverbatim
+<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
-could be used in the Python statements
+*/
+ void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
+/*!
+ Loads a %SObject.
-\verbatim
-Date=SDate(30, 12, 15, 26, 1, 79)
-print Date.Second,Date.Minute,Date.Hour,Date.Day,Date.Month,Date.Year
-\endverbatim
+ \param sco %SObject to be loaded.
*/
-/*! \page page2 Mapping of SALOME IDL definitions to Python language.
+ void Load (in SObject sco);
+/*! \brief Looking for or creating an attribute assigned to the %SObject
- - <B>%SALOME STUDY module</B>
- - <A href=HTML/SALOMEDS.html>Mapping of %SALOMEDS functions</A>
- - <A href=HTML/SALOMEDS_Attributes.html>Mapping of SALOMEDS_Attributes functions</A>
- - <B>%SAlOME KERNEL module</B>
- - <A href=HTML/Med_Gen.html>Mapping of %Med_Gen functions</A>
- - <A href=HTML/SALOME_Session.html>Mapping of %SALOME_Session functions</A>
- - <A href=HTML/SALOME_ModuleCatalog.html>Mapping of %SALOME_ModuleCatalog functions</A>
- - <A href=HTML/SALOME_Exception.html>Mapping of %SALOME_Exception functions</A>
- - <A href=HTML/SALOME_Component.html>Mapping of %SALOME_Component functions</A>
- - <B>%SALOME MED component</B>
- - <A href=HTML/MED.html>Mapping of %Med functions</A>
- - <B>%SALOME SUPERVISION module</B>
- - <A href=HTML/SUPERV.html>Mapping of %SUPERV functions</A>
- - <B>%SALOME %VISU module</B>
- - <A href=HTML/VISU_Gen.html>Mapping of %VISU_Gen functions</A>
+ Allows to find or create an attribute of a specific type which is assigned to the object.
+ \param anObject The %SObject corresponding to the attribute which is looked for.
+ \param aTypeOfAttribute Type of the attribute.
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
-/*! \defgroup Study SALOME STUDY module
+ GenericAttribute FindOrCreateAttribute(in SObject anObject,
+ in string aTypeOfAttribute) raises(LockProtection);
+
+/*! \brief Looking for an attribute assigned to a %SObject
+
+ Allows to find an attribute of a specific type which is assigned to the object.
+ \param anObject The %SObject corresponding to the attribute which is looked for.
+ \param aTypeOfAttribute Type of the attribute.
+ \param anAttribute Where the attribute is placed if it's found.
+ \return True if it finds an attribute.
+ */
+
+ boolean FindAttribute(in SObject anObject,
+ out GenericAttribute anAttribute,
+ in string aTypeOfAttribute);
+/*! \brief Deleting the attribute assigned to the %SObject
+
+ Removes the attribute of a specific type which is assigned to the object.
+ \param anObject The %SObject corresponding to the attribute.
+ \param aTypeOfAttribute Type of the attribute.
+
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
+*/
+ void RemoveAttribute(in SObject anObject,
+ in string aTypeOfAttribute) raises(LockProtection);
+/*!
+ Adds a reference between %anObject and %theReferencedObject.
+ \param anObject The %SObject which will get a reference
+ \param theReferencedObject The %SObject having a reference
*/
+ void Addreference(in SObject anObject,
+ in SObject theReferencedObject) ;
+
/*!
- \file SALOMEDS.idl This file contains a set of interfaces used for creation, managment
- and modification of the %Study
+ Removes a reference from %anObject to another object.
+ \param anObject The %SObject which contains a reference
*/
-#ifndef _SALOMEDS_IDL_
-#define _SALOMEDS_IDL_
+ void RemoveReference(in SObject anObject) ;
-#include "SALOME_Exception.idl"
+/*! \brief Identification of the %SObject's substructure.
-/*! \ingroup Study
- This package contains the interfaces used for creation, managment
- and modification of the %Study
-*/
-module SALOMEDS
-{
-/*! \typedef URL
- Name of the file in which the %Study is saved.
+ 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"
*/
- typedef string URL;
+ 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.
-/*! Main identifier of an object in %SALOME application
+\param anObject A definite %SObject which will be identified
+\param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
*/
- typedef string ID;
+ boolean IsGUID(in SObject anObject, in string theGUID);
+
+/*! \brief Creation of a new command
+
+ Creates a new command which can contain several different actions.
+
+<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
-/*! While saving the data, IOR is transformed into persistent reference
*/
- typedef string PersistentReference;
+ void NewCommand(); // command management
+/*! \brief Execution of the command
+
+ Commits all actions declared within this command.
+
+ \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
+
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
-/*! IOR of the study in %SALOME application
*/
- typedef string SalomeReference;
-/*! List of names of open studies in a %SALOME session
+ void CommitCommand() raises(LockProtection); // command management
+/*!
+ Returns True if at this moment there is a command under execution.
*/
- typedef sequence<string> ListOfOpenStudies;
-/*! List of file names
+ boolean HasOpenCommand();
+/*! \brief Cancellation of the command
+
+ Cancels all actions declared within the command.
+
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- typedef sequence<string> ListOfFileNames;
-/*! List of modification dates of the study
+ void AbortCommand(); // command management
+/*! \brief Undolimit
+
+ The number of actions which can be undone
*/
- typedef sequence<string> ListOfDates ;
-/*! An unbounded sequence of strings
+ attribute long UndoLimit;
+/*! \brief Undo method
+
+ Cancels all actions of the last command.
+
+ \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
+
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
+
*/
- typedef sequence<string> ListOfStrings ;
-/*! A byte stream which is used for binary data transfer between components
+ void Undo() raises (LockProtection);
+/*! \brief Redo method
+
+ Redoes all actions of the last command.
+
+\exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
+
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
+
*/
- typedef sequence<octet> TMPFile;
+ void Redo() raises (LockProtection);
+/*!
+ Returns True if at this moment there are any actions which can be canceled.
- // Reference to other objects is treated with function AddReference
- // and ReferencedObject
- // All other type of attributes defined in AttributeType enum are
- // treated with AddAdttribute and GetAttribute
- // The difference is made because Reference attribute don't contain
- // strings but reference to ID of other objects
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
- interface GenericAttribute;
- interface Study;
- interface StudyManager;
- interface StudyBuilder;
- interface SObject;
- interface SComponent;
- interface SComponentIterator;
- interface ChildIterator;
- interface Driver;
- interface AttributeStudyProperties;
- interface UseCaseIterator;
- interface UseCaseBuilder;
- interface Callback;
-/*! List of attributes
*/
- typedef sequence<GenericAttribute> ListOfAttributes;
-/*! Exception indicating that this feature hasn't been implemented
+ boolean GetAvailableUndos();
+/*!
+ Returns True if at this moment there are any actions which can be redone.
+
+<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
+
*/
- exception NotImplemented {};
+ boolean GetAvailableRedos();
+/*!
+ Puts name attribute with the given string value to the given %SObject
+
+ \param theSO Existing SObject to set name attribute.
+ \param theValue The value to be set to the name attribute.
+*/
+ void SetName(in SObject theSO, in string theValue) raises (LockProtection);
+
+/*!
+ Puts comment attribute with the given string value to the given %SObject
+
+ \param theSO Existing SObject to set comment attribute.
+ \param theValue The value to be set to the comment attribute.
+*/
+ void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
+
+/*!
+ Puts IOR attribute with the given string value to the given %SObject
+ \param theSO Existing SObject to set IOR attribute.
+ \param theValue The value to be set to the IOR attribute.
+*/
+ void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
+ };
//===========================================================================
/*! \brief %Study Interface
The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
- Most of the %Study operations are handled by the StudyManager and the StudyBuilder.
+ Most of the %Study operations are handled by the StudyBuilder.
What is left in the %Study interface are elementary inquiries.
(Incidentally, we recall that a CORBA attribute is implemented as a pair of get
and set methods.) A %Study is explored by a set of tools, mainly iterators
interface Study
{
- exception StudyInvalidContext {};
+
+//! Invalid study reference
+ exception StudyInvalidReference {};
+//! Invalid study component
exception StudyInvalidComponent {};
-/*! Invalid directory of the %study exception
-*/
+//! Invalid directory of the %study exception
exception StudyInvalidDirectory {};
-/*! Exception pointing that this name of the study has already been used.
-*/
+//! Exception pointing that this name of the study has already been used.
exception StudyNameAlreadyUsed {};
+//! study object already exists
exception StudyObjectAlreadyExists {};
-/*! Invalid name of the %study exception
-*/
+//! Invalid name of the %study exception
exception StudyNameError {};
+//! Invalid study comment
exception StudyCommentError {};
-/*! \brief The name of the %Study
- This is equivalent to the methods setName() & getName()
-*/
- attribute string Name; // equivalent to setName() & getName()
-/*! \brief The ID of the %Study
-
- This is equivalent to the methods setID() & getID()
-*/
- attribute short StudyId;
-/*! Sequence containing %SObjects
-*/
- typedef sequence<SObject> ListOfSObject;
/*!
- Gets a persistent reference to the %Study.
+ Determines whether the server has already been loaded or not.
*/
- PersistentReference GetPersistentReference();
+ void ping();
+ void Shutdown();
/*!
- Gets a transient reference to the %Study.
+ Returns the PID of the server
*/
- SalomeReference GetTransientReference();
+ long getPID();
/*!
- Returns True if the %Study is empty
+ Shutdown the Study process.
*/
- boolean IsEmpty();
-/*!
- Allows to find a %SComponent by its name.
- \param aComponentName It's a string value in the Comment Attribute of the Component,
- which is looked for, defining the data type of this Component.
+ oneway void ShutdownWithExit();
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-*/
- SComponent FindComponent (in string aComponentName);
-/*!
- Allows to find a %SComponent by ID of the according %SObject
-*/
- SComponent FindComponentID(in ID aComponentID);
-/*!
- Allows to find a %SObject by the Name Attribute of this %SObject
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief The name of the %Study
+ This is equivalent to the methods setName() & getName()
*/
- SObject FindObject (in string anObjectName);
-/*!
- Allows to find a %SObject by its ID
-*/
- SObject FindObjectID (in ID aObjectID);
-/*!
- Allows to find a %SObject by IOR of the object belonging to this %SObject.
+ attribute wstring Name; // equivalent to getName()
+
+/*! \brief Indicate the file where the %study has been saved
*/
- SObject FindObjectIOR (in ID aObjectIOR);
-/*!
- Returns a list of %SObjects belonging to this %Component. The Name Attribute
- of these %SObjects should correspond to <VAR>anObjectName</VAR>.
+
+//! Sequence containing %SObjects
+ typedef sequence<SObject> ListOfSObject;
+//! Get the persistent reference to the %Study.
+ PersistentReference GetPersistentReference() raises(StudyInvalidReference);
+
+/*! \brief indicate whether the %Study is empty
+
+ \return True if the %Study is empty
*/
- ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
-/*!
- Allows to find a %SObject by the path to it.
+ boolean IsEmpty() raises(StudyInvalidReference);
+/*! \brief Find a %SComponent by its name.
+
+ \param aComponentName It's a string value in the Comment Attribute of the Component,
+ which is looked for, defining the data type of this Component.
+
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
+
*/
- SObject FindObjectByPath(in string thePath);
-/*!
- Returns the path to the %SObject.
+ SComponent FindComponent (in string aComponentName) raises(StudyInvalidReference);
+
+/*! \brief Find a %SComponent by ID of the according %SObject
*/
- string GetObjectPath(in Object theObject);
+ SComponent FindComponentID(in ID aComponentID) raises(StudyInvalidReference);
+/*! \brief Find a %SObject by the Name Attribute of this %SObject
-/*!
- Sets the context of the %Study.
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ \param anObjectName String parameter defining the name of the object
+ \return The obtained %SObject
+
+<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
+*/
+ SObject FindObject (in string anObjectName) raises(StudyInvalidReference);
+/*! \brief Find a %SObject by its ID
+ \param aObjectID This parameter defines the ID of the required object
+ \return The obtained %SObject
*/
- void SetContext(in string thePath);
-/*!
- Gets the context of the %Study
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ SObject FindObjectID (in ID aObjectID) raises(StudyInvalidReference);
+/*! \brief Create a %SObject by its ID
+ \param aObjectID This parameter defines the ID of the required object
+ \return The created %SObject
*/
- string GetContext();
-/*!
- Returns 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.
+ SObject CreateObjectID (in ID aObjectID) raises(StudyInvalidReference);
+/*! \brief Find a %SObject by IOR of the object belonging to this %SObject.
+
+ \param anObjectName This parameter defines the IOR of the object
+ \return The obtained %SObject
*/
- ListOfStrings GetObjectNames(in string theContext);
-/*!
- Returns 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.
+ SObject FindObjectIOR (in ID aObjectIOR) raises(StudyInvalidReference);
+/*! \brief Find in the study all %SObjects produced by a given %Component.
+
+ \param anObjectName The Name Attribute of the searched %SObjects should correspond to <VAR>anObjectName</VAR>.
+ \param aComponentName The name of the component, which objects are searched for.
*/
- ListOfStrings GetDirectoryNames(in string theContext);
-/*!
- Returns 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.
+ ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName) raises(StudyInvalidReference);
+/*! \brief Find a %SObject by the path to it.
+
+ \param thePath The path to the required %SObject.
+ \return The obtained %SObject.
*/
- ListOfStrings GetFileNames(in string theContext);
-/*!
- Returns 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.
+ SObject FindObjectByPath(in string thePath) raises(StudyInvalidReference);
+/*! \brief Get the path to the %SObject.
*/
- ListOfStrings GetComponentNames(in string theContext);
-/*! \brief Creation of a new iterator of child levels
+ string GetObjectPath(in Object theObject) raises(StudyInvalidReference);
+
+/*! \brief Create a new iterator of child levels of the given %SObject.
- Creates a new iterator of child levels of the %SObject
+ \param aSO The given %SObject
+ \return A new iterator of child levels of the given %SObject.
*/
- ChildIterator NewChildIterator(in SObject aSO);
-/*! \brief Creation of a new iterator of the %SComponent
+ ChildIterator NewChildIterator(in SObject aSO) raises(StudyInvalidReference);
- Creates a new iterator of the %SComponent.
+/*! \brief Create a new iterator of the %SComponents.
+
+ \return A new iterator of the %SComponents.
*/
- SComponentIterator NewComponentIterator();
-/*! \brief Creation of a %StudyBuilder
+ SComponentIterator NewComponentIterator() raises(StudyInvalidReference);
+
+/*! \brief Create a new %StudyBuilder to add or modify an object in the study.
- Creates a new %StudyBuilder to add or modify an object in the study.
-<BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ \return A new %StudyBuilder.
+<em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- StudyBuilder NewBuilder() ;
+ StudyBuilder NewBuilder() raises(StudyInvalidReference);
/*! \brief Labels dependency
Updates the map with IOR attribute. It's an inner method used for optimization.
*/
- void UpdateIORLabelMap(in string anIOR, in string anEntry);
+ void UpdateIORLabelMap(in string anIOR, in string anEntry) raises(StudyInvalidReference);
/*! \brief Getting properties of the study
- Returns the attriubte, which contains the properties of this study.
-<BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ Returns the attribute, which contains the properties of this study.
+
+<em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- AttributeStudyProperties GetProperties();
-/*!
- Determines whether the %study has been saved
+ AttributeStudyProperties GetProperties() raises(StudyInvalidReference);
+/*! \brief Indicate whether the %study has been saved
*/
attribute boolean IsSaved;
-/*!
+/*! \brief Indicate whether the %study has been modified and not saved.
+
Returns True if the %study has been modified and not saved.
*/
- boolean IsModified();
-/*!
- Determines the file where the %study has been saved
+ boolean IsModified() raises(StudyInvalidReference);
+
+/*! \brief Mark the %study as being modified and not saved.
+*/
+ void Modified() raises(StudyInvalidReference);
+
+/*! \brief Indicate the file where the %study has been saved
*/
- attribute string URL;
+ attribute wstring URL;
/*! \brief List of %SObjects
Returns the list of %SObjects which refers to %anObject.
*/
- ListOfSObject FindDependances(in SObject anObject);
+ ListOfSObject FindDependances(in SObject anObject) raises(StudyInvalidReference);
/*! \brief The date of the last saving of the study
Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
*/
- string GetLastModificationDate();
+ string GetLastModificationDate() raises(StudyInvalidReference);
/*! \brief The list of modification dates of the study
Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
Note : the first modification begins the list.
*/
- ListOfDates GetModificationsDate();
+ ListOfDates GetModificationsDate() raises(StudyInvalidReference);
/*! \brief Object conversion.
Converts an object into IOR.
\return An object
*/
Object ConvertIORToObject(in string theIOR);
-/*!
- Gets a new %UseCaseBuilder.
-*/
- UseCaseBuilder GetUseCaseBuilder();
-/*!
- Closes the components in the study, removes itself from the %StudyManager.
+/*! \brief Get a new %UseCaseBuilder.
*/
- void Close();
+ UseCaseBuilder GetUseCaseBuilder() raises(StudyInvalidReference);
-/*!
- Enables(if isEnabled = True)/disables automatic addition of new %SObjects to the use case.
+/*! \brief Clear a study object
*/
- void EnableUseCaseAutoFilling(in boolean isEnabled);
- };
-
- //==========================================================================
-/*! \brief %Study Builder Interface
+ void Clear() raises(StudyInvalidReference);
- The purpose of the Builder is to add and/or remove objects and attributes.
- A %StudyBuilder is linked to a %Study. A
- command management is provided for the undo/redo functionalities.
- \note
- <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
- item's position in the tree-type structure of the browser. In general it has the following
- form: <TT>0:2:1:1</TT>
+/*! \brief Initialization a study object
*/
- //==========================================================================
+ void Init() raises(StudyInvalidReference);
- interface StudyBuilder
- {
-/*! \brief %LockProtection Exception
+/*! \brief Open a study by url
- This exception is raised while attempting to modify a locked %study.
+ Reads and activates the structure of the study %Objects.
+ \param aStudyUrl The path to the study
*/
- exception LockProtection {};
-/*! \brief Creation of a new %SComponent.
-
- Creates a new %SComponent
- \param ComponentDataType Data type of the %SComponent which will be created.
+ boolean Open (in URLPath aStudyUrl) raises (SALOME::SALOME_Exception);
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Check if study can be opened
+ Tries to open and read given url.
+ \param aStudyUrl The path to the study
*/
- SComponent NewComponent(in string ComponentDataType);
-/*! \brief Definition of the instance to the %SComponent
+ boolean CanOpen (in URLPath aStudyUrl);
- Defines the instance to the %SComponent.
-*/
- void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR);
-/*! \brief Deletion of the %SComponent
+/*! \brief Saving the study in a file (or files).
- Removes the %SComponent.
+ 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.
*/
- void RemoveComponent(in SComponent aComponent);
+ boolean Save(in boolean theMultiFile, in boolean theASCII) raises(StudyInvalidReference);
-/*! \brief Creation of a new %SObject
-
- Creates a new %SObject.
-<BR><VAR>See also <A href=exemple/Example18.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Saving the study in a specified file (or files).
-*/
- SObject NewObject (in SObject theFatherObject);
-/*! \brief Creation of a new %SObject with a definite %tag
+ Saves the study in a specified file (or files).
+ \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.
- Creates a new %SObject with a definite %tag.
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- SObject NewObjectToTag (in SObject theFatherObject, in long atag);
-/*! \brief Deletion of the %SObject
-
- Removes a %SObject from the %StudyBuilder.
+ boolean SaveAs(in URLPath aUrl, // if the file already exists
+ in boolean theMultiFile, // overwrite (as option)
+ in boolean theASCII)
+ raises(StudyInvalidReference);
+/*!
+ Returns True, if the given %SObject can be copied to the clipboard.
*/
- void RemoveObject (in SObject anObject);
-/*! \brief Deletion of the %SObject with all his child objects.
-
- Removes the %SObject with all his child objects.
+ boolean CanCopy(in SObject theObject) raises(StudyInvalidReference);
+/*!
+ Returns True, if the given %SObject is copied to the clipboard.
+ \param theObject The %SObject which will be copied
*/
- void RemoveObjectWithChildren(in SObject anObject);
-
+ boolean Copy(in SObject theObject) raises(StudyInvalidReference);
/*!
- Loads a %SComponent.
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
-
+ Returns True, if the object from the clipboard can be pasted to the given %SObject.
+ \param theObject The %SObject stored in the clipboard.
*/
- void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
+ boolean CanPaste(in SObject theObject) raises(StudyInvalidReference);
/*!
- Loads a %SObject.
+ Returns the %SObject in which the object from the clipboard was pasted to.
+ \param theObject The %SObject which will be pasted
+ \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
+ an object into a study, which is protected for modifications.
*/
- void Load (in SObject sco);
-
-/*! \brief Looking for or creating an attribute assigned to the %SObject
-
- Allows to find or create an attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute which is looked for.
- \param aTypeOfAttribute Type of the attribute.
+ SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Enable (if isEnabled = True)/disable automatic addition of new %SObjects to the use case.
*/
+ void EnableUseCaseAutoFilling(in boolean isEnabled) raises(StudyInvalidReference);
- GenericAttribute FindOrCreateAttribute(in SObject anObject,
- in string aTypeOfAttribute);
+/*!
+ Functions for internal usage only
+*/
+ void AddPostponed(in string theIOR) raises(StudyInvalidReference);
-/*! \brief Looking for an attribute assigned to %SObject
+ void AddCreatedPostponed(in string theIOR) raises(StudyInvalidReference);
- Allows to find an attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute which is looked for.
- \param aTypeOfAttribute Type of the attribute.
- \param anAttribute Where the attribute is placed if it's found.
- \return True if it finds an attribute.
- */
+ void RemovePostponed(in long theUndoLimit) raises(StudyInvalidReference);
- boolean FindAttribute(in SObject anObject,
- out GenericAttribute anAttribute,
- in string aTypeOfAttribute);
-/*! \brief Deleting the attribute assigned to the %SObject
+ void UndoPostponed(in long theWay) raises(StudyInvalidReference);
- Removes the attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute.
- \param aTypeOfAttribute Type of the attribute.
+ boolean DumpStudy(in string thePath,
+ in string theBaseName,
+ in boolean isPublished,
+ in boolean isMultiFile) raises(StudyInvalidReference);
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Returns the folder of the python script which is currently dumped.
*/
- void RemoveAttribute(in SObject anObject,
- in string aTypeOfAttribute);
-/*! \brief Addition of a reference
+ string GetDumpPath();
- Adds a reference between %anObject and %theReferencedObject.
+/*! \brief Get an AttributeParameter used to store common parameters for given %theSavePoint.
+
+ \param theID identifies a common parameters set (Example: "Interface Applicative")
+ \param theSavePoint is number of a set of parameters as there can be several sets
*/
+ AttributeParameter GetCommonParameters(in string theID, in long theSavePoint) raises(StudyInvalidReference);
- void Addreference(in SObject anObject,
- in SObject theReferencedObject) ;
-/*!
- Adds a directory in the %Study.
-<BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Get an AttributeParameter used to store parameters for given %theModuleName.
+ \param theID identifies a common parameters set (Example: "Interface Applicative")
+ \param theModuleName is a name of the module (Example: "Geometry")
+ \param theSavePoint is number of a set of parameters as there can be several sets
*/
- void AddDirectory(in string theName);
+ AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint) raises(StudyInvalidReference);
-/*! \brief Identification of the %SObject's substructure.
- Identification of the %SObject's substructure by GUID.
- It has the following format "00000000-0000-0000-0000-000000000000"
+/*! \brief Get a default Python script to restore visual parameters for given %theModuleName.
+
+ \param theModuleName is a name of the module (Example: "Geometry")
+ \param indent is a string to use for script indentation
*/
+ string GetDefaultScript(in string theModuleName, in string indent) raises(StudyInvalidReference);
- void SetGUID(in SObject anObject, in string theGUID);
/*!
-
- Returns True if the %SObject has GUID.
+ Private method, returns an implementation of this Study.
+ \param theHostname is a hostname of the caller
+ \param thePID is a process ID of the caller
+ \param isLocal is set True if the Study is launched locally with the caller
*/
- boolean IsGUID(in SObject anObject, in string theGUID);
+ long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
-/*! \brief Creation of a new command
- Creates a new command which can contain several different actions.
-<BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Mark this Study as being locked by the given locker.
+ The lock status can be checked by method IsStudyLocked
+ \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that locks the study.
*/
- void NewCommand(); // command management
-/*! \brief Execution of the command
+ void SetStudyLock(in string theLockerID) raises(StudyInvalidReference);
- Commits all actions declared within this command.
-<BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Indicate if the Study is locked
+ Returns True if the Study was marked locked.
*/
- void CommitCommand() raises(LockProtection); // command management
-/*!
- Returns True if at this moment there is a command under execution.
-*/
- boolean HasOpenCommand();
-/*! \brief Cancelation of the command
+ boolean IsStudyLocked() raises(StudyInvalidReference);
- Cancels all actions declared within the command.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Mark this Study as being unlocked by the given locker.
+
+ The lock status can be checked by method IsStudyLocked
+ \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that unlocks the study.
*/
- void AbortCommand(); // command management
-/*! \brief Undolimit
+ void UnLockStudy(in string theLockerID) raises(StudyInvalidReference);
- The number of actions which can be undone
+/*! \brief Get the list of IDs of the Study's lockers.
*/
- attribute long UndoLimit;
-/*! \brief Undo method
+ ListOfStrings GetLockerID() raises(StudyInvalidReference);
- Cancels all actions of the last command.
-<BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Create real variable with Name theVarName and value theValue
+ (or set if variable value into theValue already exists)
+ \param theVarName is a name of the variable
+ \param theVarName is a value of the variable.
*/
- void Undo() raises (LockProtection);
-/*! \brief Redo method
+ void SetReal( in string theVarName, in double theValue ) raises(StudyInvalidReference);
- Redoes all actions of the last command.
- <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Create integer variable with Name theVarName and value theValue
+ (or set if variable value into theValue already exists)
+ \param theVarName is a name of the variable
+ \param theVarName is a value of the variable.
*/
- void Redo() raises (LockProtection);
-/*!
- Returns True if at this moment there are any actions which can be canceled.
- <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ void SetInteger( in string theVarName, in long theValue ) raises(StudyInvalidReference);
+/*! \brief Create boolean variable with Name theVarName and value theValue
+ (or set if variable value into theValue already exists)
+ \param theVarName is a name of the variable
+ \param theVarName is a value of the variable.
*/
- boolean GetAvailableUndos();
-/*!
- Returns True if at this moment there are any actions which can be redone.
- <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ void SetBoolean( in string theVarName, in boolean theValue ) raises(StudyInvalidReference);
+
+/*! \brief Create string variable with Name theVarName and value theValue
+ (or set if variable value into theValue already exists)
+ \param theVarName is a name of the variable
+ \param theVarName is a value of the variable.
*/
- boolean GetAvailableRedos();
-/*!
- Sets the callback for addition of the given %SObject. Returns the previous callback.
+ void SetString( in string theVarName, in string theValue ) raises(StudyInvalidReference);
+
+/*! \brief Set current value as double for string variable
*/
- Callback SetOnAddSObject(in Callback theCallback);
-/*!
- Sets the callback for removal of the given %SObject. Returns the previous callback.
+ void SetStringAsDouble( in string theVarName, in double theValue ) raises(StudyInvalidReference);
+
+/*! \brief Get value of a real variable
+
+ \param theVarName is a name of the variable.
*/
- Callback SetOnRemoveSObject(in Callback theCallback);
+ double GetReal( in string theVarName ) raises(StudyInvalidReference);
- };
+/*! \brief Get value of an integer variable
- //==========================================================================
-/*! \brief %Study Manager interface
+ \param theVarName is a name of the variable.
+*/
+ long GetInteger( in string theVarName ) raises(StudyInvalidReference);
+
+/*! \brief Get value of a boolean variable
- The purpose of the Manager is to manipulate the %Studies. You will find in this
- interface the methods to create, open,
- close, and save a %Study. Since a %SALOME session is multi-document, you will
- also find the methods allowing to navigate
- through the collection of studies present in a session.
+ \param theVarName is a name of the variable.
*/
- //==========================================================================
+ boolean GetBoolean( in string theVarName ) raises(StudyInvalidReference);
- interface StudyManager
- {
-/*!
- Determines whether the server has already been loaded or not.
+/*! \brief Get value of a string variable
+
+ \param theVarName is a name of the variable.
*/
- void ping();
+ string GetString( in string theVarName ) raises(StudyInvalidReference);
-/*! \brief Creation of a new %Study
- Creates a new %Study with a definite name.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Indicate if a variable is real
+ Return true if variable is real otherwise return false.
+ \param theVarName is a name of the variable.
*/
- Study NewStudy(in string study_name);
+ boolean IsReal( in string theVarName ) raises(StudyInvalidReference);
-/*! \brief Open a study
+/*! \brief Indicate if a variable is integer
- Reads and activates the structure of the study %Objects.
- \warning This method doesn't activate the corba objects. Only a component can do it.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ Return true if variable is integer otherwise return false.
+ \param theVarName is a name of the variable.
*/
- Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
+ boolean IsInteger( in string theVarName ) raises(StudyInvalidReference);
-/*! \brief Closing the study
+/*! \brief Indicate if a variable is boolean
- Closes the study.
+ Return true if variable is boolean otherwise return false.
+ \param theVarName is a name of the variable.
*/
- void Close(in Study aStudy);
-/*! \brief Saving the study
+ boolean IsBoolean( in string theVarName ) raises(StudyInvalidReference);
- Saves the study.
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! \brief Indicate if a variable is string
+ Return true if variable is string otherwise return false.
+ \param theVarName is a name of the variable.
*/
- void Save(in Study aStudy, in boolean theMultiFile);
+ boolean IsString( in string theVarName ) raises(StudyInvalidReference);
- void SaveASCII(in Study aStudy, in boolean theMultiFile);
-/*! \brief Saving the study in a file
+/*! \brief Indicate if a variable exists in the study
- Saves the study in a specified file.
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ Return true if variable exists in the study,
+ otherwise return false.
+ \param theVarName is a name of the variable.
*/
- void SaveAs(in URL aUrl, // if the file already exists
- in Study aStudy,
- in boolean theMultiFile); // overwrite (as option)
+ boolean IsVariable( in string theVarName ) raises(StudyInvalidReference);
- void SaveAsASCII(in URL aUrl, // if the file already exists
- in Study aStudy,
- in boolean theMultiFile); // overwrite (as option)
+/*! \brief Get names of all variables from the study.
+*/
+ ListOfStrings GetVariableNames() raises(StudyInvalidReference);
+/*! \brief Remove a variable
-/*! \brief List of open studies.
+ Remove variable with the specified name from the study with substitution of its value.
- Returns the list of open studies in the current session.
+ \param theVarName Name of the variable.
+ \return Status of operation.
*/
- ListOfOpenStudies GetOpenStudies();
+ boolean RemoveVariable( in string theVarName ) raises(StudyInvalidReference);
+
+/*! \brief Rename a variable
-/*! \brief Getting a particular %Study picked by name
+ Rename variable with the specified name within the study.
- Activates a particular %Study
- amongst the session collection picking it by name.
+ \param theVarName Name of the variable.
+ \param theNewVarName New name for the variable.
+ \return Status of operation.
*/
- Study GetStudyByName (in string aStudyName);
+ boolean RenameVariable( in string theVarName, in string theNewVarName ) raises(StudyInvalidReference);
-/*! \brief Getting a particular %Study picked by ID
+/*! \brief Indicate whether variable is used
- Activates a particular %Study
- amongst the session collection picking it by ID.
+ Check that variable is used in the study.
+
+ \param theVarName Name of the variable.
+ \return Variable usage.
*/
- Study GetStudyByID (in short aStudyID);
+ boolean IsVariableUsed( in string theVarName ) raises(StudyInvalidReference);
- // copy/paste methods
+/*! \brief Parse variables used for object creation
-/*!
- Returns True, if the given %SObject can be copied to the clipboard.
+ \param string with variables, separated by special symbol.
+ \return Variables list.
*/
- boolean CanCopy(in SObject theObject);
-/*!
- Returns True, if the given %SObject is copied to the clipboard.
-*/
- boolean Copy(in SObject theObject);
+ ListOfListOfStrings ParseVariables( in string theVars ) raises(StudyInvalidReference);
+
/*!
- Returns True, if the object from the clipboard can be pasted to the given %SObject.
+ Attach an observer to the Study
+
+ \param theObserver observer being attached
+ \param modify when \c true, observer receives any object's modification events;
+ otherwise observer receives object's creation events only
*/
- boolean CanPaste(in SObject theObject);
+ void attach(in SALOMEDS::Observer theObserver, in boolean modify);
/*!
- Returns the %SObject in which the object from the clipboard was pasted to.
+ Detach an observer from the Study
+
+ \param theObserver observer to be detached
*/
- SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
+ void detach(in SALOMEDS::Observer theObserver);
};
-
//==========================================================================
/*! \brief %SObject interface
The objects in the %study are built by the %StudyBuilder. The %SObject interface
provides methods for elementary inquiries, like getting an object %ID or its attribuites.
\note
+
<BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
in the tree-type data structure.
<BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
*/
//==========================================================================
- interface SObject
+ interface SObject : SALOME::GenericObj
{
/*! Name of the %SObject
*/
attribute string Name; // equivalent to setName() & getName()
-/*! \brief Getting an object %ID
- Returns ID of the %SObject.
+/*! Returns true if the %SObject does not belong to any %Study
+*/
+ boolean IsNull();
+
+/*! Gets an object %ID
+ \return ID of the %SObject.
*/
ID GetID();
-/*! \brief Acquisition of the father %Component of the %SObject
- Returns the father %Component of the %SObject.
+/*! Acquisition of the father %Component of the %SObject
+ \return The father %Component of the %SObject.
*/
SComponent GetFatherComponent();
-/*! \brief Acquisition of the father %SObject of the %SObject
- Returns the father %SObject of the given %SObject.
+/*! Acquisition of the father %SObject of the %SObject
+ \return the father %SObject of the given %SObject.
*/
SObject GetFather();
-/*! \brief %Tag of %SObject
- Returns the %tag of the %SObject.
+/*! Gets the %tag of a %SObject
+ \return the %tag of a %SObject.
*/
short Tag();
-/*! \brief Looking for subobjects of an object.
- Returns True if it finds a subobject of the %SObject with a definite tag.
+/*! Returns a tag of the last child %SObject (if any) of this %SObject.
+ Returns zero if this %SObject has no children.
+*/
+ short GetLastChildTag();
+
+/*! Gets the depth of a %SObject
+ \return the depth of a %SObject.
*/
+ short Depth();
+/*! Looks for subobjects of a given %SObject.
+ \param atag Tag of the given %SObject
+ \return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
+*/
boolean FindSubObject (in long atag, out SObject obj);
-/*! \brief Looking for attributes of the %SObject
- Returns True if it finds an attribute of a definite type of the %SObject.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! Looks for attributes of a given %SObject
+ \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
+ \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
+
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean FindAttribute(out GenericAttribute anAttribute,
- in string aTypeOfAttribute);
-/*!
- Returns the object which this %SObject refers to. It also returns True if it finds
+ in string aTypeOfAttribute);
+
+/*! Looks for a %SObject which the given %SObject refers to.
+ \return The object which the given %SObject refers to as well as True if it finds
this object.
*/
boolean ReferencedObject(out SObject obj); // A REVOIR
-/*! \brief Getting all attributes of the %SObject
- Returns the list of all attributes of the %SObject.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+/*! Gets all attributes of a given %SObject
+ \return The list of all attributes of the given %SObject.
+
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
*/
ListOfAttributes GetAllAttributes();
-/*! \brief Returning the study
- Returns the study containing the given %SObject.
+/*! Gets the CORBA object by its own IOR attribute.
+ Returns nil, if can't.
+ \return The CORBA object of the %SObject.
+*/
+ Object GetObject();
+
+/*!
+ Returns the name attribute value of this SObject.
+ Returns empty string if there is no name attribute.
+*/
+ string GetName();
+
+/*!
+ Returns the comment attribute value of this SObject.
+ Returns empty string if there is no comment attribute.
+*/
+ string GetComment();
+
+/*!
+ Returns the IOR attribute value of this SObject.
+ Returns empty string if there is no IOR attribute.
+*/
+ string GetIOR();
+
+/*!
+ Set an attribute value (of type string)
+ \param name the name of the attribute
+ \param value the value of the attribute
+*/
+ void SetAttrString(in string name, in string value);
+
+/*!
+ Private method, returns an implementation of this SObject.
+ \param theHostname is a hostname of the caller
+ \param thePID is a process ID of the caller
+ \param isLocal is set True if the SObject is launched locally with the caller
*/
- Study GetStudy();
+ long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
};
//==========================================================================
/*! \brief %Generic attribute interface
- %Generic attribute is a base interface for all attributes which inherit
- its methods.
+ %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study.
*/
//==========================================================================
- interface GenericAttribute
+ interface GenericAttribute : SALOME::GenericObj
{
/*! \brief Exception locking all changes
/*! \brief Method CheckLocked
Checks whether the %Study is protected for modifications.
- \note <BR>This exception is raised only outside the transaction.
+
+ \note <BR>This exception is raised only outside a transaction.
*/
void CheckLocked() raises (LockProtection);
+
+ //! Get Type
+ string Type();
+
+ //! Get the class type
+ string GetClassType();
+
+ //! Get SObject
+ SObject GetSObject();
+
+ //! Private method, returns an implementation of this GenericAttribute.
+/*!
+ \param theHostname is a hostname of the caller
+ \param thePID is a process ID of the caller
+ \param isLocal is set True if the GenericAttribute is launched locally with the caller
+*/
+ long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
};
//==========================================================================
/*! \brief %SComponent interface
+ The %SComponent interface establishes in the study a permanent assocition to the Components integrated into %SALOME platform.
The %SComponent interface is a specialization of the %SObject interface.
It inherits the most of its methods from the %SObject interface.
*/
//==========================================================================
interface SComponent : SObject
{
-/*! \brief Data type of the %SComponent
+/*! \brief Gets the data type of the given %SComponent
- Returns the data type of the %SComponent.
+ \return The data type of this %SComponent.
*/
string ComponentDataType();
-/*!
- Returns IOR of the according component.
+/*! \brief Gets the IOR of the given component
+
+ \return True (if there is an instance of the given component) and its IOR.
*/
boolean ComponentIOR (out ID theID); //returns True if there is an instance
//In this case ID identifies this one
The search is started from the first %SComponent in the list.
*/
//==========================================================================
- interface SComponentIterator
+ interface SComponentIterator : SALOME::GenericObj
{
-/*! \brief Initialization of the Iterator
-
-Activates the %SComponentIterator.
+/*!
+\brief Activates the %SComponentIterator.
*/
void Init();
-/*! \brief Method More
+/*! \brief Method More
- Returns True if there is one more %SComponent in the list.
+ \return True if there is one more %SComponent in the list.
*/
boolean More();
-/*! \brief Moving the iterator to the next %SComponent
-
-Moves the iterator to the next %SComponent in the list.
+/*!
+\brief Moves the iterator to the next %SComponent in the list.
*/
void Next();
/*!
- Returns the %SComponent corresponding to the current %SComponent found by the iterator.
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+ \brief Returns the %SComponent corresponding to the current %SComponent found by the iterator.
+
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
SComponent Value();
levels.
*/
//==========================================================================
- interface ChildIterator
+ interface ChildIterator : SALOME::GenericObj
{
-/*! \brief Initialization of the Iterator.
+/*!
-Activates the %ChildIterator.
+\brief Activates the %ChildIterator.
*/
void Init();
-/*! \brief Initialization of the Iterator for all child levels.
+/*!
-Activates the %ChildIterator (if True) for all child levels.
+\brief Activates the %ChildIterator for all child levels.
+
+\param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels.
*/
void InitEx(in boolean allLevels);
/*! \brief Method More
- Returns True if the %ChildIterator finds one more child level.
+ \return True if there is one more %ChildIterator in the list.
*/
boolean More();
/*!
- Passes the iterator to the next level.
+ \brief Passes the iterator to the next level.
*/
void Next();
/*!
- Returns the %SObject corresponding to the current object found by the iterator.
+ \brief Returns the %SObject corresponding to the current object found by the iterator.
*/
SObject Value();
};
This interface contains a set of methods used for iteration over the objects in the use case.
*/
- interface UseCaseIterator
+ interface UseCaseIterator : SALOME::GenericObj
{
-/*! \brief Initialization of the Iterator.
-
-Activates the %UseCaseIterator. If <VAR>allLevels</VAR> is True the Iterator is activated for all subobjects.
+/*!
+Activates the %UseCaseIterator.
+\param allLevels If the value of this parameter is True the Iterator is activated for all subobjects.
*/
void Init(in boolean allLevels);
-/*! \brief Method More
+/*! Method More
- Returns True if the %UseCaseIterator finds one more object.
+ \return True if the %UseCaseIterator finds one more object.
*/
boolean More();
/*!
Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
*/
- interface UseCaseBuilder
+ interface UseCaseBuilder : SALOME::GenericObj
{
/*!
- Adds to the use case an object <VAR>theObject</VAR> as a child of the current object of the use case.
+ Adds to the use case an object as a child of the current object of the use case.
+
+ \param theObject The added %SObject.
+ \return True if this %SObject has been added in the use case.
*/
boolean Append(in SObject theObject);
/*!
- Removes an object <VAR>theObject</VAR> from the use case.
+ Removes an object from the use case.
+
+ \param theObject The deleted %SObject
+ \return True if this %SObject has been deleted from the use case.
*/
boolean Remove(in SObject theObject);
/*!
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>.
*/
Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
*/
boolean HasChildren(in SObject theObject);
+/*!
+ Returns True if children of the given object <VAR>theObject</VAR> of the use case tree were sorted successfully.
+*/
+ boolean SortChildren(in SObject theObject, in boolean theAscendingOrder);
+/*!
+ Gets father object of the given object <VAR>theObject</VAR> in the use cases tree.
+*/
+ SObject GetFather(in SObject theObject);
/*!
Sets the name of the use case.
*/
Returns True if the given object <VAR>theObject</VAR> represents a use case.
*/
boolean IsUseCase(in SObject theObject);
+/*!
+ Returns True if the given object <VAR>theObject</VAR> is included in the use cases tree on any level.
+*/
+ boolean IsUseCaseNode(in SObject theObject);
/*!
Gets the current object of the use case.
*/
UseCaseIterator GetUseCaseIterator(in SObject theObject);
};
//==========================================================================
- //==========================================================================
-/*! \brief The callback interface
-
- The %StudyBuilder can be created with the method <VAR>NewBuilder</VAR>. While invocation of this method a new object of the class <VAR>Callback</VAR> is created
- and this object is assigned to the newly created Builder as callback which should be called when adding and removing of the ojects.
-*/
- interface Callback
- {
-/*!
- Invokes the corresponding method <VAR>Append</VAR> of the %UseCaseBuilder.
-*/
- void OnAddSObject(in SObject theObject);
-/*!
- Invokes the corresponding method <VAR>Remove</VAR> of the %UseCaseBuilder.
-*/
- void OnRemoveSObject(in SObject theObject);
- };
-
- //==========================================================================
/*! \brief %Driver interface
- This interface contains a set of methods used for the management
- of the object produced in the %study by a component.
+This class represents a common tool for all components integrated into SALOME application, that allows them to communicate with the study. It contains a set of methods which
+can be called by any component and which provide the following functionality:
+<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 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>
+
*/
//==========================================================================
interface Driver
{
- /*! \brief Saving the data.
+ /*! \brief Saving the data produced by a definite component.
- This method is called by the StudyManager when saving a study.
+ This method is called when saving a study.
\param theComponent %SComponent corresponding to this Component
+ \param theURL The path to the file in which the data will be saved.
+ \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
\return A byte stream TMPFile that contains all saved data
-<BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
*/
TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
+/*! \brief Saving the data in ASCII format produced by a definite component.
+
+ This method is called when saving a study in ASCII format.
+ \param theComponent %SComponent corresponding to this Component
+ \param theURL The path to the file in which the data will be saved.
+ \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
+ \return A byte stream TMPFile that will contain all saved data
+
+<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
+
+ */
TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
/*! \brief Loading the data.
- This method is called by the StudyManager when opening a study.
+ This method is called when opening a study.
\param theComponent %SComponent corresponding to this Component
\param theStream The file which contains all data saved by the component on Save method
+ \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
+
*/
boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
+ /*! \brief Loading the data from files in ASCII format.
+
+ This method is called when opening a study.
+ \param theComponent %SComponent corresponding to this Component
+ \param theStream The file which contains all data saved by the component on Save method
+ \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
+
+ */
+
boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
/*! \brief Closing of the study
- This method Close is called by the StudyManager when closing a study.
-
+ This method Close is called when closing a study.
+ \param aSComponent The according %SComponent
*/
void Close (in SComponent aSComponent);
//void Close ( in string aIORSComponent);
- /*! \brief The type of the data
+ /*! Gets the type of the data
- Returns the type of data produced by the Component in the study.
+ \return The type of data produced by the Component in the study.
*/
string ComponentDataType();
// Driver Transient -> persistent called for each object in study
/*!
- Transforms IOR into PersistentID of the object. It is called for each
+ Transforms IOR of a given %SObject into PersistentID. It is called for each
object in the %study.
+\note <br> In %SALOME the objects which are present in an active study are identified by an IOR, when this
+study is saved these references are transformed into persintent IDs.
+
+ \param theSObject The given %SObject.
+ \param IORString The IOR of the given %SObject.
+ \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
+ \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
+
+ \return The persistent ID of the given %SObject
+
*/
string IORToLocalPersistentID (in SObject theSObject,
- in string IORString,
- in boolean isMultiFile,
- in boolean isASCII);
+ in string IORString,
+ in boolean isMultiFile,
+ in boolean isASCII);
/*!
Transforms PersistentID into IOR of the object. It is called for each
object in the %study.
+
+ \note <br> In %SALOME the objects which are present in an saved study (file) are identified by a persistent ID, when this
+study is open, these references are transformed into persintent IORs.
+
+ \param theSObject The given %SObject.
+ \param IORString The IOR of the given %SObject.
+ \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
+ \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
+
+ \return The IOR of the given %SObject
+
*/
string LocalPersistentIDToIOR (in SObject theSObject,
- in string aLocalPersistentID,
- in boolean isMultiFile,
- in boolean isASCII)
+ in string aLocalPersistentID,
+ in boolean isMultiFile,
+ in boolean isASCII)
raises (SALOME::SALOME_Exception);
// Publishing in the study
-/*! \brief Publishing in the study
+/*! Publishing in the study
- Returns True if the given %Component can publish the %object in the %study.
+ \return True if the given %Component can publish a definite object with a given IOR in the %study.
+ \param theIOR The IOR of a definite object
*/
boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
/*! \brief Publishing in the study
Publishes the given object in the %study, using the algorithm of this component.
- \param theStudy The %study in which the object is published
\param theSObject If this parameter is null the object is published for the first time. Otherwise
this parameter should contain a reference to the object published earlier
\param theObject The object which is published
\param theName The name of the published object. If this parameter is empty, the name is generated
automatically by the component.
+
+ \return The published %SObject.
*/
- SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
+ SObject PublishInStudy(in SObject theSObject, in Object theObject, in string theName);
// copy/paste methods
/*!
Returns True, if the given %SObject can be copied to the clipboard.
+
+ \param theObject The given %SObject which should be copied.
*/
boolean CanCopy(in SObject theObject);
/*!
};
};
-
+
#endif
