-//=====================================================
-// File : SALOMEDS.idl
-// Created : Thu Nov 29 21:25:39 2001
-// Author : Yves FRICAUD
-// Project : SALOME
-// Copyright : Open CASCADE 2001
-// $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
-
-would introduce a module SALOMEDS.py, which contains the following definitions:
-
-\verbatim
-# module SALOMEDS.py
-class StudyManager:
- def _Close(self,aStudy):
- pass #interfaces are discussed later
-\endverbatim
-
-To avoid conflicts, IDL names that are also Python identifiers are prefixed with an underscore (\91_\92).
-
-\subsection subsection2 Mapping for Template and Array Types
-
-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:
-
-\95 For the wide string X and the integer n, X[n] returns the nth character, which is a
-wide string of length 1.
-
-\95 len(X) returns the number of characters of wide string X.
-
-\95 CORBA.wstr(c) returns a wide character with the code point c in an
-implementation-defined encoding.
-
-\95 X+Y returns the concatenation of wide strings X and Y.
-
-\95 CORBA.word(CORBA.wstr(c)) == c
-
-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
-
-\verbatim
-module SALOMEDS {
- typedef sequence <string> StringSeq;
-
- interface AttributeTableOfInteger : GenericAttribute {
-
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
- };
-};
-\endverbatim
-
-a client could invoke the operation
-
-\verbatim
-print My_AttributeTableOfInteger.SetRowTitles(["X","F"])
-\endverbatim
-
-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.
-
-Another example with arrays. The following IDL definition
-
-\verbatim
-module SALOMEDS {
- typedef sequence<GenericAttribute> ListOfAttributes;
- interface SObject {
- ListOfAttributes GetAllAttributes();
- };
-};
-\endverbatim
-
-is equal to
-
-\verbatim
-import SALOMEDS
-
-attributes=[]
-
-attributes = My_SObject.GetAllAttributes()
-
-length = len(attributes)
-
-print "Attributes number = ", length
-print attributes
-\endverbatim
-
-\subsection subsection3 Mapping for Objects and Operations
-
-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.
-
-The nil object is represented by <STRONG>None</STRONG>.
-
-If an operation expects parameters of the IDL Object type, any Python object
-representing an object reference might be passed as actual argument.
-
-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>:
-
-\95 If there is no <VAR>result value</VAR>, the method returns None.
-
-\95 If there is exactly one <VAR>result value</VAR>, it is returned as a single value.
-
-\95 If there is more than one <VAR>result value</VAR>, all of them are packed into a tuple, and this
-tuple is returned.
-
-Assuming the IDL definition
-
-\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
-
-introduces the 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
-
-\subsection subsection7 Mapping for Structured Types
-
-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
-
-\verbatim
-struct SDate {
- short Second;
- short Minute;
- short Hour;
- short Day;
- short Month;
- short Year;
- };
-\endverbatim
-
-could be used in the Python statements
-
-\verbatim
-Date=SDate(30, 12, 15, 26, 1, 79)
-print Date.Second,Date.Minute,Date.Hour,Date.Day,Date.Month,Date.Year
-\endverbatim
-*/
-/*! \page page2 Mapping of SALOME IDL definitions to Python language.
-
-
- - <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>
-
-*/
-
-/*! \defgroup Study SALOME STUDY module
-*/
-
-/*!
- \file SALOMEDS.idl This file contains a set of interfaces used for creation, managment
+// Copyright (C) 2007-2010 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.
+//
+// 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
+//
+/*! \file SALOMEDS.idl \brief This file contains a set of interfaces used for creation, management
and modification of the %Study
*/
#define _SALOMEDS_IDL_
#include "SALOME_Exception.idl"
+#include "SALOME_GenericObj.idl"
-/*! \ingroup Study
- This package contains the interfaces used for creation, managment
+/*! \brief
+ This package contains the interfaces used for creation, management
and modification of the %Study
*/
module SALOMEDS
{
- const string SALOMEDS__doc__ = "This package contains the interfaces used for creation, \nmanagment and modification of the study.";
-/*! \typedef URL
- Name of the file in which the %Study is saved.
-
+/*! \brief Name of the file in which the %Study is saved.
*/
typedef string URL;
-/*! Main identifier of an object in %SALOME application
+/*! \brief Main identifier of an object in %SALOME application
*/
typedef string ID;
-/*! While saving the data, IOR is transformed into persistent reference
+/*! \brief While saving the data, IOR is transformed into persistent reference
*/
typedef string PersistentReference;
-/*! IOR of the study in %SALOME application
+/*! \brief IOR of the study in %SALOME application
*/
typedef string SalomeReference;
-/*! List of names of open studies in a %SALOME session
+
+/*! \brief List of the names of studies which are currently open in this %SALOME session.
+
+Since %SALOME is a multi-study application, it allows to open a lot of studies
+during each working session.
*/
typedef sequence<string> ListOfOpenStudies;
-/*! List of file names
-*/
+//! List of file names
typedef sequence<string> ListOfFileNames;
-/*! List of modification dates of the study
-*/
+//! List of modification dates of a study
typedef sequence<string> ListOfDates ;
-/*! An unbounded sequence of strings
-*/
+//! An unbounded sequence of strings
typedef sequence<string> ListOfStrings ;
-/*! A byte stream which is used for binary data transfer between components
-*/
+//! 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;
// Reference to other objects is treated with function AddReference
interface ChildIterator;
interface Driver;
interface AttributeStudyProperties;
+ interface AttributeParameter;
interface UseCaseIterator;
interface UseCaseBuilder;
- interface Callback;
-/*! List of attributes
-*/
+
+ interface Observer
+ {
+ void notifyObserverID(in string theID, in long event);
+ };
+
+
+//! List of attributes of %SObjects
typedef sequence<GenericAttribute> ListOfAttributes;
-/*! Exception indicating that this feature hasn't been implemented
-*/
+
+//! Exception indicating that this feature hasn't been implemented in %SALOME application.
exception NotImplemented {};
interface Study
{
+
+//! Invalid study context
exception StudyInvalidContext {};
+//! 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()
This is equivalent to the methods setID() & getID()
*/
attribute short StudyId;
-/*! Sequence containing %SObjects
-*/
+//! Sequence containing %SObjects
typedef sequence<SObject> ListOfSObject;
-/*!
- Gets a persistent reference to the %Study.
-*/
+//! Get the persistent reference to the %Study.
PersistentReference GetPersistentReference();
- const string GetPersistentReference__doc__ = "Gets a persistent reference to the study.";
-/*!
- Gets a transient reference to the %Study.
-*/
+//! Get a transient reference to the %Study.
SalomeReference GetTransientReference();
- const string GetTransientReference__doc__ = "Gets a transient reference to the study.";
-/*!
- Returns True if the %Study is empty
+/*! \brief indicate whether the %Study is empty
+
+ \return True if the %Study is empty
*/
boolean IsEmpty();
- const string IsEmpty__doc__ = "Returns True if the study is empty.";
-/*!
- Allows to find a %SComponent by its name.
+/*! \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.
-<BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
+
*/
SComponent FindComponent (in string aComponentName);
- const string FindComponent__doc__ = "Allows to find a SComponent by its name.";
-/*!
- Allows to find a %SComponent by ID of the according %SObject
+
+/*! \brief Find a %SComponent by ID of the according %SObject
*/
SComponent FindComponentID(in ID aComponentID);
- const string FindComponentID__doc__ = "Allows to find a SComponent by ID of the according SObject.";
-/*!
- 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 Find a %SObject by the Name Attribute of this %SObject
+ \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);
- const string FindObject__doc__ = "Allows to find a SObject by the Name Attribute of this SObject.";
-/*!
- Allows to find a %SObject by its ID
+/*! \brief Find a %SObject by its ID
+
+ \param aObjectID This parameter defines the ID of the required object
+ \return The obtained %SObject
*/
SObject FindObjectID (in ID aObjectID);
- const string FindObjectID__doc__ = "Allows to find a SObject by its ID";
-/*!
- Allows to find a %SObject by IOR of the object belonging to this %SObject.
+/*! \brief Create a %SObject by its ID
+
+ \param aObjectID This parameter defines the ID of the required object
+ \return The created %SObject
+*/
+ SObject CreateObjectID (in ID aObjectID);
+/*! \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
*/
SObject FindObjectIOR (in ID aObjectIOR);
- const string FindObjectIOR__doc__ = "Allows to find a SObject by IOR of the object belonging to this SObject.";
-/*!
- Returns a list of %SObjects belonging to this %Component. The Name Attribute
- of these %SObjects should correspond to <VAR>anObjectName</VAR>.
+/*! \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.
*/
ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
- const string FindObjectByName__doc__ = "Returns a list of SObjects belonging to this Component.";
-/*!
- Allows to find a %SObject by the path to it.
+/*! \brief Find a %SObject by the path to it.
+
+ \param thePath The path to the required %SObject.
+ \return The obtained %SObject.
*/
SObject FindObjectByPath(in string thePath);
- const string FindObjectByPath__doc__ = "Allows to find a SObject by the path to it.";
-/*!
- Returns the path to the %SObject.
+/*! \brief Get the path to the %SObject.
*/
string GetObjectPath(in Object theObject);
- const string GetObjectPath__doc__ = "Returns the path to the 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>
+/*! \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);
- const string SetContext__doc__ = "Sets the context of the study";
-/*!
- 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>
-
+/*! \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();
- const string GetContext__doc__ = "Gets the context of the study";
-/*!
- Returns a list of names of objects corresponding to the context.
+/*! \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);
- const string GetObjectNames__doc__ = "Returns a list of names of objects corresponding to the context.";
-/*!
- Returns a list of names of directories and subdirectories corresponding to the context.
+/*! \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);
- const string GetDirectoryNames__doc__ = "Returns a list of names of directories and subdirectories corresponding to the context.";
-/*!
- Returns a list of names of Files corresponding to the context.
+/*! \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);
- const string GetFileNames__doc__ = "Returns a list of names of Files corresponding to the context.";
-/*!
- Returns a list of names of Components corresponding to the context.
+/*! \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);
- const string GetComponentNames__doc__ = "Returns a list of names of Components corresponding to the context.";
-/*! \brief Creation of a new iterator of child levels
+/*! \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);
- const string NewChildIterator__doc__ = "Creates a new iterator of child levels of the SObject";
-/*! \brief Creation of a new iterator of the %SComponent
- Creates a new iterator of the %SComponent.
+/*! \brief Create a new iterator of the %SComponents.
+
+ \return A new iterator of the %SComponents.
*/
SComponentIterator NewComponentIterator();
- const string NewComponentIterator__doc__ = "Creates a new iterator of the SComponent.";
-/*! \brief Creation of a %StudyBuilder
- 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>
+/*! \brief Create a new %StudyBuilder to add or modify an object in the study.
+
+ \return A new %StudyBuilder.
+<em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
*/
StudyBuilder NewBuilder() ;
- const string NewBuilder__doc__ = "Creates a new StudyBuilder to add or modify an object in the study.";
/*! \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);
- const string UpdateIORLabelMap__doc__ = "Updates the map with IOR attribute. It's an inner method used for optimization.";
/*! \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();
- const string GetProperties__doc__ = "Returns the attriubte, which contains the properties of this study.";
-/*!
- Determines whether the %study has been saved
+/*! \brief Indicate whether the %study has been saved
*/
attribute boolean IsSaved;
- const string IsSaved__doc__ = "Determines whether the study has been saved.";
-/*!
+/*! \brief Indicate whether the %study has been modified and not saved.
+
Returns True if the %study has been modified and not saved.
*/
boolean IsModified();
- const string IsModified__doc__ = "Returns True if the study has been modified and not saved.";
-/*!
- Determines the file where the %study has been saved
+
+/*! \brief Mark the %study as being modified and not saved.
+*/
+ void Modified();
+
+/*! \brief Indicate the file where the %study has been saved
*/
attribute string URL;
Returns the list of %SObjects which refers to %anObject.
*/
ListOfSObject FindDependances(in SObject anObject);
- const string FindDependances__doc__ = "Returns the list of SObjects which refers to anObject.";
/*! \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();
- const string GetLastModificationDate__doc__ = "Returns the date of the last saving of study with format: DD/MM/YYYY HH:MM";
/*! \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();
- const string GetModificationsDate__doc__ = "Returns the list of modification dates (without creation date) with format DD/MM/YYYY HH:MM.";
/*! \brief Object conversion.
Converts an object into IOR.
\return IOR
*/
string ConvertObjectToIOR(in Object theObject);
- const string ConvertObjectToIOR__doc__ = "Converts an object into IOR.";
/*! \brief Object conversion.
Converts IOR into an object.
\return An object
*/
Object ConvertIORToObject(in string theIOR);
- const string ConvertIORToObject__doc__ = "Converts IOR into an object.";
-/*!
- Gets a new %UseCaseBuilder.
+/*! \brief Get a new %UseCaseBuilder.
*/
UseCaseBuilder GetUseCaseBuilder();
- const string GetUseCaseBuilder__doc__ = "Gets a new UseCaseBuilder.";
-/*!
- Closes the components in the study, removes itself from the %StudyManager.
+/*! \brief Close the components in the study, remove itself from the %StudyManager.
*/
void Close();
- const string Close__doc__ = "Closes the components in the study, removes itself from the StudyManager.";
-/*!
- Enables(if isEnabled = True)/disables automatic addition of new %SObjects to the use case.
+/*! \brief Enable (if isEnabled = True)/disable automatic addition of new %SObjects to the use case.
*/
void EnableUseCaseAutoFilling(in boolean isEnabled);
- const string EnableUseCaseAutoFilling__doc__ = "Enables(if isEnabled = True)/disables automatic addition of new SObjects to the use case.";
+
+/*!
+ Functions for internal usage only
+*/
+ void AddPostponed(in string theIOR);
+
+ void AddCreatedPostponed(in string theIOR);
+
+ void RemovePostponed(in long theUndoLimit);
+
+ void UndoPostponed(in long theWay);
+
+ boolean DumpStudy(in string thePath, in string theBaseName, in boolean isPublished);
+
+/*! \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);
+
+/*! \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
+*/
+ AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint);
+
+
+/*! \brief Get a default Python script to restore visual parameters for given %theModuleName.
+
+ \param theID identifies a common parameters set (Example: "Interface Applicative")
+ \param theModuleName is a name of the module (Example: "Geometry")
+*/
+ string GetDefaultScript(in string theID, in string theModuleName);
+
+/*!
+ 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
+*/
+ long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
+
+
+/*! \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 SetStudyLock(in string theLockerID);
+
+/*! \brief Indicate if the Study is locked
+
+ Returns True if the Study was marked locked.
+*/
+ boolean IsStudyLocked();
+
+/*! \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 UnLockStudy(in string theLockerID);
+
+/*! \brief Get the list of IDs of the Study's lockers.
+*/
+ ListOfStrings GetLockerID();
+
+/*! \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 SetReal( in string theVarName, in double theValue );
+
+/*! \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 SetInteger( in string theVarName, in long theValue );
+/*! \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.
+*/
+ void SetBoolean( in string theVarName, in boolean theValue );
+
+/*! \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.
+*/
+ void SetString( in string theVarName, in string theValue );
+
+/*! \brief Set current value as double for string variable
+*/
+ void SetStringAsDouble( in string theVarName, in double theValue );
+
+/*! \brief Get value of a real variable
+
+ \param theVarName is a name of the variable.
+*/
+ double GetReal( in string theVarName );
+
+/*! \brief Get value of an integer variable
+
+ \param theVarName is a name of the variable.
+*/
+ long GetInteger( in string theVarName );
+
+/*! \brief Get value of a boolean variable
+
+ \param theVarName is a name of the variable.
+*/
+ boolean GetBoolean( in string theVarName );
+
+/*! \brief Get value of a string variable
+
+ \param theVarName is a name of the variable.
+*/
+ string GetString( in string theVarName );
+
+
+/*! \brief Indicate if a variable is real
+
+ Return true if variable is real otherwise return false.
+ \param theVarName is a name of the variable.
+*/
+ boolean IsReal( in string theVarName );
+
+/*! \brief Indicate if a variable is integer
+
+ Return true if variable is integer otherwise return false.
+ \param theVarName is a name of the variable.
+*/
+ boolean IsInteger( in string theVarName );
+
+/*! \brief Indicate if a variable is boolean
+
+ Return true if variable is boolean otherwise return false.
+ \param theVarName is a name of the variable.
+*/
+ boolean IsBoolean( in string theVarName );
+
+/*! \brief Indicate if a variable is string
+
+ Return true if variable is string otherwise return false.
+ \param theVarName is a name of the variable.
+*/
+ boolean IsString( in string theVarName );
+
+/*! \brief Indicate if a variable exists in the study
+
+ Return true if variable exists in the study,
+ otherwise return false.
+ \param theVarName is a name of the variable.
+*/
+ boolean IsVariable( in string theVarName );
+
+/*! \brief Get names of all variables from the study.
+*/
+ ListOfStrings GetVariableNames();
+
+/*! \brief Remove a variable
+
+ Remove variable with the specified name from the study with substitution of its value.
+
+ \param theVarName Name of the variable.
+ \return Status of operation.
+*/
+ boolean RemoveVariable( in string theVarName );
+
+/*! \brief Rename a variable
+
+ Rename variable with the specified name within the study.
+
+ \param theVarName Name of the variable.
+ \param theNewVarName New name for the variable.
+ \return Status of operation.
+*/
+ boolean RenameVariable( in string theVarName, in string theNewVarName );
+
+/*! \brief Indicate whether variable is used
+
+ Check that variable is used in the study.
+
+ \param theVarName Name of the variable.
+ \return Variable usage.
+*/
+ boolean IsVariableUsed( in string theVarName );
+
+/*! \brief Parse variables used for object creation
+
+ \param string with variables, separated by special symbol.
+ \return Variables list.
+*/
+ ListOfListOfStrings ParseVariables( in string theVars );
+
+/*!
+ Attach an observer to the Study
+
+ \param theObserver
+*/
+ void attach(in SALOMEDS::Observer theObserver, in boolean modify);
};
- const string Study__doc__ = "The Study interface contains a set of mrthods used for management of \nthe data produced by various components of SALOME platform.";
//==========================================================================
/*! \brief %Study Builder Interface
Creates a new %SComponent
\param ComponentDataType Data type of the %SComponent which will be created.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- SComponent NewComponent(in string ComponentDataType);
- const string NewComponent__doc__ = "Creates a new SComponent.";
+ SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
/*! \brief Definition of the instance to the %SComponent
Defines the instance to the %SComponent.
*/
- void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR);
- const string DefineComponentInstance__doc__ = "Defines the instance to the SComponent.";
-/*! \brief Deletion of the %SComponent
+ void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
+
+/*! \brief Deletion of a %SComponent
- Removes the %SComponent.
+ Removes a %SComponent.
*/
- void RemoveComponent(in SComponent aComponent);
- const string RemoveComponent__doc__ = "Removes the SComponent.";
+ void RemoveComponent(in SComponent aComponent) raises(LockProtection);
/*! \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>
+ Creates a new %SObject under a definite father %SObject.
+
+ \param theFatherObject The father %SObject under which this one should be created.
+ \return New %SObject
+
+<em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- SObject NewObject (in SObject theFatherObject);
- const string NewObject__doc__ = "Creates a new SObject.";
+
+ SObject NewObject (in SObject theFatherObject) raises(LockProtection);
+
/*! \brief Creation of a new %SObject with a definite %tag
Creates a new %SObject with a definite %tag.
+
+ \param atag Long value corresponding to the tag of the new %SObject.
+ \return New %SObject
+
*/
- SObject NewObjectToTag (in SObject theFatherObject, in long atag);
- const string NewObjectToTag__doc__ = "Creates a new SObject with a definite tag.";
+ SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
/*! \brief Deletion of the %SObject
Removes a %SObject from the %StudyBuilder.
+
+ \param anObject The %SObject to be deleted.
*/
- void RemoveObject (in SObject anObject);
- const string RemoveObject__doc__ = "Removes a SObject from the StudyBuilder.";
+ void RemoveObject (in SObject anObject) raises(LockProtection);
/*! \brief Deletion of the %SObject with all his child objects.
Removes the %SObject with all his child objects.
+
+ \param anObject The %SObject to be deleted with all child objects.
*/
- void RemoveObjectWithChildren(in SObject anObject);
- const string RemoveObjectWithChildren__doc__ = "Removes the SObject with all his child objects.";
+ void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
/*!
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>
+
+<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
- const string LoadWith__doc__ = "Loads a SComponent.";
/*!
Loads a %SObject.
+
+ \param sco %SObject to be loaded.
*/
void Load (in SObject sco);
- const string Load__doc__ = "Loads a SObject.";
/*! \brief Looking for or creating an attribute assigned to the %SObject
\param anObject The %SObject corresponding to the attribute which is looked for.
\param aTypeOfAttribute Type of the attribute.
- <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
GenericAttribute FindOrCreateAttribute(in SObject anObject,
- in string aTypeOfAttribute);
- const string FindOrCreateAttribute__doc__ = "Allows to find or create an attribute of a specific type which is assigned to the object.";
+ in string aTypeOfAttribute) raises(LockProtection);
-/*! \brief Looking for an attribute assigned to %SObject
+/*! \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.
boolean FindAttribute(in SObject anObject,
out GenericAttribute anAttribute,
in string aTypeOfAttribute);
- const string FindAttribute__doc__ = "Allows to find an attribute of a specific type which is assigned to the object.";
/*! \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.
-<BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<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);
- const string RemoveAttribute__doc__ = "Removes the attribute of a specific type which is assigned to the object.";
-/*! \brief Addition of a reference
-
+ 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) ;
- const string Addreference__doc__ = "Adds a reference between anObject and theReferencedObject.";
+
+/*!
+ Removes a reference from %anObject to another object.
+ \param anObject The %SObject which contains a reference
+*/
+
+ void RemoveReference(in SObject anObject) ;
+
/*!
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>
+ \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);
- const string AddDirectory__doc__ = "Adds a directory in the Study.";
+ void AddDirectory(in string theName) raises(LockProtection);
/*! \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"
+
+
+ \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);
- const string SetGUID__doc__ = "Identification of the %SObject's substructure by GUID. \nIt has the following format: 00000000-0000-0000-0000-000000000000.";
+ 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 the %SObject has GUID.
+\param anObject A definite %SObject which will be identified
+\param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
*/
boolean IsGUID(in SObject anObject, in string theGUID);
- const string IsGUID__doc__ = "Returns True if the SObject has GUID.";
/*! \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>
+
+<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void NewCommand(); // command management
- const string NewCommand__doc__ = "Creates a new command which can contain several different actions.";
/*! \brief Execution of the command
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>
+
+ \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>
*/
void CommitCommand() raises(LockProtection); // command management
- const string CommitCommand__doc__ = "Commits all actions declared within this command.";
/*!
Returns True if at this moment there is a command under execution.
*/
boolean HasOpenCommand();
- const string HasOpenCommand__doc__ = "Returns True if at this moment there is a command under execution.";
/*! \brief Cancelation of the command
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>
+
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void AbortCommand(); // command management
- const string AbortCommand__doc__ = "Cancels all actions declared within the command.";
/*! \brief Undolimit
The number of actions which can be undone
/*! \brief Undo method
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>
+
+ \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>
*/
void Undo() raises (LockProtection);
- const string Undo__doc__ = "Cancels all actions of the last command.";
/*! \brief Redo method
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>
+
+\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>
*/
void Redo() raises (LockProtection);
- const string Redo__doc__ = "Redoes all actions of the last command.";
/*!
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>
+
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean GetAvailableUndos();
- const string GetAvailableUndos__doc__ = "Returns True if at this moment there are any actions which can be canceled.";
/*!
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>
+
+<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean GetAvailableRedos();
- const string GetAvailableRedos__doc__ = "Returns True if at this moment there are any actions which can be redone.";
/*!
- Sets the callback for addition of the given %SObject. Returns the previous callback.
+ 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.
*/
- Callback SetOnAddSObject(in Callback theCallback);
- const string SetOnAddSObject__doc__ = "Sets the callback for addition of the given SObject.";
+ void SetName(in SObject theSO, in string theValue) raises (LockProtection);
+
/*!
- Sets the callback for removal of the given %SObject. Returns the previous callback.
+ 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.
*/
- Callback SetOnRemoveSObject(in Callback theCallback);
- const string SetOnRemoveSObject__doc__ = " Sets the callback for removal of the given SObject.";
+ 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);
};
- const string StudyBuilder__doc__ = "The Study Builder Interface contains a set of methods used for adding and/or removing objects and attributes.";
//==========================================================================
/*! \brief %Study Manager interface
Determines whether the server has already been loaded or not.
*/
void ping();
- const string ping__doc__ = "Determines whether the server has already been loaded or not.";
-/*! \brief Creation of a new %Study
+ void Shutdown();
- 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>
+/*!
+ Returns the PID of the server
+*/
+ long getPID();
+
+/*!
+ Shutdown the StudyManager process.
+*/
+ oneway void ShutdownWithExit();
+
+/*! \brief Creation of a new study
+
+ Creates a new study with a definite name.
+
+ \param study_name String parameter defining the name of the study
+
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
*/
Study NewStudy(in string study_name);
- const string NewStudy__doc__ = "Creates a new study with a definite name.";
/*! \brief Open a study
Reads and activates the structure of the study %Objects.
+ \param aStudyUrl The path to the study
\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>
+
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
- const string Open__doc__ = "Reads and activates the structure of the study objects.";
/*! \brief Closing the study
- Closes the study.
+ Closes a study.
*/
void Close(in Study aStudy);
- const string Close__doc__ = "Closes the study.";
-/*! \brief Saving the study
+/*! \brief Saving the study in a HDF file (or files).
+
+ Saves a study.
+
+ \param theMultiFile If this parameter is True the study will be saved in several files.
- 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>
+<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- void Save(in Study aStudy, in boolean theMultiFile);
- const string Save__doc__ = "Saves the study.";
-/*! \brief Saving the study in a file
+ boolean Save(in Study aStudy, in boolean theMultiFile);
+/*! \brief Saving a study in a ASCII file (or files).
+
+ 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 Study aStudy, in boolean theMultiFile);
+/*! \brief Saving the study in a specified HDF 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 theMultiFile If this parameter is True the study will be saved in several files.
- 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>
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- void SaveAs(in URL aUrl, // if the file already exists
+ boolean SaveAs(in URL aUrl, // if the file already exists
in Study aStudy,
in boolean theMultiFile); // overwrite (as option)
- const string SaveAs__doc__ = "Saves the study in a specified file.";
+/*! \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 URL aUrl, // if the file already exists
+ in Study aStudy,
+ in boolean theMultiFile); // overwrite (as option)
+
+
/*! \brief List of open studies.
- Returns the list of open studies in the current session.
+Gets the list of open studies
+
+ \return A list of open studies in the current session.
*/
ListOfOpenStudies GetOpenStudies();
- const string GetOpenStudies__doc__ = "Returns the list of open studies in the current session.";
/*! \brief Getting a particular %Study picked by name
Activates a particular %Study
- amongst the session collection picking it by name.
+ among the session collection picking it by name.
+ \param aStudyName The name of the study
*/
Study GetStudyByName (in string aStudyName);
- const string GetStudyByName__doc__ = "Activates a particular study amongst the session collection picking it by name.";
/*! \brief Getting a particular %Study picked by ID
Activates a particular %Study
- amongst the session collection picking it by ID.
+ among the session collection picking it by ID.
+ \param aStudyID The ID of the study
*/
Study GetStudyByID (in short aStudyID);
- const string GetStudyByID__doc__ = "Activates a particular study amongst the session collection picking it by ID.";
// copy/paste methods
Returns True, if the given %SObject can be copied to the clipboard.
*/
boolean CanCopy(in SObject theObject);
- const string CanCopy__doc__ = "Returns True, if the given SObject can be copied to the clipboard.";
/*!
Returns True, if the given %SObject is copied to the clipboard.
+ \param theObject The %SObject which will be copied
*/
boolean Copy(in SObject theObject);
- const string Copy__doc__ = "Returns True, if the given SObject is copied to the clipboard.";
/*!
Returns True, if the object from the clipboard can be pasted to the given %SObject.
+ \param theObject The %SObject stored in the clipboard.
*/
boolean CanPaste(in SObject theObject);
- const string CanPaste__doc__ = "Returns True, if the object from the clipboard can be pasted to the given 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.
*/
SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
- const string Paste__doc__ = "Returns the SObject in which the object from the clipboard was pasted to.";
+
+/*! \brief Object conversion.
+
+ Converts an object into IOR.
+ \return IOR
+*/
+ string ConvertObjectToIOR(in Object theObject);
+/*! \brief Object conversion.
+
+ Converts IOR into an object.
+ \return An object
+*/
+ Object ConvertIORToObject(in string theIOR);
+
+/*!
+ Private method, returns an implementation of this StudyManager.
+ \param theHostname is a hostname of the caller
+ \param thePID is a process ID of the caller
+ \param isLocal is set True if the StudyManager is launched locally with the caller
+*/
+ long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
+
+
};
- const string StudyManager__doc__ = "The purpose of the Manager is to manipulate the studies. \nThe StudyManager interface contains a set of methods to create, open,close and save a study.";
//==========================================================================
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();
- const string GetID__doc__ = "Returns ID of the SObject.";
-/*! \brief Acquisition of the father %Component of the %SObject
+/*! Acquisition of the father %Component of the %SObject
- Returns the father %Component of the %SObject.
+ \return The father %Component of the %SObject.
*/
SComponent GetFatherComponent();
- const string GetFatherComponent__doc__ = "Returns the father Component of the SObject.";
-/*! \brief Acquisition of the father %SObject of the %SObject
+/*! Acquisition of the father %SObject of the %SObject
- Returns the father %SObject of the given %SObject.
+ \return the father %SObject of the given %SObject.
*/
SObject GetFather();
- const string GetFather__doc__ = "Returns the father SObject of the given SObject.";
-/*! \brief %Tag of %SObject
+/*! Gets the %tag of a %SObject
- Returns the %tag of the %SObject.
+ \return the %tag of a %SObject.
*/
short Tag();
- const string Tag__doc__ = "Returns the tag of the SObject.";
-/*! \brief Looking for subobjects of an object.
+/*! Gets the depth of a %SObject
+
+ \return the depth of a %SObject.
+*/
+ short Depth();
+/*! Looks for subobjects of a given %SObject.
- Returns True if it finds a subobject of the %SObject with a definite tag.
+ \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);
- const string FindSubObject__doc__ = "Returns True if it finds a subobject of the SObject with a definite tag.";
-/*! \brief Looking for attributes of the %SObject
+/*! Looks for attributes of a given %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>
+ \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);
- const string FindAttribute__doc__ = "Returns True if it finds an attribute of a definite type of the given SObject.";
-/*!
- Returns the object which this %SObject refers to. It also returns True if it finds
+/*! 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
- const string ReferencedObject__doc__ = "Returns the object which this given SObject refers to. \nIt also returns True if it finds this object.";
-/*! \brief Getting all attributes of the %SObject
+/*! Gets all attributes of a given %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>
+ \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();
- const string GetAllAttributes__doc__ = "Returns the list of all attributes of the given SObject.";
-/*! \brief Returning the study
+/*! Gets the study of a given %SObject.
- Returns the study containing the given %SObject.
+ \return The study containing the given %SObject.
*/
Study GetStudy();
- const string GetStudy__doc__ = "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
+*/
+ long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
};
- const string SObject__doc__ = "The objects in the study are built by the StudyBuilder. \nThe SObject interface provides methods for elementary inquiries, \nlike getting an object ID or its attribuites.";
//==========================================================================
/*! \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);
- const string CheckLocked__doc__ = "Checks whether the study is protected for modifications.";
+
+ //! 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);
};
- const string GenericAttribute__doc__ = "GenericAttribute is a base interface for all attributes which inherit its methods.";
//==========================================================================
/*! \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();
- const string ComponentDataType__doc__ = "Returns the data type of the SComponent.";
-/*!
- 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
- const string ComponentIOR__doc__ = "Returns IOR of the according component.";
};
- const string SComponent__doc__ = "The SComponent interface is a specialization of the SObject interface. \nIt inherits the most of its methods from the SObject interface.";
//==========================================================================
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();
- const string Init__doc__ = "Activates the SComponentIterator.";
-/*! \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();
- const string More__doc__ = "Returns True if there is one more SComponent in the list.";
-/*! \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();
- const string Next__doc__ = "Moves the iterator to the next SComponent in the list.";
/*!
- 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();
- const string Value__doc__ = "Returns the SComponent corresponding to the current SComponent found by the iterator.";
};
- const string SComponentIterator__doc__ = "This interface contains the methods allowing to iterate over all components in the list. \nThe search is started from the first SComponent in the list.";
//==========================================================================
/*! \brief %ChildIterator interface
levels.
*/
//==========================================================================
- interface ChildIterator
+ interface ChildIterator : SALOME::GenericObj
{
-/*! \brief Initialization of the Iterator.
+/*!
-Activates the %ChildIterator.
+\brief Activates the %ChildIterator.
*/
void Init();
- const string Init__doc__ = "Activates the ChildIterator.";
-/*! \brief Initialization of the Iterator for all child levels.
+/*!
+
+\brief Activates the %ChildIterator for all child levels.
-Activates the %ChildIterator (if True) 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);
- const string InitEx__doc__ = "Activates the ChildIterator (if True) for all child levels.";
/*! \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();
- const string More__doc__ = "Returns True if the ChildIterator finds one more child level.";
/*!
- Passes the iterator to the next level.
+ \brief Passes the iterator to the next level.
*/
void Next();
- const string Next__doc__ = "Passes the iterator to the next level.";
/*!
- 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();
- const string Value__doc__ = "Returns the SObject corresponding to the current object found by the iterator.";
};
- const string ChildIterator__doc__ = "This interface contains methods which allow to iterate over all child levels.";
//==========================================================================
//==========================================================================
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);
- const string Init__doc__ = "Activates the UseCaseIterator. \nIf the value of the parameter allLevels is True the Iterator is activated for all subobjects.";
-/*! \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();
- const string More__doc__ = "Returns True if the UseCaseIterator finds one more object.";
/*!
Passes the iterator to the next object.
*/
void Next();
- const string Next__doc__ = "Passes the iterator to the next object.";
/*!
Returns the %SObject corresponding to the current object found by the Iterator.
*/
SObject Value();
- const string Value__doc__ = "Returns the SObject corresponding to the current object found by the Iterator.";
};
- const string UseCaseIterator__doc__ = "This interface contains a set of methods used for \niteration over the objects in the use case.";
//==========================================================================
//==========================================================================
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);
- const string Append__doc__ = "Adds to the use case an object as a child of the current object of the use case.";
/*!
- 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);
- const string Remove__doc__ = "Removes an object from the use case.";
/*!
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);
- const string AppendTo__doc__ = "Adds a child object to the given father object in the use case.";
/*!
Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
*/
boolean InsertBefore(in SObject theFirst, in SObject theNext);
- const string InsertBefore__doc__ = "Inserts in the use case an object before another object.";
/*!
Sets the current object of the use case.
*/
boolean SetCurrentObject(in SObject theObject);
- const string SetCurrentObject__doc__ = "Sets the current object of the use case.";
/*!
Makes the root object to be the current object of the use case.
*/
boolean SetRootCurrent();
- const string SetRootCurrent__doc__ = "Makes the root object to be the current object of the use case.";
/*!
Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
*/
boolean HasChildren(in SObject theObject);
- const string HasChildren__doc__ = "Returns True if the given object of the use case has child objects.";
/*!
Sets the name of the use case.
*/
boolean SetName(in string theName);
- const string SetName__doc__ = "Sets the name of the use case.";
/*!
Gets the name of the use case.
*/
string GetName();
- const string GetName__doc__ = "Gets the name of the use case.";
/*!
Returns True if the given object <VAR>theObject</VAR> represents a use case.
*/
boolean IsUseCase(in SObject theObject);
- const string IsUseCase__doc__ = "Returns True if the given object represents a use case.";
/*!
Gets the current object of the use case.
*/
SObject GetCurrentObject();
- const string GetCurrentObject__doc__ = "Gets the current object of the use case.";
/*!
Creates a new use case in the use case browser.
*/
SObject AddUseCase(in string theName);
- const string AddUseCase__doc__ = "Creates a new use case in the use case browser.";
/*!
Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
*/
UseCaseIterator GetUseCaseIterator(in SObject theObject);
- const string GetUseCaseIterator__doc__ = "Returns the UseCaseIterator for the given object in the use case.";
};
- const string UseCaseBuilder__doc__ = "The UseCaseBuilder interface contains a set of methods \nused for management of the use case in the study.";
- //==========================================================================
- //==========================================================================
-/*! \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);
- const string OnAddSObject__doc__ = "Invokes the corresponding method Append of the UseCaseBuilder.";
-/*!
- Invokes the corresponding method <VAR>Remove</VAR> of the %UseCaseBuilder.
-*/
- void OnRemoveSObject(in SObject theObject);
- const string OnRemoveSObject__doc__ = "Invokes the corresponding method Remove of the UseCaseBuilder.";
- };
- const string Callback__doc__ = "The callback interface contains a set of methods which are called \nwhen adding or removing of the objects by the StudyBuilder.";
-
//==========================================================================
/*! \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 by the StudyManager 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> 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.
\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);
- const string Save__doc__ = "This method is called by the StudyManager when saving a study.";
+/*! \brief Saving the data in ASCII format produced by a definite component.
+
+ This method is called by the StudyManager 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.
\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);
- const string Load__doc__ = "This method is called by the StudyManager when opening a study.";
+ /*! \brief Loading the data from files in ASCII format.
+
+ This method is called by the StudyManager 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.
-
+ \param aSComponent The according %SComponent
*/
void Close (in SComponent aSComponent);
- const string Close__doc__ = "This method Close is called by the StudyManager when closing a study.";
//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();
- const string ComponentDataType__doc__ = "Returns the type of data produced by the Component in the study.";
// 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);
- const string IORToLocalPersistentID__doc__ = "Transforms IOR into PersistentID of the object.";
+ string IORToLocalPersistentID (in SObject theSObject,
+ 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)
+ string LocalPersistentIDToIOR (in SObject theSObject,
+ in string aLocalPersistentID,
+ in boolean isMultiFile,
+ in boolean isASCII)
raises (SALOME::SALOME_Exception);
- const string LocalPersistentIDToIOR__doc__ = "Transforms PersistentID into IOR of the object.";
// 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);
- const string CanPublishInStudy__doc__ = "Returns True if the given Component can publish the object in the study.";
/*! \brief Publishing in the study
Publishes the given object in the %study, using the algorithm of this component.
\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);
- const string PublishInStudy__doc__ = "Publishes the given object in the study, using the algorithm of this component.";
// 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);
- const string CanCopy__doc__ = "Returns True, if the given SObject can be copied to the clipboard.";
/*!
Returns the object %ID and the %TMPFile of the object from the given %SObject.
*/
TMPFile CopyFrom(in SObject theObject, out long theObjectID);
- const string CopyFrom__doc__ = "Returns the object ID and the TMPFile of the object from the given SObject.";
/*!
Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
*/
boolean CanPaste(in string theComponentName, in long theObjectID);
- const string CanPaste__doc__ = "Returns True, if the component can paste the object with given ID of the component with name <VAR>theComponentName</VAR>.";
/*!
Returns the %SObject of the pasted object.
*/
SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);
- const string PasteInto__doc__ = "Returns the SObject of the pasted object.";
};
- const string Driver__doc__ = "This interface contains a set of methods used for the management \nof the object produced in the study by a component.";
};
-
+
#endif
