#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
-"""Create a virtual Salome installation
-
-"""
+## \file appli_gen.py
+# Create a %SALOME application (virtual Salome installation)
+#
usage="""usage: %prog [options]
Typical use is:
python appli_gen.py
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## \file killSalome.py
+# Stop all %SALOME servers from all sessions by killing them
+#
+
import os, sys, re, signal
from killSalomeWithPort import killMyPort, getPiDict
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## \file killSalomeWithPort.py
+# Stop all %SALOME servers from given sessions by killing them
+#
+# The sessions are indicated by their ports on the command line as in :
+#
+# killSalomeWithPort.py 2811 2815
+#
+
import os, sys, pickle, signal, commands,glob
from launchConfigureParser import verbose
import Utils_Identity
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## @package orbmodule
+# \brief Module that provides a client for %SALOME
+#
+#
+
import sys,os,time
import string
from nameserver import *
# -----------------------------------------------------------------------------
class client:
+ """Client for SALOME"""
def __init__(self,args=None):
#set GIOP message size for bug 10560: impossible to get field values in TUI mode
# --------------------------------------------------------------------------
def showNS(self):
- """ Show the content of NS"""
+ """ Show the content of SALOME naming service """
self.showNScontext(self.rootContext)
# --------------------------------------------------------------------------
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## @package runSalome
+# \brief Module that provides services to launch SALOME
+#
+#
+
import sys, os, string, glob, time, pickle, re
import orbmodule
import setenv
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## @package salome_session
+# \brief Module that provides the SalomeSession object that helps to launch
+# a SALOME script session
+#
+#
+
import os
import sys
import string
class SalomeSession(object):
+ """Salome session launcher"""
import runSalome
import killSalomeWithPort
import killSalome
# Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
# ---
#
-"""
-Set of utility functions used by SALOME python scripts.
-"""
+## @package salome_utils
+# \brief Set of utility functions used by SALOME python scripts.
+#
+#
#
# Exported functions
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## \file showNS.py
+# \brief display the contents of %SALOME naming service
+#
+
import orbmodule
clt=orbmodule.client()
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## \file shutdownSalome.py
+# shutdown all %SALOME servers and naming service
+#
+#
+
import time
import salome
salome.salome_init()
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## \file waitContainers.py
+# \brief command to wait until containers are launched
+#
+# the container names (in naming service) are passed on the command line as in :
+# waitContainers.py FactoryServer
+
import sys
import time
import orbmodule
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## \file waitNS.py
+# \brief command to wait until module catalog server is launched
+#
import orbmodule
clt=orbmodule.client()
clt.waitNS("/Kernel/ModulCatalog")
./doc/Makefile \
./doc/salome/Makefile \
./doc/salome/tui/Makefile \
- ./doc/salome/tui/INPUT/doxyuser:./doc/salome/tui/KERNEL/doxyuser.in \
- ./doc/salome/tui/INPUT/doxydev:./doc/salome/tui/KERNEL/doxydev.in \
- ./doc/salome/tui/INPUT/sources/static/tree.js:./doc/salome/tui/KERNEL/sources/static/tree.js.in \
+ ./doc/salome/tui/doxyfile \
+ ./doc/salome/gui/Makefile \
+ ./doc/salome/gui/doxyfile \
./idl/Makefile \
./resources/Makefile \
./resources/KERNELCatalog.xml \
+++ /dev/null
-=================================================================
-Installation instructions, up to date for 3.0 version
-=================================================================
-
-*html version of this document is produced with docutils*::
-
- rst2html < doc.txt > doc.html
-
-*This document corresponds to SALOME2 2.2.9.*
-*IT IS NOT UP TO DATE with 3.2.0*
-
-.. contents::
-.. sectnum::
-
-+-------------------------------------------+
-| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
-+-------------------------------------------+
-
--------------------------------------------------------------------------------
-
-You'll find here generic instructions for installing the SALOME2 platform.
-
-Summary
--------
-
-`1. Quick Overview`_
-
-`2. System configuration`_
-
-`3. Third-party dependencies`_
-
-`4. Preparing the shell environment`_
-
-`5. Installing the KERNEL component`_
-
-`6. Installing the SALOME components`_
-
-`7. Runtime`_
-
-`8. Suggestions and advices`_
-
-
-1. Quick Overview
------------------
-
-First of all, you have to check (or install if needed) the dependant
-software programs on your system. These programs are:
-
-- common development tools as gcc, automake, autoconf and libtools.
-- third party softwares used in SALOME building or runtime process
- (python, OCC, VTK, ...)
-
-Further details can be found in sections [2] and [3].
-
-If the dependencies are installed on your system, then you have to set
-your shell environment to get access to the software components
-(cf. [4]. "Preparing the shell environment").
-
-The next step is to install the KERNEL (cf. [5] "Installing KERNEL"):
-
-::
-
-$ mkdir <kernel_build>
-$ mkdir <kernel_install>
-$ cd <kernel_src>
-$ ./build_configure
-$ cd <kernel_build>
-$ <kernel_src>/configure --prefix=<kernel_install>
-$ make
-$ make install
-
-Then, the SALOME components GEOM, MED, VISU, ... can be installed
-with a similar procedure (cf. [6]).
-
-Eventually, the platform can be run by executing the shell script
-runSalome (cf. [7]). Here, somme additionnal variables have to be set
-to describe the SALOME runtime configuration (<COMPONENT>_ROOT_DIR,
-OMNIORB_CONFIG)
-
-The following provides you with specific instructions for each step.
-
-
-2. System configuration
------------------------
-
-SALOME is compiled and tested on differents platforms with native packages:
-- Debian sarge
-- Mandrake 10.1
-- ...
-
-If you have another platform, we suggest the following configuration
-for building process:
-
-- gcc-3.3.x or 3.4.x
-- automake-1.7 or more (only aclocal is used)
-- autoconf-2.59
-- libtool-1.5.6
-
-remarks:
-
-- This is the minimum level of automake, autoconf and libtool, if you need
- to compile all the third party softwares (included OpenCascade 5.2.x).
-
-3. Third-party dependencies
----------------------------
-
-The SALOME platform relies on a set of third-party softwares. The
-current version depends on the following list
-(versions given here are from Debian Sarge, except OpenCascade, VTK and MED,
-which are not Debian packages):
-
-CAS-5.2.4 OpenCascade (try binaries,a source patch is needed)
-VTK-4.2.6 VTK 3D-viewer
-PyQt-3.13 Python-Qt Wrapper
-Python-2.3.5 Python interpreter
-SWIG-1.3.24 SWIG library
-boost-1_32_0 C++ library (only include templates are used)
-hdf5-1.6.2 Files Database library
-med-2.2.2 MED Data Format support for file records
-omniORB-4.0.5 ORB used in SALOME
-qt-x11-free-3.3.3 Qt library
-qwt-4.2 Graph components for Qt
-sip4-4.1.1 langage binding software
-
-And, in order to build the documentation:
-
-doxygen-1.4.2
-graphviz-2.2.1
-
-
-Additionnal software may be installed for optional features:
-
-netgen4.3 + patch
-tix8.1.4
-openpbs-2.3.16
-lsf-???
-
-
-
-3.1 To Do
-~~~~~~~~~
-- Instructions for installing these software programs can be found in a
- special note doc/configuration_examples/install-prerequis.
-- Installation shell scripts are also provided.
- These scripts have to be adapted to your own configuration.
-
-- See doc/configuration_examples/*
-
-In the following, we assume that all the third-party softwares are
-installed in the same root directory, named <salomeroot>/prerequis.
-Then, your file system should probably look like::
-
- <salomeroot>/prerequis/Python-2.2.2
- <salomeroot>/prerequis/omniORB-3.0.5
- <salomeroot>/prerequis/qt-x11-free-3.0.5
- ...
-
-
-4. Preparing the shell environment
-----------------------------------
-
-Some variables have to be set to get acces to third-party software
-components (include files, executable, library, ...) during building
-process and runtime.
-
-The shell file prerequis.sh, embedded in the KERNEL source package,
-provides a template for setting those variables. In this example, all the
-softwares are supposed to be installed in the same root directory,
-named here INSTALLROOT.
-
-Copy the prerequis.sh in a working directory and adjust the settings
-to your own configuration. To get the shell prepared, just
-execute the following command in the building shell:
-
-$ source prerequis.sh
-
-(we assume here a ksh or bash mode)
-
-
-5. Installing the KERNEL component
-----------------------------------
-
-We use here the notation <kernel_src> to specify the source directory
-of the KERNEL component. The shell environment is supposed to have
-been set (cf. 4).
-
-Installing the KERNEL from a source package needs three directories:
-
-- the source directory, denoted here by <kernel_src>.
-
-- the build directory, denoted by <kernel_build> in the following. This
- directory can't be the same directory as <kernel_src>.
-
-- the install directory, denoted by <kernel_install> in the following. This
- directory can't be the same directory as <kernel_src> or
- <kernel_build>.
-
-The installing process is:
-
-STEP 1:
- preparing directories
-
- create the <kernel_build> and the <kernel_install> directories::
-
- $ mkdir <kernel_build>
- $ mkdir <kernel_install>
-
-STEP 2:
- build configure script
-
- go to <kernel_src> directory and generate the "configure" script::
-
- $ cd <kernel_src>
- $ ./build_configure
-
- If it doesn't work, check your system automake tools as specified in
- section [2].
-
-STEP 3:
- configure the building process
- go to the build directory and execute the configuration process::
-
- $ cd <kernel_build>
- $ <kernel_src>/configure --prefix=<kernel_install>
-
- Note that <kernel_install> must be an absolute path.
-
- When the configure process is complete, check the status of
- third-party softwares detection. You should have a status like::
-
- ---------------------------------------------
- Summary
- ---------------------------------------------
- Configure
- cc : yes
- boost : yes
- lex_yacc : yes
- python : yes
- swig : yes
- threads : yes
- OpenGL : yes
- qt : yes
- vtk : yes
- hdf5 : yes
- med2 : yes
- omniORB : yes
- occ : yes
- sip : yes
- pyqt : yes
- qwt : yes
- doxygen : yes
- graphviz : no
- openpbs : no
- lsf : no
- Default ORB : omniORB
- ----------------------------------------------
-
-If a software get a status "no", then it's not "seen" in the system:
-
-- the software is not installed, or
-- the shell environment is not set correctly.
-
-In this example, the software programs graphviz, openpbs and lsf are not
-installed (optional for most usages).
-
-
-STEP 4 :
- Building the binary files
-
- Execute make in the <kernel_build> directory::
-
- $ make
-
-
-STEP 5:
- Installing binary files, scripts and documentation
-
- Execute install target in the <kernel_build> directory::
-
- $ make install
-
-
-6. Installing the SALOME components
------------------------------------
-
-TInstalling a component <COMPONENT> is done by following the same
-instructions as given for the KERNEL, replacing KERNEL by
-<COMPONENT> (build_configure, configure, make, make install).
-
-You just have to be aware of the dependencies between components:
-
-- MED depends on KERNEL
-- GEOM depends on KERNEL
-- SMESH depends on KERNEL, MED, GEOM
-- VISU depends on KERNEL, MED
-- SUPERV depends on KERNEL
-
-For example, installing the component SMESH needs the previous
-installation of the KERNEL component, and then the GEOM and MED components.
-
-The building process uses the variables <COMPONENT>_ROOT_DIR to
-localize the dependant components. The variables must be set to the
-install path directory of the components <COMPONENT> (ex:
-KERNEL_ROOT_DIR=<kernel_install>).
-
-In the above example, the three variables KERNEL_ROOT_DIR,
-GEOM_ROOT_DIR and MED_ROOT_DIR have to be set before configuring the
-building process of the SMESH component (STEP 3).
-
-
-7. Runtime
-----------
-
-See SALOME_Application_ to define your own configuration of SALOME and run it
-on one or several computers. This is the recommended way of configuration.
-
-.. _SALOME_Application: ./SALOME_Application.html
-
-The following explains the general principles.
-
-To run the SALOME platform, the procedure is:
-
-- set the shell environment to get acces to third-party softwares::
-
- $ source prerequis.sh
-
-- define the SALOME configuration by setting the whole set of
- variables <COMPONENT>_ROOT_DIR. Here, you just have to set the
- kernel and the components you need::
-
- $ export KERNEL_ROOT_DIR=<kernel_install>
- $ export MED_ROOT_DIR=<med_install>
- $ ...
-
-- define the CORBA configuration file by setting the variable
- OMNIORB_CONFIG. This variable must be set to a writable file
- path. The file may be arbitrary chosen and doesn't need to exist
- before running. We suggest::
-
- $ export OMNIORB_CONFIG=$HOME/.omniORB.cfg
-
-- run the SALOME platform by executing the script runSalome::
-
- $KERNEL_ROOT_DIR/bin/salome/runSalome
-
-
-8. Suggestions and advices
---------------------------
-
-For convenience or customization, we suggest the following organisation:
-
-- chose and create a root directory for the SALOME platform, say
- <salomeroot>.
-
-- install the third-party softwares in a sub-directory "prerequis"
-
-- install the SALOME components in a sub-directory "SALOME2"
-
-- make personnal copies of the files prerequis.sh and runSalome in
- <salomeroot>::
-
- $ cp <kernel_src>/prerequis.sh <rundir>/.
- $ cp <kernel_install>/bin/salome/runSalome <rundir>/.
-
- Edit the file prerequis.sh and adjust it to your own configuration.
-
-- define the SALOME2 configuration
-
- This step consists in setting the KERNEL_ROOT_DIR, the whole set of
- variables <COMPONENT>_ROOT_DIR you need, and the OMNIORB_CONFIG
- variable.
-
- We suggest to create a shell file envSalome.sh containing those
- settings. Then the configuration consists in loading envSalome.sh in
- the runtime shell::
-
- $ source envSalome.sh
-
-- When installed with this file organisation, running SALOME is done
- with the following shell commands::
-
- $ source <salomeroot>/prerequis.sh
- $ source <salomeroot>/envSalome.sh
- $ ./runSalome
-
-
--------------------------------------------------------------------------------
-
-+----------------------------------+------------------------------------------+
-| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
-+----------------------------------+------------------------------------------+
-
-.. _`General KERNEL documentation`: ./index.html
-.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html
+++ /dev/null
-=================================================================
-KERNEL Services for end user (Python interface)
-=================================================================
-
-*html version of this document is produced with docutils*::
-
- rst2html < doc.txt > doc.html
-
-This document corresponds to SALOME2 3.2.0
-
-.. contents::
-.. sectnum::
-
-+-------------------------------------------+
-| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
-+-------------------------------------------+
-
--------------------------------------------------------------------------------
-
-In a SALOME application, distributed components, servers and clients use
-the CORBA middleware for comunication. CORBA interfaces are defined via idl
-files. All the different CORBA interfaces are available for users in Python,
-see CORBA interfaces below.
-
-For some general purpose services, CORBA interfaces have been encapsulated
-in order to provide a simple interface (encapsulation is generally done in
-C++ classes, and a Python SWIG interface is also generated from C++, to
-ensure a consistent behavior between C++ modules and Python modules or user
-script).
-
-General purpose services
-========================
-
-SALOME services access from a Python shell
-------------------------------------------
-See SALOME_Application_ for detailed instructions to launch a Python
-interpreter with full acces to the SALOME environment and services.
-
-.. _SALOME_Application: ./SALOME_Application.txt
-
-You can use the embedded Python interpreter in Grahic User Interface, or an
-external interpreter, with::
-
- ./runSession
- python
-
-In either cases, SALOME services access is done with::
-
- import salome
- salome.salome_init()
-
-In the embedded interpreter, it is already done, but there is no problem to
-do it several times, so it is preferable to add these instructions
-systematically in your scripts, to allow them to work in all configurations.
-
-Container and component instanciation
--------------------------------------
-
-See LifeCycleCORBA_ for the C++ interface (Python interface obtained with SWIG
-is very similar).
-
-.. _LifeCycleCORBA: ./tui/KERNEL/classSALOME__LifeCycleCORBA.html
-
-
-In the following example, a test component provided in KERNEL is launched
-in the local container, "FactoryServer", created when SALOME starts::
-
- import salome
- salome.salome_init()
-
- import LifeCycleCORBA
- lcc = LifeCycleCORBA.LifeCycleCORBA()
- obj=lcc.FindOrLoad_Component("FactoryServer","SalomeTestComponent")
-
- import Engines
- comp=obj._narrow(Engines.TestComponent)
-
- comp.Coucou(1)
-
-The answer is something like::
-
- 'TestComponent_i : L = 1'
-
-The _narrow() instruction is not always mandatory in Python, but sometimes
-useful to be sure you have got the right type of object. Here, Testcomponent_
-interface is defined in CORBA module Engines. With this example, it works also
-without the _narrow() instruction::
-
- obj.Coucou(1)
-
-.. _Testcomponent: ./tui/KERNEL/interfaceEngines_1_1TestComponent.html
-
-
-In the next example, a component instance is created in a specific Container
-defined by it's computer hostname and it's name. Here we use the local
-computer. Note that in Utils_Identity_, getShortHostName() gives the short
-hostname of the computer, without domain suffixes, which is used in SALOME.
-The container process is created here if it does not exists, and a new
-component instance is created::
-
- import salome
- salome.salome_init()
- import LifeCycleCORBA
- lcc = LifeCycleCORBA.LifeCycleCORBA()
-
- import Utils_Identity
- host = Utils_Identity.getShortHostName()
-
- import Engines
- params={}
- params['hostname']=host
- params['container_name']='myContainer'
- comp=lcc.LoadComponent(params,'SalomeTestComponent')
- comp.Coucou(1)
-
-.. _Utils_Identity: ./tui/KERNEL/namespaceUtils__Identity.html
-
-If you want to get a list of containers and component instances, client object
-from orbmodule_ provides a list::
-
- import orbmodule
- clt=orbmodule.client()
- clt.showNS()
-
-.. _orbmodule: ./tui/KERNEL/classorbmodule_1_1client.html
-
-The list looks like::
-
- Logger.
- ContainerManager.object
- Containers.dir
- cli70ac.dir
- FactoryServerPy.object
- SuperVisionContainer.object
- FactoryServer.object
- FactoryServer.dir
- SalomeTestComponent_inst_1.object
- myContainer.object
- myContainer.dir
- SalomeTestComponent_inst_1.object
- SalomeTestComponent_inst_2.object
- Registry.object
- Kernel.dir
- ModulCatalog.object
- Session.object
- Study.dir
- Study2.object
- extStudy_1.object
- extStudy_2.object
- extStudy_3.object
- myStudyManager.object
- SalomeAppEngine.object
-
-
-File transfer service
----------------------
-
-See FileTransferCORBA_ for the C++ interface (Python interface obtained with
-SWIG is very similar).
-
-.. _FileTransferCORBA: ./tui/KERNEL/classSALOME__FileTransferCORBA.html
-
-The following example shows how to tranfer a file from a remote host to the
-client computer. Remote hostname is 'cli76cc', we would like to copy
-'tkcvs_8_0_3.tar.gz' from remote to local computer. A full pathname is
-required. A container is created on remote computer if it does not exist,
-to handle the file transfer::
-
- import salome
- salome.salome_init()
-
- import LifeCycleCORBA
- remotefile="/home/prascle/tkcvs_8_0_3.tar.gz"
- aFileTransfer=LifeCycleCORBA.SALOME_FileTransferCORBA('cli76cc',remotefile)
- localFile=aFileTransfer.getLocalFile()
-
-
-CORBA Naming service access
----------------------------
-
-See SALOME_NamingService_ for the C++ interface. The Python interface
-SALOME_NamingServicePy_ is not yet derived from the C++ interface and offers
-only the most useful functions.
-
-.. _SALOME_NamingService: ./tui/KERNEL/classSALOME__NamingService.html
-.. _SALOME_NamingServicePy: ./tui/KERNEL/classSALOME__NamingServicePy_1_1SALOME__NamingServicePy__i.html
-
-Batch services
---------------
-
-See Batch_ documentation (in french only).
-
-.. _Batch: ./Batch.html/index.html
-
-All IDL Interfaces
-==================
-
-Containers and component life cycle, File transfer service
-----------------------------------------------------------
-
-+-----------------------------+-----------------------------------------------+
-| Engines_ | Engines CORBA module. |
-+=============================+===============================================+
-| Component_ | Generic component interface. |
-| | All SALOME components inherit this interface |
-+-----------------------------+-----------------------------------------------+
-| Container_ | Container: host for C++ and Python components |
-| | components instances |
-+-----------------------------+-----------------------------------------------+
-| FileTransfer_ | Agent for file transfer created by a container|
-| | copy a local file to a distent client |
-+-----------------------------+-----------------------------------------------+
-| FileRef_ | Reference to a file, used by a container for |
-| | file transfers |
-+-----------------------------+-----------------------------------------------+
-| ContainerManager_ | Unique instance, in charge of container |
-| | creation on remote computers |
-+-----------------------------+-----------------------------------------------+
-| MPIContainer_ | An exemple of parallel implementation for |
-| | containers and components |
-+-----------------------------+-----------------------------------------------+
-| MPIObject_ | |
-+-----------------------------+-----------------------------------------------+
-
-Study management
-----------------
-
-+-----------------------------+-----------------------------------------------+
-| SALOMEDS_ | SALOMEDS CORBA module |
-+=============================+===============================================+
-| SALOMEDSidl_ | |
-+-----------------------------+-----------------------------------------------+
-| SALOMEDS_Attributes_ | |
-+-----------------------------+-----------------------------------------------+
-
-High speed transfer, object life cycle, exceptions, GUI interface...
---------------------------------------------------------------------
-
-+-----------------------------+-----------------------------------------------+
-| SALOME_ | SALOME CORBA module |
-+=============================+===============================================+
-| SALOME_Comm_ | |
-+-----------------------------+-----------------------------------------------+
-| SALOME_GenericObj_ | |
-+-----------------------------+-----------------------------------------------+
-| SALOME_Exception_ | |
-+-----------------------------+-----------------------------------------------+
-| SALOME_Session_ | |
-+-----------------------------+-----------------------------------------------+
-
-Miscelleanous
--------------
-+-----------------------------+-----------------------------------------------+
-| | other CORBA modules |
-+=============================+===============================================+
-| SALOME_ModuleCatalog_ | |
-+-----------------------------+-----------------------------------------------+
-| SALOME_RessourcesCatalog_ | |
-+-----------------------------+-----------------------------------------------+
-| SALOME_Registry_ | |
-+-----------------------------+-----------------------------------------------+
-| Logger_ | |
-+-----------------------------+-----------------------------------------------+
-
-**Other idl for test purposes**
-nstest.idl
-SALOME_TestComponent.idl
-SALOME_TestModuleCatalog.idl
-SALOME_TestMPIComponent.idl
-TestNotif.idl
-
-.. _Engines: ./tui/KERNEL/namespaceEngines.html
-.. _Component: ./tui/KERNEL/interfaceEngines_1_1Component.html
-.. _Container: ./tui/KERNEL/interfaceEngines_1_1Container.html
-.. _fileTransfer: ./tui/KERNEL/interfaceEngines_1_1fileTransfer.html
-.. _fileRef: ./tui/KERNEL/interfaceEngines_1_1fileRef.html
-.. _ContainerManager: ./tui/KERNEL/interfaceEngines_1_1ContainerManager.html
-.. _MPIContainer: ./tui/KERNEL/interfaceEngines_1_1MPIContainer.html
-.. _MPIObject: ./tui/KERNEL/interfaceEngines_1_1MPIObject.html
-.. _SALOME: ./tui/KERNEL/namespaceSALOME.html
-.. _SALOMEDS: ./tui/KERNEL/namespaceSALOMEDS.html
-.. _SALOME_Component: ./tui/KERNEL/SALOME__Component_8idl.html
-.. _SALOME_ContainerManager: ./tui/KERNEL/SALOME__ContainerManager_8idl.html
-.. _SALOMEDSidl: ./tui/KERNEL/SALOMEDS_8idl.html
-.. _SALOMEDS_Attributes: ./tui/KERNEL/SALOMEDS__Attributes_8idl.html
-.. _SALOME_ModuleCatalog: ./tui/KERNEL/SALOME__ModuleCatalog_8idl.html
-.. _SALOME_RessourcesCatalog: ./tui/KERNEL/SALOME__RessourcesCatalog_8idl.html
-.. _SALOME_Registry: ./tui/KERNEL/SALOME__Registry_8idl.html
-.. _Logger: ./tui/KERNEL/Logger_8idl.html
-.. _SALOME_Comm: ./tui/KERNEL/SALOME__Comm_8idl.html
-.. _SALOME_GenericObj: ./tui/KERNEL/SALOME__GenericObj_8idl.html
-.. _SALOME_Exception: ./tui/KERNEL/SALOME__Exception_8idl.html
-.. _SALOME_Session: ./tui/KERNEL/SALOME__Session_8idl.html
-.. _SALOME_MPIContainer: ./tui/KERNEL/SALOME__MPIContainer_8idl.html
-.. _SALOME_MPIObject: ./tui/KERNEL/SALOME__MPIObject_8idl.html
-
-
--------------------------------------------------------------------------------
-
-+----------------------------------+------------------------------------------+
-| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
-+----------------------------------+------------------------------------------+
-
-.. _`General KERNEL documentation`: ./index.html
-.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html
SUBDIRS = salome
-# if RST2HTML_IS_OK
-# DOC_FILES = \
-# index.html \
-# UnitTests.html \
-# SALOME_Application.html \
-# INSTALL.html \
-# kernel_resources.html \
-# KERNEL_Services.html
-# CSS_FILE = rst.css
-# endif
-
-nodist_doc_DATA = $(DOC_FILES)
-
-EXTRA_DIST=$(DOC_FILES:%.html=%.txt) $(CSS_FILE)
-
-# Building html from restructured text files
-STYLESHEET=$(CSS_FILE)
-RST2HTML=@RST2HTML@
-RSTOPTS=--output-encoding=latin1 --stylesheet=$(STYLESHEET)
-
-%.html: %.txt
- $(RST2HTML) $(RSTOPTS) $< $@
+docs: usr_docs
usr_docs:
(cd salome && $(MAKE) $(AM_MAKEFLAGS) usr_docs)
dev_docs:
(cd salome && $(MAKE) $(AM_MAKEFLAGS) dev_docs)
+
+dist-hook:
+ cp -Rp $(srcdir)/configuration_examples $(distdir)
+ rm -rf $(distdir)/configuration_examples/CVS
+++ /dev/null
-======================================================================
-SALOME Application Concept. Configuration for one or more computers
-======================================================================
-
-*html version of this document is produced with docutils*::
-
- rst2html doc.txt > doc.html
-
-This document corresponds to SALOME2 3.2.0
-
-.. contents::
-.. sectnum::
-
-+-------------------------------------------+
-| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
-+-------------------------------------------+
-
--------------------------------------------------------------------------------
-
-The following explains how to configure your own application with your list of
-modules, how to define and run this application on one or more computers.
-
-General principles
-------------------
-
-A SALOME application is defined by a set of modules (GEOM, SMESH, ASTER...).
-
-A SALOME User can define several SALOME Applications. These applications are
-runnable from the same user account. These applications may share the same
-KERNEL and modules. Thus, the application configuration is independant of
-KERNEL and must not be put in KERNEL_ROOT_DIR.
-
-Furthermore, prerequisites may not be the same on all the applications.
-
-A SALOME Session can run on a several computers.
-
-Binary modules and prerequisites are installed on the different computers.
-There is no need to have all the modules on each computer (the minimum is
-KERNEL).
-
-There is no need of standardization or centralised information on the details
-of configuration on each computer (PATH, LD_LIBRARY_PATH, environment
-variables) provided the application modules are version - compatible. Details
-of configuration stay private to the computer, and are held by scripts on each
-computer.
-
-There is no hierarchy between the computers (for example only one master
-computer used to launch application).
-
-The SALOME user has an account on all the computers. Access between
-account@computer is via rsh or ssh and must be configured for use without
-password (key exchange for ssh). Account may be different on each
-computer.
-
-Application Directory
----------------------
-
-Two ways for creation of an application directory
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-First way - references to different module directories
-''''''''''''''''''''''''''''''''''''''''''''''''''''''
-
-The script createAppli.sh in ${KERNEL_ROOT_DIR}/bin/salome creates an
-application directory with the given path in parameter. ${APPLI} is a path
-relative to ${HOME}.
-
-The directory is only a skeleton, the user has to edit several files to
-configure his own application. These files are described after, the list is:
-
-- env.d/atFirst.sh
-- env.d/envProducts.sh
-- env.d/envSalome.sh
-- CatalogResources.xml
-- SalomeApp.xml
-
-Second and easiest way - one single virtual install directory
-'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
-
-The user must create a SALOME application configuration file by modifying a
-copy of ${KERNEL_ROOT_DIR}/bin/salome/config_appli.xml.
-The file describes the list of SALOME modules used in the application, with
-their respective installation path. The configuration file also defines the
-path of an existing script which sets the SALOME prerequisites,
-and optionnaly, the path of samples directory (SAMPLES_SRC).
-The following command::
-
- python <KERNEL_ROOT_DIR>/bin/salome/appli_gen.py --prefix=<install directory> --config=<configuration file>
-
-creates a virtual installation of SALOME in the application directory ${APPLI}
-(bin, lib, doc, share...), with, for each file (executable, script, data,
-library, resources...), symbolic links to the actual file.
-
-Providing an existing an existing script for SALOME prerequisites (the same one
-used for modules compilation, or given with the modules installation), the
-installation works without further modification for a single computer (unless
-some modules needs a special environment not defined in the above script).
-For a distributed application (several computers), one must copy and adapt
-CatalogResources.xml from ${KERNEL_ROOT_DIR}/bin/salome/appliskel (see below).
-
-General rules
--------------
-
-Directory ${APPLI} must be created on each computer of the application.
-The easiest way is to use the same relative path (to ${HOME}) on each computer.
-(Sometimes it is not possible to use the same path everywhere, for instance
-when ${HOME} is shared with NFS, so it is possible to define different path
-following the computers).
-
-The ${APPLI} directory contains scripts for environment and runs. Environment
-scripts must be configured (by the user) on each computer. All the environment
-scripts are in the ${APPLI}/env.d directory.
-
-The script ${APPLI}/envd sources **all** the files (\*.sh) in ${APPLI}/env.d
-in alphanumeric order (after edition, think to remove backup files). the envd
-script is used by run scripts.
-
-
-env.d scripts
-~~~~~~~~~~~~~
-With the first way of installation, each user **must define** his own
-configuration for these scripts, following the above rules.
-With the virtual installation (second way, above), env.d
-scripts are built automatically.
-
- **The following is only an example proposed by createAppli.sh, (first way of installation) not working as it is**.
-
-atFirst.sh
- Sets the computer configuration not directly related to SALOME,
- like useful tools, default PATH.
-
-envProducts.sh
- Sets the SALOME prerequisites.
-
-envSALOME.sh
- Sets all the MODULE_ROOT_DIR that can be used in the SALOME application.
-
- SalomeAppConfig is also defined by::
-
- export SalomeAppConfig=${HOME}/${APPLI}
-
- where SalomeAppConfig designates the directory containing SalomeApp.xml.
- Note that ${APPLI} is already defined by the calling scripts when
- env.d/envSalome.sh is sourced.
-
-User run scripts
-~~~~~~~~~~~~~~~~
-
-The SALOME user can use 4 scripts:
-
-runAppli
- Launches a SALOME Session
- (similar to ${KERNEL_ROOT_DIR}/bin/salome/runSalome but with a different
- name to avoid confusions).
-
-runSession
- Launches a shell script in the SALOME application environment, with access
- to the current (last launched) SALOME session (naming service), if any.
- Without arguments, the script is interactive. With arguments, the script
- executes the command in the SALOME application environment.
-
-runConsole
- Gives a python console connected to the current SALOME Session.
- It is also possible to use runSession, then python.
-
-runTests
- Similar to runSession, used for unit testing. runSession tries to use an
- already existing naming service definition from a running session (hostname
- and port number), runTests defines a new configuration for naming service
- (new port number).
-
-SALOME internal run scripts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-envd
- Sets SALOME application environment, envd is sourced by other scripts.
-
-For remote calls, SALOME uses one script.
-
-runRemote.sh
- This script is mainly used to launch containers. The first 2 arguments
- define the hostname and port userd for naming service, the remaining
- arguments define the command to execute.
-
-Other configuration files
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-SalomeApp.xml
- This file is similar to the default given
- in ${GUI_ROOT_DIR}/share/salome/resources/gui
-
-
-CatalogRessources.xml
- This files describes all the computers the application can use. The given
- example is minimal and suppose ${APPLI} is the same relative path
- to ${HOME}, on all the computers. A different directory can be set on a
- particular computer with a line::
-
- appliPath="my/specific/path/on/this/computer"
-
-
-Examples of use
----------------
-
-Launch a SALOME session with a GUI interface
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Launch is done with a command like::
-
- ./runAppli --logger
-
-The --logger option means here : collect all the traces from the all the
-distributed process, via CORBA, in a single file : logger.log.
-
-There are a lot of options, a complete list is given by::
-
- ./runAppli --help
-
-Note that, without argument, runAppli is a non interactive Python application,
-and, with arguments, runAppli is an interactive Python interpreter.
-
-Several options are already defined by default in SalomeApp.xml files. Optional
-arguments given in the command override the SalomeApp.xml configuration.
-
-Several sessions can run simultaneously, each session use a different port for
-CORBA naming service, so the sessions are totally separated from each other.
-
-When the GUI is closed, the different SALOME servers are still running.
-
-Close a SALOME session, kill all the servers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Inside the interactive python interpreter you get when you use runAppli
-with arguments, you can kill all the servers of your session with::
-
- >>> killLocalPort()
-
-or the servers of all the sessions with::
-
- >>> killAllPorts()
-
-If you have no active Python interpreter connected to your session, you can
-kill all the SALOME servers of **all the sessions** on a given computer::
-
- ./runSession killSalome.py
-
-Remember! it's the same idea in *Windows (R) operating system* [#]_ :
-use the start menu to stop...
-
-When you use only one session at a time, you don't need more.
-
-To kill a given session (when several session are running), one needs
-the naming service port number::
-
- ./runSession killSalomeWithPort 2810
-
-Note that the port number of the last launched session can be found on Linux,
-in the prompt, within a runSession shell (see below).
-
-It is also possible to get the Naming Service host and port number of
-the last launched session with::
-
- ./runSession NSparam.py
-
-.. [#] Microsoft and Windows are either registered trademarks or trademarks of
- Microsoft Corporation in the United States and/or other countries.
-
-Launch a SALOME session without GUI interface
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This is used to launch a SALOME Python script without GUI
-(no GUI server = SALOME_session_server)
-
-Example of script (test_session_geom.py)::
-
- import salome_session
- salome_session.startSession(modules=["GEOM"])
- import GEOM_usinggeom
- raw_input("Press a key and the servers will be killed ...")
-
-This script is run in a non interactive way with::
-
- ./runSession python test_session_geom.py
-
-All the process are automatically killed when Python is closed
-(with salome_session delete).
-
-Add an external Python interpretor to a running session
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-It's often easier to develop and try Python scripts outside the GUI embedded
-Python interpreter. Imagine, for instance, you are writing a script involving
-geometry and mesh modules.
-first, launch a SALOME session with gui, then, on another terminal::
-
- ./runSession
- python
-
-Import salome module. salome_init() without arguments creates a new study
-in the running session (note: salome_init(n) attachs to a running session whose
-studyId is n)::
-
- import salome
- salome.salome_init()
-
-An example of script given with SMESH::
-
- import ex01_cube2build
-
-It is possible to connect the GUI interface to the study created in the above
-script with the file/connect menu, then browse study and display objects.
-Further modifications on study can be done either with GUI or external script
-(use refresh popup in GUI object browser to see study modifications generated
-by the external script). **AVOID modifications with GUI when a Python script
-is running**. Not all the modules are protected against concurrent actions...
-
-
-Different uses of the runSession shell interpreter
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-runSession invoked without arguments gives an interactive shell with the full
-environment of SALOME (PATH, LD_LIBRARY_PATH, PYTHONPATH, other variables).
-If there are running sessions of the same SALOME application, runSession
-connects to the last launched session (i.e. gets the naming service references
-of the session: hostname and port)
-
-On Linux, the shell prompt (bash) gives information on naming service
-references, hostname and port::
-
- [NS=cli76cc:2811]prascle@cli76cc:~/SALOME2/Run/Virtual$
-
-If there is no running session, prompt looks like::
-
- [NS=:]prascle@cli76cc:~/SALOME2/Run/Virtual$
-
-runSession is useful to launch any script or program which needs the complete
-SALOME environment, with or without a session already running.
-For instance, to launch the ddd debugger interface on the gui server, first
-launch a SALOME session with gui, then, on another terminal::
-
- ./runSession ddd
-
-Then attach to the running SALOME_Session_Server process.
-
-
--------------------------------------------------------------------------------
-
-+----------------------------------+------------------------------------------+
-| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
-+----------------------------------+------------------------------------------+
-
-.. _`General KERNEL documentation`: ./index.html
-.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html
+++ /dev/null
-=================================================================
-Source code structuration and Unit Tests
-=================================================================
-
-*html version of this document is produced with docutils*::
-
- rst2html < doc.txt > doc.html
-
-*This document corresponds to SALOME2 3.2.0*
-
-.. contents::
-.. sectnum::
-
-+-------------------------------------------+
-| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
-+-------------------------------------------+
-
--------------------------------------------------------------------------------
-
-You will find here general information on code directories structure,
-unit tests associated to the different kind of classes, and how to run
-the unit tests.
-
-SALOME KERNEL source code structuration
-=======================================
-
-General structure of KERNEL_SRC
--------------------------------
-
-KERNEL_SRC
- Some README files and configuration tools for build
-
-KERNEL_SRC/adm_local
- Part of the configuration files, other modules have a directory with the
- same name. Not used in KERNEL.
-
-KERNEL_SRC/bin
- Python and shell scripts used at run time.
- Kit to install a SALOME Application.
-
-KERNEL_SRC/doc
- Kit for KERNEL end user documentation production:
- public interfaces, Python, CORBA.
- Integrator and Developper documentation.
-
-KERNEL_SRC/idl
- All CORBA interfaces from KERNEL are regrouped here.
-
-KERNEL_SRC/resources
- Configuration files for servers (examples).
- Interfaces definitions for KERNEL test components.
-
-KERNEL_SRC/salome_adm
- Configuration files used by autotools (M4 macros & co.)
-
-KERNEL_SRC/src
- The source code (C++ and Python)
-
-
-Directory src: C++ and Python source code
------------------------------------------
-
-Basic services non related to CORBA
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Basics
- A set of general purpose C++ services, not related to CORBA.
- Some general purpose services that are in Utils directory (CORBA related),
- are progressivley moved here, as they are not related to CORBA.
-
-
-SALOMELocalTrace
- A multithread trace system that allows message tracing on standard error
- or a file.
-
-CASCatch
- Exceptions and signal handler.
-
-HDFPersist
- A C++ interface to HDF.
-
-Basic CORBA services
-~~~~~~~~~~~~~~~~~~~~
-
-Logger
- A CORBA server that collects the trace messages from differents CORBA
- process.
-
-SALOMETraceCollector
- A multithread trace system derived from SALOMELocalTrace, that sends messages
- to Logger server via CORBA.
-
-Utils
- A set of general purpose services related to CORBA, such as basic CORBA
- exception system. See also Basics directory above.
-
-NamingService
- C++ and Python interfaces to name, store and retrieve CORBA objects
-
-GenericObj
- A generic CORBA interface for CORBA objects, to count distributed references,
- and to allow destruction by client.
-
-Miscellaneous CORBA servers
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Registry
- Implements SALOME_registry.idl.
- Provides a CORBA server library and a separate server program.
-
-ModuleCatalog
- Implements SALOME_moduleCatalog.idl.
- Provide a CORBA server library and separate server and client programs.
-
-ModuleGenerator
- Tool to generate a module catalog from CORBA idl
-
-ResourcesManager
- library included in container server
-
-Notification
- library included in differents servers (container)
-
-NOTIFICATION_SWIG
-
-
-CORBA Containers for SALOME Modules
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Container
-
-TestContainer
-
-LifeCycleCORBA
-
-LifeCycleCORBA_SWIG
-
-STUDY server and related interfaces and tools
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-SALOMEDSClient
-
-TOOLSDS
-
-SALOMEDSImpl
-
-SALOMEDS
-
-Python interface to SALOME
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-KERNEL_PY
-
-Efficient CORBA transfer services
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Communication
-
-Communication_SWIG
-
-A Parallel container with MPI
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-MPIContainer
-
-TestMPIContainer
-
-Batch interface library
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Batch
-
-Batch_SWIG
-
-Unit tests
-~~~~~~~~~~
-
-UnitTests
-
-
-Tools and principles used for Unit testing
-==========================================
-
-**TO BE COMPLETED**
-
-Unit Testing rely on cppunit package for C++ testing, and on unittest module
-for Python. See these products for general principles of unit testing.
-
-The cppunit package is optional. When the prerequisite is detected, the unit
-tests are compiled.
-
-Unit Tests sources are in directories Test under the src/directories
-containing the classes to test.
-
-Test are ordered following the order of directories given above.
-
-Tests can be run as a whole, or for a particular directory. In this case, only
-a partial test is run (the classes to test, and the classes used, i.e. the
-preceding test directories).
-
-
-Today, only some tests are written as an example. There are not yet python
-scripts in KERNEL_SRC, but it's a matter of days, there are working scripts
-to test LifeCycleCORBA_SWIG interface.
-
-
-
-
-
--------------------------------------------------------------------------------
-
-+----------------------------------+------------------------------------------+
-| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
-+----------------------------------+------------------------------------------+
-
-.. _`General KERNEL documentation`: ./index.html
-.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html
+++ /dev/null
-=================================================================
-KERNEL common Services
-=================================================================
-
-*html version of this document is produced with docutils*::
-
- rst2html < doc.txt > doc.html
-
-*This document corresponds to SALOME2 3.2.0*
-
-.. contents::
-.. sectnum::
-
-+-------------------------------------------+
-| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
-+-------------------------------------------+
-
--------------------------------------------------------------------------------
-
-**General information, for users, integrators and developers**
-
-**Users, integrators and developers, which documentation ?**
-
-Following your kind of usage of SALOME, you will find some specific
-introductory documentation, listed below.
-
-End user
-========
-
-How to configure a SALOME application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The end user may have to configure his own SALOME application by selection of a
-subset of availables SALOME modules. He also may want to install his
-application on several computers.
-
-See SALOME_Application_ to define your own configuration of SALOME and run it
-on one or several computers. This is the recommended way of configuration.
-
-.. _SALOME_Application: ./SALOME_Application.html
-
-
-How to launch SALOME in a SALOME application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-See SALOME_Application_.
-
-How to use KERNEL services in Python scripts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The SALOME KERNEL offers offers a list of services available in Python.
-
-See KERNEL_Services_.
-
-.. _KERNEL_Services: ./KERNEL_Services.html
-
-Application Integrator
-======================
-
-Applications integrators are in charge of configuration and installation of
-specific SALOME applications over a local network. Application Integrators
-built SALOME modules binaries from sources tarballs.
-
-How to install SALOME
-~~~~~~~~~~~~~~~~~~~~~
-
-See INSTALL_ for general information on required configuration and
-prerequisites, compilation procedure, setting environment principles.
-
-.. _INSTALL: ./INSTALL.html
-
-How to configure a SALOME application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-See SALOME_Application_ to define your own configuration of SALOME and run it
-on one or several computers. This is the recommended way of configuration.
-
-.. _SALOME_Application: ./SALOME_Application.html
-
-
-Module maintainer
-=================
-
-Module maintainers are in charge of the development and debug of the SALOME
-modules. Each SALOME module is stored in a CVS base. CVS bases are organised
-in separate branches for developments and debug. All official or development
-releases are identified by a CVS tag.
-
-Source code structuration and Unit Tests
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-See UnitTests_ for general information on code directories structure,
-unit tests associated to the different kind of classes, and how to run
-the unit tests.
-
-.. _UnitTests: ./UnitTests.html
-
-Some development utilities
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-See kernel_resources_ for information on basic utilities for C++ and Python
-development, like trace and debug, exceptions, singleton.
-
-.. _kernel_resources: ./kernel_resources.html
-
--------------------------------------------------------------------------------
-
-+----------------------------------+------------------------------------------+
-| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
-+----------------------------------+------------------------------------------+
-
-.. _`General KERNEL documentation`: ./index.html
-.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html
+++ /dev/null
-======================================================================
-SALOME Kernel resources for developer
-======================================================================
-
-*html version of this document is produced with docutils*::
-
- rst2html doc.txt > doc.html
-
-*This document corresponds to SALOME2 3.2.0*
-
-:Authors:
- Antoine Yessayan,
- Paul Rascle
-
-:Version: 0.3 - february 17, 2006
-
-+-------------------------------------------+
-| **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
-+-------------------------------------------+
-
--------------------------------------------------------------------------------
-
-**Abstract**
-
-This document describes the development environment for
-C++ and Python. Makefiles generation and usage are
-introduced in another document: "using the SALOME
-configuration and building system environment".
-Development environment is intended here as: trace and
-debug macros usage; SALOME exceptions usage, in C++ and
-Python; user CORBA exceptions usage, in C++ and Python,
-with and without Graphical User Interface; some general
-purpose services such as singleton, used for CORBA
-connection and disconnection.
-
-.. contents::
-.. sectnum::
-
--------------------------------------------------------------------------------
-
-Trace and debug Utilities
-=========================
-
-During the development process, an execution log is
-useful to identify problems. This log contains
-messages, variables values, source files names and line
-numbers. It is recommended to verify assertions on
-variables values and if necessary, to stop the
-execution at debug time, in order to validate all parts
-of code.
-
-Two modes: debug and release
-----------------------------
-
-The goal of debug mode is to check as many features as
-possible during the early stages of the development
-process. The purpose of the utilities provided in
-SALOME is to help the developer to add detailed traces
-and check variables values, without writing a lot of code.
-
-When the code is assumed to be valid, the release mode
-optimizes execution, in terms of speed, memory, and
-display only user level messages.
-
-But, some informations must always be displayed in both
-modes: especially messages concerning environment or
-internal errors, with version identification. When an
-end user is confronted to such a message, he may refer
-to a configuration documentation or send the message to
-the people in charge of SALOME installation, or to the
-development team, following the kind of error.
-
-C++ Macros for trace and debug
-------------------------------
-
-SALOME provides C++ macros for trace and debug. These
-macros are in::
-
- KERNEL_SRC/src/SALOMELocalTrace/utilities.h
-
-This file must be included in C++ source. Some
-macros are activated only in debug mode, others are
-always activated. To activate the debug mode, ``_DEBUG_``
-must be defined, which is the case when SALOME
-Makefiles are generated from configure, without
-options. When ``_DEBUG_`` is undefined (release mode:
-``configure --disable-debug --enable-production``), the
-debug mode macros are defined empty (they do nothing).
-So, when switching from debug to release, it is
-possible (and recommended) to let the macro calls
-unchanged in the source.
-
-All the macros generate trace messages, stored in a
-circular buffer pool. A separate thread reads the
-messages in the buffer pool, and, depending on options
-given at SALOME start, writes the messages on the
-standard output, a file, or send them via CORBA, in
-case of a multi machine configuration.
-
-Three informations are systematically added in front of
-the information displayed:
-
-* the thread number from which the message come from;
-
-* the name of the source file in which the macros is set;
-
-* the line number of the source file at which the macro
- is set.
-
-Macros defined in debug and release modes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**INFOS_COMPILATION**
- The C++ macro INFOS_COMPILATION writes on the trace
- buffer pool informations about the compiling process:
-
- * the name of the compiler : g++, KCC, CC, pgCC;
-
- * the date and the time of the compiling processing process.
-
- This macro INFOS_COMPILATION does not have any
- argument. Moreover, it is defined in both compiling
- mode : _DEBUG_ and _RELEASE_.
-
- Example::
-
- #include "utilities.h"
- int main(int argc , char **argv)
- {
- INFOS_COMPILATION;
- ...
- }
- INFOS(str)
-
-**INFOS**
- In both compiling mode _DEBUG_ and _RELEASE_, The C++
- macro INFOS writes on the trace buffer pool the string
- which has been passed in argument by the user.
-
- Example::
-
- #include "utilities.h"
- int main(int argc , char **argv)
- {
- ...
- INFOS("NORMAL END OF THE PROCESS");
- return 0;
- }
-
- displays::
-
- main.cxx [5] : NORMAL END OF THE PROCESS
-
-
-**INTERRUPTION(str)**
- In both compiling mode _DEBUG_ and _RELEASE_, The C++
- macro INTERRUPTION writes on the trace buffer pool the
- string, with a special ABORT type. When the thread in
- charge of collecting messages finds this message, it
- terminates the application, after message treatment.
-
-**IMMEDIATE_ABORT(str)**
- In both compiling mode _DEBUG_ and _RELEASE_, The C++
- macro IMMEDIATE_ABORT writes the message str immediately on
- standard error and exits the application. Remaining
- messages not treated by the message collector thread
- are lost.
-
-Macros defined only in debug mode
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-**MESSAGE(str)**
- In _DEBUG_ compiling mode only, the C++ macro MESSAGE
- writes on the trace buffer pool the string which has
- been passed in argument by the user. In _RELEASE_
- compiling mode, this macro is blank.
-
- Example::
-
- #include "utilities.h"
- #include <string>
-
- using namespace std;
-
- int main(int argc , char **argv)
- {
- ...
- const char *str = "Salome";
- MESSAGE(str);
- ... const string st;
- st = "Aster";
- MESSAGE(c_str(st+" and CASTEM"));
- return 0;
- }
-
- displays::
-
- - Trace main.cxx [8] : Salome
- - Trace main.cxx [12] : Aster and CASTEM
-
-**BEGIN_OF(func_name)**
- In _DEBUG_ compiling mode, The C++ macro BEGIN_OF
- appends the string "Begin of " to the one passed in
- argument by the user and displays the result on the
- trace buffer pool. In _RELEASE_ compiling mode, this
- macro is blank.
-
- Example::
-
- #include "utilities.h"
- int main(int argc , char **argv)
- {
- BEGIN_OF(argv[0]);
- return 0;
- }
-
- displays::
-
- - Trace main.cxx [3] : Begin of a.out
-
-
-**END_OF(func_name)**
- In _DEBUG_ compiling mode, The C++ macro END_OF appends
- the string "Normal end of " to the one passed in
- argument by the user and displays the result on the
- trace buffer pool. In _RELEASE_ compiling mode, this
- macro is blank.
-
- Example::
-
- #include "utilities.h"
- int main(int argc , char **argv)
- {
- END_OF(argv[0]);
- return 0;
- }
-
- displays::
-
- - Trace main.cxx [4] : Normal end of a.out
-
-**SCRUTE(var)**
- In _DEBUG_ compiling mode, The C++ macro SCRUTE
- displays its argument which is an application variable
- followed by the value of the variable. In _RELEASE_
- compiling mode, this macro is blank.
-
- Example::
-
- #include "utilities.h"
- int main(int argc , char **argv)
- {
- const int i=999;
- if( i > 0 ) SCRUTE(i) ; i=i+1;
- return 0;
- }
-
- displays::
-
- - Trace main.cxx [5] : i=999
-
-**ASSERT(condition)**
- In _DEBUG_ compiling mode only, The C++ macro ASSERT
- checks the expression passed in argument to be not
- NULL. If it is NULL the condition is written with the
- macro INTERRUPTION (see above). The process exits after
- trace of this last message. In _RELEASE_ compiling
- mode, this macro is blank. N.B. : if ASSERT is already
- defined, this macro is ignored.
-
- Example::
-
- #include "utilities.h"
- ...
- const char *ptrS = fonc();
- ASSERT(ptrS!=NULL);
- cout << strlen(ptrS);
- float table[10];
- int k;
- ...
- ASSERT(k<10);
- cout << table[k];
-
-Exceptions
-==========
-
-C++ exceptions: class SALOME_Exception
---------------------------------------
-
-definition
-~~~~~~~~~~
-
-The class SALOME_Exception provides a generic method to
-send a message, with optional source file name and line
-number. This class is intended to serve as a base class
-for all kinds of exceptions SALOME code. All the
-exceptions derived from SALOME_Exception could be
-handled in a single catch, in which the message
-associated to the exception is displayed, or sent to a
-log file.
-
-The class SALOME_Exception inherits its behavior from
-the STL class exception.
-
-usage
-~~~~~
-
-The header SALOME/src/utils/utils_SALOME_Exception.hxx
-must be included in the C++ source, when raised or trapped::
-
- #include "utils_SALOME_Exception.hxx"
-
-The SALOME_Exception constructor is::
-
- SALOME_Exception( const char *text,
- const char *fileName=0,
- const unsigned int lineNumber=0 );
-
-The exception is raised like this::
-
- throw SALOME_Exception("my pertinent message");
-
-or like this::
-
- throw SALOME_Exception(LOCALIZED("my pertinent message"));
-
-where LOCALIZED is a macro provided with
-``utils_SALOME_Exception.hxx`` which gives file name and
-line number.
-
-The exception is handled like this::
-
- try
- {
- ...
- }
- catch (const SALOME_Exception &ex)
- {
- cerr << ex.what() <<endl;
- }
-
-The what() method overrides the one defined in the STL
-exception class.
-
-CORBA exceptions
-----------------
-
-definition
-~~~~~~~~~~
-
-The idl SALOME_Exception provides a generic CORBA
-exception for SALOME, with an attribute that gives an
-exception type,a message, plus optional source file
-name and line number.
-
-This idl is intended to serve for all user CORBA
-exceptions raised in SALOME code, as IDL specification
-does not support exception inheritance. So, all the
-user CORBA exceptions from SALOME could be handled in a
-single catch.
-
-The exception types defined in idl are:
-
- - COMM CORBA communication problem,
-
- - BAD_PARAM Bad User parameters,
-
- - INTERNAL_ERROR application level problem (often irrecoverable).
-
-CORBA system and user exceptions already defined in the
-packages used within SALOME, such as OmniORB
-exceptions, must be handled separately.
-
-usage
-~~~~~
-
-CORBA servant, C++
-^^^^^^^^^^^^^^^^^^
-
- The CORBA Server header for SALOME_Exception and a
- macro to throw the exception are provided with the
- header ``KERNEL_SRC/src/Utils/Utils_CorbaException.hxx``::
-
- #include "Utils_CorbaException.hxx"
-
- The exception is raised with a macro which appends file
- name and line number::
-
- if (myStudyName.size() == 0)
- THROW_SALOME_CORBA_EXCEPTION("No Study Name given",
- SALOME::BAD_PARAM);
-
-CORBA Client, GUI Qt C++
-^^^^^^^^^^^^^^^^^^^^^^^^
-
- **NO MORE AVAILABLE in SALOME 3.x**
-
- The CORBA Client header for SALOME_Exception and a Qt
- function header that displays a message box are
- provided in:
-
- ``KERNEL_SRC/src/SALOMEGUI/SALOMEGUI_QtCatchCorbaException.hxx``
-
- ::
-
- #include "SALOMEGUI_QtCatchCorbaException.hxx"
-
- A typical exchange with a CORBA Servant will be::
-
- try
- {
- ... // one ore more CORBA calls
- }
-
- catch (const SALOME::SALOME_Exception & S_ex)
- {
- QtCatchCorbaException(S_ex);
- }
-
-
-
-CORBA Client, C++, without GUI
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
- Nothing specific has been provided to the developer
- yet. See the idl or the Qt function
- SALOMEGUI_QtCatchCorbaException.hxx to see how to get
- the information given by the exception object.
-
-Miscellaneous tools
-===================
-
-Singleton
----------
-
-Definition
-~~~~~~~~~~
-
-A singleton is an application data which is created and
-deleted only once at the end of the application
-process. The C++ compiler allows the user to create a
-static singleton data before the first executable
-statement. They are deleted after the last statement execution.
-
-The ``SINGLETON_`` template class deals with dynamic
-singleton. It is useful for functor objects. For
-example, an object that connects the application to a
-system at creation and disconnects the application at deletion.
-
-Usage
-~~~~~
-
-To create a single instance of a POINT object::
-
- # include "Utils_SINGLETON.hxx"
- ...
- POINT *ptrPoint=SINGLETON_<POINT>::Instance() ;
- assert(ptrPoint!=NULL) ;
-
-No need to delete ptrPoint. Deletion is achieved
-automatically at exit. If the user tries to create more
-than one singleton by using the class method
-SINGLETON_<TYPE>::Instance(), the pointer is returned
-with the same value even if this is done in different
-functions (threads ?)::
-
- POINT *p1=SINGLETON_<POINT>::Instance() ;
- ...
- POINT *p2=SINGLETON_<POINT>::Instance() ;
-
- assert(p1==p2)
-
-Design description
-~~~~~~~~~~~~~~~~~~
-
-Here are the principles features of the singleton
-design:
-
-* the user creates an object of class TYPE by using the
- class method ``SINGLETON_<TYPE>::Instance()`` which
- returns a pointer to the single object ;
-
-* to create an object, ``SINGLETON_<TYPE>::Instance()``
- uses the default constructor of class TYPE ;
-
-* at the same time, this class method creates a
- destructor object which is added to the generic list
- of destructor objects to be executed at the end of
- the application (atexit) ;
-
-* at the end of the application process all the
- deletions are performed by the ``Nettoyage()`` C function
- which executes the destruction objects end then
- deletes the destructions objects themselves ;
-
-* the ``Nettoyage()`` C function using ``atexit()`` C function
- is embedded in a static single object ``ATEXIT_()``.
-
-
--------------------------------------------------------------------------------
-
-+----------------------------------+------------------------------------------+
-| `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
-+----------------------------------+------------------------------------------+
-
-.. _`General KERNEL documentation`: ./index.html
-.. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html
+++ /dev/null
-/*
-:Authors: David Goodger, David Abrahams
-:Contact: goodger@users.sourceforge.net, dave@boost-consulting.com
-:date: $Date$
-:version: $Revision$
-:copyright: This stylesheet has been placed in the public domain.
-
-This stylesheet is for the use of ReStructuredText in a Boost context.
-It is basically an agglomeration of boost.css and the default.css that
-comes from docutils.
-
- */
-
-.first {
- margin-top: 0 }
-
-.last {
- margin-bottom: 0 }
-
-a.toc-backref {
- text-decoration: none ;
- color: #00008B }
-
-dd {
- margin-bottom: 0.5em }
-
-div.abstract {
- margin: 2em 5em }
-
-div.abstract p.topic-title {
- font-weight: bold ;
- text-align: center }
-
-div.attention, div.caution, div.danger, div.error, div.hint,
-div.important, div.note, div.tip, div.warning, div.admonition {
- margin: 2em ;
- border: medium outset ;
- padding: 1em }
-
-div.attention p.admonition-title, div.caution p.admonition-title,
-div.danger p.admonition-title, div.error p.admonition-title,
-div.warning p.admonition-title {
- color: red ;
- font-weight: bold ;
- font-family: sans-serif }
-
-div.hint p.admonition-title, div.important p.admonition-title,
-div.note p.admonition-title, div.tip p.admonition-title,
-div.admonition p.admonition-title {
- font-weight: bold ;
- font-family: sans-serif }
-
-div.dedication {
- margin: 2em 5em ;
- text-align: center ;
- font-style: italic }
-
-div.dedication p.topic-title {
- font-weight: bold ;
- font-style: normal }
-
-div.figure {
- margin-left: 2em }
-
-div.footer, div.header {
- font-size: smaller }
-
-div.sidebar {
- margin-left: 1em ;
- border: medium outset ;
- padding: 0em 1em ;
- background-color: #ffffee ;
- width: 40% ;
- float: right ;
- clear: right }
-
-div.sidebar p.rubric {
- font-family: sans-serif ;
- font-size: medium }
-
-div.system-messages {
- margin: 5em }
-
-div.system-messages h1 {
- color: red }
-
-div.system-message {
- border: medium outset ;
- padding: 1em }
-
-div.system-message p.system-message-title {
- color: red ;
- font-weight: bold }
-
-div.topic {
- margin: 2em }
-
-H1.title
-{
- FONT-SIZE: 150%;
- COLOR: #00008B;
- text-align: center
-}
-H1
-{
- FONT-SIZE: 125%;
-}
-H2
-{
- FONT-SIZE: 108%;
-}
-h2.subtitle {
- text-align: center }
-H3
-{
- FONT-SIZE: 100%;
-}
-BODY
-{
- FONT-SIZE: 100%;
- BACKGROUND-COLOR: #ffffff;
-}
-PRE
-{
- MARGIN-LEFT: 2em;
- FONT-FAMILY: Courier;
-}
-CODE
-{
- FONT-FAMILY: Courier;
- white-space: pre;
-}
-.pre
-{
- FONT-FAMILY: Courier;
- white-space: pre;
-}
-.index
-{
- TEXT-ALIGN: left;
-}
-.page-index
-{
- TEXT-ALIGN: left;
-}
-.definition
-{
- TEXT-ALIGN: left;
-}
-.footnote
-{
- FONT-SIZE: 66%;
- VERTICAL-ALIGN: super;
- TEXT-DECORATION: none;
-}
-.function-semantics
-{
- CLEAR: left;
-}
-
-hr {
- width: 75% }
-
-ol.simple, ul.simple {
- margin-bottom: 1em }
-
-ol.arabic {
- list-style: decimal }
-
-ol.loweralpha {
- list-style: lower-alpha }
-
-ol.upperalpha {
- list-style: upper-alpha }
-
-ol.lowerroman {
- list-style: lower-roman }
-
-ol.upperroman {
- list-style: upper-roman }
-
-p.attribution {
- text-align: right ;
- margin-left: 50% }
-
-p.caption {
- font-style: italic }
-
-p.credits {
- font-style: italic ;
- font-size: smaller }
-
-p.label {
- white-space: nowrap }
-
-p.rubric {
- font-weight: bold ;
- font-size: larger ;
- color: maroon ;
- text-align: center }
-
-p.sidebar-title {
- font-family: sans-serif ;
- font-weight: bold ;
- font-size: larger }
-
-p.sidebar-subtitle {
- font-family: sans-serif ;
- font-weight: bold }
-
-p.topic-title {
- font-weight: bold }
-
-pre.address {
- margin-bottom: 0 ;
- margin-top: 0 ;
- font-family: serif ;
- font-size: 100% }
-
-pre.line-block {
- font-family: serif ;
- font-size: 100% }
-
-pre.literal-block, pre.doctest-block {
- margin-left: 2em ;
- margin-right: 2em ;
- font-size: 80%;
- border: solid thin gray ;
- background-color: #eeeeee }
-
-span.classifier {
- font-family: sans-serif ;
- font-style: oblique }
-
-span.classifier-delimiter {
- font-family: sans-serif ;
- font-weight: bold }
-
-span.interpreted {
- font-family: sans-serif }
-
-span.option {
- white-space: nowrap }
-
-span.option-argument {
- font-style: italic }
-
-span.pre {
- white-space: pre }
-
-span.problematic {
- color: red }
-
-table {
- margin-top: 0.5em ;
- margin-bottom: 0.5em }
-
-table.citation {
- border-left: solid thin gray ;
- padding-left: 0.5ex }
-
-table.docinfo {
- margin: 2em 4em }
-
-table.footnote {
- border-left: solid thin black ;
- padding-left: 0.5ex }
-
-td, th {
- padding-left: 0.5em ;
- padding-right: 0.5em ;
- vertical-align: top }
-
-th.docinfo-name, th.field-name {
- font-weight: bold ;
- text-align: left ;
- white-space: nowrap }
-
-/*
- dwa 2003/7/29 -- commented out so that it wouldn't override earlier
- styles from boost.css
-
-h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
- font-size: 100% }
-*/
-
-ul.auto-toc {
- list-style-type: none }
#
include $(top_srcdir)/salome_adm/unix/make_common_starter.am
-SUBDIRS= tui
-SUBDIRSGUI= tui
-SUBDIRSTUI= tui
+SUBDIRS= tui gui
-index_html:
- $(INSTALL) -d $(DESTDIR)$(docdir);
+docs:usr_docs
-usr_docs: index_html
- list='$(SUBDIRSGUI)'; for subdir in $$list; do \
- echo "Making usr_docs in $$subdir"; \
- (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) usr_docs) \
- done;
+usr_docs:
+ echo "Making usr_docs in gui"; \
+ (cd gui && $(MAKE) $(AM_MAKEFLAGS) usr_docs)
-dev_docs: index_html
- list='$(SUBDIRSTUI)'; for subdir in $$list; do \
- echo "Making dev_docs in $$subdir"; \
- (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) dev_docs) \
- done;
-
-
-# VSR: nullify these make targets to avoid 'make distcheck' failure
-dvi:
-pdf:
-ps:
-
-info_TEXINFOS = Batch.texi
-
-install-data-local: html usr_docs
- cp -rp $(top_builddir)/doc/salome/Batch.html $(DESTDIR)$(docdir)
-
-uninstall-local:
- rm -rf $(DESTDIR)$(docdir)/Batch.html
+dev_docs:
+ echo "Making dev_docs in tui"; \
+ (cd tui && $(MAKE) $(AM_MAKEFLAGS) dev_docs)
EXTRA_DIST= main.dox install.dox \
kernel_resources.dox kernel_services.dox \
+++ /dev/null
-/*!
-
-\page batch_page Batch
-
-<a href="Batch.html/index.html"> Batch documentation </a>
-
-*/
-
-
-
--- /dev/null
+
+# create AttributeReal
+#=================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeReal")
+if A == None :
+ raise RuntimeError, "Can't create AttributeReal attribute"
+A = A._narrow(SALOMEDS.AttributeReal)
+A.SetValue(0.0001)
+if A.Value() != 0.0001:
+ raise RuntimeError, "Error : wrong value of AttributeReal"
+
+# save / restore study
+#=================================
+
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+#file = "/tmp/ggg.hdf"
+
+print " ------- We will save to", file, "-----------"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy=batchmode_geompy.myStudyManager.Open(file)
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeReal
+#=================================
+
+res,A=father.FindAttribute("AttributeReal")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeReal"
+
+A = A._narrow(SALOMEDS.AttributeReal)
+if A.Value() != 0.0001:
+ raise RuntimeError, "Error : wrong value of AttributeReal"
--- /dev/null
+
+# create AttributeExpandable
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute( batchmode_geompy.father, "AttributeExpandable")
+if A == None :
+ raise RuntimeError, "Can't create AttributeExpandable attribute"
+A = A._narrow(SALOMEDS.AttributeExpandable)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeExpandable attribute"
+
+A.SetExpandable(1)
+
+if A.IsExpandable() == 0:
+ "Error: wrong value of AttributeExpandable"
+
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy = batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeExpandable
+#============================================================
+
+res,A=father.FindAttribute("AttributeExpandable")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeExpandable"
+
+A = A._narrow(SALOMEDS.AttributeExpandable)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeExpandable attribute"
+
+if A.IsExpandable() == 0:
+ "Error: wrong value of AttributeExpandable"
+
--- /dev/null
+
+# create AttributeOpened
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeOpened")
+if A == None :
+ raise RuntimeError, "Can't create AttributeOpened attribute"
+A = A._narrow(SALOMEDS.AttributeOpened)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeOpened attribute"
+
+A.SetOpened(1)
+
+if A.IsOpened() == 0:
+ "Error: wrong value of AttributeOpened"
+
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy=batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeOpened
+#============================================================
+
+res,A=father.FindAttribute("AttributeOpened")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeOpened"
+
+A = A._narrow(SALOMEDS.AttributeOpened)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeOpened attribute"
+
+if A.IsOpened() == 0:
+ "Error: wrong value of AttributeOpened"
--- /dev/null
+
+#--------------------------------------------------------------------------
+# create AttributeTextColor
+#===========================================================
+import SALOMEDS_Attributes_idl
+color = SALOMEDS_Attributes_idl._0_SALOMEDS.Color(234,345,231)
+
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeTextColor")
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeTextColor attribute"
+A = A._narrow(SALOMEDS.AttributeTextColor)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeTextColor attribute"
+
+A.SetTextColor(color)
+
+c = A.TextColor();
+
+if c.R != 234 or c.G != 345 or c.B != 231:
+ print "Error: wrong value of AttributeTextColor"
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy = batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeTextColor
+#============================================================
+
+res,A=father.FindAttribute("AttributeTextColor")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeTextColor"
+
+A = A._narrow(SALOMEDS.AttributeTextColor)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeTextColor attribute"
+
+c = A.TextColor();
+if c.R != 234 or c.G != 345 or c.B != 231:
+ print "Error: wrong value of AttributeTextColor"
+
--- /dev/null
+
+#--------------------------------------------------------------------------
+# create AttributeTextHighlightColor
+#===========================================================
+
+import SALOMEDS_Attributes_idl
+highlightcolor=SALOMEDS_Attributes_idl._0_SALOMEDS.Color(256,256,256)
+
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeTextHighlightColor")
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeTextHighlightColor attribute"
+A = A._narrow(SALOMEDS.AttributeTextHighlightColor)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeTextHighlightColor attribute"
+
+A.SetTextHighlightColor(highlightcolor)
+
+c = A.TextHighlightColor();
+if c.R != 256 or c.G != 256 or c.B != 256:
+ print "Error: wrong value of AttributeTextHighlightColor"
+
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy=batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeTextHighlightColor
+#============================================================
+
+res, A = father.FindAttribute("AttributeTextHighlightColor")
+print res, A
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeTextHighlightColor"
+
+A = A._narrow(SALOMEDS.AttributeTextHighlightColor)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeTextHighlightColor attribute"
+
+c = A.TextHighlightColor();
+
+if c.R != 256 or c.G != 256 or c.B != 256:
+ print "Error: wrong value of AttributeTextTextHighlightColor"
+
--- /dev/null
+
+#--------------------------------------------------------------------------
+# create AttributePixMap
+#===============================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributePixMap")
+if A == None :
+ raise RuntimeError, "Can't create AttributePixMap attribute"
+aPixmap = A._narrow(SALOMEDS.AttributePixMap);
+aPixmap.SetPixMap( "ICON_OBJBROWSER_Geometry" );
+
+if aPixmap.GetPixMap() != "ICON_OBJBROWSER_Geometry":
+ print "Error: wrong value of AttributePixMap"
+
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy = batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributePixMap
+#============================================================
+
+res,A=father.FindAttribute("AttributePixMap")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: AttributePixMap not found "
+
+A = A._narrow(SALOMEDS.AttributePixMap)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributePixMap attribute"
+
+if A.GetPixMap() != "ICON_OBJBROWSER_Geometry":
+ print "Error: wrong value of AttributePixMap"
+
--- /dev/null
+
+# create AttributeLocalID
+#=================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeLocalID")
+if A == None :
+ raise RuntimeError, "Can't create AttributeLocalID attribute"
+A = A._narrow(SALOMEDS.AttributeLocalID)
+
+A.SetValue(763242882)
+
+if A.Value() != 763242882:
+ print "Error: wrong value of AttributeLocalID"
+
+# save / restore study
+#=================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy = batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeLocalID
+#=================================
+
+res,A=father.FindAttribute("AttributeLocalID")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeLocalID"
+
+A = A._narrow(SALOMEDS.AttributeLocalID)
+
+if A.Value() != 763242882:
+ print "Error: wrong value of AttributeLocalID"
+
--- /dev/null
+
+dir= os.getenv("TmpDir")
+if dir == None:
+ dir = "/tmp"
+
+batchmode_geompy.myBuilder._set_UndoLimit(20)
+
+# 1st transaction -----------------------------------------
+batchmode_geompy.myBuilder.NewCommand()
+# create AttributeSequenceOfInteger
+#=========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")
+if A == None :
+ raise RuntimeError, "Can't create AttributeSequenceOfInteger attribute"
+A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)
+if A == None :
+ raise RuntimeError, "Can't create AttributeSequenceOfInteger attribute"
+
+A.Add(100)
+A.Add(300)
+A.Add(500)
+A.Add(400)
+A.Add(700)
+print "First transaction goes on : HasOpenCommand() = ", batchmode_geompy.myBuilder.HasOpenCommand()
+batchmode_geompy.myBuilder.CommitCommand() #--------------
+
+# 2nd transaction ------------------------------------------
+batchmode_geompy.myBuilder.NewCommand()
+A.Remove(3)
+A.ChangeValue(4,500)
+batchmode_geompy.myBuilder.CommitCommand() #--------------
+
+if batchmode_geompy.myBuilder.GetAvailableUndos() == 0:
+ raise RuntimeError, "GetAvailableUndos() = 0 but must not !"
+
+if A.Length() != 4:
+ print "Wrong length of SequenceOfInteger"
+if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 500:
+ raise RuntimeError, "Wrong value of AttributeSequenceOfInteger"
+
+file1 = dir + "/test1.hdf"
+batchmode_geompy.myStudyManager.SaveAs(file1, batchmode_geompy.myStudy)
+
+# 1st Undo ---------------------------------------
+batchmode_geompy.myBuilder.Undo()
+res, A = batchmode_geompy.myBuilder.FindAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")
+if A is None:
+ raise RuntimeError, "After first 'undo' can't find AttributeSequenceOfInteger"
+if A.Length() != 5:
+ print "Wrong length of SequenceOfInteger"
+if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 500 or A.Value(4) != 400 or A.Value(5) != 700:
+ print A.Value(1), A.Value(2), A.Value(3), A.Value(4), A.Value(5)
+ raise RuntimeError, "Wrong value of AttributeSequenceOfInteger after the first 'undo'!"
+# save
+file2 = dir + "/test2.hdf"
+batchmode_geompy.myStudyManager.SaveAs(file2, batchmode_geompy.myStudy)
+#-------------------------------------------------
+# 2nd Undo ---------------------------------------
+batchmode_geompy.myBuilder.Undo()
+res, attr = batchmode_geompy.myBuilder.FindAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")
+if res !=0 or attr != None :
+ raise RuntimeError, "After the second 'undo' AttributeSequenceOfInteger exists but must not!"
+file3 = dir + "/test3.hdf"
+batchmode_geompy.myStudyManager.SaveAs(file3, batchmode_geompy.myStudy)
+#-------------------------------------------------
+
+#make redo twice ---------------------------------
+if batchmode_geompy.myBuilder.GetAvailableRedos() == 0:
+ raise RuntimeError, "GetAvailableRedos() = 0 but must not !"
+batchmode_geompy.myBuilder.Redo()
+batchmode_geompy.myBuilder.Redo()
+res, A = batchmode_geompy.myBuilder.FindAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")
+if res ==0 or A== None :
+ raise RuntimeError, "AttributeSequenceOfInteger is not found but must be!"
+if A.Length() != 4:
+ print "Wrong length of SequenceOfInteger"
+if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 500:
+ raise RuntimeError, "Wrong value of AttributeSequenceOfInteger"
+
+
+#----------------------------------------------------------------------
+openedStudy=batchmode_geompy.myStudyManager.Open(file1);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeSequenceOfInteger
+#======================================
+
+res,A=father.FindAttribute("AttributeSequenceOfInteger")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeSequenceOfInteger"
+
+A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)
+
+if A.Length() != 4:
+ print "Wrong length of SequenceOfInteger"
+if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 500:
+ print "Wrong value of AttributeSequenceOfInteger"
+#----------------------------------------------------------------------
+openedStudy=batchmode_geompy.myStudyManager.Open(file2);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeSequenceOfInteger
+#======================================
+
+res,A=father.FindAttribute("AttributeSequenceOfInteger")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeSequenceOfInteger"
+
+A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)
+
+if A.Length() != 5:
+ print "Wrong length of SequenceOfInteger"
+if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 500 or A.Value(4) != 400 or A.Value(5) != 700:
+ raise RuntimeError, "Wrong value of AttributeSequenceOfInteger after the first 'undo'!"
+
+#----------------------------------------------------------------------
+openedStudy=batchmode_geompy.myStudyManager.Open(file3);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeSequenceOfInteger
+#======================================
+
+res,A=father.FindAttribute("AttributeSequenceOfInteger")
+
+if res!=0 or A != None:
+ raise RuntimeError, " AttributeSequenceOfInteger is found but must not!"
+
--- /dev/null
+
+batchmode_geompy.myBuilder._set_UndoLimit(20)
+
+batchmode_geompy.myBuilder.NewCommand()
+child = batchmode_geompy.myBuilder.NewObject(batchmode_geompy.father)
+batchmode_geompy.myBuilder.CommitCommand()
+
+batchmode_geompy.myBuilder.NewCommand()
+#==========================================================
+# create AttributeSequenceOfReal
+#==========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeSequenceOfReal")
+if A == None :
+ raise RuntimeError, "Can't create AttributeSequenceOfReal attribute"
+A = A._narrow(SALOMEDS.AttributeSequenceOfReal)
+if A == None :
+ raise RuntimeError, "_narrow returns None instead of AttributeSequenceOfReal pointer"
+
+A.Add(0.0293)
+A.Add(522)
+A.Add(98234)
+A.Add(83.287)
+batchmode_geompy.myBuilder.CommitCommand()
+
+
+batchmode_geompy.myBuilder.NewCommand()
+#==========================================================
+# create AttributeInteger
+#==========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeInteger")
+if A == None :
+ raise RuntimeError, "Can't create AttributeInteger attribute"
+A = A._narrow(SALOMEDS.AttributeInteger)
+A.SetValue(1000000)
+
+if A.Value() != 1000000:
+ raise RuntimeError, "Error : wrong value of AttributeInteger"
+
+batchmode_geompy.myBuilder.CommitCommand()
+
+batchmode_geompy.myBuilder.NewCommand() #===================
+# create AttributeName
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A.SetValue("AttributesTesting")
+
+if A.Value() != "AttributesTesting":
+ print "Wrong value of AttributeName"
+
+batchmode_geompy.myBuilder.CommitCommand()
+
+batchmode_geompy.myBuilder.NewCommand() #===================
+# create AttributeComment
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeComment")
+if A == None :
+ raise RuntimeError, "Can't create AttributeComment attribute"
+A = A._narrow(SALOMEDS.AttributeComment)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeComment attribute"
+
+A.SetValue("GEOM")
+
+batchmode_geompy.myBuilder.AbortCommand()
+
+batchmode_geompy.myBuilder.NewCommand() #===================
+# create AttributePersistentRef
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributePersistentRef")
+if A == None :
+ raise RuntimeError, "Can't create AttributePersistentRef attribute"
+A = A._narrow(SALOMEDS.AttributePersistentRef)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributePersistentRef attribute"
+
+A.SetValue("/tmp/test;1")
+batchmode_geompy.myBuilder.CommitCommand()
+
+batchmode_geompy.myBuilder.NewCommand() #===================================
+# create AttributeDrawable
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeDrawable")
+if A == None :
+ raise RuntimeError, "Can't create AttributeDrawable attribute"
+A = A._narrow(SALOMEDS.AttributeDrawable)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeDrawable attribute"
+
+A.SetDrawable(1)
+
+if A.IsDrawable() == 0:
+ "Error: wrong value of AttributeDrawable"
+batchmode_geompy.myBuilder.CommitCommand()
+
+
+
+batchmode_geompy.myBuilder.NewCommand() #===================
+# create AttributeSelectable
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeSelectable")
+if A == None :
+ raise RuntimeError, "Can't create AttributeSelectable attribute"
+A = A._narrow(SALOMEDS.AttributeSelectable)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeSelectable attribute"
+
+A.SetSelectable(1)
+
+if A.IsSelectable() == 0:
+ "Error: wrong value of AttributeSelectable"
+batchmode_geompy.myBuilder.CommitCommand()
+
+
+batchmode_geompy.myBuilder.NewCommand() #===================
+#===========================================================
+batchmode_geompy.myBuilder.RemoveAttribute(child,"AttributeSelectable")
+batchmode_geompy.myBuilder.CommitCommand()
+
+# Control the attributes
+#===========================================================
+
+res, A = batchmode_geompy.myBuilder.FindAttribute(child, "AttributeComment")
+print "res = ", res
+if A != None :
+ print " AttributeComment was found"
+else:
+ print " AttributeComment is not found. It's correct"
+
+attributes=[]
+
+attributes = child.GetAllAttributes()
+
+length = len(attributes)
+
+print "Attributes number = ", length
+print attributes
+for i in range(0, length) :
+ attr = attributes[i]
+ if attr is None :
+ print i,"None item of object attributes list"
+
+if length != 5 :
+ raise RuntimeError, "Wrong number of attributes"
+
--- /dev/null
+
+child1 = batchmode_geompy.myBuilder.NewObject(batchmode_geompy.father)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child1,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N1")
+N1 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child1, "AttributeTreeNode")
+if N1 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+child2 = batchmode_geompy.myBuilder.NewObject(batchmode_geompy.father)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child2,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N2")
+N2 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child2, "AttributeTreeNode")
+if N2 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+child3 = batchmode_geompy.myBuilder.NewObject(batchmode_geompy.father)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child3,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N3")
+N3 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child3, "AttributeTreeNode")
+if N3 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+
+child11 = batchmode_geompy.myBuilder.NewObject(child1)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child11,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N11")
+
+N11 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child11, "AttributeTreeNode")
+
+if N11 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+child111 = batchmode_geompy.myBuilder.NewObject(child11)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child111, "AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N111")
+
+N111 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child111, "AttributeTreeNode")
+
+if N111 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+
+child31 = batchmode_geompy.myBuilder.NewObject(child3)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child31,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N31")
+
+N31 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child31, "AttributeTreeNode")
+if N31 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+child32 = batchmode_geompy.myBuilder.NewObject(child3)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child32,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N32")
+
+N32 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child32, "AttributeTreeNode")
+if N32 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+child321 = batchmode_geompy.myBuilder.NewObject(child32)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child321,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N321")
+
+N321 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child321, "AttributeTreeNode")
+if N321 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+child33 = batchmode_geompy.myBuilder.NewObject(child3)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child33,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N33")
+
+N33 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child33, "AttributeTreeNode")
+if N33 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+child34 = batchmode_geompy.myBuilder.NewObject(child3)
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child34,"AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+A.SetValue("N34")
+
+N34 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child34, "AttributeTreeNode")
+if N34 == None :
+ raise RuntimeError, "Can't create AttributeTreeNode attribute"
+
+
+
+#Create links between tree nodes.
+# -| root
+# --N1 __
+# | N11__
+# | N111
+# --N2
+# |
+# --N3__
+# N31
+# N32__
+# N321
+# N33
+# N34
+
+N11.SetFather(N1)
+N11.Append(N111)
+N3.SetPrevious(N1)
+N3.Prepend(N2)
+
+N32.SetFather(N3)
+N32.Prepend(N31)
+N33.InsertAfter(N32)
+N33.Append(N34)
+print "------------- ", N1, " ------------- "
+print "N1.Label() = ", N1.Label() , "IsRoot() = ", N1.IsRoot(), "Depth() = ", N1.Depth()
+print "N11.Label() = ", N11.Label() , "IsRoot() = ", N11.IsRoot(), "Depth() = ", N11.Depth()
+print "N111.Label() = ", N111.Label() , "IsRoot() = ", N111.IsRoot(), "Depth() = ", N111.Depth()
+print "N2.Label() = ", N2.Label() , "IsRoot() = ", N2.IsRoot(), "Depth() = ", N2.Depth()
+print "N3.Label() = ", N3.Label() , "IsRoot() = ", N3.IsRoot(), "Depth() = ", N3.Depth()
+print "N31.Label() = ", N31.Label() , "IsRoot() = ", N31.IsRoot(), "Depth() = ", N31.Depth()
+print "N32.Label() = ", N32.Label() , "IsRoot() = ", N32.IsRoot(), "Depth() = ", N32.Depth()
+print "N321.Label() = ", N321.Label() , "IsRoot() = ", N321.IsRoot(), "Depth() = ", N321.Depth()
+print "N33.Label() = ", N33.Label() , "IsRoot() = ", N33.IsRoot(), "Depth() = ", N33.Depth()
+print "N34.Label() = ", N34.Label() , "IsRoot() = ", N34.IsRoot(), "Depth() = ", N34.Depth()
+print "N1.IsRoot()=", N1.IsRoot()
+
+print "N1.HasNext() = ",N1.HasNext()
+if N1.HasNext():
+ print N1.Next().Label()
+
+print "N32.HasPrevious() = ",N32.HasPrevious()
+if N32.HasPrevious():
+ print N32.GetPrevious().Label()
+
+print "N111.HasFirst()=",N111.HasFirst()
+print "N111.HasFather()=",N111.HasFather()
+if N111.HasFather() :
+ print "N111.GetFather().Label()=",N111.GetFather().Label()
+
--- /dev/null
+
+#======================================================================
+#1. Create Study and add some components to it
+#======================================================================
+
+#=================================
+# create AttributeReal
+#=================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeReal")
+if A == None :
+ raise RuntimeError, "Can't create AttributeReal attribute"
+A = A._narrow(SALOMEDS.AttributeReal)
+A.SetValue(0.0001)
+if A.Value() != 0.0001:
+ raise RuntimeError, "Error : wrong value of AttributeReal"
+
+# === Geometry ==================================================
+
+import batchmode_geompy
+
+#===================================
+# define a box
+#===================================
+
+box = batchmode_geompy.MakeBox(0., 0., 0., 100., 200., 300.)
+idbox = batchmode_geompy.addToStudy(box,"box")
+
+
+geom = batchmode_geompy.geom
+import SMESH
+import batchmode_smesh
+ShapeType = batchmode_smesh.ShapeType
+
+# ---- add first face of box in study
+
+subShapeList = batchmode_geompy.SubShapeAll(box,ShapeType["Face"])
+face=subShapeList[0]
+name = "box_face"
+print name
+idface= batchmode_geompy.addToStudyInFather(box,face,name)
+
+# ---- add shell from box in study
+
+subShellList= batchmode_geompy.SubShapeAll(box,ShapeType["Shell"])
+shell = subShellList[0]
+name = "box_shell"
+print name
+idshell= batchmode_geompy.addToStudyInFather(box,shell,name)
+
+# ---- add first edge of face in study
+
+edgeList = batchmode_geompy.SubShapeAll(face,ShapeType["Edge"])
+edge=edgeList[0];
+name = "face_edge"
+print name
+idedge= batchmode_geompy.addToStudyInFather(face,edge,name)
+
+# ---- launch SMESH, init a Mesh with the box
+
+smesh = batchmode_smesh.smesh
+# -- Init --
+shape = batchmode_geompy.IDToObject(idbox)
+mesh=smesh.Init(geom, batchmode_geompy.myStudyId, shape)
+
+orb = batchmode_geompy.orb
+
+idmesh = batchmode_smesh.AddNewMesh( orb.object_to_string(mesh) )
+batchmode_smesh.SetName(idmesh, "Meshbox");
+batchmode_smesh.SetShape(idbox, idmesh);
+
+# ---- create Hypothesis
+
+print "-------------------------- create Hypothesis ----------------------"
+print "-------------------------- LocalLength"
+hyp1 = smesh.CreateHypothesis("LocalLength", batchmode_geompy.myStudyId )
+hypLen1 = hyp1._narrow(SMESH.SMESH_LocalLength)
+hypLen1.SetLength(100)
+print hypLen1.GetName()
+print hypLen1.GetId()
+print hypLen1.GetLength()
+
+idlength = batchmode_smesh.AddNewHypothesis( orb.object_to_string(hypLen1) );
+batchmode_smesh.SetName(idlength, "Local_Length_100");
+
+print "-------------------------- NumberOfSegments"
+hyp2 = smesh.CreateHypothesis("NumberOfSegments", batchmode_geompy.myStudyId )
+hypNbSeg1=hyp2._narrow(SMESH.SMESH_NumberOfSegments)
+hypNbSeg1.SetNumberOfSegments(7)
+print hypNbSeg1.GetName()
+print hypNbSeg1.GetId()
+print hypNbSeg1.GetNumberOfSegments()
+
+idseg = batchmode_smesh.AddNewHypothesis( orb.object_to_string(hypNbSeg1) );
+batchmode_smesh.SetName(idseg, "NumberOfSegments_7");
+
+print "-------------------------- MaxElementArea"
+hyp3 = smesh.CreateHypothesis("MaxElementArea", batchmode_geompy.myStudyId)
+hypArea1=hyp3._narrow(SMESH.SMESH_MaxElementArea)
+hypArea1.SetMaxElementArea(2500)
+print hypArea1.GetName()
+print hypArea1.GetId()
+print hypArea1.GetMaxElementArea()
+
+idarea1 = batchmode_smesh.AddNewHypothesis( orb.object_to_string(hypArea1) );
+batchmode_smesh.SetName(idarea1, "MaxElementArea_2500");
+
+print "-------------------------- MaxElementArea"
+hyp3 = smesh.CreateHypothesis("MaxElementArea", batchmode_geompy.myStudyId)
+hypArea2 = hyp3._narrow(SMESH.SMESH_MaxElementArea)
+hypArea2.SetMaxElementArea(500)
+print hypArea2.GetName()
+print hypArea2.GetId()
+print hypArea2.GetMaxElementArea()
+
+idarea2 = batchmode_smesh.AddNewHypothesis( orb.object_to_string(hypArea2) );
+batchmode_smesh.SetName(idarea2, "MaxElementArea_500");
+
+print "-------------------------- Regular_1D"
+alg1 = smesh.CreateHypothesis("Regular_1D", batchmode_geompy.myStudyId)
+algo1 = alg1._narrow(SMESH.SMESH_Algo)
+listHyp = algo1.GetCompatibleHypothesis()
+for hyp in listHyp:
+ print hyp
+algoReg=alg1._narrow(SMESH.SMESH_Regular_1D)
+print algoReg.GetName()
+print algoReg.GetId()
+
+idreg = batchmode_smesh.AddNewAlgorithms( orb.object_to_string(algoReg) );
+batchmode_smesh.SetName(idreg, "Regular_1D");
+
+print "-------------------------- MEFISTO_2D"
+alg2 = smesh.CreateHypothesis("MEFISTO_2D", batchmode_geompy.myStudyId)
+algo2 = alg2._narrow(SMESH.SMESH_Algo)
+listHyp=algo2.GetCompatibleHypothesis()
+for hyp in listHyp:
+ print hyp
+algoMef=alg2._narrow(SMESH.SMESH_MEFISTO_2D)
+print algoMef.GetName()
+print algoMef.GetId()
+
+idmef = batchmode_smesh.AddNewAlgorithms( orb.object_to_string(algoMef) );
+batchmode_smesh.SetName(idmef, "MEFISTO_2D");
+
+
+# ---- add hypothesis to edge
+
+print "-------------------------- add hypothesis to edge"
+edge = batchmode_geompy.IDToObject(idedge)
+submesh = mesh.GetElementsOnShape(edge)
+ret = mesh.AddHypothesis(edge,algoReg)
+print ret
+ret=mesh.AddHypothesis(edge,hypLen1)
+print ret
+
+idsm1 = batchmode_smesh.AddSubMeshOnShape( idmesh,
+ idedge,
+ orb.object_to_string(submesh),
+ ShapeType["Edge"] )
+batchmode_smesh.SetName(idsm1, "SubMeshEdge")
+batchmode_smesh.SetAlgorithms( idsm1, idreg );
+batchmode_smesh.SetHypothesis( idsm1, idlength );
+
+print "-------------------------- add hypothesis to face"
+face=batchmode_geompy.IDToObject(idface)
+submesh=mesh.GetElementsOnShape(face)
+ret=mesh.AddHypothesis(face,hypArea2)
+print ret
+
+idsm2 = batchmode_smesh.AddSubMeshOnShape( idmesh,
+ idface,
+ orb.object_to_string(submesh),
+ ShapeType["Face"] )
+batchmode_smesh.SetName(idsm2, "SubMeshFace")
+batchmode_smesh.SetHypothesis( idsm2, idarea2 );
+
+# ---- add hypothesis to box
+
+print "-------------------------- add hypothesis to box"
+box=batchmode_geompy.IDToObject(idbox)
+submesh=mesh.GetElementsOnShape(box)
+ret=mesh.AddHypothesis(box,algoReg)
+print ret
+ret=mesh.AddHypothesis(box,hypNbSeg1)
+print ret
+ret=mesh.AddHypothesis(box,algoMef)
+print ret
+ret=mesh.AddHypothesis(box,hypArea1)
+print ret
+
+batchmode_smesh.SetAlgorithms( idmesh, idreg );
+batchmode_smesh.SetHypothesis( idmesh, idseg );
+batchmode_smesh.SetAlgorithms( idmesh, idmef );
+batchmode_smesh.SetHypothesis( idmesh, idarea1 );
+
+# ---- compute box
+
+print "-------------------------- compute box"
+ret=smesh.Compute(mesh,box)
+print ret
+log=mesh.GetLog(0); # no erase trace
+for linelog in log:
+ print linelog
+
+
+#=======================================================
+# add SuperVision component
+#=======================================================
+
+from batchmode_SuperV import *
+import os
+dir= os.getenv("SUPERV_ROOT_DIR")
+if dir == None:
+ raise RuntimeError, "SUPERV_ROOT_DIR is not defined"
+xmlfile = dir +"/examples/GraphEssai.xml"
+print "--------------\n"+xmlfile+"\n--------------\n"
+
+myGraph = Graph ( xmlfile )
+
+# This DataFlow is "valid" : no loop, correct links between Nodes etc...
+print myGraph.IsValid()
+
+# Get Nodes
+myGraph.PrintNodes()
+Add,Sub,Mul,Div = myGraph.Nodes()
+
+# Load Datas
+Addx = Add.Input("x",3.)
+Addy = Add.Input("y",4.5)
+Subx = Sub.Input("x",1.5)
+
+# Get Output Port
+Addz = Add.Port('z')
+Subz = Sub.Port('z')
+Mulz = Mul.Port('z')
+Divz = Div.Port('z')
+
+# This DataFlow is "executable" : all pending Ports are defined with Datas
+print myGraph.IsExecutable()
+
+# Starts only execution of that DataFlow and gets control immediatly
+print myGraph.Run()
+
+# That DataFlow is running ==> 0 (false)
+print myGraph.IsDone()
+
+# Events of execution :
+aStatus,aNode,anEvent,aState = myGraph.Event()
+while aStatus :
+ print aNode.Thread(),aNode.SubGraph(),aNode.Name(),anEvent,aState
+ aStatus,aNode,anEvent,aState = myGraph.Event()
+print myGraph.IsDone()
+
+# Wait for Completion (but it is already done after event loop ...)
+print "Done : ",myGraph.DoneW()
+
+# Get result
+print "Result : ",Divz.ToString()
+
+# Intermediate results :
+print "Intermediate Result Add\z : ",Addz.ToString()
+print "Intermediate Result Sub\z : ",Subz.ToString()
+print "Intermediate Result Mul\z : ",Mulz.ToString()
+
+print " "
+#print "Type : print myGraph.IsDone()"
+#print " If execution is finished ==> 1 (true)"
+res=myGraph.IsDone()
+if res != 1:
+ raise RuntimeError, "myGraph.Run() is not done"
+
+print " "
+print "Type : print Divz.ToString()"
+print " You will get the result"
+Divz.ToString()
+
+print " "
+print "Type : myGraph.PrintPorts()"
+print " to see input and output values of the graph"
+myGraph.PrintPorts()
+
+print " "
+print "Type : Add.PrintPorts()"
+Add.PrintPorts()
+
+print "Type : Sub.PrintPorts()"
+Sub.PrintPorts()
+
+print "Type : Mul.PrintPorts()"
+Mul.PrintPorts()
+
+print "Type : Div.PrintPorts()"
+print " to see input and output values of nodes"
+Div.PrintPorts()
+
+# Export will create newsupervisionexample.xml and the corresponding .py file
+tmpdir=os.getenv("TmpDir")
+if tmpdir is None:
+ tmpdir="/tmp"
+file = tmpdir + "/newsupervisionexample"
+print "--------------\n"+file+"\n--------------\n"
+myGraph.Export(file)
+
+ior = batchmode_geompy.orb.object_to_string(myGraph.G)
+addStudy(ior)
+
+GraphName = myGraph.Name()
+print "Befor save ",
+nodes = myGraph.Nodes()
+length_bs = len(nodes)
+print "ListOfNodes length = ", length_bs
+names=[]
+for node in nodes:
+ names.append(node.Name())
+print names
+
+
+#=================================
+# save / restore study
+#=================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+
+#==================================================
+#1. SaveAs
+#==================================================
+print " ------- We will save to", file, "-----------"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+batchmode_geompy.myStudyManager.Close(batchmode_geompy.myStudy)
+
+#rename the file and try to reread it again
+
+os.mkdir(str + "/test_dir")
+
+#2.==================================================
+print " ------- We rename the file as " + str + "/test_dir/test_new.hdf"
+os.rename(file, str+"/test_dir/test_new.hdf")
+
+#==================================================
+#3. Open
+#==================================================
+print " ------- We try to open " + str + "/test_dir/test_new.hdf"
+
+try:
+ openedStudy=batchmode_geompy.myStudyManager.Open(str+"/test_dir/test_new.hdf")
+except Exception:
+ raise RuntimeError, "Can't open saved study!"
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "GEOM component is not found! Wrong study is opened."
+
+
+#=================================
+# find AttributeReal
+#=================================
+
+res,A=father.FindAttribute("AttributeReal")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeReal"
+
+A = A._narrow(SALOMEDS.AttributeReal)
+if A.Value() != 0.0001:
+ raise RuntimeError, "Error : wrong value of AttributeReal"
+
+#==================================================
+# find box
+#==================================================
+box = openedStudy.FindObject("box")
+if box is None :
+ raise RuntimeError, "box was not found! Wrong study is opened."
+
+edge=openedStudy.FindObject("face_edge")
+if edge is None :
+ raise RuntimeError, "face_edge was not found! Wrong study is opened."
+
+
+father = openedStudy.FindComponent("MESH")
+if father is None:
+ raise RuntimeError, "MESH component is not found! Wrong study is opened."
+
+hp=openedStudy.FindObject("Meshbox")
+if hp is None:
+ raise RuntimeError, "Meshbox object was not found! Wrong study is opened."
+
+hp = openedStudy.FindObject("Algorithms Definition")
+if hp is None:
+ raise RuntimeError, "Algorithms Definition object was not found! Wrong study is opened."
+
+hp = openedStudy.FindObject("MEFISTO_2D")
+if hp is None:
+ raise RuntimeError, "MEFISTO_2D object was not found! Wrong study is opened."
+
+hp = openedStudy.FindObject("Hypothesis Definition")
+if hp is None:
+ raise RuntimeError, "Algoriths Definition was not found! Wrong study is opened."
+
+#==================================================
+# Find Supervisor
+#==================================================
+father = openedStudy.FindComponent("SUPERV")
+if father is None:
+ raise RuntimeError, "SUPERV component is not found! Wrong study is opened."
+
+SuperV = lcc.FindOrLoadComponent("SuperVisionContainer","Supervision")
+Builder = openedStudy.NewBuilder()
+Builder.LoadWith(father, SuperV)
+import SALOMEDS
+
+aChildIterator = openedStudy.NewChildIterator(father)
+
+#while aChildIterator.More():
+anSObject = aChildIterator.Value()
+#print "iterate: ", anSObject.GetID()
+res, anAttr=anSObject.FindAttribute("AttributeIOR")
+if res :
+ anAttr=anAttr._narrow(SALOMEDS.AttributeIOR)
+ ior = anAttr.Value()
+ Graph=SuperV.getGraph(ior)
+ ListOfNodes=Graph.Nodes()
+ length_as= len(ListOfNodes)
+ print "ListOfNodes length = ", length_as
+ if length_as != length_bs:
+ raise RuntimeErrror, "defferent length of nodes after study open"
+#aChildIterator.Next()
+
+Names = []
+for node in ListOfNodes:
+ Names.append(node.Name())
+names.sort()
+Names.sort()
+if names != Names :
+ raise RuntimeError, "List of dataflow nodes after save differs from one befor save operation"
+
+#==================================================
+#4. Save
+#==================================================
+batchmode_geompy.myStudyManager.Save(openedStudy)
+batchmode_geompy.myStudyManager.Close(openedStudy)
+#==================================================
+#5. Open
+#==================================================
+try:
+ openedStudy = batchmode_geompy.myStudyManager.Open(str+"/test_dir/test_new.hdf")
+except Exception:
+ raise RuntimeError, "Can't open saved study!"
+
+
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+#find AttributeReal
+res,A=father.FindAttribute("AttributeReal")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeReal"
+
+A = A._narrow(SALOMEDS.AttributeReal)
+if A.Value() != 0.0001:
+ raise RuntimeError, "Error : wrong value of AttributeReal"
+#==================================================
+# find box
+#==================================================
+box = openedStudy.FindObject("box")
+if box is None :
+ raise RuntimeError, "box was not found! Wrong study is opened."
+
+edge=openedStudy.FindObject("face_edge")
+if edge is None :
+ raise RuntimeError, "face_edge was not found! Wrong study is opened."
+
+
+father = openedStudy.FindComponent("MESH")
+if father is None:
+ raise RuntimeError, "MESH component is not found! Wrong study is opened."
+
+hp=openedStudy.FindObject("Meshbox")
+if hp is None:
+ raise RuntimeError, "Meshbox object was not found! Wrong study is opened."
+
+hp = openedStudy.FindObject("Algorithms Definition")
+if hp is None:
+ raise RuntimeError, "Algorithms Definition object was not found! Wrong study is opened."
+
+hp = openedStudy.FindObject("MEFISTO_2D")
+if hp is None:
+ raise RuntimeError, "MEFISTO_2D object was not found! Wrong study is opened."
+
+hp = openedStudy.FindObject("Hypothesis Definition")
+if hp is None:
+ raise RuntimeError, "Algoriths Definition was not found! Wrong study is opened."
+
+#==================================================
+# Find Supervisor
+#==================================================
+father = openedStudy.FindComponent("SUPERV")
+if father is None:
+ raise RuntimeError, "SUPERV component is not found! Wrong study is opened."
+
+SuperV = lcc.FindOrLoadComponent("SuperVisionContainer","Supervision")
+Builder = openedStudy.NewBuilder()
+Builder.LoadWith(father, SuperV)
+import SALOMEDS
+
+aChildIterator = openedStudy.NewChildIterator(father)
+
+#while aChildIterator.More():
+anSObject = aChildIterator.Value()
+
+res, anAttr=anSObject.FindAttribute("AttributeIOR")
+if res :
+ anAttr=anAttr._narrow(SALOMEDS.AttributeIOR)
+ ior = anAttr.Value()
+ Graph=SuperV.getGraph(ior)
+ ListOfNodes=Graph.Nodes()
+ length_as= len(ListOfNodes)
+ print "ListOfNodes length = ", length_as
+ if length_as != length_bs:
+ raise RuntimeErrror, "defferent length of nodes after study open"
+#aChildIterator.Next()
+
+Names = []
+for node in ListOfNodes:
+ Names.append(node.Name())
+names.sort()
+Names.sort()
+if names != Names :
+ raise RuntimeError, "List of dataflow nodes after save differs from one befor save operation"
+
--- /dev/null
+
+batchmode_geompy.myBuilder._set_UndoLimit(20)
+
+#--------------------------------------------------------------------------
+# create AttributeReal
+#===============================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeReal")
+if A == None :
+ raise RuntimeError, "Can't create AttributeReal attribute"
+A = A._narrow(SALOMEDS.AttributeReal)
+A.SetValue(0.0001)
+if A.Value() != 0.0001:
+ raise RuntimeError, "Error : wrong value of AttributeReal"
+
+# create AttributeStudyProperties
+#================================================
+A = batchmode_geompy.myStudy.GetProperties()
+if A == None :
+ raise RuntimeError, "Can't create AttributeStudyProperties attribute"
+A = A._narrow(SALOMEDS.AttributeStudyProperties)
+
+batchmode_geompy.myBuilder.NewCommand();
+print "A.GetUserName()= ", A.GetUserName()
+res,mm,hh,dd,mnth,yy=A.GetCreationDate()
+print "A.GetCreationDate() = ", mm,hh,dd,mnth,yy
+print "A.GetCreationMode() = ", A.GetCreationMode()
+print "A.IsModified() = ", A.IsModified()
+print "A.IsLocked() = ", A.IsLocked()
+if A.IsLocked() == 0 :
+ A.SetUserName("tester"); print 'A.SetUserName("tester"), A.GetUserName() = ', A.GetUserName()
+ A.SetCreationDate(11,11,11,11,2002); print 'A.SetCreationDate(11,11,11,11,2002), A.GetCreationDate() =', A.GetCreationDate()
+ print "A.IsModified() = ", A.IsModified()
+A.SetLocked(1)
+
+#check the transaction result
+batchmode_geompy.myBuilder.CommitCommand()
+if A.GetUserName() != "tester":
+ print 'Control after transaction close : A.GetUserName() = ', A.GetUserName()
+ raise RuntimeError, "Field 'UserName' was not modified but had to!"
+
+# try to make some changes wrapped by transaction
+#================================================
+batchmode_geompy.myBuilder.NewCommand()
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeInteger")
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeInteger attribute"
+A = A._narrow(SALOMEDS.AttributeInteger)
+A.SetValue(1000000)
+
+exception_was = None
+try : batchmode_geompy.myBuilder.CommitCommand()
+except Exception: exception_was = 1
+
+if exception_was is None:
+ raise RuntimeError, "Study was locked for changes but CommitCommand did not generate an exception !"
+
+# save / restore study
+
+#================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+print " ------- We will save to", file, "-----------"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+
+
+#--------------------------------------------------------------------------#
+#--------------------------- Open file ------------------------------------#
+#--------------------------------------------------------------------------#
+
+print" -------------- Open " + file + "-------------- "
+
+openedStudy = batchmode_geompy.myStudyManager.Open(file)
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+#1. find AttributeReal
+#================================================
+
+res,A=father.FindAttribute("AttributeReal")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeReal"
+
+A = A._narrow(SALOMEDS.AttributeReal)
+if A.Value() != 0.0001:
+ raise RuntimeError, "Error : wrong value of AttributeReal"
+
+
+#2. find AttributeStudyProperties
+#=================================================
+A=openedStudy.GetProperties()
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeStudyProperties"
+
+A = A._narrow(SALOMEDS.AttributeStudyProperties)
+if A.IsLocked() == 0 :
+ raise RuntimeError, "Error : AttributeStudyProperties must have Locked flag but have no!"
+
+#get the builder
+myBuilder = openedStudy.NewBuilder()
+
+#3. try to make some changes wrapped by transaction
+#==================================================
+exception_was = None
+try :
+ myBuilder.NewCommand()
+ A = myBuilder.FindOrCreateAttribute(father, "AttributeInteger")
+
+ if A == None :
+ raise RuntimeError, "Can't create AttributeInteger attribute"
+ A = A._narrow(SALOMEDS.AttributeInteger)
+ A.SetValue(1000000)
+ myBuilder.CommitCommand()
+except Exception: exception_was = 1
+
+if exception_was is None:
+ raise RuntimeError, "Study was locked for changes but CommitCommand did not generate an exception !"
+
+
+myBuilder.NewCommand()
+A=openedStudy.GetProperties()
+A = A._narrow(SALOMEDS.AttributeStudyProperties)
+A.SetLocked(0)
+myBuilder.CommitCommand()
+
+#4.
+myBuilder.NewCommand()
+A.SetLocked(0);
+print "A.GetUserName()= ", A.GetUserName()
+print "A.GetCreationDate() = ", A.GetCreationDate()
+print "A.GetCreationMode() = ", A.GetCreationMode()
+print "A.IsModified() = ", A.IsModified()
+myBuilder.CommitCommand()
+
+#5.
+myBuilder.NewCommand()
+A.SetUserName("tester1")
+myBuilder.CommitCommand()
+print "A.GetUserName()= ", A.GetUserName()
+
+#remove the document file
+os.remove(file)
+
--- /dev/null
+
+# create AttributeReal
+#=======================================================================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeTableOfInteger")
+if A == None :
+ raise RuntimeError, "Can't create AttributeTableOfInteger attribute"
+A = A._narrow(SALOMEDS.AttributeTableOfInteger)
+a=[1,2]
+
+b=[3,4]
+
+# 2x2
+# --- rows ---
+A.AddRow(a)
+A.AddRow(b)
+a=[34,14]
+A.SetRow(1,a)
+
+# 3x3
+#
+b=[54,56]
+A.AddRow(b)
+
+# --- columns ---
+a=[76,25,12]
+
+A.AddColumn(a)
+a=[836,3425,342]
+A.SetColumn(3,a)
+
+# change attribute values
+print "A.GetValue(2,2) = ", A.GetValue(2,2)
+print "A.PutValue(2,2,625323)"
+A.PutValue(625323,2,2)
+print "A.GetValue(2,2) = ", A.GetValue(2,2)
+
+#set Titles
+
+A.SetTitle("TEST")
+
+A.SetRowTitle(1,"FR")
+A.SetRowTitle(2,"SR")
+A.SetRowTitle(3,"TR")
+
+A.SetColumnTitle(1,"FC")
+A.SetColumnTitle(2,"SC")
+A.SetColumnTitle(3,"TC")
+
+
+#check the table
+print "Common title : ",A.GetTitle()
+print "Rows titles : ", A.GetRowTitles()
+rnb = A.GetNbRows()
+for i in range(1, rnb):
+ b=A.GetRow(i)
+ print b
+
+cnb = A.GetNbColumns()
+print "Columns title : ", A.GetColumnTitles()
+for i in range(1, cnb):
+ b=A.GetColumn(i)
+ print b
+
+# set titles
+#titles=["11","12","13"]
+#A.SetRowTitles(titles)
+#titles=["21","22","23"]
+#A.SetRowTitles(2,titles)
+#titles=["31","32","33"]
+#A.SetRowTitles(3,titles)
+
+#--------------------------------------------------------------------------#
+# ----------------------- save the study ----------------------------------#
+#--------------------------------------------------------------------------#
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+print " ------- We will save to", file, "-----------"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+
+#--------------------------------------------------------------------------#
+#---------------------------- Open file -----------------------------------#
+#--------------------------------------------------------------------------#
+
+print" -------------- Open " + file + "-------------- "
+
+openedStudy=batchmode_geompy.myStudyManager.Open(file)
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+# --- check attribute ---
+
+res,A=father.FindAttribute("AttributeTableOfInteger")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeTableOfInteger"
+
+A = A._narrow(SALOMEDS.AttributeTableOfInteger)
+
+#check the table
+print "Common title : ",A.GetTitle()
+print "Rows titles : ", A.GetRowTitles()
+rnb = A.GetNbRows()
+for i in range(1, rnb):
+ b=A.GetRow(i)
+ print b
+
+cnb = A.GetNbColumns()
+print "Columns title : ", A.GetColumnTitles()
+for i in range(1, cnb):
+ b=A.GetColumn(i)
+ print b
+
+titles=["ff","ss","tt"]
+A.SetRowTitles(titles)
+print "Rows titles : ", A.GetRowTitles()
+
+titles=["ww","zz","cc"]
+A.SetColumnTitles(titles)
+print "Column titles : ", A.GetColumnTitles()
+
--- /dev/null
+
+# create AttributeReal
+#===============================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeTableOfReal")
+if A == None :
+ raise RuntimeError, "Can't create AttributeTableOfReal attribute"
+A = A._narrow(SALOMEDS.AttributeTableOfReal)
+a=[1,2]
+
+b=[3,4]
+
+# 2x2
+# --- rows ---
+A.AddRow(a)
+A.AddRow(b)
+a=[34,14]
+A.SetRow(1,a)
+
+# 3x3
+#
+b=[54,56]
+A.AddRow(b)
+
+# --- columns ---
+a=[76,25,12]
+
+A.AddColumn(a)
+a=[836,3425,342]
+A.SetColumn(3,a)
+
+# change attribute values
+print "A.GetValue(2,2) = ", A.GetValue(2,2)
+print "A.PutValue(2,2,625323)"
+A.PutValue(625323,2,2)
+print "A.GetValue(2,2) = ", A.GetValue(2,2)
+
+#set Titles
+
+A.SetTitle("TEST")
+
+A.SetRowTitle(1,"FR")
+A.SetRowTitle(2,"SR")
+A.SetRowTitle(3,"TR")
+
+A.SetColumnTitle(1,"FC")
+A.SetColumnTitle(2,"SC")
+A.SetColumnTitle(3,"TC")
+
+
+#check the table
+print "Common title : ",A.GetTitle()
+print "Rows titles : ", A.GetRowTitles()
+rnb = A.GetNbRows() + 1
+for i in range(1, rnb):
+ b=A.GetRow(i)
+ print b
+
+cnb = A.GetNbColumns() + 1
+print "Columns title : ", A.GetColumnTitles()
+for i in range(1, cnb):
+ b=A.GetColumn(i)
+ print b
+
+# set titles
+#titles=["11","12","13"]
+#A.SetRowTitles(titles)
+#titles=["21","22","23"]
+#A.SetRowTitles(2,titles)
+#titles=["31","32","33"]
+#A.SetRowTitles(3,titles)
+
+#--------------------------------------------------------------------------#
+#------------------------ save the study ----------------------------------#
+#--------------------------------------------------------------------------#
+import os
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+print " ------- We will save to", file, "-----------"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+
+#--------------------------------------------------------------------------#
+#---------------------------- Open file -----------------------------------#
+#--------------------------------------------------------------------------#
+
+print" -------------- Open " + file + "-------------- "
+
+openedStudy = batchmode_geompy.myStudyManager.Open(file)
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+# --- check attribute ---
+
+res,A=father.FindAttribute("AttributeTableOfReal")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeTableOfReal"
+
+A = A._narrow(SALOMEDS.AttributeTableOfReal)
+
+#check the table
+print "Common title : ",A.GetTitle()
+print "Rows titles : ", A.GetRowTitles()
+rnb = A.GetNbRows() + 1
+for i in range(1, rnb):
+ b=A.GetRow(i)
+ print b
+
+cnb = A.GetNbColumns() + 1
+print "Columns title : ", A.GetColumnTitles()
+for i in range(1, cnb):
+ b=A.GetColumn(i)
+ print b
+
+titles=["ff","ss","tt"]
+A.SetRowTitles(titles)
+print "Rows titles : ", A.GetRowTitles()
+
+titles=["ww","zz","cc"]
+A.SetColumnTitles(titles)
+print "Column titles : ", A.GetColumnTitles()
+
--- /dev/null
+
+import batchmode_salome
+#import SALOMEDS
+
+aStudy = batchmode_salome.myStudy
+
+#Add new component 'User data'
+aBuilder = aStudy.NewBuilder()
+aComponent = aBuilder.NewComponent("User data")
+anAttr = aBuilder.FindOrCreateAttribute(aComponent, "AttributeName")
+anAttrName = anAttr._narrow(SALOMEDS.AttributeName)
+anAttrName.SetValue("User data")
+
+
+#Add a new case 'Case1' to the component 'User data'
+aBuilder.AddDirectory("/User data/Case1")
+
+#Set a study context to '/User data/Case1'
+aStudy.SetContext("/User data/Case1")
+
+#Print the current study context
+print aStudy.GetContext()
+
+#Add a sub directory 'aSubCase' to 'Case1' (under the current context)
+aBuilder.AddDirectory("aSubCase")
+
+
+#Add a new case 'Case2' to component 'User data'
+aBuilder.AddDirectory("/User data/Case2")
+
--- /dev/null
+
+# create AttributeSequenceOfReal
+#=================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeSequenceOfReal")
+if A == None :
+ raise RuntimeError, "Can't create AttributeSequenceOfReal attribute"
+A = A._narrow(SALOMEDS.AttributeSequenceOfReal)
+if A == None :
+ raise RuntimeError, "_narrow returns None instead of AttributeSequenceOfReal pointer"
+
+A.Add(0.0293)
+A.Add(625.1e+2)
+A.Add(0.928e+100)
+A.Add(83.287)
+
+print "initial values ",A.Value(1), A.Value(2), A.Value(3), A.Value(4)
+A.Remove(3)
+print "after remove ", A.Value(1), A.Value(2), A.Value(3)
+A.ChangeValue(2,76.265)
+print "after second item change", A.Value(1), A.Value(2), A.Value(3)
+
+if A.Length() != 3:
+ print "Error : wrong length of SequenceOfReal"
+if A.Value(1) != 0.0293 or A.Value(2) != 76.265 or A.Value(3) != 83.287:
+ print "Error : wrong value of AttributeSequenceOfReal"
+
+# save / restore study
+#=================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy=batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeSequenceOfReal
+#=================================
+
+res,A=father.FindAttribute("AttributeSequenceOfReal")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeSequenceOfReal"
+
+A = A._narrow(SALOMEDS.AttributeSequenceOfReal)
+
+if A.Length() != 3:
+ print "Error : wrong length of SequenceOfReal"
+if A.Value(1) != 0.0293 or A.Value(2) != 76.265 or A.Value(3) != 83.287:
+ print "Error : wrong value of AttributeSequenceOfReal"
+print "after restoring ", A.Value(1), A.Value(2), A.Value(3)
+
--- /dev/null
+
+# create AttributeSequenceOfInteger
+#==========================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")
+if A == None :
+ raise RuntimeError, "Can't create AttributeSequenceOfInteger attribute"
+A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)
+if A == None :
+ raise RuntimeError, "Can't create AttributeSequenceOfInteger attribute"
+
+A.Add(100)
+A.Add(300)
+A.Add(500)
+A.Add(400)
+A.Add(700)
+
+A.Remove(3)
+A.ChangeValue(4,500)
+
+
+if A.Length() != 4:
+ print "Wrong length of SequenceOfInteger"
+if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 700:
+ print "Wrong value of AttributeSequenceOfInteger"
+
+
+# save / restore study
+#=================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy=batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeSequenceOfInteger
+#======================================
+
+res,A=father.FindAttribute("AttributeSequenceOfInteger")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeSequenceOfInteger"
+
+A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)
+
+if A.Length() != 4:
+ print "Wrong length of SequenceOfInteger"
+if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 700:
+ print "Wrong value of AttributeSequenceOfInteger"
+
--- /dev/null
+
+# create AttributeName
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeName")
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A = A._narrow(SALOMEDS.AttributeName)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+A.SetValue("AttributesTesting")
+
+if A.Value() != "AttributesTesting":
+ print "Wrong value of AttributeName"
+
+
+# save / restore study
+#=================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy = batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeName
+#======================================
+
+res,A=father.FindAttribute("AttributeName")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeName"
+
+A = A._narrow(SALOMEDS.AttributeName)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeName attribute"
+
+if A.Value() != "AttributesTesting":
+ print "Wrong value of AttributeName"
+
--- /dev/null
+
+# create AttributeComment
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeComment")
+if A == None :
+ raise RuntimeError, "Can't create AttributeComment attribute"
+A = A._narrow(SALOMEDS.AttributeComment)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeComment attribute"
+
+A.SetValue("GEOM")
+
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy = batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeComment
+#============================================================
+
+res,A=father.FindAttribute("AttributeComment")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeComment"
+
+A = A._narrow(SALOMEDS.AttributeComment)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeComment attribute"
+
+if A.Value() != "GEOM":
+ "Error: wrong value of AttributeComment"
+
--- /dev/null
+
+# create AttributePersistentRef
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributePersistentRef")
+if A == None :
+ raise RuntimeError, "Can't create AttributePersistentRef attribute"
+A = A._narrow(SALOMEDS.AttributePersistentRef)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributePersistentRef attribute"
+
+A.SetValue("/tmp/test;1")
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy = batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributePersistentRef
+#============================================================
+
+res,A=father.FindAttribute("AttributePersistentRef")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributePersistentRef"
+
+A = A._narrow(SALOMEDS.AttributePersistentRef)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributePersistentRef attribute"
+
+if A.Value() != "/tmp/test;1":
+ "Error: wrong value of AttributePersistentRef"
--- /dev/null
+
+from batchmode_geompy import *
+import os
+
+#--------------------------------------------------------------------------
+# create AttributeDrawable
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeDrawable")
+if A == None :
+ raise RuntimeError, "Can't create AttributeDrawable attribute"
+A = A._narrow(SALOMEDS.AttributeDrawable)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeDrawable attribute"
+
+A.SetDrawable(1)
+
+if A.IsDrawable() == 0:
+ "Error: wrong value of AttributeDrawable"
+
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy=batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeDrawable
+#============================================================
+
+res,A=father.FindAttribute("AttributeDrawable")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeDrawable"
+
+A = A._narrow(SALOMEDS.AttributeDrawable)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeDrawable attribute"
+
+if A.IsDrawable() == 0:
+ "Error: wrong value of AttributeDrawable"
+
--- /dev/null
+
+# create AttributeSelectable
+#===========================================================
+A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeSelectable")
+if A == None :
+ raise RuntimeError, "Can't create AttributeSelectable attribute"
+A = A._narrow(SALOMEDS.AttributeSelectable)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeSelectable attribute"
+
+A.SetSelectable(1)
+
+if A.IsSelectable() == 0:
+ "Error: wrong value of AttributeSelectable"
+
+
+# save / restore study
+#============================================================
+str= os.getenv("TmpDir")
+if str == None:
+ str = "/tmp"
+file = str+"/test.hdf"
+
+batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)
+openedStudy = batchmode_geompy.myStudyManager.Open(file);
+
+if openedStudy == None:
+ raise RuntimeError, "Can't open saved study!"
+
+father = openedStudy.FindComponent("GEOM")
+if father is None:
+ raise RuntimeError, "Geom component is not found! Wrong study is opened."
+
+
+# find AttributeSelectable
+#============================================================
+
+res,A=father.FindAttribute("AttributeSelectable")
+if res == 0 or A == None:
+ raise RuntimeError, "Error: not found AttributeSelectable"
+
+A = A._narrow(SALOMEDS.AttributeSelectable)
+
+if A == None :
+ raise RuntimeError, "Can't create AttributeSelectable attribute"
+
+if A.IsSelectable() == 0:
+ "Error: wrong value of AttributeSelectable"
+
--- /dev/null
+include $(top_srcdir)/salome_adm/unix/make_common_starter.am
+
+usr_docs: doxyfile ../Batch.html
+ echo "Running doxygen in directory: "`pwd`; \
+ $(DOXYGEN) $< ; \
+ cp -rf ../Batch.html KERNEL
+
+docs: usr_docs
+
+info_TEXINFOS = ../Batch.texi
+
+install-data-local: usr_docs
+ $(INSTALL) -d $(DESTDIR)$(docdir)/gui
+ cp -rp KERNEL $(DESTDIR)$(docdir)/gui
+
+uninstall-local:
+ rm -rf $(DESTDIR)$(docdir)/gui/KERNEL
+
+clean-local:
+ -rm -fr KERNEL log.txt
+
+dist-hook:
+ cp -Rp $(srcdir)/images $(distdir) ; \
+ rm -rf $(distdir)/images/CVS ; \
+ cp -Rp $(srcdir)/static $(distdir) ; \
+ rm -rf $(distdir)/static/CVS
+
--- /dev/null
+# Doxyfile 1.4.6
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = "SALOME v.@VERSION@"
+PROJECT_NUMBER =
+OUTPUT_DIRECTORY = KERNEL
+CREATE_SUBDIRS = NO
+OUTPUT_LANGUAGE = English
+USE_WINDOWS_ENCODING = NO
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF =
+ALWAYS_DETAILED_SEC = YES
+INLINE_INHERITED_MEMB = YES
+FULL_PATH_NAMES = YES
+STRIP_FROM_PATH = @top_builddir@ @top_srcdir@
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = NO
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE = 5
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = YES
+OPTIMIZE_OUTPUT_JAVA = NO
+BUILTIN_STL_SUPPORT = NO
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = NO
+EXTRACT_PRIVATE = NO
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = NO
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = YES
+CASE_SENSE_NAMES = YES
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = NO
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = NO
+SORT_BRIEF_DOCS = NO
+SORT_BY_SCOPE_NAME = YES
+GENERATE_TODOLIST = NO
+GENERATE_TESTLIST = NO
+GENERATE_BUGLIST = NO
+GENERATE_DEPRECATEDLIST= NO
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 25
+SHOW_USED_FILES = NO
+SHOW_DIRECTORIES = NO
+FILE_VERSION_FILTER =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE = log.txt
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = \
+ @top_srcdir@/doc/salome \
+ @top_srcdir@/bin \
+ @top_srcdir@/idl \
+ @top_srcdir@/src/Container \
+ @top_srcdir@/src/LifeCycleCORBA \
+ @top_srcdir@/src/NamingService \
+ @top_srcdir@/src/Notification \
+ @top_srcdir@/src/SALOMEDS/SALOME_DriverPy.py \
+ @top_srcdir@/src/KERNEL_PY/salome.py \
+ @top_srcdir@/src/KERNEL_PY/salome_iapp.py \
+ @top_srcdir@/src/Utils \
+ @top_srcdir@/src/DSC
+
+FILE_PATTERNS = *.dox *.idl *.hxx *.cxx *.py
+RECURSIVE = YES
+EXCLUDE = @top_srcdir@/doc/salome/batch.dox
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS =
+EXAMPLE_PATH = @top_srcdir@/doc/salome/examples
+EXAMPLE_PATTERNS =
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH = @srcdir@/images
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION = NO
+USE_HTAGS = NO
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = NO
+COLS_IN_ALPHA_INDEX = 3
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = .
+HTML_FILE_EXTENSION = .html
+HTML_HEADER = @srcdir@/static/header.html
+HTML_FOOTER = @srcdir@/static/footer.html
+HTML_STYLESHEET =
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+BINARY_TOC = YES
+TOC_EXPAND = YES
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH = 250
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = NO
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+HIDE_UNDOC_RELATIONS = NO
+HAVE_DOT = YES
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = NO
+GROUP_GRAPHS = NO
+UML_LOOK = NO
+TEMPLATE_RELATIONS = YES
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = NO
+CALL_GRAPH = NO
+GRAPHICAL_HIERARCHY = NO
+DIRECTORY_GRAPH = NO
+DOT_IMAGE_FORMAT = jpg
+DOT_PATH =
+DOTFILE_DIRS =
+MAX_DOT_GRAPH_WIDTH = 1024
+MAX_DOT_GRAPH_HEIGHT = 1200
+MAX_DOT_GRAPH_DEPTH = 0
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = NO
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+</head>
+<body>
+<hr style="width: 100%; height: 2px;">
+<div style="text-align: center;">Copyright © 2003-2007 CEA, EDF<br>
+</div>
+</body>
+</html>
--- /dev/null
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <title>$title</title>
+ <link href="tabs.css" rel="stylesheet" type="text/css">
+ <link href="doxygen.css" rel="stylesheet" type="text/css">
+</head>
+<hr>
+<center>
+SALOME documentation central
+</center>
+<hr>
/*!
\page INSTALL Installation instructions
-<b>NOT UP TO DATE %SALOME 4</b>
-<b>WORK in PROGRESS, INCOMPLETE DOCUMENT</b>
+<b>NOT UP TO DATE AND INCOMPLETE DOCUMENT BUT CAN BE HELPFUL</b>
-You'll find here generic instructions for installing the SALOME2 platform.
+You'll find here generic instructions for installing the SALOME platform.
\section Summary
-<ol>
-<li> \ref S1_install </li>
-<li> \ref S2_install </li>
-<li> \ref S3_install </li>
-<li> \ref S4_install </li>
-<li> \ref S5_install </li>
-<li> \ref S6_install </li>
-<li> \ref S7_install </li>
-<li> \ref S8_install </li>
-</ol>
+-# \ref S1_install
+-# \ref S2_install
+-# \ref S3_install
+-# \ref S4_install
+-# \ref S5_install
+-# \ref S6_install
+-# \ref S7_install
+-# \ref S8_install
\section S1_install Quick Overview
software programs on your system. These programs are:
- common development tools as gcc, automake, autoconf and libtools.
-- third party softwares used in SALOME building or runtime process
+- third party softwares used in %SALOME building or runtime process
(python, OCC, VTK, ...)
-Further details can be found in sections [2] and [3].
+Further details can be found in sections \ref S2_install and \ref S3_install.
If the dependencies are installed on your system, then you have to set
your shell environment to get access to the software components
-(cf. [4]. "Preparing the shell environment").
+(cf. \ref S4_install).
-The next step is to install the KERNEL (cf. [5] "Installing KERNEL"):
+The next step is to install the KERNEL (cf. \ref S5_install):
\code
$ mkdir <kernel_build>
\endcode
Then, the %SALOME components GEOM, MED, VISU, ... can be installed
-with a similar procedure (cf. [6]).
+with a similar procedure (cf. \ref S6_install).
-Eventually, the platform ccodean be run by executing the shell script
-runSalome (cf. [7]). Here, somme additionnal variables have to be set
+Eventually, the platform can be run by executing the shell script
+%runSalome (cf. \ref S7_install). Here, somme additionnal variables have to be set
to describe the %SALOME runtime configuration (<COMPONENT>_ROOT_DIR,
OMNIORB_CONFIG)
In the following, we assume that all the third-party softwares are
installed in the same root directory, named <salomeroot>/prerequis.
-Then, your file system should probably look like::
+Then, your file system should probably look like:
\code
<salomeroot>/prerequis/Python-2.2.2
\section S4_install Preparing the shell environment
-Some variables have to be set to get acces to third-party software
+Some variables have to be set to get access to third-party software
components (include files, executable, library, ...) during building
process and runtime.
We use here the notation <kernel_src> to specify the source directory
of the KERNEL component. The shell environment is supposed to have
-been set (cf. 4).
+been set (cf. \ref S4_install).
Installing the KERNEL from a source package needs three directories:
\endcode
If it doesn't work, check your system automake tools as specified in
- section [2].
+ section \ref S2_install.
<b>STEP 3:</b>
configure the building process
- go to the build directory and execute the configuration process::
+ go to the build directory and execute the configuration process:
\code
$ cd <kernel_build>
Note that <kernel_install> must be an absolute path.
When the configure process is complete, check the status of
- third-party softwares detection. You should have a status like::
+ third-party softwares detection. You should have a status like:
\code
---------------------------------------------
<b>STEP 4 :</b>
Building the binary files
- Execute make in the <kernel_build> directory::
+ Execute make in the <kernel_build> directory:
\code
$ make
<b>STEP 5:</b>
Installing binary files, scripts and documentation
- Execute install target in the <kernel_build> directory::
+ Execute install target in the <kernel_build> directory:
\code
$ make install
\section S6_install Installing the SALOME components
-TInstalling a component <COMPONENT> is done by following the same
+Installing a component <COMPONENT> is done by following the same
instructions as given for the KERNEL, replacing KERNEL by
<COMPONENT> (build_configure, configure, make, make install).
- GEOM depends on KERNEL
- SMESH depends on KERNEL, MED, GEOM
- VISU depends on KERNEL, MED
-- SUPERV depends on KERNEL
+- YACS depends on KERNEL
For example, installing the component SMESH needs the previous
installation of the KERNEL component, and then the GEOM and MED components.
\section S7_install Runtime
-See SALOME_Application to define your own configuration of %SALOME and run it
+See \ref SALOME_Application to define your own configuration of %SALOME and run it
on one or several computers. This is the recommended way of configuration.
The following explains the general principles.
To run the %SALOME platform, the procedure is:
-- set the shell environment to get acces to third-party softwares:
-
-\code
+- set the shell environment to get access to third-party softwares:
+ \code
$ source prerequis.sh
-\endcode
+ \endcode
- define the %SALOME configuration by setting the whole set of
variables <COMPONENT>_ROOT_DIR. Here, you just have to set the
- kernel and the components you need::
-
+ kernel and the components you need:
\code
$ export KERNEL_ROOT_DIR=<kernel_install>
$ export MED_ROOT_DIR=<med_install>
- define the CORBA configuration file by setting the variable
OMNIORB_CONFIG. This variable must be set to a writable file
path. The file may be arbitrary chosen and doesn't need to exist
- before running. We suggest::
-
+ before running. We suggest:
\code
$ export OMNIORB_CONFIG=$HOME/.omniORB.cfg
\endcode
-- run the %SALOME platform by executing the script runSalome:
-
+- run the %SALOME platform by executing the script %runSalome:
\code
$KERNEL_ROOT_DIR/bin/salome/runSalome
\endcode
For convenience or customization, we suggest the following organisation:
-- chose and create a root directory for the %SALOME platform, say
+- choose and create a root directory for the %SALOME platform, say
<salomeroot>.
- install the third-party softwares in a sub-directory "prerequis"
- install the %SALOME components in a sub-directory "SALOME2"
-- make personnal copies of the files prerequis.sh and runSalome in
+- make personnal copies of the files prerequis.sh and %runSalome in
<salomeroot>:
-
\code
$ cp <kernel_src>/prerequis.sh <rundir>/.
$ cp <kernel_install>/bin/salome/runSalome <rundir>/.
\endcode
-
Edit the file prerequis.sh and adjust it to your own configuration.
-- define the SALOME2 configuration
-
+- define the SALOME2 configuration\n
This step consists in setting the KERNEL_ROOT_DIR, the whole set of
variables <COMPONENT>_ROOT_DIR you need, and the OMNIORB_CONFIG
variable.
-
+ \n
We suggest to create a shell file envSalome.sh containing those
settings. Then the configuration consists in loading envSalome.sh in
the runtime shell:
-
-\code
+ \code
$ source envSalome.sh
-\endcode
+ \endcode
- When installed with this file organisation, running %SALOME is done
- with the following shell commands::
-
+ with the following shell commands:
\code
$ source <salomeroot>/prerequis.sh
$ source <salomeroot>/envSalome.sh
$ ./runSalome
\endcode
+
*/
/*!
-\page kernel_resources SALOME Kernel resources for developer
+\page kernel_resources Salome Kernel resources for developer
-<b>WORK in PROGRESS, INCOMPLETE DOCUMENT</b>
-\section S1_kernel_res Abstract
-
This document describes the development environment for
C++ and Python. Makefiles generation and usage are
introduced in another document: "using the %SALOME
execution at debug time, in order to validate all parts
of code.
-<ol>
-<li>
-<b>Two modes: debug and release</b>
+\subsection subsection21 Two modes: debug and release
The goal of debug mode is to check as many features as
possible during the early stages of the development
to a configuration documentation or send the message to
the people in charge of %SALOME installation, or to the
development team, following the kind of error.
-</li>
-<li>
-<b>C++ Macros for trace and debug</b>
+
+\subsection subsection22 C++ Macros for trace and debug
%SALOME provides C++ macros for trace and debug. These
macros are in:
This file must be included in C++ source. Some
macros are activated only in debug mode, others are
-always activated. To activate the debug mode, ``_DEBUG_``
+always activated. To activate the debug mode, _DEBUG_
must be defined, which is the case when %SALOME
Makefiles are generated from configure, without
-options. When ``_DEBUG_`` is undefined (release mode:
-``configure --disable-debug --enable-production``), the
+options. When _DEBUG_ is undefined (release mode:
+configure --disable-debug --enable-production), the
debug mode macros are defined empty (they do nothing).
So, when switching from debug to release, it is
possible (and recommended) to let the macro calls
Three informations are systematically added in front of
the information displayed:
-
- the %thread number from which the message come from;
-
- the name of the source file in which the macros is set;
-
- the line number of the source file at which the macro
is set.
-<ol>
-<li>
-<b>Macros defined in debug and release modes</b>
-\n
-<b>INFOS_COMPILATION</b>
+\subsection subsection23 Macros defined in debug and release modes
+- <b>INFOS_COMPILATION</b>\n
The C++ macro INFOS_COMPILATION writes on the trace
buffer pool informations about the compiling process:
-
- the name of the compiler : g++, KCC, CC, pgCC;
-
- the date and the time of the compiling processing process.
-
+ .
This macro INFOS_COMPILATION does not have any
argument. Moreover, it is defined in both compiling
- mode : _DEBUG_ and _RELEASE_.
-
+ mode : _DEBUG_ and _RELEASE_.\n
Example:
-
\code
#include "utilities.h"
int main(int argc , char **argv)
INFOS_COMPILATION;
...
}
-INFOS(str)
\endcode
-\n
-<b>INFOS</b>
+- <b>INFOS</b>\n
In both compiling mode _DEBUG_ and _RELEASE_, The C++
macro INFOS writes on the trace buffer pool %the string
- which has been passed in argument by the user.
-
+ which has been passed in argument by the user.\n
Example:
-
\code
#include "utilities.h"
int main(int argc , char **argv)
return 0;
}
\endcode
-
Displays:
-
\code
main.cxx [5] : NORMAL END OF THE PROCESS
\endcode
-\n
-<b>INTERRUPTION(str)</b>
+- <b>INTERRUPTION(str)</b>\n
In both compiling mode _DEBUG_ and _RELEASE_, The C++
macro INTERRUPTION writes on the trace buffer pool the
%string, with a special ABORT type. When the %thread in
charge of collecting messages finds this message, it
terminates the application, after message treatment.
-<b>IMMEDIATE_ABORT(str)</b>
-
+- <b>IMMEDIATE_ABORT(str)</b>\n
In both compiling mode _DEBUG_ and _RELEASE_, The C++
macro IMMEDIATE_ABORT writes the message str immediately on
standard error and exits the application. Remaining
messages not treated by the message collector %thread
are lost.
-</li>
-<li>
-<b>Macros defined only in debug mode</b>
-\n
-<b>MESSAGE(str)</b>
+\subsection subsection24 Macros defined only in debug mode
+- <b>MESSAGE(str)</b>\n
In _DEBUG_ compiling mode only, the C++ macro MESSAGE
writes on the trace buffer pool the %string which has
been passed in argument by the user. In _RELEASE_
- compiling mode, this macro is blank.
-
+ compiling mode, this macro is blank.\n
Example:
-
\code
#include "utilities.h"
#include <string>
}
\endcode
-
Displays:
-
\code
- Trace main.cxx [8] : Salome
- Trace main.cxx [12] : Aster and CASTEM
\endcode
-\n
-<b>BEGIN_OF(func_name)</b>
-
+- <b>BEGIN_OF(func_name)</b>\n
In _DEBUG_ compiling mode, The C++ macro BEGIN_OF
appends the %string "Begin of " to the one passed in
argument by the user and displays the result on the
trace buffer pool. In _RELEASE_ compiling mode, this
- macro is blank.
-
+ macro is blank.\n
Example:
-
\code
#include "utilities.h"
int main(int argc , char **argv)
return 0;
}
\endcode
-
Displays:
-
\code
- Trace main.cxx [3] : Begin of a.out
\endcode
-\n
-<b>END_OF(func_name)</b>
+- <b>END_OF(func_name)</b>\n
In _DEBUG_ compiling mode, The C++ macro END_OF appends
the %string "Normal end of " to the one passed in
argument by the user and displays the result on the
trace buffer pool. In _RELEASE_ compiling mode, this
- macro is blank.
-
+ macro is blank.\n
Example:
-
\code
#include "utilities.h"
int main(int argc , char **argv)
return 0;
}
\endcode
-
Displays:
-
\code
- Trace main.cxx [4] : Normal end of a.out
\endcode
-\n
-<b>SCRUTE(var)</b>
+- <b>SCRUTE(var)</b>\n
In _DEBUG_ compiling mode, The C++ macro SCRUTE
displays its argument which is an application variable
followed by the value of the variable. In _RELEASE_
- compiling mode, this macro is blank.
-
+ compiling mode, this macro is blank.\n
Example:
-
\code
#include "utilities.h"
int main(int argc , char **argv)
return 0;
}
\endcode
-
Displays:
-
\code
- Trace main.cxx [5] : i=999
\endcode
-\n
-<b>ASSERT(condition)</b>
+- <b>ASSERT(condition)</b>\n
In _DEBUG_ compiling mode only, The C++ macro ASSERT
checks the expression passed in argument to be not
NULL. If it is NULL the condition is written with the
macro INTERRUPTION (see above). The process exits after
trace of this last message. In _RELEASE_ compiling
mode, this macro is blank. N.B. : if ASSERT is already
- defined, this macro is ignored.
-
+ defined, this macro is ignored.\n
Example:
-
\code
#include "utilities.h"
...
cout << table[k];
\endcode
-</li>
-</ol>
-</li>
-</ol>
-
\section S3_kernel_res Exceptions
-<ol>
-<li>
-<b>C++ exceptions: class SALOME_Exception</b>
+\subsection subsection31 C++ exceptions: class SALOME_Exception
-<ol>
-<li>
-<b>definition</b>
+\subsubsection subsubsection311 Definition
The class SALOME_Exception provides a generic method to
send a message, with optional source file name and line
The class SALOME_Exception inherits its behavior from
the STL class exception.
-</li>
-<li>
-<b>usage</b>
+
+\subsubsection subsubsection312 Usage
The header %SALOME/src/utils/utils_SALOME_Exception.hxx
must be included in the C++ source, when raised or trapped:
\endcode
where LOCALIZED is a macro provided with
-``utils_SALOME_Exception.hxx`` which gives file name and
+utils_SALOME_Exception.hxx which gives file name and
line number.
The exception is handled like this:
The what() method overrides the one defined in the STL
exception class.
-</li>
-</ol>
-</li>
-<li>
-<b>CORBA exceptions</b>
-<ol>
-<li>
-<b>definition</b>
+\subsection subsection32 CORBA exceptions
+
+\subsubsection subsubsection321 Definition
The idl SALOME_Exception provides a generic CORBA
exception for %SALOME, with an attribute that gives an
packages used within %SALOME, such as OmniORB
exceptions, must be handled separately.
-</li>
-<li>
-<b>usage</b>
-<ol>
-<li>
+\subsubsection subsubsection322 Usage
<b>CORBA servant, C++</b>
The CORBA Server header for SALOME_Exception and a
macro to throw the exception are provided with the
- header ``KERNEL_SRC/src/Utils/Utils_CorbaException.hxx``:
+ header KERNEL_SRC/src/Utils/Utils_CorbaException.hxx:
\code
#include "Utils_CorbaException.hxx"
SALOME::BAD_PARAM);
\endcode
-</li>
-<li>
-<b>CORBA Client, GUI Qt C++</b>
-
- <b>NO MORE AVAILABLE in %SALOME 3.x</b>
+<b>CORBA Client, GUI Qt C++ (NO MORE AVAILABLE in %SALOME 3.x and later)</b>
The CORBA Client header for SALOME_Exception and a Qt
function header that displays a message box are
provided in:
- ``KERNEL_SRC/src/SALOMEGUI/SALOMEGUI_QtCatchCorbaException.hxx``
+ KERNEL_SRC/src/SALOMEGUI/SALOMEGUI_QtCatchCorbaException.hxx
\code
#include "SALOMEGUI_QtCatchCorbaException.hxx"
}
\endcode
-</li>
-<li>
<b>CORBA Client, C++, without GUI</b>
Nothing specific has been provided to the developer
SALOMEGUI_QtCatchCorbaException.hxx to see how to get
the information given by the exception %object.
-</li>
-</ol>
-</li>
-</ol>
-</ol>
-
\section S4_kernel_res Miscellaneous tools
-<ol>
-<li>
-<b>Singleton</b>
-<ol>
-<li>
-<b>Definition</b>
+\subsection subsection41 Singleton
+\subsubsection subsubsection411 Definition
%A singleton is an application data which is created and
deleted only once at the end of the application
static singleton data before the first executable
statement. They are deleted after the last statement execution.
-The ``SINGLETON_`` template class deals with dynamic
+The SINGLETON_ template class deals with dynamic
singleton. It is useful for functor objects. For
example, an %object that connects the application to a
system at creation and disconnects the application at deletion.
-</li>
-<li>
-<b>Usage</b>
+\subsubsection subsubsection412 Usage
To create a single instance of a POINT %object:
assert(p1==p2)
\endcode
-</li>
-<li>
-<b>Design description</b>
+\subsubsection subsubsection413 Design description
Here are the principles features of the singleton
design:
-
- the user creates an %object of class TYPE by using the
- class method ``SINGLETON_<TYPE>::Instance()`` which
+ class method SINGLETON_<TYPE>::Instance() which
returns a pointer to the single %object ;
-
-- to create an %object, ``SINGLETON_<TYPE>::Instance()``
+- to create an %object, SINGLETON_<TYPE>::Instance()
uses the default constructor of class TYPE ;
-
- at the same time, this class method creates a
destructor %object which is added to the generic list
of destructor objects to be executed at the end of
the application (atexit) ;
-
- at the end of the application process all the
- deletions are performed by the ``Nettoyage()`` C function
+ deletions are performed by the Nettoyage() C function
which executes the destruction objects end then
deletes the destructions objects themselves ;
+- the Nettoyage() C function using atexit() C function
+ is embedded in a static single %object ATEXIT_().
-- the ``Nettoyage()`` C function using ``atexit()`` C function
- is embedded in a static single %object ``ATEXIT_()``.
-
-</li>
-</ol>
-</li>
-</ol>
*/
/*!
\page KERNEL_Services KERNEL Services for end user (Python interface)
-<b>WORK in PROGRESS, INCOMPLETE DOCUMENT</b>
-
In a %SALOME application, distributed components, servers and clients use
the CORBA middleware for comunication. CORBA interfaces are defined via idl
files. All the different CORBA interfaces are available for users in Python,
\section S1_kernel_ser General purpose services
-<ol>
-<li>
-<b>%SALOME services access from a Python shell</b>
+\subsection subsection11 SALOME services access from a Python shell
-See \ref SALOME_Application for detailed instructions to launch a Python
-interpreter with full acces to the %SALOME environment and services.
+See \ref SALOME_Application for detailed instructions on how to launch a Python
+interpreter with full access to the %SALOME environment and services.
-You can use the embedded Python interpreter in Grahic User Interface, or an
+You can use the embedded Python interpreter in Graphical User Interface, or an
external interpreter, with:
\code
do it several times, so it is preferable to add these instructions
systematically in your scripts, to allow them to work in all configurations.
-</li>
-<li>
-<b>Container and component instanciation</b>
+\subsection subsection12 Container and component instanciation
-See LifeCycleCORBA for the C++ interface (Python interface obtained with SWIG
+See SALOME_LifeCycleCORBA for the C++ interface (Python interface obtained with SWIG
is very similar).
In the following example, a test component provided in KERNEL is launched
In the next example, a component instance is created in a specific Container
defined by it's computer hostname and it's name. Here we use the local
-computer. Note that in Utils_Identity, getShortHostName() gives the short
+computer. Note that in Utils_Identity, Utils_Identity::getShortHostName() gives the short
hostname of the computer, without domain suffixes, which is used in %SALOME.
The container process is created here if it does not exists, and a new
component instance is created:
SalomeAppEngine.object
\endcode
-</li>
-<li>
-<b>File transfer service</b>
+\subsection subsection13 File transfer service
See SALOME_FileTransferCORBA for the C++ interface (Python interface obtained with
SWIG is very similar).
localFile=aFileTransfer.getLocalFile()
\endcode
-</li>
-<li>
-<b>CORBA Naming service access</b>
+\subsection subsection14 CORBA Naming service access
See SALOME_NamingService for the C++ interface. The Python interface
-SALOME_NamingServicePy is not yet derived from the C++ interface and offers
+SALOME_NamingServicePy::SALOME_NamingServicePy_i is not yet derived from the C++ interface and offers
only the most useful functions.
-</li>
-<li>
-<b>Batch services</b>
-
-See \ref batch_page documentation (in french only).
+\subsection subsection5 Batch services
-</li>
-</ol>
+See <a href="Batch.html/index.html"> Batch documentation </a> (in french only).
\section S2_kernel_ser All IDL Interfaces
-<ol>
-<li>
-<b>Containers and component life cycle, File transfer service</b>
-
-- Engines : engines CORBA module.
-- Engines::Component : generic component interface. All %SALOME components inherit this interface.
-- Engines::Container : host for C++ and Python components components instances
-- Engines::fileTransfer : agent for file transfer created by a container copy a local file to a distent client
-- Engines::fileRef : reference to a file, used by a container for file transfers
-- Engines::ContainerManager : unique instance, in charge of container creation on remote computers
-- Engines::MPIContainer : an exemple of parallel implementation for containers and components
-- Engines::MPIObject
-
-</li>
-<li>
-<b>Study management</b>
-
-- SALOMEDS : SALOMEDS CORBA module
-- SALOMEDS.idl
-- SALOMEDS_Attributes.idl
-
-</li>
-<li>
-<b>High speed transfer, object life cycle, exceptions, GUI interface...</b>
-
-- SALOME : %SALOME CORBA module
-- SALOME_Comm.idl
-- SALOME_GenericObj.idl
-- SALOME_Exception
-- SALOME_Session.idl
-
-</li>
-<li>
-<b>Miscelleanous</b>
-
-- SALOME_ModuleCatalog
-- SALOME_RessourcesCatalog
-- SALOME_Registry.idl
-- Logger.idl
-
-<b>Other idl for test purposes</b>
-\n
-- nstest.idl
-- SALOME_TestComponent.idl
-- SALOME_TestModuleCatalog.idl
-- SALOME_TestMPIComponent.idl
-- TestNotif.idl
+-# <b>Containers and component life cycle, File transfer service</b>
+ - Engines : engines CORBA module.
+ - Engines::Component : generic component interface. All %SALOME components inherit this interface.
+ - Engines::Container : host for C++ and Python components components instances
+ - Engines::fileTransfer : agent for file transfer created by a container copy a local file to a distent client
+ - Engines::fileRef : reference to a file, used by a container for file transfers
+ - Engines::ContainerManager : unique instance, in charge of container creation on remote computers
+ - Engines::MPIContainer : a parallel implementation for containers and components
+ - Engines::MPIObject
+ .
+-# <b>Study management</b>
+ - SALOMEDS : SALOMEDS CORBA module
+ - SALOMEDS.idl : \copybrief SALOMEDS.idl
+ - SALOMEDS_Attributes.idl : \copybrief SALOMEDS_Attributes.idl
+ .
+-# <b>High speed transfer, object life cycle, exceptions, GUI interface...</b>
+ - SALOME : \copybrief SALOME
+ - SALOME_Comm.idl : \copybrief SALOME_Comm.idl
+ - SALOME_GenericObj.idl : \copybrief SALOME_GenericObj.idl
+ - SALOME_Exception.idl : \copybrief SALOME_Exception.idl
+ - SALOME_Session.idl : \copybrief SALOME_Session.idl
+ .
+-# <b>Miscelleanous</b>
+ - SALOME_ModuleCatalog : \copybrief SALOME_ModuleCatalog
+ - SALOME_RessourcesCatalog : \copybrief SALOME_RessourcesCatalog
+ - Registry : \copybrief Registry
+ - SALOME_Logger : \copybrief SALOME_Logger
+ .
+-# <b>Other idl for test purposes</b>
+ - NSTEST : for naming service test
+ - SALOME_TestComponent.idl : for Component test
+ - SALOME_TestModuleCatalog : for SALOME_ModuleCatalog test
+ - SALOME_TestMPIComponent.idl : \copybrief SALOME_TestMPIComponent.idl
+ - TestNotif.idl : \copybrief TestNotif.idl
+ .
+-# <b>Some useful command scripts </b>
+ - waitNS.py : \copybrief waitNS.py
+ - waitContainers.py : \copybrief waitContainers.py
+ - showNS.py : \copybrief showNS.py
+ - shutdownSalome.py : \copybrief shutdownSalome.py
+ - killSalome.py : \copybrief killSalome.py
+ - killSalomeWithPort.py : \copybrief killSalomeWithPort.py
+ - appli_gen.py : \copybrief appli_gen.py
+ .
*/
+
+/** \example example1
+AttributeReal interface (creations/saving/restoring)
+\n
+Methods : FindOrCreateAttribute, Value, SaveAs, SetValue, FindComponent, FindAttribute, Open
+ */
+/** \example example3
+AttributeSequenceOfReal interface(creations/saving/restoring)\n
+AttributeSequenceOfReal : ChangeValue, Add, Value, Remove, Length\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open
+ */
+/** \example example16
+Methods : GetAvailableUndos, ChangeValue, FindOrCreateAttribute, SaveAs, GetAvailableRedos, Undo, FindComponent, Redo, FindAttribute, Open, CommitCommand, NewCommand
+ */
+/** \example example17
+SALOMEDS methods : RemoveAttribute, FindOrCreateAttribute, NewStudy, GetAllAttributes, NewCommand, CommitCommand, AbortCommand, NewComponent
+ */
+/** \example example18
+AttributeTreeNode interface(creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, NewObject\n
+Attribute methods : HasFirst, HasFather, SetPrevious, Next, InsertAfter, GetFather, HasNext, SetValue, Append, NewStudy, Label, IsRoot, Prepend, SetFather, Depth, HasPrevious
+ */
+/** \example example19
+ SALOMEDS methods : FindOrCreateAttribute, Save, SaveAs, Close, Open, FindComponent, FindAttribute, FindObject, LoadWith
+\n
+ Attribute methods : Value, SetValue
+ */
+/** \example example20
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, NewCommand, GetProperties, Open, CommitCommand, NewBuilder\n
+Attribute methods : SetLocked, IsLocked, GetCreationMode, SetCreationDate, IsModified, GetUserName, Value, SetUserName, SetValue, GetCreationDate
+ */
+/** \example example23
+Methods:
+ */
+/** \example example8
+AttributeDrawable interface(creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods : SetDrawable, IsDrawable
+ */
+/** \example example9
+AttributeSelectable interface(creations/saving/restoring)\n
+SALOMEDS methods: FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods: SetSelectable, IsSelectable
+ */
+/** \example example10
+AttributeExpandable interface(creations/saving/restoring)\n
+SALOMEDS methods : SaveAs FindComponent FindAttribute Open\n
+Attribute methods : SetExpandable IsExpandable
+ */
+/** \example example11
+Test AttributeOpened (creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods : SetOpened, IsOpened
+ */
+/** \example example12
+AttributeTextColor interface (creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods : SetTextColor TextColor
+ */
+/** \example example13
+Test AttributeTextHighlightColor interface(creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods : SetTextHighlightColor TextHighlightColor
+ */
+/** \example example14
+AttributePixMap interface (creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods : SetPixMap, GetPixMap
+ */
+
+/** \example example21
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods: GetValue, GetNbColumns, AddColumn, SetRowTitles, PutValue, GetColumn, GetColumnTitles, GetTitle, SetRow, GetRowTitles, SetColumnTitles, SetColumn, GetRow, GetNbRows, SetColumnTitle, AddRow, SetTitle, SetRowTitle
+ */
+/** \example example15
+AttributeLocalID interface(creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods : Value, SetValue
+*/
+/** \example example22
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open\n
+Attribute methods : GetValue, GetNbColumns, AddColumn, SetRowTitles, PutValue, GetColumn, GetColumnTitles, GetTitle, SetRow, GetRowTitles, SetColumnTitles, SetColumn, GetRow, GetNbRows, SetColumnTitle, AddRow, SetTitle, SetRowTitle
+*/
+/** \example example4
+AttributeSequenceOfInteger interface(creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute FindComponent FindAttribute Open Add SaveAs
+AttributeSequenceOfInteger methods : Value, Remove, Length
+*/
+/** \example example5
+AttributeName interface(creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent FindAttribute Open\n
+Attribute methods : SetValue, Value
+*/
+/** \example example6
+AttributeComment interface(creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs FindComponent FindAttribute Open\n
+Attribute methods : Value, SetValue
+*/
+/** \example example7
+AttributePersistentRef interface(creations/saving/restoring)\n
+SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent FindAttribute Open\n
+Attribute methods : SetValue, Value
+*/
+
/*! \mainpage SALOME KERNEL Reference Documentation
- \image html kernel_about_4.png
-
- \section S1_main Introduction
+ \image html icon_about.png
Welcome to the %SALOME KERNEL documentation !
Following your kind of usage of %SALOME, you will find some specific
introductory documentation, listed below.
- \section S2_main End user
+\section S2_main End user
-<ol>
- <li>
- <b>How to configure a %SALOME application</b>
- \n The end user may have to configure his own %SALOME application by selection of a
+-# <b>How to configure a %SALOME application</b>\n
+ The end user may have to configure his own %SALOME application by selection of a
subset of availables %SALOME modules. He also may want to install his
application on several computers.
See \subpage SALOME_Application to define your own configuration of %SALOME and run it
on one or several computers. This is the recommended way of configuration.
- </li>
- <li>
- <b>How to launch %SALOME in a %SALOME application</b>
- \n See \ref SALOME_Application.
- </li>
- <li>
- <b>How to use KERNEL services in Python scripts</b>
- \n The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services.
- </li>
-</ol>
+-# <b>How to launch %SALOME in a %SALOME application</b>\n
+ See \ref SALOME_Application.
+-# <b>How to use KERNEL services in Python scripts</b>\n
+ The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services.
- \section S3_main Application Integrator
+\section S3_main Application Integrator
Applications integrators are in charge of configuration and installation of
specific %SALOME applications over a local network. Application Integrators
built %SALOME modules binaries from sources tarballs.
-<ol>
- <li>
- <b>How to install %SALOME</b>
- \n See \subpage INSTALL for general information on required configuration and
+-# <b>How to install %SALOME</b>\n
+ See \subpage INSTALL for general information on required configuration and
prerequisites, compilation procedure, setting environment principles.
- </li>
- <li>
- <b>How to configure a %SALOME application</b>
- \n See \ref SALOME_Application to define your own configuration of %SALOME and run it
+-# <b>How to configure a %SALOME application</b>\n
+ See \ref SALOME_Application to define your own configuration of %SALOME and run it
on one or several computers. This is the recommended way of configuration.
- </li>
-</ol>
- \section S4_main Module maintainer
+\section S4_main Module maintainer
Module maintainers are in charge of the development and debug of the %SALOME
modules. Each %SALOME module is stored in a CVS base. CVS bases are organised
in separate branches for developments and debug. All official or development
releases are identified by a CVS tag.
-<ol>
- <li>
- <b>Source code structuration and Unit Tests</b>
- \n See \subpage UnitTests for general information on code directories structure,
+-# <b>Source code structuration and Unit Tests</b>\n
+ See \subpage UnitTests for general information on code directories structure,
unit tests associated to the different kind of classes, and how to run
the unit tests.
- </li>
- <li>
- <b>Some development utilities</b>
- \n See \subpage kernel_resources for information on basic utilities for C++ and Python
+-# <b>Some development utilities</b> \n
+ See \subpage kernel_resources for information on basic utilities for C++ and Python
development, like trace and debug, exceptions, singleton.
- </li>
-</ol>
- \section S5_main SALOME programming model
+\section S5_main SALOME programming model
You will find in the next pages informations about
specific points of %SALOME Kernel :
- \subpage dsc_page : DSC documentation page.
- \subpage salome_file_page : Salome_file documentation page.
- - \subpage batch_page : BATCH documentation page.
+ - <a href="Batch.html/index.html"> Batch documentation </a>
*/
/*!
- \page SALOME_Application SALOME Application Concept
+ \page SALOME_Application Salome Application Concept
- <b>Configuration for one or more computers</b>
-
-
-<b> **WORK in PROGRESS, INCOMPLETE DOCUMENT** </b>
The following explains how to configure your own application with your list of
modules, how to define and run this application on one or more computers.
\section S1_sal_appl General principles
-%A %SALOME application is defined by a set of modules (GEOM, SMESH, ASTER...).
+%A %SALOME application is defined by a set of modules (GEOM, SMESH, ASTER...). %A %SALOME application
+lives in an application directory.
+%A %SALOME application is a virtual installation of %SALOME in the application directory
+(bin, lib, doc, share...), with, for each file (executable, script, data,
+library, resources...), symbolic links to the actual files.
%A %SALOME User can define several %SALOME Applications. These applications are
runnable from the same user account. These applications may share the same
\section S2_sal_appl Application Directory
-There are two ways for creation of an application directory, <b>the recommended way is
-the second, easier to configure.</b>
-
-<ol>
- <li>
- <b>First way - references to different module directories</b>
-
-The script createAppli.sh in ${KERNEL_ROOT_DIR}/bin/salome creates an
-application directory with the given path in parameter. The path given, ${APPLI}, is
-relative to ${HOME}.
-
-The directory is only a skeleton, the user has to edit several files to
-configure his own application. These files are described after, the list is:
-
-- env.d/atFirst.sh
-- env.d/envProducts.sh
-- env.d/envSALOME.sh
-- CatalogResources.xml
-- SALOMEApp.xml
-
- </li>
- <li>
- <b>Second and easiest way - one single virtual install directory</b>
-
-The user must create a %SALOME application configuration file by modifying a
+First, the user must create a %SALOME application configuration file by modifying a
copy of ${KERNEL_ROOT_DIR}/bin/salome/config_appli.xml.
The file describes the list of %SALOME modules used in the application, with
their respective installation path. The configuration file also defines the
path of an existing script which sets the %SALOME prerequisites,
and optionnaly, the path of samples directory (SAMPLES_SRC).
-The following command::
+The following command:
\code
python <KERNEL_ROOT_DIR>/bin/salome/appli_gen.py --prefix=<install directory> --config=<configuration file>
\endcode
-creates a virtual installation of %SALOME in the application directory ${APPLI}
-(bin, lib, doc, share...), with, for each file (executable, script, data,
-library, resources...), symbolic links to the actual file.
-<b>Note: it is recommended to set the environment for %SALOME prerequisites
-before invoking the above command, in order to use the same python as SALOME,
-otherwise installation may be wrong</b>
+creates a %SALOME application in the application directory given by the prefix option (local directory
+by default) with the configuration file given by the config option (config_appli.xml by default).
Providing an existing script for %SALOME prerequisites (the same one
used for modules compilation, or given with the modules installation), the
installation works without further modification for a single computer (unless
some modules needs a special environment not defined in the above script).
+
For a distributed application (several computers), one must copy and adapt
CatalogResources.xml from ${KERNEL_ROOT_DIR}/bin/salome/appliskel (see below).
- </li>
-</ol>
\section S3_sal_appl General rules
-Directory ${APPLI} must be created on each computer of the application.
+The application directory must be created on each computer of the application.
The easiest way is to use the same relative path (to ${HOME}) on each computer.
(Sometimes it is not possible to use the same path everywhere, for instance
when ${HOME} is shared with NFS, so it is possible to define different path
following the computers).
-The ${APPLI} directory contains scripts for environment and runs. Environment
+The application directory contains scripts for environment and runs. Environment
scripts must be configured (by the user) on each computer. All the environment
-scripts are in the ${APPLI}/env.d directory.
+scripts are in the env.d subdirectory.
-The script ${APPLI}/envd sources **all** the files (\*.sh) in ${APPLI}/env.d
-in alphanumeric order (after edition, think to remove backup files). the envd
+The script envd sources \b all the files (*.sh) in subdirectory env.d
+in alphanumeric order (after edition, think to remove backup files). The envd
script is used by run scripts.
<ol>
<li>
<b>env.d scripts</b>
-With the first way of installation, each user **must define** his own
-configuration for these scripts, following the above rules.
-<b>With the virtual installation (second way, above), env.d
-scripts are built automatically.</b>
-
- **The following is only an example proposed by createAppli.sh, (first way of installation) not working as it is**.
-
-- atFirst.sh
- Sets the computer configuration not directly related to %SALOME,
- like useful tools, default PATH.
-
-- envProducts.sh
- Sets the %SALOME prerequisites.
-
-- envSALOME.sh
- Sets all the MODULE_ROOT_DIR that can be used in the %SALOME application.
+<b>env.d scripts are built automatically.</b>
- SALOMEAppConfig is also defined by:
+You can add your own environment scripts in env.d subdirectory, they will be sourced as
+the generated ones provided they have a .sh extension.
-\code
-export SALOMEAppConfig=${HOME}/${APPLI}
-\endcode
-
- where SALOMEAppConfig designates the directory containing SALOMEApp.xml.
- Note that ${APPLI} is already defined by the calling scripts when
- env.d/envSALOME.sh is sourced.
</li>
<li>
<b>User run scripts</b>
The %SALOME user can use 4 scripts:
-- runAppli
+- runAppli\n
Launches a %SALOME Session
(similar to ${KERNEL_ROOT_DIR}/bin/salome/runSalome but with a different
name to avoid confusions). See parameters below.
-- runSession
+- runSession\n
Launches a shell script in the %SALOME application environment, with access
to the current (last launched) %SALOME session (naming service), if any.
Without arguments, the script is interactive. With arguments, the script
executes the command in the %SALOME application environment.
-- runConsole
+- runConsole\n
Gives a python console connected to the current %SALOME Session.
It is also possible to use runSession, then python.
-- runTests
+- runTests\n
Similar to runSession, used for unit testing, but runSession tries to use an
already existing naming service definition from a running session (hostname
and port number), and runTests defines a new configuration for naming service
<li>
<b>%SALOME internal run scripts</b>
-- envd
+- envd\n
Sets %SALOME application environment, envd is sourced by other scripts.
For remote calls, %SALOME uses one script.
-- runRemote.sh
+- runRemote.sh\n
This script is mainly used to launch containers. The first 3 arguments
define the hostname and port userd for naming service, plus a working directory, the remaining
arguments define the command to execute.
<li>
<b>Other configuration files</b>
-- SALOMEApp.xml
+- SALOMEApp.xml\n
This file is similar to the default given
in ${GUI_ROOT_DIR}/share/SALOME/resources/gui
-- CatalogRessources.xml
- This files describes all the computers the application can use. The given
- example is minimal and suppose ${APPLI} is the same relative path
+- CatalogRessources.xml\n
+ This file describes all the computers the application can use. The given
+ example is minimal and suppose application directory is the same relative path
to ${HOME}, on all the computers. %A different directory can be set on a
particular computer with a line:
-
-\code
+ \code
appliPath="my/specific/path/on/this/computer"
-\endcode
+ \endcode
</li>
</ol>
<li>
<b>Launch a %SALOME session with a GUI interface</b>
-Launch is done with a command like::
+Launch is done with a command like:
\code
./runAppli --logger
The --logger option means here : collect all the traces from the all the
distributed process, via CORBA, in a single file : logger.log.
-There are a lot of options, a complete list is given by::
+There are a lot of options, a complete list is given by:
\code
./runAppli --help
<b>Close a %SALOME session, kill all the servers</b>
Inside the interactive python interpreter you get when you use runAppli
-with arguments, you can kill all the servers of your session with::
+with arguments, you can kill all the servers of your session with:
\code
>>> killLocalPort()
\endcode
-or the servers of all the sessions with::
+or the servers of all the sessions with:
\code
>>> killAllPorts()
\endcode
If you have no active Python interpreter connected to your session, you can
-kill all the %SALOME servers of **all the sessions** on a given computer::
+kill all the %SALOME servers of <b>all the sessions</b> on a given computer:
\code
./runSession killSalome.py
When you use only one session at a time, you don't need more.
To kill a given session (when several session are running), one needs
-the naming service port number::
+the naming service port number:
\code
./runSession killSalomeWithPort 2810
in the prompt, within a runSession shell (see below).
It is also possible to get the Naming Service host and port number of
-the last launched session with::
+the last launched session with:
\code
./runSession NSparam.py
raw_input("Press a key and the servers will be killed ...")
\endcode
-This script is run in a non interactive way with::
+This script is run in a non interactive way with:
\code
./runSession python test_session_geom.py
It's often easier to develop and try Python scripts outside the GUI embedded
Python interpreter. Imagine, for instance, you are writing a script involving
geometry and mesh modules.
-first, launch a %SALOME session with gui, then, on another terminal::
+first, launch a %SALOME session with gui, then, on another terminal:
\code
./runSession
python
\endcode
-Import %SALOME module. salome_init() without arguments creates a new study
-in the running session (note: SALOME_init(n) attachs to a running session whose
-studyId is n)::
+Import salome module. salome_init() without arguments creates a new study
+in the running session (note: salome_init(n) attachs to a running session whose
+studyId is n):
\code
import salome
salome.salome_init()
\endcode
-An example of script given with SMESH::
+An example of script given with SMESH:
\code
import ex01_cube2build
script with the file/connect menu, then browse study and display objects.
Further modifications on study can be done either with GUI or external script
(use refresh popup in GUI %object browser to see study modifications generated
-by the external script). **AVOID modifications with GUI when a Python script
-is running**. Not all the modules are protected against concurrent actions...
+by the external script). <b>AVOID modifications with GUI when a Python script
+is running</b>. Not all the modules are protected against concurrent actions...
</li>
<li>
<b>Different uses of the runSession shell interpreter</b>
of the session: hostname and port)
On Linux, the shell prompt (bash) gives information on naming service
-references, hostname and port::
+references, hostname and port:
\code
[NS=cli76cc:2811]prascle@cli76cc:~/SALOME2/Run/Virtual$
\endcode
-If there is no running session, prompt looks like::
+If there is no running session, prompt looks like:
\code
[NS=:]prascle@cli76cc:~/SALOME2/Run/Virtual$
runSession is useful to launch any script or program which needs the complete
%SALOME environment, with or without a session already running.
For instance, to launch the ddd debugger interface on the gui %server, first
-launch a %SALOME session with gui, then, on another terminal::
+launch a %SALOME session with gui, then, on another terminal:
\code
./runSession ddd
\section S1_Salome_file Principles
Salome_file is a CORBA %object. It's role is to managed many system files. When a Salome_file
-is created, no files are managed. Then, files are added using Salome_file interface. %A file is represented
+is created, no files are managed. Then, files are added using Salome_file_i interface. %A file is represented
by a <b>name</b> and a <b>path</b>.
There is two different cases when a file is added :
};
\endcode
-\section S3_Salome_file Using Salome_file into %SALOME services
-
-Currently you can't use Salome_file into YACS schema. In the next version of %SALOME,
-files ports will be available to connect output files to input files.
-
*/
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Logger</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void putMessage ( in string message )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>putMessage ( message )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ping ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ping ( )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Study</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>PersistentReference GetPersistentReference ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetPersistentReference ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SalomeReference GetTransientReference ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetTransientReference ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsEmpty ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsEmpty ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SComponent FindComponent ( in string aComponentName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindComponent ( aComponentName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SComponent FindComponentID ( in ID aComponentID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindComponentID ( aComponentID )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject FindObject ( in string anObjectName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindObject ( anObjectName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject FindObjectID ( in ID aObjectID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindObjectID ( aObjectID )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject CreateObjectID ( in ID aObjectID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CreateObjectID ( aObjectID )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject FindObjectIOR ( in ID aObjectIOR )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindObjectIOR ( aObjectIOR )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfSObject FindObjectByName ( in string anObjectName, in string aComponentName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindObjectByName ( anObjectName, aComponentName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject FindObjectByPath ( in string thePath )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindObjectByPath ( thePath )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetObjectPath ( in Object theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetObjectPath ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetContext ( in string thePath )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetContext ( thePath )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetContext ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetContext ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfStrings GetObjectNames ( in string theContext )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetObjectNames ( theContext )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfStrings GetDirectoryNames ( in string theContext )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetDirectoryNames ( theContext )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfStrings GetFileNames ( in string theContext )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetFileNames ( theContext )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfStrings GetComponentNames ( in string theContext )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComponentNames ( theContext )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ChildIterator NewChildIterator ( in SObject aSO )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = NewChildIterator ( aSO )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SComponentIterator NewComponentIterator ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = NewComponentIterator ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StudyBuilder NewBuilder ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = NewBuilder ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void UpdateIORLabelMap ( in string anIOR, in string anEntry )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>UpdateIORLabelMap ( anIOR, anEntry )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>AttributeStudyProperties GetProperties ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetProperties ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsModified ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsModified ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfSObject FindDependances ( in SObject anObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindDependances ( anObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetLastModificationDate ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetLastModificationDate ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfDates GetModificationsDate ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetModificationsDate ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string ConvertObjectToIOR ( in Object theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = ConvertObjectToIOR ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Object ConvertIORToObject ( in string theIOR )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = ConvertIORToObject ( theIOR )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>UseCaseBuilder GetUseCaseBuilder ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetUseCaseBuilder ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Close ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Close ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void EnableUseCaseAutoFilling ( in boolean isEnabled )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>EnableUseCaseAutoFilling ( isEnabled )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddPostponed ( in string theIOR )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddPostponed ( theIOR )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddCreatedPostponed ( in string theIOR )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddCreatedPostponed ( theIOR )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void RemovePostponed ( in long theUndoLimit )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>RemovePostponed ( theUndoLimit )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void UndoPostponed ( in long theWay )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>UndoPostponed ( theWay )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface StudyBuilder</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SComponent NewComponent ( in string ComponentDataType )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = NewComponent ( ComponentDataType )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void DefineComponentInstance ( in SComponent aComponent, in Object ComponentIOR )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>DefineComponentInstance ( aComponent, ComponentIOR )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void RemoveComponent ( in SComponent aComponent )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>RemoveComponent ( aComponent )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject NewObject ( in SObject theFatherObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = NewObject ( theFatherObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject NewObjectToTag ( in SObject theFatherObject, in long atag )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = NewObjectToTag ( theFatherObject, atag )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void RemoveObject ( in SObject anObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>RemoveObject ( anObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void RemoveObjectWithChildren ( in SObject anObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>RemoveObjectWithChildren ( anObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void LoadWith ( in SComponent sco, in Driver Engine )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>LoadWith ( sco, Engine )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Load ( in SObject sco )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Load ( sco )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>GenericAttribute FindOrCreateAttribute ( in SObject anObject, in string aTypeOfAttribute )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = FindOrCreateAttribute ( anObject, aTypeOfAttribute )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean FindAttribute ( in SObject anObject, out GenericAttribute anAttribute, in string aTypeOfAttribute )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>[ return_value, anAttribute ] = FindAttribute ( anObject, aTypeOfAttribute )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void RemoveAttribute ( in SObject anObject, in string aTypeOfAttribute )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>RemoveAttribute ( anObject, aTypeOfAttribute )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Addreference ( in SObject anObject, in SObject theReferencedObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Addreference ( anObject, theReferencedObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void RemoveReference ( in SObject anObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>RemoveReference ( anObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddDirectory ( in string theName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddDirectory ( theName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetGUID ( in SObject anObject, in string theGUID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetGUID ( anObject, theGUID )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsGUID ( in SObject anObject, in string theGUID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsGUID ( anObject, theGUID )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void NewCommand ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>NewCommand ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void CommitCommand ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>CommitCommand ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasOpenCommand ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasOpenCommand ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AbortCommand ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AbortCommand ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Undo ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Undo ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Redo ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Redo ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean GetAvailableUndos ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetAvailableUndos ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean GetAvailableRedos ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetAvailableRedos ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Callback SetOnAddSObject ( in Callback theCallback )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SetOnAddSObject ( theCallback )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Callback SetOnRemoveSObject ( in Callback theCallback )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SetOnRemoveSObject ( theCallback )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetName ( in SObject theSO, in string theValue )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetName ( theSO, theValue )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetComment ( in SObject theSO, in string theValue )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetComment ( theSO, theValue )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetIOR ( in SObject theSO, in string theValue )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetIOR ( theSO, theValue )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface StudyManager</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ping ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ping ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Study NewStudy ( in string study_name )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = NewStudy ( study_name )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Study Open ( in URL aStudyUrl )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Open ( aStudyUrl )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Close ( in Study aStudy )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Close ( aStudy )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Save ( in Study aStudy, in boolean theMultiFile )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Save ( aStudy, theMultiFile )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SaveASCII ( in Study aStudy, in boolean theMultiFile )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SaveASCII ( aStudy, theMultiFile )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SaveAs ( in URL aUrl, in Study aStudy, in boolean theMultiFile )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SaveAs ( aUrl, aStudy, theMultiFile )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SaveAsASCII ( in URL aUrl, in Study aStudy, in boolean theMultiFile )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SaveAsASCII ( aUrl, aStudy, theMultiFile )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfOpenStudies GetOpenStudies ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetOpenStudies ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Study GetStudyByName ( in string aStudyName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetStudyByName ( aStudyName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Study GetStudyByID ( in short aStudyID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetStudyByID ( aStudyID )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean CanCopy ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CanCopy ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Copy ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Copy ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean CanPaste ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CanPaste ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject Paste ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Paste ( theObject )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface SObject</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ID GetID ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetID ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SComponent GetFatherComponent ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetFatherComponent ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject GetFather ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetFather ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>short Tag ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Tag ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>short Depth ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Depth ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean FindSubObject ( in long atag, out SObject obj )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>[ return_value, obj ] = FindSubObject ( atag )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean FindAttribute ( out GenericAttribute anAttribute, in string aTypeOfAttribute )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>[ return_value, anAttribute ] = FindAttribute ( aTypeOfAttribute )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean ReferencedObject ( out SObject obj )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>[ return_value, obj ] = ReferencedObject ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfAttributes GetAllAttributes ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetAllAttributes ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Study GetStudy ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetStudy ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Object GetObject ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetObject ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetName ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetName ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetComment ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComment ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetIOR ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetIOR ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface GenericAttribute</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void CheckLocked ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>CheckLocked ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Store ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Store ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Restore ( in string theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Restore ( theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Type ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Type ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject GetSObject ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetSObject ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface SComponent</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string ComponentDataType ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = ComponentDataType ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean ComponentIOR ( out ID theID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>[ return_value, theID ] = ComponentIOR ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface SComponentIterator</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Init ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Init ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean More ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = More ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Next ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Next ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SComponent Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface ChildIterator</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Init ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Init ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void InitEx ( in boolean allLevels )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>InitEx ( allLevels )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean More ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = More ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Next ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Next ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface UseCaseIterator</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Init ( in boolean allLevels )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Init ( allLevels )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean More ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = More ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Next ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Next ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface UseCaseBuilder</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Append ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Append ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Remove ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Remove ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean AppendTo ( in SObject theFather, in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = AppendTo ( theFather, theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean InsertBefore ( in SObject theFirst, in SObject theNext )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = InsertBefore ( theFirst, theNext )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean SetCurrentObject ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SetCurrentObject ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean SetRootCurrent ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SetRootCurrent ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasChildren ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasChildren ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean SetName ( in string theName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SetName ( theName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetName ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetName ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsUseCase ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsUseCase ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject GetCurrentObject ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetCurrentObject ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject AddUseCase ( in string theName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = AddUseCase ( theName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>UseCaseIterator GetUseCaseIterator ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetUseCaseIterator ( theObject )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Callback</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void OnAddSObject ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>OnAddSObject ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void OnRemoveSObject ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>OnRemoveSObject ( theObject )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Driver</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>TMPFile Save ( in SComponent theComponent, in string theURL, in boolean isMultiFile )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Save ( theComponent, theURL, isMultiFile )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>TMPFile SaveASCII ( in SComponent theComponent, in string theURL, in boolean isMultiFile )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SaveASCII ( theComponent, theURL, isMultiFile )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Load ( in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Load ( theComponent, theStream, theURL, isMultiFile )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean LoadASCII ( in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = LoadASCII ( theComponent, theStream, theURL, isMultiFile )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Close ( in SComponent aSComponent )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Close ( aSComponent )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string ComponentDataType ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = ComponentDataType ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string IORToLocalPersistentID ( in SObject theSObject, in string IORString, in boolean isMultiFile, in boolean isASCII )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IORToLocalPersistentID ( theSObject, IORString, isMultiFile, isASCII )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string LocalPersistentIDToIOR ( in SObject theSObject, in string aLocalPersistentID, in boolean isMultiFile, in boolean isASCII )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = LocalPersistentIDToIOR ( theSObject, aLocalPersistentID, isMultiFile, isASCII )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean CanPublishInStudy ( in Object theIOR )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CanPublishInStudy ( theIOR )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject PublishInStudy ( in Study theStudy, in SObject theSObject, in Object theObject, in string theName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = PublishInStudy ( theStudy, theSObject, theObject, theName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean CanCopy ( in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CanCopy ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>TMPFile CopyFrom ( in SObject theObject, out long theObjectID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>[ return_value, theObjectID ] = CopyFrom ( theObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean CanPaste ( in string theComponentName, in long theObjectID )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CanPaste ( theComponentName, theObjectID )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>SObject PasteInto ( in TMPFile theStream, in long theObjectID, in SObject theObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = PasteInto ( theStream, theObjectID, theObject )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeReal</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>double Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in double value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeInteger</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in long value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeSequenceOfReal</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Assign ( in DoubleSeq other )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Assign ( other )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>DoubleSeq CorbaSequence ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CorbaSequence ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Add ( in double value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Add ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Remove ( in long index )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Remove ( index )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ChangeValue ( in long index, in double value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ChangeValue ( index, value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>double Value ( in short index )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( index )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long Length ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Length ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeSequenceOfInteger</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Assign ( in LongSeq other )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Assign ( other )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>LongSeq CorbaSequence ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CorbaSequence ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Add ( in long value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Add ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Remove ( in long index )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Remove ( index )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ChangeValue ( in long index, in long value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ChangeValue ( index, value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long Value ( in short index )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( index )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long Length ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Length ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeName</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeComment</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeIOR</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributePersistentRef</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeExternalFileDef</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeFileType</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeDrawable</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsDrawable ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsDrawable ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetDrawable ( in boolean value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetDrawable ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeSelectable</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsSelectable ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsSelectable ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetSelectable ( in boolean value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetSelectable ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeExpandable</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsExpandable ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsExpandable ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetExpandable ( in boolean value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetExpandable ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeOpened</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsOpened ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsOpened ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetOpened ( in boolean value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetOpened ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeTextColor</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Color TextColor ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = TextColor ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetTextColor ( in Color value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetTextColor ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeTextHighlightColor</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Color TextHighlightColor ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = TextHighlightColor ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetTextHighlightColor ( in Color value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetTextHighlightColor ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributePixMap</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasPixMap ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasPixMap ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetPixMap ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetPixMap ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetPixMap ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetPixMap ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeTreeNode</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetFather ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetFather ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasFather ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasFather ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>AttributeTreeNode GetFather ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetFather ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetPrevious ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetPrevious ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasPrevious ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasPrevious ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>AttributeTreeNode GetPrevious ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetPrevious ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetNext ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetNext ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasNext ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasNext ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>AttributeTreeNode GetNext ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetNext ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetFirst ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetFirst ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasFirst ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasFirst ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>AttributeTreeNode GetFirst ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetFirst ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetTreeID ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetTreeID ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetTreeID ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetTreeID ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Append ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Append ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Prepend ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Prepend ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void InsertBefore ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>InsertBefore ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void InsertAfter ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>InsertAfter ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Remove ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Remove ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long Depth ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Depth ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsRoot ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsRoot ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsDescendant ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsDescendant ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsFather ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsFather ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsChild ( in AttributeTreeNode value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsChild ( value )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Label ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Label ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeLocalID</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in long value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeUserID</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Value ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Value ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetValue ( in string value )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetValue ( value )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeTarget</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Add ( in SObject anObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Add ( anObject )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfSObject Get ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Get ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Remove ( in SObject anObject )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Remove ( anObject )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeTableOfInteger</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetTitle ( in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetTitle ( theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetTitle ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetTitle ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowTitle ( in long theIndex, in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowTitle ( theIndex, theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowTitles ( in StringSeq theTitles )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowTitles ( theTitles )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetRowTitles ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowTitles ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumnTitle ( in long theIndex, in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumnTitle ( theIndex, theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumnTitles ( in StringSeq theTitles )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumnTitles ( theTitles )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetColumnTitles ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetColumnTitles ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowUnit ( in long theIndex, in string theUnit )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowUnit ( theIndex, theUnit )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowUnits ( in StringSeq theUnits )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowUnits ( theUnits )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetRowUnits ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowUnits ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetNbRows ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetNbRows ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetNbColumns ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetNbColumns ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddRow ( in LongSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddRow ( theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRow ( in long theRow, in LongSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRow ( theRow, theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>LongSeq GetRow ( in long theRow )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRow ( theRow )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddColumn ( in LongSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddColumn ( theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumn ( in long theColumn, in LongSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumn ( theColumn, theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>LongSeq GetColumn ( in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetColumn ( theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void PutValue ( in long theValue, in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>PutValue ( theValue, theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasValue ( in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasValue ( theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetValue ( in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetValue ( theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetNbColumns ( in long theNbColumns )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetNbColumns ( theNbColumns )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>LongSeq GetRowSetIndices ( in long theRow )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowSetIndices ( theRow )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean ReadFromFile ( in TMPFile theStream )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = ReadFromFile ( theStream )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>TMPFile SaveToFile ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SaveToFile ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeTableOfReal</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetTitle ( in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetTitle ( theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetTitle ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetTitle ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowTitle ( in long theIndex, in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowTitle ( theIndex, theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowTitles ( in StringSeq theTitles )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowTitles ( theTitles )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetRowTitles ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowTitles ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumnTitle ( in long theIndex, in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumnTitle ( theIndex, theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumnTitles ( in StringSeq theTitles )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumnTitles ( theTitles )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetColumnTitles ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetColumnTitles ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowUnit ( in long theIndex, in string theUnit )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowUnit ( theIndex, theUnit )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowUnits ( in StringSeq theUnits )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowUnits ( theUnits )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetRowUnits ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowUnits ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetNbRows ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetNbRows ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetNbColumns ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetNbColumns ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddRow ( in DoubleSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddRow ( theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRow ( in long theRow, in DoubleSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRow ( theRow, theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>DoubleSeq GetRow ( in long theRow )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRow ( theRow )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddColumn ( in DoubleSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddColumn ( theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumn ( in long theColumn, in DoubleSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumn ( theColumn, theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>DoubleSeq GetColumn ( in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetColumn ( theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void PutValue ( in double theValue, in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>PutValue ( theValue, theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasValue ( in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasValue ( theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>double GetValue ( in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetValue ( theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetNbColumns ( in long theNbColumns )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetNbColumns ( theNbColumns )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>LongSeq GetRowSetIndices ( in long theRow )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowSetIndices ( theRow )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean ReadFromFile ( in TMPFile theStream )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = ReadFromFile ( theStream )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>TMPFile SaveToFile ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SaveToFile ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeTableOfString</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetTitle ( in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetTitle ( theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetTitle ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetTitle ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowTitle ( in long theIndex, in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowTitle ( theIndex, theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowTitles ( in StringSeq theTitles )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowTitles ( theTitles )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetRowTitles ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowTitles ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumnTitle ( in long theIndex, in string theTitle )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumnTitle ( theIndex, theTitle )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumnTitles ( in StringSeq theTitles )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumnTitles ( theTitles )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetColumnTitles ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetColumnTitles ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowUnit ( in long theIndex, in string theUnit )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowUnit ( theIndex, theUnit )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRowUnits ( in StringSeq theUnits )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRowUnits ( theUnits )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetRowUnits ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowUnits ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetNbRows ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetNbRows ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetNbColumns ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetNbColumns ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddRow ( in StringSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddRow ( theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetRow ( in long theRow, in StringSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetRow ( theRow, theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetRow ( in long theRow )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRow ( theRow )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void AddColumn ( in StringSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>AddColumn ( theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetColumn ( in long theColumn, in StringSeq theData )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetColumn ( theColumn, theData )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StringSeq GetColumn ( in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetColumn ( theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void PutValue ( in string theValue, in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>PutValue ( theValue, theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean HasValue ( in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = HasValue ( theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetValue ( in long theRow, in long theColumn )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetValue ( theRow, theColumn )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetNbColumns ( in long theNbColumns )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetNbColumns ( theNbColumns )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>LongSeq GetRowSetIndices ( in long theRow )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetRowSetIndices ( theRow )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean ReadFromFile ( in TMPFile theStream )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = ReadFromFile ( theStream )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>TMPFile SaveToFile ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = SaveToFile ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributeStudyProperties</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetUserName ( in string theName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetUserName ( theName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetUserName ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetUserName ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetCreationDate ( in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetCreationDate ( theMinute, theHour, theDay, theMonth, theYear )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean GetCreationDate ( out long theMinute, out long theHour, out long theDay, out long theMonth, out long theYear )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>[ return_value, theMinute, theHour, theDay, theMonth, theYear ] = GetCreationDate ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetCreationMode ( in string theMode )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetCreationMode ( theMode )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetCreationMode ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetCreationMode ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetModified ( in long theModified )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetModified ( theModified )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsModified ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsModified ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetModified ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetModified ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetLocked ( in boolean theLocked )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetLocked ( theLocked )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsLocked ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsLocked ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetModification ( in string theName, in long theMinute, in long theHour, in long theDay, in long theMonth, in long theYear )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetModification ( theName, theMinute, theHour, theDay, theMonth, theYear )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void GetModificationsList ( out StringSeq theNames, out LongSeq theMinutes, out LongSeq theHours, out LongSeq theDays, out LongSeq theMonths, out LongSeq theYears, in boolean theWithCreator )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>[ theNames, theMinutes, theHours, theDays, theMonths, theYears ] = GetModificationsList ( theWithCreator )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface AttributePythonObject</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void SetObject ( in string theSequence, in boolean IsScript )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>SetObject ( theSequence, IsScript )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetObject ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetObject ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean IsScript ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = IsScript ( )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Container</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Container start_impl ( in string ContainerName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = start_impl ( ContainerName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Component load_impl ( in string nameToRegister, in string componentName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = load_impl ( nameToRegister, componentName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void remove_impl ( in Component component_i )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>remove_impl ( component_i )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void finalize_removal ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>finalize_removal ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ping ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ping ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Kill_impl ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Kill_impl ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string getHostName ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = getHostName ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long getPID ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = getPID ( )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Component</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ping ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ping ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void destroy ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>destroy ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Container GetContainerRef ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetContainerRef ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void setProperties ( in FieldsDict dico )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>setProperties ( dico )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>FieldsDict getProperties ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = getProperties ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Names ( in string aGraphName, in string aNodeName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Names ( aGraphName, aNodeName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Kill_impl ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Kill_impl ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Stop_impl ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Stop_impl ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Suspend_impl ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Suspend_impl ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Resume_impl ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Resume_impl ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long CpuUsed_impl ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = CpuUsed_impl ( )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface DataCatalog</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfDataTypeName GetDataTypeList ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetDataTypeList ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean isDerivedFrom ( in string type_in, in string type_out )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = isDerivedFrom ( type_in, type_out )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetDataInterfaceRead ( in string type )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetDataInterfaceRead ( type )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetDataInterfaceWrite ( in string type )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetDataInterfaceWrite ( type )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfDataTypeName GetDataTypeParents ( in string type )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetDataTypeParents ( type )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Acomponent</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfInterfaces GetInterfaceList ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetInterfaceList ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>DefinitionInterface GetInterface ( in string interfacename )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetInterface ( interfacename )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfServices GetServiceList ( in string interfacename )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetServiceList ( interfacename )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Service GetService ( in string interfacename, in string servicename )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetService ( interfacename, servicename )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Service GetDefaultService ( in string interfacename )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetDefaultService ( interfacename )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetPathPrefix ( in string machinename )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetPathPrefix ( machinename )</b></div></td>
-</tr>
-</table><br>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface ModuleCatalog</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ping ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ping ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfComputers GetComputerList ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComputerList ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string GetPathPrefix ( in string machinename )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetPathPrefix ( machinename )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfComponents GetComponentList ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComponentList ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfIAPP_Affich GetComponentIconeList ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComponentIconeList ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfComponents GetTypedComponentList ( in ComponentType component_type )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetTypedComponentList ( component_type )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Acomponent GetComponent ( in string componentname )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComponent ( componentname )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Component GetComponentInfo ( in string componentName )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComponentInfo ( componentName )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ImportXmlCatalogFile ( in string filename )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ImportXmlCatalogFile ( filename )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void shutdown ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>shutdown ( )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Components</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ping ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ping ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>unsigned long add ( in Infos lesInfos )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = add ( lesInfos )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void remove ( in unsigned long id )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>remove ( id )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>unsigned long size ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = size ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>AllInfos getall ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = getall ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>AllInfos history ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = history ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void end ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>end ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void hello ( in unsigned long id )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>hello ( id )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface RessourcesCatalog</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfComputer GetComputerList ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComputerList ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>ListOfContainerType GetContainerTypeList ( in string computer )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetContainerTypeList ( computer )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>computer_info GetComputerInfo ( in string computer )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetComputerInfo ( computer )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Session</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void GetInterface ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>GetInterface ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>Component GetVisuComponent ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetVisuComponent ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void StopSession ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>StopSession ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>StatSession GetStatSession ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetStatSession ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ping ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ping ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>long GetActiveStudyId ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = GetActiveStudyId ( )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface TestComponent</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>string Coucou ( in long L )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Coucou ( L )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Setenv ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Setenv ( )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-<table width="100%" BORDER>
-<tr bgcolor="#FFFFCC">
-<td colspan="11"><font size="+3"><b><div align="center"><i>interface Solver</i></div></b></font></td>
-</tr>
-<td width="50%" bgcolor= "lightgreen" ><font size="+2"><div align="center"><b><i>IDL file</i></b></div></font></td>
-<td width="50%" bgcolor= "lightgreen"><font size="+2"><div align="center"><b><i>Python</i></b></div></font></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>boolean Connect ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>return_value = Connect ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void Start ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>Start ( )</b></div></td>
-</tr>
-<tr>
-<td bgcolor= "lightgreen"><div align="center"><b>void ReStart ( )</b></div></td>
-<td bgcolor= "lightgreen"><div align="center"><b>ReStart ( )</b></div></td>
-</tr>
-</table><br>
-</b></HTML>
+++ /dev/null
-<HTML><b>
-</b></HTML>
+++ /dev/null
-# Doxyfile 1.4.6
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-PROJECT_NAME = "SALOME v.@VERSION@"
-PROJECT_NUMBER =
-OUTPUT_DIRECTORY = ../
-CREATE_SUBDIRS = NO
-OUTPUT_LANGUAGE = English
-USE_WINDOWS_ENCODING = NO
-BRIEF_MEMBER_DESC = YES
-REPEAT_BRIEF = NO
-ABBREVIATE_BRIEF =
-ALWAYS_DETAILED_SEC = YES
-INLINE_INHERITED_MEMB = YES
-FULL_PATH_NAMES = YES
-STRIP_FROM_PATH = @top_builddir@ \
- @top_srcdir@
-STRIP_FROM_INC_PATH =
-SHORT_NAMES = NO
-JAVADOC_AUTOBRIEF = YES
-MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP = NO
-INHERIT_DOCS = YES
-SEPARATE_MEMBER_PAGES = NO
-TAB_SIZE = 5
-ALIASES =
-OPTIMIZE_OUTPUT_FOR_C = YES
-OPTIMIZE_OUTPUT_JAVA = NO
-BUILTIN_STL_SUPPORT = NO
-DISTRIBUTE_GROUP_DOC = NO
-SUBGROUPING = YES
-
-#---------------------------------------------------------------------------
-# Build related configuration options
-#---------------------------------------------------------------------------
-EXTRACT_ALL = YES
-EXTRACT_PRIVATE = YES
-EXTRACT_STATIC = YES
-EXTRACT_LOCAL_CLASSES = YES
-EXTRACT_LOCAL_METHODS = YES
-HIDE_UNDOC_MEMBERS = NO
-HIDE_UNDOC_CLASSES = NO
-HIDE_FRIEND_COMPOUNDS = NO
-HIDE_IN_BODY_DOCS = NO
-INTERNAL_DOCS = YES
-CASE_SENSE_NAMES = YES
-HIDE_SCOPE_NAMES = NO
-SHOW_INCLUDE_FILES = YES
-INLINE_INFO = YES
-SORT_MEMBER_DOCS = NO
-SORT_BRIEF_DOCS = NO
-SORT_BY_SCOPE_NAME = YES
-GENERATE_TODOLIST = NO
-GENERATE_TESTLIST = NO
-GENERATE_BUGLIST = NO
-GENERATE_DEPRECATEDLIST= NO
-ENABLED_SECTIONS =
-MAX_INITIALIZER_LINES = 25
-SHOW_USED_FILES = NO
-SHOW_DIRECTORIES = NO
-FILE_VERSION_FILTER =
-
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-QUIET = NO
-WARNINGS = YES
-WARN_IF_UNDOCUMENTED = YES
-WARN_IF_DOC_ERROR = YES
-WARN_NO_PARAMDOC = NO
-WARN_FORMAT = "$file:$line: $text"
-WARN_LOGFILE = log.txt
-
-#---------------------------------------------------------------------------
-# configuration options related to the input files
-#---------------------------------------------------------------------------
-INPUT = \
- @top_srcdir@
-FILE_PATTERNS = *.idl *.?xx *.h *.hh *.i *c *.cc python_extension_must_be_here
-RECURSIVE = YES
-EXCLUDE =
-EXCLUDE_SYMLINKS = NO
-EXCLUDE_PATTERNS =
-EXAMPLE_PATH =
-EXAMPLE_PATTERNS =
-EXAMPLE_RECURSIVE = NO
-IMAGE_PATH = sources/
-INPUT_FILTER =
-FILTER_PATTERNS =
-FILTER_SOURCE_FILES = YES
-
-#---------------------------------------------------------------------------
-# configuration options related to source browsing
-#---------------------------------------------------------------------------
-SOURCE_BROWSER = NO
-INLINE_SOURCES = NO
-STRIP_CODE_COMMENTS = YES
-REFERENCED_BY_RELATION = NO
-REFERENCES_RELATION = YES
-USE_HTAGS = NO
-VERBATIM_HEADERS = YES
-
-#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
-#---------------------------------------------------------------------------
-ALPHABETICAL_INDEX = YES
-COLS_IN_ALPHA_INDEX = 3
-IGNORE_PREFIX =
-
-#---------------------------------------------------------------------------
-# configuration options related to the HTML output
-#---------------------------------------------------------------------------
-GENERATE_HTML = YES
-HTML_OUTPUT = KERNEL
-HTML_FILE_EXTENSION = .html
-HTML_HEADER = sources/myheader.html
-HTML_FOOTER = sources/footer.html
-HTML_STYLESHEET = sources/doxygen.css
-HTML_ALIGN_MEMBERS = YES
-GENERATE_HTMLHELP = NO
-CHM_FILE =
-HHC_LOCATION =
-GENERATE_CHI = NO
-BINARY_TOC = YES
-TOC_EXPAND = YES
-DISABLE_INDEX = NO
-ENUM_VALUES_PER_LINE = 4
-GENERATE_TREEVIEW = NO
-TREEVIEW_WIDTH = 250
-
-#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
-#---------------------------------------------------------------------------
-GENERATE_LATEX = NO
-LATEX_OUTPUT = latex
-LATEX_CMD_NAME = latex
-MAKEINDEX_CMD_NAME = makeindex
-COMPACT_LATEX = NO
-PAPER_TYPE = a4wide
-EXTRA_PACKAGES =
-LATEX_HEADER =
-PDF_HYPERLINKS = NO
-USE_PDFLATEX = NO
-LATEX_BATCHMODE = NO
-LATEX_HIDE_INDICES = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to the RTF output
-#---------------------------------------------------------------------------
-GENERATE_RTF = NO
-RTF_OUTPUT = rtf
-COMPACT_RTF = NO
-RTF_HYPERLINKS = NO
-RTF_STYLESHEET_FILE =
-RTF_EXTENSIONS_FILE =
-
-#---------------------------------------------------------------------------
-# configuration options related to the man page output
-#---------------------------------------------------------------------------
-GENERATE_MAN = NO
-MAN_OUTPUT = man
-MAN_EXTENSION = .3
-MAN_LINKS = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to the XML output
-#---------------------------------------------------------------------------
-GENERATE_XML = NO
-XML_OUTPUT = xml
-XML_SCHEMA =
-XML_DTD =
-XML_PROGRAMLISTING = YES
-
-#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
-#---------------------------------------------------------------------------
-GENERATE_AUTOGEN_DEF = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
-#---------------------------------------------------------------------------
-GENERATE_PERLMOD = NO
-PERLMOD_LATEX = NO
-PERLMOD_PRETTY = YES
-PERLMOD_MAKEVAR_PREFIX =
-
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
-#---------------------------------------------------------------------------
-ENABLE_PREPROCESSING = YES
-MACRO_EXPANSION = YES
-EXPAND_ONLY_PREDEF = NO
-SEARCH_INCLUDES = YES
-INCLUDE_PATH =
-INCLUDE_FILE_PATTERNS =
-PREDEFINED =
-EXPAND_AS_DEFINED =
-SKIP_FUNCTION_MACROS = NO
-
-#---------------------------------------------------------------------------
-# Configuration::additions related to external references
-#---------------------------------------------------------------------------
-TAGFILES =
-GENERATE_TAGFILE =
-ALLEXTERNALS = NO
-EXTERNAL_GROUPS = YES
-PERL_PATH = /usr/bin/perl
-
-#---------------------------------------------------------------------------
-# Configuration options related to the dot tool
-#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = YES
-HIDE_UNDOC_RELATIONS = NO
-HAVE_DOT = YES
-CLASS_GRAPH = YES
-COLLABORATION_GRAPH = YES
-GROUP_GRAPHS = NO
-UML_LOOK = YES
-TEMPLATE_RELATIONS = YES
-INCLUDE_GRAPH = YES
-INCLUDED_BY_GRAPH = NO
-CALL_GRAPH = NO
-GRAPHICAL_HIERARCHY = YES
-DIRECTORY_GRAPH = YES
-DOT_IMAGE_FORMAT = jpg
-DOT_PATH =
-DOTFILE_DIRS =
-MAX_DOT_GRAPH_WIDTH = 1024
-MAX_DOT_GRAPH_HEIGHT = 1200
-MAX_DOT_GRAPH_DEPTH = 0
-DOT_TRANSPARENT = NO
-DOT_MULTI_TARGETS = NO
-GENERATE_LEGEND = NO
-DOT_CLEANUP = YES
-
-#---------------------------------------------------------------------------
-# Configuration::additions related to the search engine
-#---------------------------------------------------------------------------
-SEARCHENGINE = NO
+++ /dev/null
-# Doxyfile 1.3-rc1
-
-#---------------------------------------------------------------------------
-# General configuration options
-#---------------------------------------------------------------------------
-PROJECT_NAME = "SALOME v.@VERSION@"
-PROJECT_NUMBER = id#1.1
-OUTPUT_DIRECTORY = ../
-OUTPUT_LANGUAGE = English
-EXTRACT_ALL = YES
-EXTRACT_PRIVATE = YES
-EXTRACT_STATIC = YES
-EXTRACT_LOCAL_CLASSES = YES
-HIDE_UNDOC_MEMBERS = NO
-HIDE_UNDOC_CLASSES = NO
-HIDE_FRIEND_COMPOUNDS = NO
-HIDE_IN_BODY_DOCS = NO
-BRIEF_MEMBER_DESC = YES
-REPEAT_BRIEF = NO
-ALWAYS_DETAILED_SEC = YES
-INLINE_INHERITED_MEMB = YES
-FULL_PATH_NAMES = NO
-STRIP_FROM_PATH =
-INTERNAL_DOCS = YES
-CASE_SENSE_NAMES = YES
-SHORT_NAMES = NO
-HIDE_SCOPE_NAMES = NO
-VERBATIM_HEADERS = YES
-SHOW_INCLUDE_FILES = YES
-JAVADOC_AUTOBRIEF = YES
-MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP = NO
-INHERIT_DOCS = YES
-INLINE_INFO = YES
-SORT_MEMBER_DOCS = NO
-DISTRIBUTE_GROUP_DOC = NO
-TAB_SIZE = 5
-GENERATE_TODOLIST = YES
-GENERATE_TESTLIST = YES
-GENERATE_BUGLIST = YES
-GENERATE_DEPRECATEDLIST= YES
-ALIASES =
-ENABLED_SECTIONS =
-MAX_INITIALIZER_LINES = 25
-OPTIMIZE_OUTPUT_FOR_C = YES
-OPTIMIZE_OUTPUT_JAVA = YES
-SHOW_USED_FILES = NO
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-QUIET = NO
-WARNINGS = YES
-WARN_IF_UNDOCUMENTED = YES
-WARN_FORMAT = "$file:$line: $text"
-WARN_LOGFILE = log.txt
-#---------------------------------------------------------------------------
-# configuration options related to the input files
-#---------------------------------------------------------------------------
-INPUT = ../../../../share/salome/idl/SALOME_ModuleCatalog.idl \
- ../../../../share/salome/idl/SALOMEDS.idl \
- ../../../../share/salome/idl/SALOME_Exception.idl \
- ../../../../share/salome/idl/SALOMEDS_Attributes.idl \
- ../../../../share/salome/idl/SALOME_Component.idl \
- ../../../../share/salome/src/LifeCycleCORBA/SALOME_LifeCycleCORBA.hxx \
- ../../../../share/salome/src/NamingService/SALOME_NamingService.hxx \
- ../../../../share/salome/src/NamingService/SALOME_NamingService.cxx \
- ../../../../share/salome/src/LifeCycleCORBA/SALOME_LifeCycleCORBA.cxx \
- ../../../../build/salome/bin/salome \
- ../../../../build/salome/src/Batch_SWIG \
- ../../../../build/salome/src/Communication_SWIG \
- ../../../../build/salome/src/LifeCycleCORBA_SWIG \
- ../../../../build/salome/src/LifeCycleCORBA_SWIG \
- ../../../../build/salome/src/NOTIFICATION_SWIG
-FILE_PATTERNS = *.idl *.hxx *.cxx python_extension_must_be_here
-RECURSIVE = YES
-EXCLUDE =
-EXCLUDE_SYMLINKS = NO
-EXCLUDE_PATTERNS =
-EXAMPLE_PATH =
-EXAMPLE_PATTERNS =
-EXAMPLE_RECURSIVE = NO
-IMAGE_PATH = sources/
-INPUT_FILTER =
-FILTER_SOURCE_FILES = YES
-#---------------------------------------------------------------------------
-# configuration options related to source browsing
-#---------------------------------------------------------------------------
-SOURCE_BROWSER = NO
-INLINE_SOURCES = NO
-STRIP_CODE_COMMENTS = YES
-REFERENCED_BY_RELATION = NO
-REFERENCES_RELATION = YES
-#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
-#---------------------------------------------------------------------------
-ALPHABETICAL_INDEX = NO
-COLS_IN_ALPHA_INDEX = 5
-IGNORE_PREFIX =
-#---------------------------------------------------------------------------
-# configuration options related to the HTML output
-#---------------------------------------------------------------------------
-GENERATE_HTML = YES
-HTML_OUTPUT = KERNEL
-HTML_FILE_EXTENSION = .html
-HTML_HEADER = sources/myheader.html
-HTML_FOOTER =
-HTML_STYLESHEET =
-HTML_ALIGN_MEMBERS = YES
-GENERATE_HTMLHELP = NO
-CHM_FILE =
-HHC_LOCATION =
-GENERATE_CHI = NO
-BINARY_TOC = YES
-TOC_EXPAND = YES
-DISABLE_INDEX = YES
-ENUM_VALUES_PER_LINE = 4
-GENERATE_TREEVIEW = YES
-TREEVIEW_WIDTH = 250
-#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
-#---------------------------------------------------------------------------
-GENERATE_LATEX = NO
-LATEX_OUTPUT = latex
-LATEX_CMD_NAME = latex
-MAKEINDEX_CMD_NAME = makeindex
-COMPACT_LATEX = NO
-PAPER_TYPE = a4wide
-EXTRA_PACKAGES =
-LATEX_HEADER =
-PDF_HYPERLINKS = NO
-USE_PDFLATEX = NO
-LATEX_BATCHMODE = NO
-#---------------------------------------------------------------------------
-# configuration options related to the RTF output
-#---------------------------------------------------------------------------
-GENERATE_RTF = NO
-RTF_OUTPUT = rtf
-COMPACT_RTF = NO
-RTF_HYPERLINKS = NO
-RTF_STYLESHEET_FILE =
-RTF_EXTENSIONS_FILE =
-#---------------------------------------------------------------------------
-# configuration options related to the man page output
-#---------------------------------------------------------------------------
-GENERATE_MAN = NO
-MAN_OUTPUT = man
-MAN_EXTENSION = .3
-MAN_LINKS = NO
-#---------------------------------------------------------------------------
-# configuration options related to the XML output
-#---------------------------------------------------------------------------
-GENERATE_XML = NO
-XML_SCHEMA =
-XML_DTD =
-#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
-#---------------------------------------------------------------------------
-GENERATE_AUTOGEN_DEF = NO
-#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
-#---------------------------------------------------------------------------
-GENERATE_PERLMOD = NO
-PERLMOD_LATEX = NO
-PERLMOD_PRETTY = YES
-PERLMOD_MAKEVAR_PREFIX =
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
-#---------------------------------------------------------------------------
-ENABLE_PREPROCESSING = YES
-MACRO_EXPANSION = YES
-EXPAND_ONLY_PREDEF = NO
-SEARCH_INCLUDES = YES
-INCLUDE_PATH =
-INCLUDE_FILE_PATTERNS =
-PREDEFINED =
-EXPAND_AS_DEFINED =
-SKIP_FUNCTION_MACROS = NO
-#---------------------------------------------------------------------------
-# Configuration::addtions related to external references
-#---------------------------------------------------------------------------
-TAGFILES =
-GENERATE_TAGFILE =
-ALLEXTERNALS = NO
-EXTERNAL_GROUPS = YES
-PERL_PATH = /usr/bin/perl
-#---------------------------------------------------------------------------
-# Configuration options related to the dot tool
-#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = YES
-HIDE_UNDOC_RELATIONS = NO
-HAVE_DOT = YES
-CLASS_GRAPH = YES
-COLLABORATION_GRAPH = NO
-TEMPLATE_RELATIONS = YES
-INCLUDE_GRAPH = YES
-INCLUDED_BY_GRAPH = NO
-GRAPHICAL_HIERARCHY = YES
-DOT_IMAGE_FORMAT = jpg
-DOT_PATH =
-DOTFILE_DIRS =
-MAX_DOT_GRAPH_WIDTH = 1024
-MAX_DOT_GRAPH_HEIGHT = 1200
-GENERATE_LEGEND = NO
-DOT_CLEANUP = YES
-#---------------------------------------------------------------------------
-# Configuration::addtions related to the search engine
-#---------------------------------------------------------------------------
-SEARCHENGINE = NO
-CGI_NAME = search.cgi
-CGI_URL =
-DOC_URL =
-DOC_ABSPATH =
-BIN_ABSPATH = /usr/local/bin/
-EXT_DOC_PATHS =
+++ /dev/null
-# Doxyfile 1.4.6
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-PROJECT_NAME = "SALOME v.@VERSION@"
-PROJECT_NUMBER =
-OUTPUT_DIRECTORY = ../
-CREATE_SUBDIRS = NO
-OUTPUT_LANGUAGE = English
-USE_WINDOWS_ENCODING = NO
-BRIEF_MEMBER_DESC = YES
-REPEAT_BRIEF = NO
-ABBREVIATE_BRIEF =
-ALWAYS_DETAILED_SEC = YES
-INLINE_INHERITED_MEMB = YES
-FULL_PATH_NAMES = YES
-STRIP_FROM_PATH = @top_builddir@ \
- @top_srcdir@
-STRIP_FROM_INC_PATH =
-SHORT_NAMES = NO
-JAVADOC_AUTOBRIEF = YES
-MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP = NO
-INHERIT_DOCS = YES
-SEPARATE_MEMBER_PAGES = NO
-TAB_SIZE = 5
-ALIASES =
-OPTIMIZE_OUTPUT_FOR_C = YES
-OPTIMIZE_OUTPUT_JAVA = NO
-BUILTIN_STL_SUPPORT = NO
-DISTRIBUTE_GROUP_DOC = NO
-SUBGROUPING = YES
-
-#---------------------------------------------------------------------------
-# Build related configuration options
-#---------------------------------------------------------------------------
-EXTRACT_ALL = YES
-EXTRACT_PRIVATE = NO
-EXTRACT_STATIC = YES
-EXTRACT_LOCAL_CLASSES = YES
-EXTRACT_LOCAL_METHODS = NO
-HIDE_UNDOC_MEMBERS = NO
-HIDE_UNDOC_CLASSES = NO
-HIDE_FRIEND_COMPOUNDS = NO
-HIDE_IN_BODY_DOCS = NO
-INTERNAL_DOCS = YES
-CASE_SENSE_NAMES = YES
-HIDE_SCOPE_NAMES = NO
-SHOW_INCLUDE_FILES = YES
-INLINE_INFO = YES
-SORT_MEMBER_DOCS = NO
-SORT_BRIEF_DOCS = NO
-SORT_BY_SCOPE_NAME = YES
-GENERATE_TODOLIST = NO
-GENERATE_TESTLIST = NO
-GENERATE_BUGLIST = NO
-GENERATE_DEPRECATEDLIST= NO
-ENABLED_SECTIONS =
-MAX_INITIALIZER_LINES = 25
-SHOW_USED_FILES = YES
-SHOW_DIRECTORIES = YES
-FILE_VERSION_FILTER =
-
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-QUIET = NO
-WARNINGS = YES
-WARN_IF_UNDOCUMENTED = YES
-WARN_IF_DOC_ERROR = YES
-WARN_NO_PARAMDOC = NO
-WARN_FORMAT = "$file:$line: $text"
-WARN_LOGFILE = log.txt
-
-#---------------------------------------------------------------------------
-# configuration options related to the input files
-#---------------------------------------------------------------------------
-INPUT = \
- @top_srcdir@/doc/salome \
- @top_srcdir@/bin \
- @top_srcdir@/idl \
- @top_srcdir@/src/Container \
- @top_srcdir@/src/LifeCycleCORBA \
- @top_srcdir@/src/NamingService \
- @top_srcdir@/src/Notification \
- @top_srcdir@/src/Utils \
- @top_srcdir@/src/DSC
-FILE_PATTERNS = *.dox *.idl *.hxx *.cxx python_extension_must_be_here
-RECURSIVE = YES
-EXCLUDE =
-EXCLUDE_SYMLINKS = NO
-EXCLUDE_PATTERNS =
-EXAMPLE_PATH =
-EXAMPLE_PATTERNS =
-EXAMPLE_RECURSIVE = NO
-IMAGE_PATH = sources/
-INPUT_FILTER =
-FILTER_PATTERNS =
-FILTER_SOURCE_FILES = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to source browsing
-#---------------------------------------------------------------------------
-SOURCE_BROWSER = YES
-INLINE_SOURCES = YES
-STRIP_CODE_COMMENTS = YES
-REFERENCED_BY_RELATION = YES
-REFERENCES_RELATION = YES
-USE_HTAGS = NO
-VERBATIM_HEADERS = YES
-
-#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
-#---------------------------------------------------------------------------
-ALPHABETICAL_INDEX = NO
-COLS_IN_ALPHA_INDEX = 3
-IGNORE_PREFIX =
-
-#---------------------------------------------------------------------------
-# configuration options related to the HTML output
-#---------------------------------------------------------------------------
-GENERATE_HTML = YES
-HTML_OUTPUT = KERNEL
-HTML_FILE_EXTENSION = .html
-HTML_HEADER = sources/myheader.html
-HTML_FOOTER = sources/footer.html
-HTML_STYLESHEET =
-HTML_ALIGN_MEMBERS = YES
-GENERATE_HTMLHELP = NO
-CHM_FILE =
-HHC_LOCATION =
-GENERATE_CHI = NO
-BINARY_TOC = YES
-TOC_EXPAND = YES
-DISABLE_INDEX = NO
-ENUM_VALUES_PER_LINE = 4
-GENERATE_TREEVIEW = YES
-TREEVIEW_WIDTH = 250
-
-#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
-#---------------------------------------------------------------------------
-GENERATE_LATEX = NO
-LATEX_OUTPUT = latex
-LATEX_CMD_NAME = latex
-MAKEINDEX_CMD_NAME = makeindex
-COMPACT_LATEX = NO
-PAPER_TYPE = a4wide
-EXTRA_PACKAGES =
-LATEX_HEADER =
-PDF_HYPERLINKS = NO
-USE_PDFLATEX = NO
-LATEX_BATCHMODE = NO
-LATEX_HIDE_INDICES = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to the RTF output
-#---------------------------------------------------------------------------
-GENERATE_RTF = NO
-RTF_OUTPUT = rtf
-COMPACT_RTF = NO
-RTF_HYPERLINKS = NO
-RTF_STYLESHEET_FILE =
-RTF_EXTENSIONS_FILE =
-
-#---------------------------------------------------------------------------
-# configuration options related to the man page output
-#---------------------------------------------------------------------------
-GENERATE_MAN = NO
-MAN_OUTPUT = man
-MAN_EXTENSION = .3
-MAN_LINKS = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to the XML output
-#---------------------------------------------------------------------------
-GENERATE_XML = NO
-XML_OUTPUT = xml
-XML_SCHEMA =
-XML_DTD =
-XML_PROGRAMLISTING = YES
-
-#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
-#---------------------------------------------------------------------------
-GENERATE_AUTOGEN_DEF = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
-#---------------------------------------------------------------------------
-GENERATE_PERLMOD = NO
-PERLMOD_LATEX = NO
-PERLMOD_PRETTY = YES
-PERLMOD_MAKEVAR_PREFIX =
-
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
-#---------------------------------------------------------------------------
-ENABLE_PREPROCESSING = YES
-MACRO_EXPANSION = YES
-EXPAND_ONLY_PREDEF = NO
-SEARCH_INCLUDES = YES
-INCLUDE_PATH =
-INCLUDE_FILE_PATTERNS =
-PREDEFINED =
-EXPAND_AS_DEFINED =
-SKIP_FUNCTION_MACROS = NO
-
-#---------------------------------------------------------------------------
-# Configuration::additions related to external references
-#---------------------------------------------------------------------------
-TAGFILES =
-GENERATE_TAGFILE =
-ALLEXTERNALS = NO
-EXTERNAL_GROUPS = YES
-PERL_PATH = /usr/bin/perl
-
-#---------------------------------------------------------------------------
-# Configuration options related to the dot tool
-#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = NO
-HIDE_UNDOC_RELATIONS = NO
-HAVE_DOT = YES
-CLASS_GRAPH = YES
-COLLABORATION_GRAPH = NO
-GROUP_GRAPHS = NO
-UML_LOOK = NO
-TEMPLATE_RELATIONS = YES
-INCLUDE_GRAPH = YES
-INCLUDED_BY_GRAPH = NO
-CALL_GRAPH = NO
-GRAPHICAL_HIERARCHY = YES
-DIRECTORY_GRAPH = YES
-DOT_IMAGE_FORMAT = jpg
-DOT_PATH =
-DOTFILE_DIRS =
-MAX_DOT_GRAPH_WIDTH = 1024
-MAX_DOT_GRAPH_HEIGHT = 1200
-MAX_DOT_GRAPH_DEPTH = 0
-DOT_TRANSPARENT = NO
-DOT_MULTI_TARGETS = NO
-GENERATE_LEGEND = NO
-DOT_CLEANUP = YES
-
-#---------------------------------------------------------------------------
-# Configuration::additions related to the search engine
-#---------------------------------------------------------------------------
-SEARCHENGINE = NO
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Exemple</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeReal interface (creations/saving/restoring)%\r
-#%Methods : FindOrCreateAttribute, Value, SaveAs, SetValue, FindComponent, FindAttribute, Open%\r
-\r
-\r
-# create AttributeReal \r
-#=================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeReal")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeReal attribute"\r
-A = A._narrow(SALOMEDS.AttributeReal)\r
-A.SetValue(0.0001)\r
-if A.Value() != 0.0001:\r
- raise RuntimeError, "Error : wrong value of AttributeReal"\r
-\r
-# save / restore study \r
-#=================================\r
-\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-#file = "/tmp/ggg.hdf"\r
-\r
-print " ------- We will save to", file, "-----------"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file)\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeReal\r
-#=================================\r
-\r
-res,A=father.FindAttribute("AttributeReal")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeReal"\r
-\r
-A = A._narrow(SALOMEDS.AttributeReal)\r
-if A.Value() != 0.0001:\r
- raise RuntimeError, "Error : wrong value of AttributeReal"\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeExpandable interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : SaveAs FindComponent FindAttribute Open%\r
-#%Attribute methods : SetExpandable IsExpandable%\r
-\r
-# create AttributeExpandable\r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute( batchmode_geompy.father, "AttributeExpandable")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeExpandable attribute"\r
-A = A._narrow(SALOMEDS.AttributeExpandable)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeExpandable attribute"\r
-\r
-A.SetExpandable(1)\r
-\r
-if A.IsExpandable() == 0:\r
- "Error: wrong value of AttributeExpandable"\r
-\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeExpandable\r
-#============================================================\r
-\r
-res,A=father.FindAttribute("AttributeExpandable")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeExpandable"\r
-\r
-A = A._narrow(SALOMEDS.AttributeExpandable)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeExpandable attribute"\r
-\r
-if A.IsExpandable() == 0:\r
- "Error: wrong value of AttributeExpandable"\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%Test AttributeOpened (creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute SaveAs, FindComponent, FindAttribute, Open%\r
-#%Attribute methods : SetOpened, IsOpened%\r
-\r
-# create AttributeOpened\r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeOpened")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeOpened attribute"\r
-A = A._narrow(SALOMEDS.AttributeOpened)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeOpened attribute"\r
-\r
-A.SetOpened(1)\r
-\r
-if A.IsOpened() == 0:\r
- "Error: wrong value of AttributeOpened"\r
-\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeOpened\r
-#============================================================\r
-\r
-res,A=father.FindAttribute("AttributeOpened")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeOpened"\r
-\r
-A = A._narrow(SALOMEDS.AttributeOpened)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeOpened attribute"\r
-\r
-if A.IsOpened() == 0:\r
- "Error: wrong value of AttributeOpened"\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeTextColor interface (creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open%\r
-#%Attribute methods : SetTextColor TextColor%\r
-\r
-\r
-#--------------------------------------------------------------------------\r
-# create AttributeTextColor\r
-#===========================================================\r
-import SALOMEDS_Attributes_idl\r
-color = SALOMEDS_Attributes_idl._0_SALOMEDS.Color(234,345,231)\r
-\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeTextColor")\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeTextColor attribute"\r
-A = A._narrow(SALOMEDS.AttributeTextColor)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeTextColor attribute"\r
-\r
-A.SetTextColor(color)\r
-\r
-c = A.TextColor();\r
-\r
-if c.R != 234 or c.G != 345 or c.B != 231:\r
- print "Error: wrong value of AttributeTextColor"\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeTextColor\r
-#============================================================\r
-\r
-res,A=father.FindAttribute("AttributeTextColor")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeTextColor"\r
-\r
-A = A._narrow(SALOMEDS.AttributeTextColor)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeTextColor attribute"\r
-\r
-c = A.TextColor();\r
-if c.R != 234 or c.G != 345 or c.B != 231:\r
- print "Error: wrong value of AttributeTextColor"\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%Test AttributeTextHighlightColor interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open%\r
-#%Attribute methods : SetTextHighlightColor TextHighlightColor%\r
-\r
-#--------------------------------------------------------------------------\r
-# create AttributeTextHighlightColor\r
-#===========================================================\r
-\r
-import SALOMEDS_Attributes_idl\r
-highlightcolor=SALOMEDS_Attributes_idl._0_SALOMEDS.Color(256,256,256)\r
-\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeTextHighlightColor")\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeTextHighlightColor attribute"\r
-A = A._narrow(SALOMEDS.AttributeTextHighlightColor)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeTextHighlightColor attribute"\r
-\r
-A.SetTextHighlightColor(highlightcolor)\r
-\r
-c = A.TextHighlightColor();\r
-if c.R != 256 or c.G != 256 or c.B != 256:\r
- print "Error: wrong value of AttributeTextHighlightColor"\r
-\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeTextHighlightColor\r
-#============================================================\r
-\r
-res, A = father.FindAttribute("AttributeTextHighlightColor")\r
-print res, A\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeTextHighlightColor"\r
-\r
-A = A._narrow(SALOMEDS.AttributeTextHighlightColor)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeTextHighlightColor attribute"\r
-\r
-c = A.TextHighlightColor();\r
-\r
-if c.R != 256 or c.G != 256 or c.B != 256:\r
- print "Error: wrong value of AttributeTextTextHighlightColor"\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributePixMap interface (creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open%\r
-#%Attribute methods : SetPixMap, GetPixMap%\r
-\r
-#--------------------------------------------------------------------------\r
-\r
-#--------------------------------------------------------------------------\r
-# create AttributePixMap\r
-#===============================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributePixMap")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributePixMap attribute"\r
-aPixmap = A._narrow(SALOMEDS.AttributePixMap);\r
-aPixmap.SetPixMap( "ICON_OBJBROWSER_Geometry" );\r
-\r
-if aPixmap.GetPixMap() != "ICON_OBJBROWSER_Geometry":\r
- print "Error: wrong value of AttributePixMap"\r
-\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributePixMap\r
-#============================================================\r
-\r
-res,A=father.FindAttribute("AttributePixMap")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: AttributePixMap not found "\r
-\r
-A = A._narrow(SALOMEDS.AttributePixMap)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributePixMap attribute"\r
-\r
-if A.GetPixMap() != "ICON_OBJBROWSER_Geometry":\r
- print "Error: wrong value of AttributePixMap"\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeLocalID interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open% \r
-#%Attribute methods : Value, SetValue%\r
-\r
-# create AttributeLocalID\r
-#=================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeLocalID")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeLocalID attribute"\r
-A = A._narrow(SALOMEDS.AttributeLocalID)\r
-\r
-A.SetValue(763242882)\r
-\r
-if A.Value() != 763242882:\r
- print "Error: wrong value of AttributeLocalID"\r
-\r
-# save / restore study \r
-#=================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeLocalID\r
-#=================================\r
-\r
-res,A=father.FindAttribute("AttributeLocalID")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeLocalID"\r
-\r
-A = A._narrow(SALOMEDS.AttributeLocalID)\r
-\r
-if A.Value() != 763242882:\r
- print "Error: wrong value of AttributeLocalID"\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>Methods : GetAvailableUndos, ChangeValue, FindOrCreateAttribute, SaveAs, GetAvailableRedos, Undo, FindComponent, Redo, FindAttribute, Open, CommitCommand, NewCommand\r
-\r
-\r
-dir= os.getenv("TmpDir")\r
-if dir == None:\r
- dir = "/tmp"\r
-\r
-batchmode_geompy.myBuilder._set_UndoLimit(20)\r
-\r
-# 1st transaction -----------------------------------------\r
-batchmode_geompy.myBuilder.NewCommand()\r
-# create AttributeSequenceOfInteger \r
-#=========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSequenceOfInteger attribute"\r
-A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSequenceOfInteger attribute"\r
-\r
-A.Add(100)\r
-A.Add(300)\r
-A.Add(500)\r
-A.Add(400)\r
-A.Add(700)\r
-print "First transaction goes on : HasOpenCommand() = ", batchmode_geompy.myBuilder.HasOpenCommand()\r
-batchmode_geompy.myBuilder.CommitCommand() #--------------\r
-\r
-# 2nd transaction ------------------------------------------\r
-batchmode_geompy.myBuilder.NewCommand() \r
-A.Remove(3)\r
-A.ChangeValue(4,500)\r
-batchmode_geompy.myBuilder.CommitCommand() #--------------\r
-\r
-if batchmode_geompy.myBuilder.GetAvailableUndos() == 0:\r
- raise RuntimeError, "GetAvailableUndos() = 0 but must not !"\r
-\r
-if A.Length() != 4:\r
- print "Wrong length of SequenceOfInteger"\r
-if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 500:\r
- raise RuntimeError, "Wrong value of AttributeSequenceOfInteger"\r
-\r
-file1 = dir + "/test1.hdf"\r
-batchmode_geompy.myStudyManager.SaveAs(file1, batchmode_geompy.myStudy)\r
-\r
-# 1st Undo ---------------------------------------\r
-batchmode_geompy.myBuilder.Undo()\r
-res, A = batchmode_geompy.myBuilder.FindAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")\r
-if A is None:\r
- raise RuntimeError, "After first 'undo' can't find AttributeSequenceOfInteger"\r
-if A.Length() != 5:\r
- print "Wrong length of SequenceOfInteger"\r
-if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 500 or A.Value(4) != 400 or A.Value(5) != 700:\r
- print A.Value(1), A.Value(2), A.Value(3), A.Value(4), A.Value(5)\r
- raise RuntimeError, "Wrong value of AttributeSequenceOfInteger after the first 'undo'!"\r
-# save \r
-file2 = dir + "/test2.hdf"\r
-batchmode_geompy.myStudyManager.SaveAs(file2, batchmode_geompy.myStudy)\r
-#-------------------------------------------------\r
-# 2nd Undo ---------------------------------------\r
-batchmode_geompy.myBuilder.Undo()\r
-res, attr = batchmode_geompy.myBuilder.FindAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")\r
-if res !=0 or attr != None :\r
- raise RuntimeError, "After the second 'undo' AttributeSequenceOfInteger exists but must not!"\r
-file3 = dir + "/test3.hdf"\r
-batchmode_geompy.myStudyManager.SaveAs(file3, batchmode_geompy.myStudy)\r
-#-------------------------------------------------\r
-\r
-#make redo twice ---------------------------------\r
-if batchmode_geompy.myBuilder.GetAvailableRedos() == 0:\r
- raise RuntimeError, "GetAvailableRedos() = 0 but must not !"\r
-batchmode_geompy.myBuilder.Redo()\r
-batchmode_geompy.myBuilder.Redo()\r
-res, A = batchmode_geompy.myBuilder.FindAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")\r
-if res ==0 or A== None :\r
- raise RuntimeError, "AttributeSequenceOfInteger is not found but must be!"\r
-if A.Length() != 4:\r
- print "Wrong length of SequenceOfInteger"\r
-if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 500:\r
- raise RuntimeError, "Wrong value of AttributeSequenceOfInteger"\r
-\r
-\r
-#----------------------------------------------------------------------\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file1);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeSequenceOfInteger\r
-#======================================\r
-\r
-res,A=father.FindAttribute("AttributeSequenceOfInteger")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeSequenceOfInteger"\r
-\r
-A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)\r
-\r
-if A.Length() != 4:\r
- print "Wrong length of SequenceOfInteger"\r
-if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 500:\r
- print "Wrong value of AttributeSequenceOfInteger"\r
-#----------------------------------------------------------------------\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file2);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeSequenceOfInteger\r
-#======================================\r
-\r
-res,A=father.FindAttribute("AttributeSequenceOfInteger")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeSequenceOfInteger"\r
-\r
-A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)\r
-\r
-if A.Length() != 5:\r
- print "Wrong length of SequenceOfInteger"\r
-if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 500 or A.Value(4) != 400 or A.Value(5) != 700:\r
- raise RuntimeError, "Wrong value of AttributeSequenceOfInteger after the first 'undo'!"\r
-\r
-#----------------------------------------------------------------------\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file3);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeSequenceOfInteger\r
-#======================================\r
-\r
-res,A=father.FindAttribute("AttributeSequenceOfInteger")\r
-\r
-if res!=0 or A != None:\r
- raise RuntimeError, " AttributeSequenceOfInteger is found but must not!"\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#% Check methods : %\r
-SALOMEDS methods : RemoveAttribute, FindOrCreateAttribute, NewStudy, GetAllAttributes, NewCommand, CommitCommand, AbortCommand, NewComponent%\r
-\r
-batchmode_geompy.myBuilder._set_UndoLimit(20)\r
-\r
-batchmode_geompy.myBuilder.NewCommand() \r
-child = batchmode_geompy.myBuilder.NewObject(batchmode_geompy.father)\r
-batchmode_geompy.myBuilder.CommitCommand()\r
-\r
-batchmode_geompy.myBuilder.NewCommand() \r
-#==========================================================\r
-# create AttributeSequenceOfReal \r
-#==========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeSequenceOfReal")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSequenceOfReal attribute"\r
-A = A._narrow(SALOMEDS.AttributeSequenceOfReal)\r
-if A == None :\r
- raise RuntimeError, "_narrow returns None instead of AttributeSequenceOfReal pointer"\r
-\r
-A.Add(0.0293)\r
-A.Add(522)\r
-A.Add(98234)\r
-A.Add(83.287)\r
-batchmode_geompy.myBuilder.CommitCommand()\r
-\r
-\r
-batchmode_geompy.myBuilder.NewCommand() \r
-#==========================================================\r
-# create AttributeInteger \r
-#==========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeInteger")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeInteger attribute"\r
-A = A._narrow(SALOMEDS.AttributeInteger)\r
-A.SetValue(1000000)\r
-\r
-if A.Value() != 1000000:\r
- raise RuntimeError, "Error : wrong value of AttributeInteger"\r
-\r
-batchmode_geompy.myBuilder.CommitCommand()\r
-\r
-batchmode_geompy.myBuilder.NewCommand() #===================\r
-# create AttributeName \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A.SetValue("AttributesTesting")\r
-\r
-if A.Value() != "AttributesTesting":\r
- print "Wrong value of AttributeName" \r
-\r
-batchmode_geompy.myBuilder.CommitCommand()\r
-\r
-batchmode_geompy.myBuilder.NewCommand() #===================\r
-# create AttributeComment \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeComment")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeComment attribute"\r
-A = A._narrow(SALOMEDS.AttributeComment)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeComment attribute"\r
-\r
-A.SetValue("GEOM")\r
-\r
-batchmode_geompy.myBuilder.AbortCommand()\r
-\r
-batchmode_geompy.myBuilder.NewCommand() #===================\r
-# create AttributePersistentRef \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributePersistentRef")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributePersistentRef attribute"\r
-A = A._narrow(SALOMEDS.AttributePersistentRef)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributePersistentRef attribute"\r
-\r
-A.SetValue("/tmp/test;1")\r
-batchmode_geompy.myBuilder.CommitCommand()\r
-\r
-batchmode_geompy.myBuilder.NewCommand() #===================================\r
-# create AttributeDrawable \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeDrawable")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeDrawable attribute"\r
-A = A._narrow(SALOMEDS.AttributeDrawable)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeDrawable attribute"\r
-\r
-A.SetDrawable(1)\r
-\r
-if A.IsDrawable() == 0:\r
- "Error: wrong value of AttributeDrawable"\r
-batchmode_geompy.myBuilder.CommitCommand()\r
-\r
-\r
-\r
-batchmode_geompy.myBuilder.NewCommand() #===================\r
-# create AttributeSelectable \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child, "AttributeSelectable")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSelectable attribute"\r
-A = A._narrow(SALOMEDS.AttributeSelectable)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSelectable attribute"\r
-\r
-A.SetSelectable(1)\r
-\r
-if A.IsSelectable() == 0:\r
- "Error: wrong value of AttributeSelectable"\r
-batchmode_geompy.myBuilder.CommitCommand()\r
-\r
-\r
-batchmode_geompy.myBuilder.NewCommand() #===================\r
-#===========================================================\r
-batchmode_geompy.myBuilder.RemoveAttribute(child,"AttributeSelectable")\r
-batchmode_geompy.myBuilder.CommitCommand()\r
-\r
-# Control the attributes \r
-#===========================================================\r
-\r
-res, A = batchmode_geompy.myBuilder.FindAttribute(child, "AttributeComment")\r
-print "res = ", res\r
-if A != None :\r
- print " AttributeComment was found"\r
-else:\r
- print " AttributeComment is not found. It's correct"\r
-\r
-attributes=[]\r
- \r
-attributes = child.GetAllAttributes()\r
-\r
-length = len(attributes)\r
-\r
-print "Attributes number = ", length\r
-print attributes\r
-for i in range(0, length) :\r
- attr = attributes[i]\r
- if attr is None :\r
- print i,"None item of object attributes list"\r
-\r
-if length != 5 :\r
- raise RuntimeError, "Wrong number of attributes"\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeTreeNode interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, NewObject%\r
-#%Attribute methods : HasFirst, HasFather, SetPrevious, Next, InsertAfter, GetFather, HasNext, SetValue, Append, NewStudy, Label, IsRoot, Prepend, SetFather, Depth, HasPrevious%\r
-\r
-child1 = batchmode_geompy.myBuilder.NewObject(batchmode_geompy.father)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child1,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N1")\r
-N1 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child1, "AttributeTreeNode")\r
-if N1 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-child2 = batchmode_geompy.myBuilder.NewObject(batchmode_geompy.father)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child2,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N2")\r
-N2 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child2, "AttributeTreeNode")\r
-if N2 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-child3 = batchmode_geompy.myBuilder.NewObject(batchmode_geompy.father)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child3,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N3")\r
-N3 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child3, "AttributeTreeNode")\r
-if N3 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-\r
-child11 = batchmode_geompy.myBuilder.NewObject(child1)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child11,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N11")\r
-\r
-N11 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child11, "AttributeTreeNode")\r
-\r
-if N11 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-child111 = batchmode_geompy.myBuilder.NewObject(child11)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child111, "AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N111")\r
-\r
-N111 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child111, "AttributeTreeNode")\r
-\r
-if N111 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
- \r
-\r
-child31 = batchmode_geompy.myBuilder.NewObject(child3)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child31,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N31")\r
-\r
-N31 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child31, "AttributeTreeNode")\r
-if N31 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-child32 = batchmode_geompy.myBuilder.NewObject(child3)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child32,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N32")\r
-\r
-N32 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child32, "AttributeTreeNode")\r
-if N32 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-child321 = batchmode_geompy.myBuilder.NewObject(child32)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child321,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N321")\r
-\r
-N321 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child321, "AttributeTreeNode")\r
-if N321 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-child33 = batchmode_geompy.myBuilder.NewObject(child3)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child33,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N33")\r
-\r
-N33 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child33, "AttributeTreeNode")\r
-if N33 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-child34 = batchmode_geompy.myBuilder.NewObject(child3)\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(child34,"AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-A.SetValue("N34")\r
-\r
-N34 = batchmode_geompy.myBuilder.FindOrCreateAttribute(child34, "AttributeTreeNode")\r
-if N34 == None :\r
- raise RuntimeError, "Can't create AttributeTreeNode attribute"\r
-\r
-\r
-\r
-#Create links between tree nodes.\r
-# -| root\r
-# --N1 __\r
-# | N11__\r
-# | N111\r
-# --N2 \r
-# | \r
-# --N3__\r
-# N31\r
-# N32__\r
-# N321\r
-# N33\r
-# N34\r
- \r
-N11.SetFather(N1)\r
-N11.Append(N111)\r
-N3.SetPrevious(N1)\r
-N3.Prepend(N2)\r
-\r
-N32.SetFather(N3)\r
-N32.Prepend(N31)\r
-N33.InsertAfter(N32)\r
-N33.Append(N34)\r
-print "------------- ", N1, " ------------- "\r
-print "N1.Label() = ", N1.Label() , "IsRoot() = ", N1.IsRoot(), "Depth() = ", N1.Depth()\r
-print "N11.Label() = ", N11.Label() , "IsRoot() = ", N11.IsRoot(), "Depth() = ", N11.Depth()\r
-print "N111.Label() = ", N111.Label() , "IsRoot() = ", N111.IsRoot(), "Depth() = ", N111.Depth()\r
-print "N2.Label() = ", N2.Label() , "IsRoot() = ", N2.IsRoot(), "Depth() = ", N2.Depth()\r
-print "N3.Label() = ", N3.Label() , "IsRoot() = ", N3.IsRoot(), "Depth() = ", N3.Depth()\r
-print "N31.Label() = ", N31.Label() , "IsRoot() = ", N31.IsRoot(), "Depth() = ", N31.Depth()\r
-print "N32.Label() = ", N32.Label() , "IsRoot() = ", N32.IsRoot(), "Depth() = ", N32.Depth()\r
-print "N321.Label() = ", N321.Label() , "IsRoot() = ", N321.IsRoot(), "Depth() = ", N321.Depth()\r
-print "N33.Label() = ", N33.Label() , "IsRoot() = ", N33.IsRoot(), "Depth() = ", N33.Depth()\r
-print "N34.Label() = ", N34.Label() , "IsRoot() = ", N34.IsRoot(), "Depth() = ", N34.Depth()\r
-print "N1.IsRoot()=", N1.IsRoot()\r
-\r
-print "N1.HasNext() = ",N1.HasNext()\r
-if N1.HasNext():\r
- print N1.Next().Label()\r
-\r
-print "N32.HasPrevious() = ",N32.HasPrevious()\r
-if N32.HasPrevious():\r
- print N32.GetPrevious().Label()\r
-\r
-print "N111.HasFirst()=",N111.HasFirst()\r
-print "N111.HasFather()=",N111.HasFather()\r
-if N111.HasFather() :\r
- print "N111.GetFather().Label()=",N111.GetFather().Label()\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Exemple</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>\r
-#^ SALOMEDS methods : FindOrCreateAttribute, Save, SaveAs, Close, Open, FindComponent, FindAttribute, FindObject, LoadWith^\r
-#^ Attribute methods : Value, SetValue^\r
-#======================================================================\r
-#1. Create Study and add some components to it\r
-#======================================================================\r
-\r
-#=================================\r
-# create AttributeReal \r
-#=================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeReal")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeReal attribute"\r
-A = A._narrow(SALOMEDS.AttributeReal)\r
-A.SetValue(0.0001)\r
-if A.Value() != 0.0001:\r
- raise RuntimeError, "Error : wrong value of AttributeReal"\r
-\r
-# === Geometry ==================================================\r
-\r
-import batchmode_geompy\r
- \r
-#===================================\r
-# define a box\r
-#===================================\r
-\r
-box = batchmode_geompy.MakeBox(0., 0., 0., 100., 200., 300.)\r
-idbox = batchmode_geompy.addToStudy(box,"box")\r
-\r
-\r
-geom = batchmode_geompy.geom\r
-import SMESH\r
-import batchmode_smesh\r
-ShapeType = batchmode_smesh.ShapeType\r
-\r
-# ---- add first face of box in study\r
-\r
-subShapeList = batchmode_geompy.SubShapeAll(box,ShapeType["Face"])\r
-face=subShapeList[0]\r
-name = "box_face"\r
-print name\r
-idface= batchmode_geompy.addToStudyInFather(box,face,name)\r
-\r
-# ---- add shell from box in study\r
-\r
-subShellList= batchmode_geompy.SubShapeAll(box,ShapeType["Shell"])\r
-shell = subShellList[0]\r
-name = "box_shell"\r
-print name\r
-idshell= batchmode_geompy.addToStudyInFather(box,shell,name)\r
-\r
-# ---- add first edge of face in study\r
-\r
-edgeList = batchmode_geompy.SubShapeAll(face,ShapeType["Edge"])\r
-edge=edgeList[0];\r
-name = "face_edge"\r
-print name\r
-idedge= batchmode_geompy.addToStudyInFather(face,edge,name)\r
-\r
-# ---- launch SMESH, init a Mesh with the box\r
-\r
-smesh = batchmode_smesh.smesh\r
-# -- Init --\r
-shape = batchmode_geompy.IDToObject(idbox)\r
-mesh=smesh.Init(geom, batchmode_geompy.myStudyId, shape)\r
-\r
-orb = batchmode_geompy.orb\r
-\r
-idmesh = batchmode_smesh.AddNewMesh( orb.object_to_string(mesh) )\r
-batchmode_smesh.SetName(idmesh, "Meshbox");\r
-batchmode_smesh.SetShape(idbox, idmesh);\r
-\r
-# ---- create Hypothesis\r
-\r
-print "-------------------------- create Hypothesis ----------------------"\r
-print "-------------------------- LocalLength"\r
-hyp1 = smesh.CreateHypothesis("LocalLength", batchmode_geompy.myStudyId )\r
-hypLen1 = hyp1._narrow(SMESH.SMESH_LocalLength)\r
-hypLen1.SetLength(100)\r
-print hypLen1.GetName()\r
-print hypLen1.GetId()\r
-print hypLen1.GetLength()\r
-\r
-idlength = batchmode_smesh.AddNewHypothesis( orb.object_to_string(hypLen1) );\r
-batchmode_smesh.SetName(idlength, "Local_Length_100");\r
-\r
-print "-------------------------- NumberOfSegments"\r
-hyp2 = smesh.CreateHypothesis("NumberOfSegments", batchmode_geompy.myStudyId )\r
-hypNbSeg1=hyp2._narrow(SMESH.SMESH_NumberOfSegments)\r
-hypNbSeg1.SetNumberOfSegments(7)\r
-print hypNbSeg1.GetName()\r
-print hypNbSeg1.GetId()\r
-print hypNbSeg1.GetNumberOfSegments()\r
-\r
-idseg = batchmode_smesh.AddNewHypothesis( orb.object_to_string(hypNbSeg1) );\r
-batchmode_smesh.SetName(idseg, "NumberOfSegments_7");\r
-\r
-print "-------------------------- MaxElementArea"\r
-hyp3 = smesh.CreateHypothesis("MaxElementArea", batchmode_geompy.myStudyId)\r
-hypArea1=hyp3._narrow(SMESH.SMESH_MaxElementArea)\r
-hypArea1.SetMaxElementArea(2500)\r
-print hypArea1.GetName()\r
-print hypArea1.GetId()\r
-print hypArea1.GetMaxElementArea()\r
-\r
-idarea1 = batchmode_smesh.AddNewHypothesis( orb.object_to_string(hypArea1) );\r
-batchmode_smesh.SetName(idarea1, "MaxElementArea_2500");\r
-\r
-print "-------------------------- MaxElementArea"\r
-hyp3 = smesh.CreateHypothesis("MaxElementArea", batchmode_geompy.myStudyId)\r
-hypArea2 = hyp3._narrow(SMESH.SMESH_MaxElementArea)\r
-hypArea2.SetMaxElementArea(500)\r
-print hypArea2.GetName()\r
-print hypArea2.GetId()\r
-print hypArea2.GetMaxElementArea()\r
-\r
-idarea2 = batchmode_smesh.AddNewHypothesis( orb.object_to_string(hypArea2) );\r
-batchmode_smesh.SetName(idarea2, "MaxElementArea_500");\r
-\r
-print "-------------------------- Regular_1D"\r
-alg1 = smesh.CreateHypothesis("Regular_1D", batchmode_geompy.myStudyId)\r
-algo1 = alg1._narrow(SMESH.SMESH_Algo)\r
-listHyp = algo1.GetCompatibleHypothesis()\r
-for hyp in listHyp:\r
- print hyp\r
-algoReg=alg1._narrow(SMESH.SMESH_Regular_1D)\r
-print algoReg.GetName()\r
-print algoReg.GetId()\r
-\r
-idreg = batchmode_smesh.AddNewAlgorithms( orb.object_to_string(algoReg) );\r
-batchmode_smesh.SetName(idreg, "Regular_1D");\r
-\r
-print "-------------------------- MEFISTO_2D"\r
-alg2 = smesh.CreateHypothesis("MEFISTO_2D", batchmode_geompy.myStudyId)\r
-algo2 = alg2._narrow(SMESH.SMESH_Algo)\r
-listHyp=algo2.GetCompatibleHypothesis()\r
-for hyp in listHyp:\r
- print hyp\r
-algoMef=alg2._narrow(SMESH.SMESH_MEFISTO_2D)\r
-print algoMef.GetName()\r
-print algoMef.GetId()\r
-\r
-idmef = batchmode_smesh.AddNewAlgorithms( orb.object_to_string(algoMef) );\r
-batchmode_smesh.SetName(idmef, "MEFISTO_2D");\r
-\r
-\r
-# ---- add hypothesis to edge\r
-\r
-print "-------------------------- add hypothesis to edge"\r
-edge = batchmode_geompy.IDToObject(idedge)\r
-submesh = mesh.GetElementsOnShape(edge)\r
-ret = mesh.AddHypothesis(edge,algoReg)\r
-print ret\r
-ret=mesh.AddHypothesis(edge,hypLen1)\r
-print ret\r
-\r
-idsm1 = batchmode_smesh.AddSubMeshOnShape( idmesh,\r
- idedge,\r
- orb.object_to_string(submesh),\r
- ShapeType["Edge"] )\r
-batchmode_smesh.SetName(idsm1, "SubMeshEdge")\r
-batchmode_smesh.SetAlgorithms( idsm1, idreg );\r
-batchmode_smesh.SetHypothesis( idsm1, idlength );\r
-\r
-print "-------------------------- add hypothesis to face"\r
-face=batchmode_geompy.IDToObject(idface)\r
-submesh=mesh.GetElementsOnShape(face)\r
-ret=mesh.AddHypothesis(face,hypArea2)\r
-print ret\r
-\r
-idsm2 = batchmode_smesh.AddSubMeshOnShape( idmesh,\r
- idface,\r
- orb.object_to_string(submesh),\r
- ShapeType["Face"] )\r
-batchmode_smesh.SetName(idsm2, "SubMeshFace")\r
-batchmode_smesh.SetHypothesis( idsm2, idarea2 );\r
-\r
-# ---- add hypothesis to box\r
-\r
-print "-------------------------- add hypothesis to box"\r
-box=batchmode_geompy.IDToObject(idbox)\r
-submesh=mesh.GetElementsOnShape(box)\r
-ret=mesh.AddHypothesis(box,algoReg)\r
-print ret\r
-ret=mesh.AddHypothesis(box,hypNbSeg1)\r
-print ret\r
-ret=mesh.AddHypothesis(box,algoMef)\r
-print ret\r
-ret=mesh.AddHypothesis(box,hypArea1)\r
-print ret\r
-\r
-batchmode_smesh.SetAlgorithms( idmesh, idreg );\r
-batchmode_smesh.SetHypothesis( idmesh, idseg );\r
-batchmode_smesh.SetAlgorithms( idmesh, idmef );\r
-batchmode_smesh.SetHypothesis( idmesh, idarea1 );\r
-\r
-# ---- compute box\r
-\r
-print "-------------------------- compute box"\r
-ret=smesh.Compute(mesh,box)\r
-print ret\r
-log=mesh.GetLog(0); # no erase trace\r
-for linelog in log:\r
- print linelog\r
-\r
-\r
-#=======================================================\r
-# add SuperVision component\r
-#=======================================================\r
-\r
-from batchmode_SuperV import *\r
-import os\r
-dir= os.getenv("SUPERV_ROOT_DIR")\r
-if dir == None:\r
- raise RuntimeError, "SUPERV_ROOT_DIR is not defined"\r
-xmlfile = dir +"/examples/GraphEssai.xml"\r
-print "--------------\n"+xmlfile+"\n--------------\n"\r
-\r
-myGraph = Graph ( xmlfile )\r
-\r
-# This DataFlow is "valid" : no loop, correct links between Nodes etc...\r
-print myGraph.IsValid()\r
-\r
-# Get Nodes\r
-myGraph.PrintNodes()\r
-Add,Sub,Mul,Div = myGraph.Nodes()\r
-\r
-# Load Datas\r
-Addx = Add.Input("x",3.)\r
-Addy = Add.Input("y",4.5)\r
-Subx = Sub.Input("x",1.5)\r
-\r
-# Get Output Port\r
-Addz = Add.Port('z')\r
-Subz = Sub.Port('z')\r
-Mulz = Mul.Port('z')\r
-Divz = Div.Port('z')\r
-\r
-# This DataFlow is "executable" : all pending Ports are defined with Datas\r
-print myGraph.IsExecutable()\r
-\r
-# Starts only execution of that DataFlow and gets control immediatly\r
-print myGraph.Run()\r
-\r
-# That DataFlow is running ==> 0 (false)\r
-print myGraph.IsDone()\r
-\r
-# Events of execution :\r
-aStatus,aNode,anEvent,aState = myGraph.Event()\r
-while aStatus :\r
- print aNode.Thread(),aNode.SubGraph(),aNode.Name(),anEvent,aState\r
- aStatus,aNode,anEvent,aState = myGraph.Event()\r
-print myGraph.IsDone()\r
-\r
-# Wait for Completion (but it is already done after event loop ...)\r
-print "Done : ",myGraph.DoneW()\r
-\r
-# Get result\r
-print "Result : ",Divz.ToString()\r
-\r
-# Intermediate results :\r
-print "Intermediate Result Add\z : ",Addz.ToString()\r
-print "Intermediate Result Sub\z : ",Subz.ToString()\r
-print "Intermediate Result Mul\z : ",Mulz.ToString()\r
-\r
-print " "\r
-#print "Type : print myGraph.IsDone()"\r
-#print " If execution is finished ==> 1 (true)"\r
-res=myGraph.IsDone()\r
-if res != 1:\r
- raise RuntimeError, "myGraph.Run() is not done"\r
-\r
-print " "\r
-print "Type : print Divz.ToString()"\r
-print " You will get the result"\r
-Divz.ToString()\r
-\r
-print " "\r
-print "Type : myGraph.PrintPorts()"\r
-print " to see input and output values of the graph"\r
-myGraph.PrintPorts()\r
-\r
-print " "\r
-print "Type : Add.PrintPorts()"\r
-Add.PrintPorts()\r
-\r
-print "Type : Sub.PrintPorts()"\r
-Sub.PrintPorts()\r
-\r
-print "Type : Mul.PrintPorts()"\r
-Mul.PrintPorts()\r
-\r
-print "Type : Div.PrintPorts()"\r
-print " to see input and output values of nodes"\r
-Div.PrintPorts()\r
-\r
-# Export will create newsupervisionexample.xml and the corresponding .py file\r
-tmpdir=os.getenv("TmpDir")\r
-if tmpdir is None:\r
- tmpdir="/tmp"\r
-file = tmpdir + "/newsupervisionexample"\r
-print "--------------\n"+file+"\n--------------\n"\r
-myGraph.Export(file)\r
-\r
-ior = batchmode_geompy.orb.object_to_string(myGraph.G)\r
-addStudy(ior)\r
-\r
-GraphName = myGraph.Name()\r
-print "Befor save ",\r
-nodes = myGraph.Nodes()\r
-length_bs = len(nodes)\r
-print "ListOfNodes length = ", length_bs\r
-names=[]\r
-for node in nodes:\r
- names.append(node.Name())\r
-print names\r
-\r
-\r
-#=================================\r
-# save / restore study \r
-#=================================\r
-str= os.getenv("TmpDir")\r
-if str == None: \r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-\r
-#==================================================\r
-#1. SaveAs\r
-#==================================================\r
-print " ------- We will save to", file, "-----------"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-batchmode_geompy.myStudyManager.Close(batchmode_geompy.myStudy)\r
-\r
-#rename the file and try to reread it again\r
-\r
-os.mkdir(str + "/test_dir")\r
-\r
-#2.==================================================\r
-print " ------- We rename the file as " + str + "/test_dir/test_new.hdf"\r
-os.rename(file, str+"/test_dir/test_new.hdf")\r
-\r
-#==================================================\r
-#3. Open\r
-#==================================================\r
-print " ------- We try to open " + str + "/test_dir/test_new.hdf"\r
-\r
-try:\r
- openedStudy=batchmode_geompy.myStudyManager.Open(str+"/test_dir/test_new.hdf")\r
-except Exception:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "GEOM component is not found! Wrong study is opened." \r
-\r
-\r
-#=================================\r
-# find AttributeReal\r
-#=================================\r
-\r
-res,A=father.FindAttribute("AttributeReal")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeReal"\r
-\r
-A = A._narrow(SALOMEDS.AttributeReal)\r
-if A.Value() != 0.0001:\r
- raise RuntimeError, "Error : wrong value of AttributeReal"\r
-\r
-#==================================================\r
-# find box\r
-#==================================================\r
-box = openedStudy.FindObject("box")\r
-if box is None :\r
- raise RuntimeError, "box was not found! Wrong study is opened."\r
-\r
-edge=openedStudy.FindObject("face_edge")\r
-if edge is None :\r
- raise RuntimeError, "face_edge was not found! Wrong study is opened."\r
-\r
-\r
-father = openedStudy.FindComponent("MESH")\r
-if father is None:\r
- raise RuntimeError, "MESH component is not found! Wrong study is opened." \r
-\r
-hp=openedStudy.FindObject("Meshbox")\r
-if hp is None:\r
- raise RuntimeError, "Meshbox object was not found! Wrong study is opened."\r
-\r
-hp = openedStudy.FindObject("Algorithms Definition")\r
-if hp is None:\r
- raise RuntimeError, "Algorithms Definition object was not found! Wrong study is opened."\r
-\r
-hp = openedStudy.FindObject("MEFISTO_2D")\r
-if hp is None:\r
- raise RuntimeError, "MEFISTO_2D object was not found! Wrong study is opened."\r
-\r
-hp = openedStudy.FindObject("Hypothesis Definition")\r
-if hp is None:\r
- raise RuntimeError, "Algoriths Definition was not found! Wrong study is opened."\r
-\r
-#==================================================\r
-# Find Supervisor\r
-#==================================================\r
-father = openedStudy.FindComponent("SUPERV")\r
-if father is None: \r
- raise RuntimeError, "SUPERV component is not found! Wrong study is opened." \r
-\r
-SuperV = lcc.FindOrLoadComponent("SuperVisionContainer","Supervision")\r
-Builder = openedStudy.NewBuilder()\r
-Builder.LoadWith(father, SuperV)\r
-import SALOMEDS\r
-\r
-aChildIterator = openedStudy.NewChildIterator(father)\r
-\r
-#while aChildIterator.More():\r
-anSObject = aChildIterator.Value()\r
-#print "iterate: ", anSObject.GetID()\r
-res, anAttr=anSObject.FindAttribute("AttributeIOR")\r
-if res :\r
- anAttr=anAttr._narrow(SALOMEDS.AttributeIOR)\r
- ior = anAttr.Value()\r
- Graph=SuperV.getGraph(ior)\r
- ListOfNodes=Graph.Nodes()\r
- length_as= len(ListOfNodes)\r
- print "ListOfNodes length = ", length_as\r
- if length_as != length_bs:\r
- raise RuntimeErrror, "defferent length of nodes after study open"\r
-#aChildIterator.Next()\r
-\r
-Names = []\r
-for node in ListOfNodes:\r
- Names.append(node.Name())\r
-names.sort()\r
-Names.sort()\r
-if names != Names :\r
- raise RuntimeError, "List of dataflow nodes after save differs from one befor save operation"\r
-\r
-#==================================================\r
-#4. Save\r
-#==================================================\r
-batchmode_geompy.myStudyManager.Save(openedStudy)\r
-batchmode_geompy.myStudyManager.Close(openedStudy)\r
-#==================================================\r
-#5. Open\r
-#==================================================\r
-try:\r
- openedStudy = batchmode_geompy.myStudyManager.Open(str+"/test_dir/test_new.hdf")\r
-except Exception:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-#find AttributeReal\r
-res,A=father.FindAttribute("AttributeReal")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeReal"\r
-\r
-A = A._narrow(SALOMEDS.AttributeReal)\r
-if A.Value() != 0.0001:\r
- raise RuntimeError, "Error : wrong value of AttributeReal"\r
-#==================================================\r
-# find box\r
-#==================================================\r
-box = openedStudy.FindObject("box")\r
-if box is None :\r
- raise RuntimeError, "box was not found! Wrong study is opened."\r
-\r
-edge=openedStudy.FindObject("face_edge")\r
-if edge is None :\r
- raise RuntimeError, "face_edge was not found! Wrong study is opened."\r
-\r
-\r
-father = openedStudy.FindComponent("MESH")\r
-if father is None:\r
- raise RuntimeError, "MESH component is not found! Wrong study is opened." \r
-\r
-hp=openedStudy.FindObject("Meshbox")\r
-if hp is None:\r
- raise RuntimeError, "Meshbox object was not found! Wrong study is opened."\r
-\r
-hp = openedStudy.FindObject("Algorithms Definition")\r
-if hp is None:\r
- raise RuntimeError, "Algorithms Definition object was not found! Wrong study is opened."\r
-\r
-hp = openedStudy.FindObject("MEFISTO_2D")\r
-if hp is None:\r
- raise RuntimeError, "MEFISTO_2D object was not found! Wrong study is opened."\r
-\r
-hp = openedStudy.FindObject("Hypothesis Definition")\r
-if hp is None:\r
- raise RuntimeError, "Algoriths Definition was not found! Wrong study is opened."\r
-\r
-#==================================================\r
-# Find Supervisor\r
-#==================================================\r
-father = openedStudy.FindComponent("SUPERV")\r
-if father is None:\r
- raise RuntimeError, "SUPERV component is not found! Wrong study is opened." \r
-\r
-SuperV = lcc.FindOrLoadComponent("SuperVisionContainer","Supervision")\r
-Builder = openedStudy.NewBuilder()\r
-Builder.LoadWith(father, SuperV)\r
-import SALOMEDS\r
-\r
-aChildIterator = openedStudy.NewChildIterator(father)\r
-\r
-#while aChildIterator.More():\r
-anSObject = aChildIterator.Value()\r
-\r
-res, anAttr=anSObject.FindAttribute("AttributeIOR")\r
-if res :\r
- anAttr=anAttr._narrow(SALOMEDS.AttributeIOR)\r
- ior = anAttr.Value()\r
- Graph=SuperV.getGraph(ior)\r
- ListOfNodes=Graph.Nodes()\r
- length_as= len(ListOfNodes)\r
- print "ListOfNodes length = ", length_as\r
- if length_as != length_bs:\r
- raise RuntimeErrror, "defferent length of nodes after study open"\r
-#aChildIterator.Next()\r
-\r
-Names = []\r
-for node in ListOfNodes:\r
- Names.append(node.Name())\r
-names.sort()\r
-Names.sort()\r
-if names != Names :\r
- raise RuntimeError, "List of dataflow nodes after save differs from one befor save operation"\r
-</PRE>\r
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeInteger interface(creation/saving/restoring)%\r
-#%Methods : FindOrCreateAttribute , Value, SaveAs, SetValue, FindComponent, FindAttribute, Open%\r
-\r
-# create AttributeInteger \r
-#=================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeInteger")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeInteger attribute"\r
-A = A._narrow(SALOMEDS.AttributeInteger)\r
-A.SetValue(1000000)\r
-\r
-if A.Value() != 1000000:\r
- raise RuntimeError, "Error : wrong value of AttributeInteger"\r
-\r
-# save and restore the study\r
-#=================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-# ... save ...\r
-batchmode_geompy.myStudyManager.SaveAs(str+"/test.hdf", batchmode_geompy.myStudy)\r
-# ... open ...\r
-openedStudy= batchmode_geompy.myStudyManager.Open(str+"/test.hdf");\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-# find AttributeInteger\r
-#================================\r
-res,A=father.FindAttribute("AttributeInteger")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeInteger"\r
-A = A._narrow(SALOMEDS.AttributeInteger)\r
-if A.Value() != 1000000:\r
- raise RuntimeError, "Error : wrong value of AttributeInteger after study restoring"\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Exemple</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>\r
-#^SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, NewCommand, GetProperties, Open, CommitCommand, NewBuilder^\r
-#^Attribute methods : SetLocked, IsLocked, GetCreationMode, SetCreationDate, IsModified, GetUserName, Value, SetUserName, SetValue, GetCreationDate^\r
-\r
-batchmode_geompy.myBuilder._set_UndoLimit(20)\r
-\r
-#--------------------------------------------------------------------------\r
-# create AttributeReal \r
-#===============================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeReal")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeReal attribute"\r
-A = A._narrow(SALOMEDS.AttributeReal)\r
-A.SetValue(0.0001)\r
-if A.Value() != 0.0001:\r
- raise RuntimeError, "Error : wrong value of AttributeReal"\r
-\r
-# create AttributeStudyProperties\r
-#================================================\r
-A = batchmode_geompy.myStudy.GetProperties()\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeStudyProperties attribute"\r
-A = A._narrow(SALOMEDS.AttributeStudyProperties)\r
-\r
-batchmode_geompy.myBuilder.NewCommand();\r
-print "A.GetUserName()= ", A.GetUserName()\r
-res,mm,hh,dd,mnth,yy=A.GetCreationDate()\r
-print "A.GetCreationDate() = ", mm,hh,dd,mnth,yy\r
-print "A.GetCreationMode() = ", A.GetCreationMode()\r
-print "A.IsModified() = ", A.IsModified()\r
-print "A.IsLocked() = ", A.IsLocked()\r
-if A.IsLocked() == 0 :\r
- A.SetUserName("tester"); print 'A.SetUserName("tester"), A.GetUserName() = ', A.GetUserName()\r
- A.SetCreationDate(11,11,11,11,2002); print 'A.SetCreationDate(11,11,11,11,2002), A.GetCreationDate() =', A.GetCreationDate()\r
- print "A.IsModified() = ", A.IsModified()\r
-A.SetLocked(1)\r
-\r
-#check the transaction result \r
-batchmode_geompy.myBuilder.CommitCommand()\r
-if A.GetUserName() != "tester":\r
- print 'Control after transaction close : A.GetUserName() = ', A.GetUserName()\r
- raise RuntimeError, "Field 'UserName' was not modified but had to!"\r
-\r
-# try to make some changes wrapped by transaction \r
-#================================================\r
-batchmode_geompy.myBuilder.NewCommand()\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeInteger")\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeInteger attribute"\r
-A = A._narrow(SALOMEDS.AttributeInteger)\r
-A.SetValue(1000000)\r
-\r
-exception_was = None\r
-try : batchmode_geompy.myBuilder.CommitCommand()\r
-except Exception: exception_was = 1\r
-\r
-if exception_was is None:\r
- raise RuntimeError, "Study was locked for changes but CommitCommand did not generate an exception !"\r
-\r
-# save / restore study \r
-\r
-#================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-print " ------- We will save to", file, "-----------"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-\r
-\r
-#--------------------------------------------------------------------------#\r
-#--------------------------- Open file ------------------------------------# \r
-#--------------------------------------------------------------------------#\r
-\r
-print" -------------- Open " + file + "-------------- " \r
-\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file)\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-#1. find AttributeReal\r
-#================================================\r
-\r
-res,A=father.FindAttribute("AttributeReal")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeReal"\r
-\r
-A = A._narrow(SALOMEDS.AttributeReal)\r
-if A.Value() != 0.0001:\r
- raise RuntimeError, "Error : wrong value of AttributeReal"\r
- \r
-\r
-#2. find AttributeStudyProperties\r
-#=================================================\r
-A=openedStudy.GetProperties()\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeStudyProperties"\r
-\r
-A = A._narrow(SALOMEDS.AttributeStudyProperties)\r
-if A.IsLocked() == 0 :\r
- raise RuntimeError, "Error : AttributeStudyProperties must have Locked flag but have no!"\r
-\r
-#get the builder\r
-myBuilder = openedStudy.NewBuilder()\r
-\r
-#3. try to make some changes wrapped by transaction \r
-#==================================================\r
-exception_was = None\r
-try : \r
- myBuilder.NewCommand()\r
- A = myBuilder.FindOrCreateAttribute(father, "AttributeInteger")\r
-\r
- if A == None :\r
- raise RuntimeError, "Can't create AttributeInteger attribute"\r
- A = A._narrow(SALOMEDS.AttributeInteger)\r
- A.SetValue(1000000)\r
- myBuilder.CommitCommand()\r
-except Exception: exception_was = 1\r
-\r
-if exception_was is None:\r
- raise RuntimeError, "Study was locked for changes but CommitCommand did not generate an exception !"\r
-\r
-\r
-myBuilder.NewCommand()\r
-A=openedStudy.GetProperties()\r
-A = A._narrow(SALOMEDS.AttributeStudyProperties)\r
-A.SetLocked(0)\r
-myBuilder.CommitCommand()\r
-\r
-#4.\r
-myBuilder.NewCommand()\r
-A.SetLocked(0);\r
-print "A.GetUserName()= ", A.GetUserName()\r
-print "A.GetCreationDate() = ", A.GetCreationDate()\r
-print "A.GetCreationMode() = ", A.GetCreationMode()\r
-print "A.IsModified() = ", A.IsModified()\r
-myBuilder.CommitCommand()\r
-\r
-#5.\r
-myBuilder.NewCommand()\r
-A.SetUserName("tester1")\r
-myBuilder.CommitCommand()\r
-print "A.GetUserName()= ", A.GetUserName()\r
-\r
-#remove the document file\r
-os.remove(file)\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Exemple</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>\r
-#^SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open^\r
-#^Attribute methods: GetValue, GetNbColumns, AddColumn, SetRowTitles, PutValue, GetColumn, GetColumnTitles, GetTitle, SetRow, GetRowTitles, SetColumnTitles, SetColumn, GetRow, GetNbRows, SetColumnTitle, AddRow, SetTitle, SetRowTitle^\r
-\r
-# create AttributeReal \r
-#=======================================================================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeTableOfInteger")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeTableOfInteger attribute"\r
-A = A._narrow(SALOMEDS.AttributeTableOfInteger)\r
-a=[1,2]\r
-\r
-b=[3,4]\r
-\r
-# 2x2\r
-# --- rows ---\r
-A.AddRow(a)\r
-A.AddRow(b)\r
-a=[34,14]\r
-A.SetRow(1,a)\r
-\r
-# 3x3\r
-#\r
-b=[54,56]\r
-A.AddRow(b)\r
-\r
-# --- columns ---\r
-a=[76,25,12]\r
-\r
-A.AddColumn(a)\r
-a=[836,3425,342]\r
-A.SetColumn(3,a)\r
-\r
-# change attribute values\r
-print "A.GetValue(2,2) = ", A.GetValue(2,2)\r
-print "A.PutValue(2,2,625323)"\r
-A.PutValue(625323,2,2)\r
-print "A.GetValue(2,2) = ", A.GetValue(2,2)\r
-\r
-#set Titles\r
-\r
-A.SetTitle("TEST")\r
-\r
-A.SetRowTitle(1,"FR")\r
-A.SetRowTitle(2,"SR")\r
-A.SetRowTitle(3,"TR")\r
-\r
-A.SetColumnTitle(1,"FC")\r
-A.SetColumnTitle(2,"SC")\r
-A.SetColumnTitle(3,"TC")\r
-\r
-\r
-#check the table\r
-print "Common title : ",A.GetTitle()\r
-print "Rows titles : ", A.GetRowTitles()\r
-rnb = A.GetNbRows()\r
-for i in range(1, rnb):\r
- b=A.GetRow(i)\r
- print b\r
-\r
-cnb = A.GetNbColumns()\r
-print "Columns title : ", A.GetColumnTitles()\r
-for i in range(1, cnb):\r
- b=A.GetColumn(i)\r
- print b\r
-\r
-# set titles\r
-#titles=["11","12","13"]\r
-#A.SetRowTitles(titles)\r
-#titles=["21","22","23"]\r
-#A.SetRowTitles(2,titles)\r
-#titles=["31","32","33"]\r
-#A.SetRowTitles(3,titles)\r
-\r
-#--------------------------------------------------------------------------#\r
-# ----------------------- save the study ----------------------------------#\r
-#--------------------------------------------------------------------------#\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-print " ------- We will save to", file, "-----------"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-\r
-#--------------------------------------------------------------------------#\r
-#---------------------------- Open file -----------------------------------# \r
-#--------------------------------------------------------------------------#\r
-\r
-print" -------------- Open " + file + "-------------- " \r
-\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file)\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-# --- check attribute ---\r
-\r
-res,A=father.FindAttribute("AttributeTableOfInteger")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeTableOfInteger"\r
-\r
-A = A._narrow(SALOMEDS.AttributeTableOfInteger)\r
-\r
-#check the table\r
-print "Common title : ",A.GetTitle()\r
-print "Rows titles : ", A.GetRowTitles()\r
-rnb = A.GetNbRows()\r
-for i in range(1, rnb):\r
- b=A.GetRow(i)\r
- print b\r
-\r
-cnb = A.GetNbColumns()\r
-print "Columns title : ", A.GetColumnTitles()\r
-for i in range(1, cnb):\r
- b=A.GetColumn(i)\r
- print b\r
-\r
-titles=["ff","ss","tt"]\r
-A.SetRowTitles(titles)\r
-print "Rows titles : ", A.GetRowTitles()\r
-\r
-titles=["ww","zz","cc"]\r
-A.SetColumnTitles(titles)\r
-print "Column titles : ", A.GetColumnTitles()\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Exemple</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>\r
-#^ SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open^\r
-#^ Attribute methods : GetValue, GetNbColumns, AddColumn, SetRowTitles, PutValue, GetColumn, GetColumnTitles, GetTitle, SetRow, GetRowTitles, SetColumnTitles, SetColumn, GetRow, GetNbRows, SetColumnTitle, AddRow, SetTitle, SetRowTitle^\r
-\r
-# create AttributeReal \r
-#===============================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeTableOfReal")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeTableOfReal attribute"\r
-A = A._narrow(SALOMEDS.AttributeTableOfReal)\r
-a=[1,2]\r
-\r
-b=[3,4]\r
-\r
-# 2x2\r
-# --- rows ---\r
-A.AddRow(a)\r
-A.AddRow(b)\r
-a=[34,14]\r
-A.SetRow(1,a)\r
-\r
-# 3x3\r
-#\r
-b=[54,56]\r
-A.AddRow(b)\r
-\r
-# --- columns ---\r
-a=[76,25,12]\r
-\r
-A.AddColumn(a)\r
-a=[836,3425,342]\r
-A.SetColumn(3,a)\r
-\r
-# change attribute values\r
-print "A.GetValue(2,2) = ", A.GetValue(2,2)\r
-print "A.PutValue(2,2,625323)"\r
-A.PutValue(625323,2,2)\r
-print "A.GetValue(2,2) = ", A.GetValue(2,2)\r
-\r
-#set Titles\r
-\r
-A.SetTitle("TEST")\r
-\r
-A.SetRowTitle(1,"FR")\r
-A.SetRowTitle(2,"SR")\r
-A.SetRowTitle(3,"TR")\r
-\r
-A.SetColumnTitle(1,"FC")\r
-A.SetColumnTitle(2,"SC")\r
-A.SetColumnTitle(3,"TC")\r
-\r
-\r
-#check the table\r
-print "Common title : ",A.GetTitle()\r
-print "Rows titles : ", A.GetRowTitles()\r
-rnb = A.GetNbRows() + 1\r
-for i in range(1, rnb):\r
- b=A.GetRow(i)\r
- print b\r
-\r
-cnb = A.GetNbColumns() + 1\r
-print "Columns title : ", A.GetColumnTitles()\r
-for i in range(1, cnb):\r
- b=A.GetColumn(i)\r
- print b\r
-\r
-# set titles\r
-#titles=["11","12","13"]\r
-#A.SetRowTitles(titles)\r
-#titles=["21","22","23"]\r
-#A.SetRowTitles(2,titles)\r
-#titles=["31","32","33"]\r
-#A.SetRowTitles(3,titles)\r
-\r
-#--------------------------------------------------------------------------#\r
-#------------------------ save the study ----------------------------------#\r
-#--------------------------------------------------------------------------#\r
-import os\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-print " ------- We will save to", file, "-----------"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-\r
-#--------------------------------------------------------------------------#\r
-#---------------------------- Open file -----------------------------------# \r
-#--------------------------------------------------------------------------#\r
-\r
-print" -------------- Open " + file + "-------------- " \r
-\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file)\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-# --- check attribute ---\r
-\r
-res,A=father.FindAttribute("AttributeTableOfReal")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeTableOfReal"\r
-\r
-A = A._narrow(SALOMEDS.AttributeTableOfReal)\r
-\r
-#check the table\r
-print "Common title : ",A.GetTitle()\r
-print "Rows titles : ", A.GetRowTitles()\r
-rnb = A.GetNbRows() + 1\r
-for i in range(1, rnb):\r
- b=A.GetRow(i)\r
- print b\r
-\r
-cnb = A.GetNbColumns() + 1\r
-print "Columns title : ", A.GetColumnTitles()\r
-for i in range(1, cnb):\r
- b=A.GetColumn(i)\r
- print b\r
-\r
-titles=["ff","ss","tt"]\r
-A.SetRowTitles(titles)\r
-print "Rows titles : ", A.GetRowTitles()\r
-\r
-titles=["ww","zz","cc"]\r
-A.SetColumnTitles(titles)\r
-print "Column titles : ", A.GetColumnTitles()\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Exemple</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>\r
-import batchmode_salome\r
-#import SALOMEDS\r
-\r
-aStudy = batchmode_salome.myStudy \r
-\r
-#Add new component 'User data'\r
-aBuilder = aStudy.NewBuilder()\r
-aComponent = aBuilder.NewComponent("User data")\r
-anAttr = aBuilder.FindOrCreateAttribute(aComponent, "AttributeName")\r
-anAttrName = anAttr._narrow(SALOMEDS.AttributeName) \r
-anAttrName.SetValue("User data")\r
-\r
-\r
-#Add a new case 'Case1' to the component 'User data'\r
-aBuilder.AddDirectory("/User data/Case1")\r
-\r
-#Set a study context to '/User data/Case1'\r
-aStudy.SetContext("/User data/Case1")\r
-\r
-#Print the current study context\r
-print aStudy.GetContext()\r
-\r
-#Add a sub directory 'aSubCase' to 'Case1' (under the current context)\r
-aBuilder.AddDirectory("aSubCase")\r
-\r
-\r
-#Add a new case 'Case2' to component 'User data'\r
-aBuilder.AddDirectory("/User data/Case2")\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeSequenceOfReal interface(creations/saving/restoring)%\r
-#% AttributeSequenceOfReal : ChangeValue, Add, Value, Remove, Length%\r
-#% SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open%\r
-\r
-# create AttributeSequenceOfReal \r
-#=================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeSequenceOfReal")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSequenceOfReal attribute"\r
-A = A._narrow(SALOMEDS.AttributeSequenceOfReal)\r
-if A == None :\r
- raise RuntimeError, "_narrow returns None instead of AttributeSequenceOfReal pointer"\r
-\r
-A.Add(0.0293)\r
-A.Add(625.1e+2)\r
-A.Add(0.928e+100)\r
-A.Add(83.287)\r
-\r
-print "initial values ",A.Value(1), A.Value(2), A.Value(3), A.Value(4)\r
-A.Remove(3)\r
-print "after remove ", A.Value(1), A.Value(2), A.Value(3)\r
-A.ChangeValue(2,76.265)\r
-print "after second item change", A.Value(1), A.Value(2), A.Value(3)\r
-\r
-if A.Length() != 3:\r
- print "Error : wrong length of SequenceOfReal"\r
-if A.Value(1) != 0.0293 or A.Value(2) != 76.265 or A.Value(3) != 83.287:\r
- print "Error : wrong value of AttributeSequenceOfReal"\r
-\r
-# save / restore study \r
-#=================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeSequenceOfReal\r
-#=================================\r
-\r
-res,A=father.FindAttribute("AttributeSequenceOfReal")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeSequenceOfReal"\r
-\r
-A = A._narrow(SALOMEDS.AttributeSequenceOfReal)\r
-\r
-if A.Length() != 3:\r
- print "Error : wrong length of SequenceOfReal"\r
-if A.Value(1) != 0.0293 or A.Value(2) != 76.265 or A.Value(3) != 83.287:\r
- print "Error : wrong value of AttributeSequenceOfReal"\r
-print "after restoring ", A.Value(1), A.Value(2), A.Value(3)\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeSequenceOfInteger interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute FindComponent FindAttribute Open Add SaveAs%\r
-#%AttributeSequenceOfInteger methods : Value, Remove, Length%\r
-\r
-# create AttributeSequenceOfInteger \r
-#==========================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeSequenceOfInteger")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSequenceOfInteger attribute"\r
-A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSequenceOfInteger attribute"\r
-\r
-A.Add(100)\r
-A.Add(300)\r
-A.Add(500)\r
-A.Add(400)\r
-A.Add(700)\r
-\r
-A.Remove(3)\r
-A.ChangeValue(4,500)\r
-\r
-\r
-if A.Length() != 4:\r
- print "Wrong length of SequenceOfInteger"\r
-if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 700:\r
- print "Wrong value of AttributeSequenceOfInteger"\r
-\r
-\r
-# save / restore study \r
-#=================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeSequenceOfInteger\r
-#======================================\r
-\r
-res,A=father.FindAttribute("AttributeSequenceOfInteger")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeSequenceOfInteger"\r
-\r
-A = A._narrow(SALOMEDS.AttributeSequenceOfInteger)\r
-\r
-if A.Length() != 4:\r
- print "Wrong length of SequenceOfInteger"\r
-if A.Value(1) != 100 or A.Value(2) != 300 or A.Value(3) != 400 or A.Value(4) != 700:\r
- print "Wrong value of AttributeSequenceOfInteger"\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeName interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent FindAttribute Open%\r
-#%Attribute methods : SetValue, Value%\r
-\r
-# create AttributeName \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeName")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-A.SetValue("AttributesTesting")\r
-\r
-if A.Value() != "AttributesTesting":\r
- print "Wrong value of AttributeName"\r
-\r
-\r
-# save / restore study \r
-#=================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeName\r
-#======================================\r
-\r
-res,A=father.FindAttribute("AttributeName")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeName"\r
-\r
-A = A._narrow(SALOMEDS.AttributeName)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeName attribute"\r
-\r
-if A.Value() != "AttributesTesting":\r
- print "Wrong value of AttributeName"\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeComment interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, SaveAs FindComponent FindAttribute Open%\r
-#%Attribute methods : Value, SetValue%\r
-\r
-# create AttributeComment \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeComment")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeComment attribute"\r
-A = A._narrow(SALOMEDS.AttributeComment)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeComment attribute"\r
-\r
-A.SetValue("GEOM")\r
-\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeComment\r
-#============================================================\r
-\r
-res,A=father.FindAttribute("AttributeComment")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeComment"\r
-\r
-A = A._narrow(SALOMEDS.AttributeComment)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeComment attribute"\r
-\r
-if A.Value() != "GEOM":\r
- "Error: wrong value of AttributeComment"\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributePersistentRef interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent FindAttribute Open%\r
-#%Attribute methods : SetValue, Value%\r
-\r
-# create AttributePersistentRef \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributePersistentRef")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributePersistentRef attribute"\r
-A = A._narrow(SALOMEDS.AttributePersistentRef)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributePersistentRef attribute"\r
-\r
-A.SetValue("/tmp/test;1")\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributePersistentRef\r
-#============================================================\r
-\r
-res,A=father.FindAttribute("AttributePersistentRef")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributePersistentRef"\r
-\r
-A = A._narrow(SALOMEDS.AttributePersistentRef)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributePersistentRef attribute"\r
-\r
-if A.Value() != "/tmp/test;1":\r
- "Error: wrong value of AttributePersistentRef"\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeDrawable interface(creations/saving/restoring)%\r
-#%SALOMEDS methods : FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open%\r
-#%Attribute methods : SetDrawable, IsDrawable% \r
-#--------------------------------------------------------------------------\r
-\r
-from batchmode_geompy import *\r
-import os\r
-\r
-#--------------------------------------------------------------------------\r
-# create AttributeDrawable \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeDrawable")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeDrawable attribute"\r
-A = A._narrow(SALOMEDS.AttributeDrawable)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeDrawable attribute"\r
-\r
-A.SetDrawable(1)\r
-\r
-if A.IsDrawable() == 0:\r
- "Error: wrong value of AttributeDrawable"\r
-\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy=batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeDrawable\r
-#============================================================\r
-\r
-res,A=father.FindAttribute("AttributeDrawable")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeDrawable"\r
-\r
-A = A._narrow(SALOMEDS.AttributeDrawable)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeDrawable attribute"\r
-\r
-if A.IsDrawable() == 0:\r
- "Error: wrong value of AttributeDrawable"\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML>\r
-<HEAD>\r
-<!-- hennerik CVSweb $Revision$ -->\r
-<TITLE>Example</TITLE></HEAD>\r
-<BODY BGCOLOR="#eeeeee">\r
-<HR noshade><PRE>#%AttributeSelectable interface(creations/saving/restoring)%\r
-#%SALOMEDS methods: FindOrCreateAttribute, SaveAs, FindComponent, FindAttribute, Open%\r
-#%Attribute methods: SetSelectable, IsSelectable%\r
-\r
-# create AttributeSelectable \r
-#===========================================================\r
-A = batchmode_geompy.myBuilder.FindOrCreateAttribute(batchmode_geompy.father, "AttributeSelectable")\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSelectable attribute"\r
-A = A._narrow(SALOMEDS.AttributeSelectable)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSelectable attribute"\r
-\r
-A.SetSelectable(1)\r
-\r
-if A.IsSelectable() == 0:\r
- "Error: wrong value of AttributeSelectable"\r
-\r
-\r
-# save / restore study \r
-#============================================================\r
-str= os.getenv("TmpDir")\r
-if str == None:\r
- str = "/tmp"\r
-file = str+"/test.hdf"\r
-\r
-batchmode_geompy.myStudyManager.SaveAs(file, batchmode_geompy.myStudy)\r
-openedStudy = batchmode_geompy.myStudyManager.Open(file);\r
-\r
-if openedStudy == None:\r
- raise RuntimeError, "Can't open saved study!"\r
-\r
-father = openedStudy.FindComponent("GEOM")\r
-if father is None:\r
- raise RuntimeError, "Geom component is not found! Wrong study is opened." \r
-\r
-\r
-# find AttributeSelectable\r
-#============================================================\r
-\r
-res,A=father.FindAttribute("AttributeSelectable")\r
-if res == 0 or A == None:\r
- raise RuntimeError, "Error: not found AttributeSelectable"\r
-\r
-A = A._narrow(SALOMEDS.AttributeSelectable)\r
-\r
-if A == None :\r
- raise RuntimeError, "Can't create AttributeSelectable attribute"\r
-\r
-if A.IsSelectable() == 0:\r
- "Error: wrong value of AttributeSelectable"\r
-\r
-</PRE>
\ No newline at end of file
+++ /dev/null
-H1 {
- text-align: center;
-}
-
-CAPTION {
- font-weight: bold
-}
-
-/* Link in the top navbar */
-A.qindex {}
-
-A.qindexRef {}
-
-/* Link to any cross-referenced Doxygen element */
-A.el {
- text-decoration: none;
- font-weight: bold
-}
-
-A.elRef {
- font-weight: bold
-}
-
-/* Link to any cross-referenced Doxygen element inside a code section
- (ex: header)
-*/
-A.code {
- text-decoration: none;
- font-weight: normal;
- color: #4444ee
-}
-
-A.codeRef {
- font-weight: normal;
- color: #4444ee
-}
-
-A:hover {
- text-decoration: none;
- background-color: lightblue
-}
-
-DL.el {
- margin-left: -1cm
-}
-
-/* A code fragment (ex: header) */
-DIV.fragment {
- width: 100%;
- border: none;
- background-color: #CCCCCC
-}
-
-/* In the alpha list (coumpound index), style of an alphabetical index letter */
-DIV.ah {
- background-color: #CCCCCC;
- font-weight: bold;
- color: #ffffff;
- margin-bottom: 3px;
- margin-top: 3px
-}
-
-/* Method name (+ type) */
-TD.md {
- background-color: lightblue;
- font-weight: bold;
-}
-
-/* Method parameter (some of them) */
-TD.mdname1 {
- background-color: lightblue;
- font-weight: bold; color: #602020;
-}
-
-/* Method parameter (some of them) */
-TD.mdname {
- background-color: lightblue;
- font-weight: bold;
- color: #602020;
- width: 600px;
-}
-
-/* Separator between methods group (usually empty, seems not supported by IE) */
-DIV.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- margin-bottom: 6px;
- font-weight: bold
-}
-
-DIV.groupText {
- margin-left: 16px;
- font-style: italic;
- font-size: smaller
-}
-
-BODY {
- background: #FFFFFF;
-}
-
-/*div.div-page {
- background-color: #FFFFFF;
- margin-left: 1em;
- margin-right: 1em;
- margin-top: 1em;
- margin-bottom: 0.1em;
-
- padding-left: 1em;
- padding-right: 1em;
- padding-top: 0.5em;
- padding-bottom: 0.5em;
-
- border: 2px solid #0D299A;
- border-width: 2px;
- border-color: #0D299A;
-}*/
-
-div.tabs {
- text-align: justify;
- margin-left : 2px;
- margin-right : 2px;
- margin-top : 2px;
- margin-bottom : 2px
- font-weight: bold;
- color: #FFFFFF;
-}
-
-DIV.div-footer {
- margin-left: 1em;
- margin-right: 1em;
- margin-bottom: 0.2em;
- text-align: right;
- font-size: 9pt;
-}
-
-/* In File List, Coumpound List, etc, 1st column of the index */
-TD.indexkey {
- background-color: #CCCCCC;
- font-weight: bold;
- padding-right : 10px;
- padding-top : 2px;
- padding-left : 10px;
- padding-bottom : 2px;
- margin-left : 0px;
- margin-right : 0px;
- margin-top : 2px;
- margin-bottom : 2px
-}
-
-/* In File List, Coumpound List, etc, 2nd column of the index */
-TD.indexvalue {
- background-color: #CCCCCC;
- font-style: italic;
- padding-right : 10px;
- padding-top : 2px;
- padding-left : 10px;
- padding-bottom : 2px;
- margin-left : 0px;
- margin-right : 0px;
- margin-top : 2px;
- margin-bottom : 2px
-}
-
-span.keyword { color: #008000 }
-span.keywordtype { color: #604020 }
-span.keywordflow { color: #e08000 }
-span.comment { color: #800000 }
-span.preprocessor { color: #806020 }
-span.stringliteral { color: #002080 }
-span.charliteral { color: #008080 }
+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-</head>
-<body>
-<hr style="width: 100%; height: 2px;">
-<div style="text-align: center;">Copyright © 2003-2007 CEA, EDF<br>
-</div>
-</body>
-</html>
+++ /dev/null
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <title>$title</title>
- <link href="tabs.css" rel="stylesheet" type="text/css">
- <link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
-<hr>
-<center>
-SALOME documentation central
-</center>
-<hr>
+++ /dev/null
-H1 {
- text-align: center;
-}
-
-CAPTION {
- font-weight: bold
-}
-
-/* Link in the top navbar */
-A.qindex {}
-
-A.qindexRef {}
-
-/* Link to any cross-referenced Doxygen element */
-A.el {
- text-decoration: none;
- font-weight: bold
-}
-
-A.elRef {
- font-weight: bold
-}
-
-/* Link to any cross-referenced Doxygen element inside a code section
- (ex: header)
-*/
-A.code {
- text-decoration: none;
- font-weight: normal;
- color: #4444ee
-}
-
-A.codeRef {
- font-weight: normal;
- color: #4444ee
-}
-
-A:hover {
- text-decoration: none;
- background-color: lightblue
-}
-
-DL.el {
- margin-left: -1cm
-}
-
-/* A code fragment (ex: header) */
-DIV.fragment {
- width: 100%;
- border: none;
- background-color: #CCCCCC
-}
-
-/* In the alpha list (coumpound index), style of an alphabetical index letter */
-DIV.ah {
- background-color: #CCCCCC;
- font-weight: bold;
- color: #ffffff;
- margin-bottom: 3px;
- margin-top: 3px
-}
-
-/* Method name (+ type) */
-TD.md {
- background-color: lightblue;
- font-weight: bold;
-}
-
-/* Method parameter (some of them) */
-TD.mdname1 {
- background-color: lightblue;
- font-weight: bold; color: #602020;
-}
-
-/* Method parameter (some of them) */
-TD.mdname {
- background-color: lightblue;
- font-weight: bold;
- color: #602020;
- width: 600px;
-}
-
-/* Separator between methods group (usually empty, seems not supported by IE) */
-DIV.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- margin-bottom: 6px;
- font-weight: bold
-}
-
-DIV.groupText {
- margin-left: 16px;
- font-style: italic;
- font-size: smaller
-}
-
-BODY {
- background: #FFFFFF;
-}
-
-/*div.div-page {
- background-color: #FFFFFF;
- margin-left: 1em;
- margin-right: 1em;
- margin-top: 1em;
- margin-bottom: 0.1em;
-
- padding-left: 1em;
- padding-right: 1em;
- padding-top: 0.5em;
- padding-bottom: 0.5em;
-
- border: 2px solid #0D299A;
- border-width: 2px;
- border-color: #0D299A;
-}*/
-
-div.tabs {
- text-align: justify;
- margin-left : 2px;
- margin-right : 2px;
- margin-top : 2px;
- margin-bottom : 2px
- font-weight: bold;
- color: #FFFFFF;
-}
-
-DIV.div-footer {
- margin-left: 1em;
- margin-right: 1em;
- margin-bottom: 0.2em;
- text-align: right;
- font-size: 9pt;
-}
-
-/* In File List, Coumpound List, etc, 1st column of the index */
-TD.indexkey {
- background-color: #CCCCCC;
- font-weight: bold;
- padding-right : 10px;
- padding-top : 2px;
- padding-left : 10px;
- padding-bottom : 2px;
- margin-left : 0px;
- margin-right : 0px;
- margin-top : 2px;
- margin-bottom : 2px
-}
-
-/* In File List, Coumpound List, etc, 2nd column of the index */
-TD.indexvalue {
- background-color: #CCCCCC;
- font-style: italic;
- padding-right : 10px;
- padding-top : 2px;
- padding-left : 10px;
- padding-bottom : 2px;
- margin-left : 0px;
- margin-right : 0px;
- margin-top : 2px;
- margin-bottom : 2px
-}
-
-span.keyword { color: #008000 }
-span.keywordtype { color: #604020 }
-span.keywordflow { color: #e08000 }
-span.comment { color: #800000 }
-span.preprocessor { color: #806020 }
-span.stringliteral { color: #002080 }
-span.charliteral { color: #008080 }
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
-
- <meta http-equiv="Content-Type"
- content="text/html; charset=iso-8859-1">
-
- <meta name="GENERATOR"
- content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Main Page</title>
-
- <link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
- <body>
-
-<center>
-<table width="96%">
- <tbody>
- <tr>
- <td><a href="http://www.opencascade.com"><img
- src="sources/logocorp.gif" border="0" height="46" width="122">
- </a></td>
- <td>
- <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
- src="sources/application.gif" border="0" height="46" width="108">
- </a></div>
- </td>
- </tr>
-
- </tbody>
-</table>
-</center>
-
-<h1><a name="page2">Examples</a> </h1>
- <small><i><big><b>Package SALOME</b></big></i></small><b><i>_ModuleCatalog</i></b><br>
-<small><br>
- <big>interface <a href="#module_catalog">SALOME_ModuleCatalog::ModuleCatalog</a></big><br>
-<br>
-<i><big><b>Package SALOME<br>
-<br>
- </b></big></i></small>interface<a href="#Session"> SALOME::Session</a><br>
-<br>
-<small><i><big><b>Package Engines<br>
- </b></big></i><i><big><b> </b></big></i></small><br>
- interface <a href="#container">Engines::Container</a><small><br>
-</small><small><br>
-<i><big><b> <br>
- </b></big></i></small><br>
-<br>
-<div align="center"> <u><font
- face="Helvetica, Arial, sans-serif"><big><big><b><small><big><a
- name="module_catalog"></a>SALOME_ModuleCatalog::ModuleCatalog interface</big></small></b></big></big></font></u>
-<br>
-</div>
-<br>
-<div align="center"><big><big><u><b><font
- face="Helvetica, Arial, sans-serif"><br>
-</font></b></u></big></big>
-<div align="left"><br>
-<big><b><a class="el"
- href="interfaceSALOME__ModuleCatalog_1_1Acomponent.html">Acomponent</a>
-GetComponent (in string <i>componentname</i>)</b></big><br>
-<br>
-See the <a href="#load_com_ex">example</a> below<br>
-<br>
-</div>
-<big><big><u><b><font face="Helvetica, Arial, sans-serif"><br>
-</font></b><small><font face="Helvetica, Arial, sans-serif"><big><b><a
- name="Session"></a>SALOME::Session interface</b></big></font></small></u></big></big><br>
-<div align="left"><br>
-<br>
-<big><b>GetInterface ()</b><b>, StopSession () raises (GUIActive, RunningStudies)</b></big><br>
-<br>
-<u><i>Stop session and restart GUI application: </i></u><br>
-<br>
-mySession.StopSession()<br>
-<br>
-mySession.GetInterface()<br>
-<br>
-<br>
-<div align="center"><u><big><big><font
- face="Helvetica, Arial, sans-serif"><b><a name="container"></a>Engines::Container
-interface</b></font></big></big></u><br>
-<br>
-<br>
-<div align="left"><big><b><a class="el"
- href="interfaceEngines_1_1Component.html">Component</a>
-load_impl (in string <i>nameToRegister</i>, in string <i>componentName</i>)</b></big><br>
-<br>
-<i><u><a name="load_com_ex"></a>Load component with defined component name:</u></i><br>
-<br>
-compinfo = module_catalog.GetComponent(componentName)<br>
-<br>
- try:<br>
- machineName = theComputer # name of machine<br>
- path = compoinfo.GetPathPrefix(machineName) + "/"<br>
- except SALOME_ModuleCatalog.NotFound, ex:<br>
- MESSAGE( "machine " + machineName + " not found in Module
-Catalog" )<br>
- MESSAGE( "trying localhost" )<br>
- try:<br>
- path = compoinfo.GetPathPrefix("localhost") + "/"<br>
- except SALOME_ModuleCatalog.NotFound, ex:<br>
- path = ""<br>
-<br>
-implementation = path + "lib" + componentName + "Engine.so"<br>
-MESSAGE( "Trying to load " + implementation )<br>
-<br>
- try:<br>
-<div align="left"> component = container.load_impl(componentName,
-implementation)<i> # Loads into the container a new component, registers
-it and starts it's CORBA servant. </i><br>
-</div>
- MESSAGE( "component " + component._get_instanceName()
-+ " launched !" )<br>
- return component<br>
-except:<br>
- MESSAGE( "component " + componentName + " NOT launched
-!" )<br>
-<br>
-<br>
-</div>
-<br>
-</div>
-<br>
-</div>
-<br>
-</div>
-
-<br>
-<br>
-<br>
-</body>
-</html>
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
-
- <meta http-equiv="Content-Type"
- content="text/html; charset=iso-8859-1">
-
- <meta name="GENERATOR"
- content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Main Page</title>
-
- <link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
- <body>
-
-<center>
-<table width="96%">
- <tbody>
- <tr>
- <td><a href="http://www.opencascade.com"><img
- src="sources/logocorp.gif" border="0" height="46" width="122">
- </a></td>
- <td>
- <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
- src="sources/application.gif" border="0" height="46" width="108">
- </a></div>
- </td>
- </tr>
-
- </tbody>
-</table>
-</center>
-
-<h1><a name="page2">Examples</a> </h1>
- <font color="#3333ff">//There is a CXX example of LifeCycleCORBA using<br>
-</font><br>
-#include CORBA_CLIENT_HEADER(TestComponent)<br>
-#include "SALOME_NamingService.hxx"<br>
-#include "SALOME_LifeCycleCORBA.hxx"<br>
-<br>
-int main (int argc, char * argv[]){<br>
- try {<br>
-<font color="#3333ff"> // Initializing omniORB<br>
-</font> CORBA::ORB_var orb = CORBA::ORB_init(argc,
-argv);<br>
- <br>
-<font color="#3333ff"> // Obtain a reference
-to the root POA<br>
-</font> CORBA::Object_var obj = orb->resolve_initial_references("RootPOA")
-;<br>
- PortableServer::POA_var poa = PortableServer::POA::_narrow(obj)
-;<br>
- <br>
- SALOME_NamingService _NS(orb) ;<br>
-<br>
- SALOME_LifeCycleCORBA _LCC(&_NS) ;<br>
-<br>
- Engines::Component_var myComponent = _LCC.FindOrLoad_Component("FactoryServerPy","TestComponentPy");<br>
- if(!CORBA::is_nil(myComponent)){<br>
- Engines::TestComponent_var
-myConcreateComponent = TestComponent::_narrow(myComponent);<br>
-<font color="#3333ff"> //do something
-what you like with the interface<br>
- ...<br>
-</font> return 0;<br>
- }<br>
- }<br>
- catch(CORBA::COMM_FAILURE& ex){<br>
- cout<<"Caught system exception COMM_FAILURE
--- unable to contact the object.\n";<br>
- }catch(CORBA::SystemException&){<br>
- cout<<"Caught a CORBA::SystemException.\n";<br>
- }catch(CORBA::Exception&){<br>
- cout<<"Caught CORBA::Exception.\n";<br>
- }catch(...){<br>
- cout<<"Caught unknown exception.\n";<br>
- }<br>
- return 1;<br>
-}<br>
-<br>
-<font color="#3333ff">#The example may be rewritten on Python like this:<br>
-</font><br>
-from omniORB import CORBA<br>
-from SALOME_TestComponent import *<br>
-from SALOME_NamingServicePy import *<br>
-from LifeCycleCORBA import *<br>
-<br>
-try:<br>
- orb = CORBA.ORB_init(sys.argv,CORBA.ORB_ID)<br>
- _NS = SALOME_NamingService(orb)<br>
- _LCC = SALOME_LifeCycleCORBA(orb)<br>
-<br>
- myComponent = _LCC.FindOrLoadComponent("FactoryServerPy","TestComponentPy");<br>
- myConcreatComponent = myComponent._narrow(TestComponent)<br>
- if myConcreatComponent is not None :<font
- color="#3333ff"><br>
- //do something what you like with the
-interface<br>
- ...<br>
- </font> return 0<br>
- }<br>
-except CosNaming.NamingContext.NotFound, e :<br>
- print "Caught exception: Naming Service can't found Logger"<br>
-except CORBA.COMM_FAILURE, e:<br>
- print "Caught CORBA::SystemException CommFailure"<br>
-except CORBA.SystemException, e:<br>
- print "Caught CORBA::SystemException."<br>
-except CORBA.Exception, e:<br>
- print "Caught CORBA::Exception."<br>
-except Exception, e:<br>
- print "Caught unknown exception."<br>
- <br>
-<br>
-<br>
-</body>
-</html>
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
-
- <meta http-equiv="Content-Type"
- content="text/html; charset=iso-8859-1">
-
- <meta name="GENERATOR"
- content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Main Page</title>
-
- <link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
- <body>
-
-<center>
-<table width="96%">
- <tbody>
- <tr>
- <td><a href="http://www.opencascade.com"><img
- src="sources/logocorp.gif" border="0" height="46" width="122">
- </a></td>
- <td>
- <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
- src="sources/application.gif" border="0" height="46" width="108">
- </a></div>
- </td>
- </tr>
-
- </tbody>
-</table>
-</center>
-
-<h1><a name="page2">Examples</a> </h1>
- <font color="#3333ff">#There is a python example of using SALOME_NamingService<br>
-</font><br>
-from omniORB import CORBA<br>
-from time import sleep<br>
-from LifeCycleCORBA import *<br>
-from SALOME_NamingServicePy import *<br>
-<br>
-<font color="#3333ff"># initialise the ORB<br>
-</font>orb = CORBA.ORB_init([''], CORBA.ORB_ID)<br>
-<br>
-<font color="#3333ff"># create an LifeCycleCORBA instance<br>
-</font>myLifeCycleCORBA = LifeCycleCORBA(orb)<br>
-<br>
-<font color="#3333ff">#create a naming service instance<br>
-</font>naming_service = SALOME_NamingServicePy_i(orb)<br>
-<br>
-mySession = myNamingService.Resolve("/Kernel/Session")<br>
-mySession.GetInterface()<br>
-sleep(10)<br>
-myLocalVisu = myLifeCycleCORBA.FindOrLoadComponent("FactoryServer", "Visu")<br>
-<br>
-<br>
-<font color="#3333ff">//There is some part of a code written by C++<br>
-</font><br>
-SALOME_NamingService aNamingService(orb);<br>
-CORBA::Object_ptr anObject = aNamingService.Resolve("/Kernel/Session");<br>
-SALOME::Session_var aSession = SALOME::Session::_narrow(anObject);<br>
-Engines::Component_var aComponent = aSession->GetVisuGen();<br>
-myVisuGen = VISU::VISU_Gen::_narrow(aComponent);<br>
-<br>
-</body>
-</html>
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
-
- <meta http-equiv="Content-Type"
- content="text/html; charset=iso-8859-1">
-
- <meta name="GENERATOR"
- content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Main Page</title>
-
- <link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
- <body>
-
-<center>
-<table width="96%">
- <tbody>
- <tr>
- <td><a href="http://www.opencascade.com"><img src="sources/ogocorp.gif"
- border="0" height="46" width="122">
- </a></td>
- <td>
- <div align="right"><a href="http://www.opencascade.org/SALOME/"><img
- src="sources/application.gif" border="0" height="46" width="108">
- </a></div>
- </td>
- </tr>
-
- </tbody>
-</table>
- </center>
-
-<h1><a name="page2">Examples</a> </h1>
- <br>
- <br>
-
-<div align="justify"> <big><b><i> <small>Interfaces:</small></i></b></big><br>
- <br>
- <a href="#SALOMEDS::Study_impl">SALOMEDS::Study</a><br>
- <a href="#SALOMEDS::StudyBuilder_impl">SALOMEDS::StudyBuilder</a><br>
- <a href="#SALOMEDS::StudyManager_impl">SALOMEDS::StudyManager</a><br>
- <a href="#SALOMEDS::SObject_impl">SALOMEDS::SObject</a><br>
- <a href="#SALOMEDS::SComponent_impl">SALOMEDS::SComponent</a><br>
- <a href="#SALOMEDS::SComponentIterator_impl">SALOMEDS::SComponentIterator</a><br>
- <a href="#SALOMEDS::ChildIterator_impl">SALOMEDS::ChildIterator<br>
- </a> <a href="#SALOMEDS::AttributeComment_impl"> SALOMEDS::AttributeComment</a><br>
- <br>
- </div>
- <br>
- <br>
- <br>
-
-<div align="center"> <small><small><u><big><big><a
- name="SALOMEDS::Study_impl"></a><font color="#000000"
- face="Helvetica, Arial, sans-serif"><big><big><b>SALOMEDS::Study interface</b></big></big></font></big></big></u></small></small><br>
- <br>
-
-<div align="left"> <big><br>
- </big></div>
- <big><br>
- </big>
-<div align="left"><b><big><a class="el"
- href="interfaceSALOMEDS_1_1SComponent.html">SComponent</a> FindComponent(
-in string <i>aComponentName </i>)</big></b><br>
- <i><br>
- <u>Find GEOMETRY component in the opened study by its name:</u></i><br>
- <br>
- str= os.getenv("TmpDir")<br>
- if str == None:<br>
- str = "/tmp"<br>
- file = str+"/test.hdf"<br>
- <br>
- openedStudy=batchmode_geompy.myStudyManager.Open(file)<br>
- <br>
- father = openedStudy.FindComponent("GEOM")<br>
- if father is None:<br>
- raise RuntimeError, "Geom
- component is not found! Wrong study is opened." <br>
- <br>
- <br>
- </div>
-
-<div align="left"><b><big><a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> FindObject ( in string
-<em>anObjectName </em>)</big></b><br>
- <br>
- <u><i>Find the SObject of the box by its NameAttribute "box":</i></u><br>
- </div>
-
-<div align="left"><br>
- </div>
-
-<div align="left">box = openedStudy.FindObject("box")<br>
- if box is None :<br>
- raise RuntimeError, "box was not found! Wrong
-study is opened."<br>
- <br>
- <br>
- <small><big><big><a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a></big></big><b><big><big> FindObjectID
- ( in</big> <big><a class="el" href="namespaceSALOMEDS.html#a1">ID</a> </big><em><big>aObjectID
-)</big><br>
- #result: "/User data/Case1". <br>
- </em><big><em></em></big><big><em></em></big></big></b></small><u><i>Find
- the SObject of the box by its ID </i>"</u><u>0:1:1:2"<i>:</i></u><br>
- <br>
- </div>
-
-<div align="left">box =openedStudy.FindObjectID("0:1:1:2")<br>
- </div>
-
-<div align="left">if box is None :<br>
- raise RuntimeError, "box was not found! Wrong
-ID is used."<br>
- <br>
- <br>
- <small><big><big><a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a></big></big></small><big><b> FindObjectIOR
- ( in <a class="el" href="namespaceSALOMEDS.html#a1">ID</a> <em>aObjectIOR</em>
-)</b></big><br>
- <br>
- <u><i>Find the SObject </i></u><u><i>of the result on imported MED file
-by it's IOR:</i></u><br>
- <br>
- theResult = myVisu.ImportFile(medFile)<br>
- aSObj = myStudy.FindObjectIOR(theResult.GetID())<br>
- <br>
- <br>
- <big><b><a class="el" href="interfaceSALOMEDS_1_1SObject.html">SObject</a>
- FindObjectByPath ( in string <i>thePath</i> )</b></big><br>
- <br>
- <u><i>Find SObject by path to it:</i></u><br>
- <i><br>
- # create new auxiliary componen</i>t<br>
- aComponent = myStudyBuilder.NewComponent("Virtual Component")<br>
- <br>
- # create auxiliary subtree<br>
- aPath = "/Virtual Component/Case1"<br>
- myStudyBuilder.AddDirectory(aPath)<br>
- <br>
- aSObj = myStudy.FindObjectByPath(aPath)<br>
- <br>
- <br>
- <big><b>void SetContext ( in string <i>thePath</i>)</b> </big><b><big><big>/</big>
- string GetContext ()</big></b><br>
- <br>
- <u><i>Set context of the study to the created case and get it for printing:</i></u><br>
- <br>
- aComponent = myStudyBuilder.NewComponent("User data")<br>
- anAttr = aBuilder.FindOrCreateAttribute(aComponent, "AttributeName")<br>
- anAttrName = anAttr._narrow(SALOMEDS.AttributeName) <br>
- anAttrName.SetValue("User data")<br>
- <br>
- #Add a new case 'Case1' to the component 'User data'<br>
- aBuilder.AddDirectory("/User data/Case1")<br>
- <br>
- #Set a study context to '/User data/Case1'<br>
- aStudy.SetContext("/User data/Case1")<br>
- <br>
- #Print the current study context<br>
- print aStudy.GetContext()<br>
- <u><small><br>
- </small><i>#result: "/User data/Case1".</i></u><br>
- <br>
- <br>
- <big><b><a class="el" href="interfaceSALOMEDS_1_1ChildIterator.html">ChildIterator</a>
- NewChildIterator ( in <a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> aSO ) </b></big><br>
- <br>
- <u><i>Import med file and print all mesh names that this file includes
-(mesh is a child of the result of imported file):</i></u><br>
- <br>
- <i># define file name</i><br>
- aFileName = datadir + "fra.med"<br>
- <br>
- <i># import file in visu module and get result</i><br>
- theVisu = batchmode_visu.myVisu<br>
- aResult = theVisu.ImportFile(aFileName)<br>
- if aResult is None : raise RuntimeError, "Error"<br>
- else : print "OK"<br>
- <br>
- <i># get current study and its' SObject </i>
- <br>
- myLocalStudy = theVisu.GetCurrentStudy()<br>
- aSObj = myLocalStudy.FindObjectIOR(aResult.GetID())<br>
- if aSObj is None : raise RuntimeError, "Error"<br>
- else : print "OK"<br>
- <br>
- <i># create iterator by SObject of the current study</i><br>
- aMeshIter = myLocalStudy.NewChildIterator(aSObj);<br>
- <br>
- <i># iterating in the current study (with the help of created iterator)
-to find all mesh names</i> <br>
- while aMeshIter.More() :<br>
- aMeshSObj = aMeshIter.Value()<br>
- aMeshIter.Next()<br>
- anAttr = aMeshSObj.FindAttribute("AttributeName")[1]<br>
- if anAttr is None :<br>
- aMeshSObj
- = aMeshIter.Value()<br>
- aMeshIter.Next()<br>
- anAttr
- = aMeshSObj.FindAttribute("AttributeName")[1]<br>
- anAttr = anAttr._narrow(SALOMEDS.AttributeName);<br>
- aMeshName = anAttr.Value()<br>
- print " ", aMeshName<br>
- <br>
- <br>
- <big><b><a class="el"
- href="interfaceSALOMEDS_1_1SComponentIterator.html">SComponentIterator</a>
-NewComponentIterator ()</b></big><br>
- <br>
- <u><i>Find the number an names of all components in the study:</i></u><br>
- <br>
- aCompItr = myStudy.NewComponentIterator()<br>
- <br>
- compNb = 0<br>
- while aCompItr.More():<br>
- aComp = aCompItr.Value()<br>
- aName = aComp.ComponentDataType()<br>
- print "Component name = ", aName<br>
- compNb += 1<br>
- aCompItr.Next()<br>
- <br>
- <br>
- <big><b><a class="el" href="interfaceSALOMEDS_1_1StudyBuilder.html">StudyBuilder</a>
-NewBuilder ()</b></big><br>
- </div>
- </div>
- <br>
- <i><u>Create a new StudyBuilder (uses to add or modify an object in the
-study ):</u></i><br>
- <br>
- myBuilder = myStudy.NewBuilder() <br>
- <br>
- <br>
- <big><b><a class="el"
- href="interfaceSALOMEDS_1_1AttributeStudyProperties.html">AttributeStudyProperties</a>
-GetProperties ()</b></big><br>
- <br>
- <i><u>Get the attribute, which contains the properties of the study, and
-change properties of the study </u></i><u>by changing it</u>: <br>
- <br>
- aProperties = myStudy.GetProperties()<br>
- if aProperties == None :<br>
- raise RuntimeError, "Can't create AttributeStudyProperties
-attribute"<br>
- aProperties = aProperties._narrow(SALOMEDS.AttributeStudyProperties)<br>
- <br>
- A = aProperties<br>
- <br>
- <i># print stydy properties</i><br>
- print "A.GetUserName()= ", A.GetUserName()<br>
- res,mm,hh,dd,mnth,yy=A.GetCreationDate()<br>
- print "A.GetCreationDate() = ", mm,hh,dd,mnth,yy<br>
- print "A.GetCreationMode() = ", A.GetCreationMode()<br>
- print "A.IsModified() = ", A.IsModified()<br>
- print "A.IsLocked() = ", A.IsLocked()<br>
- <br>
- <i># change the properties of the study</i><br>
- if A.IsLocked() == 0 :<br>
- A.SetUserName("tester"); print 'A.SetUserName("tester"),
-A.GetUserName() = ', A.GetUserName()<br>
- A.SetCreationDate(11,11,11,11,2002); print 'A.SetCreationDate(11,11,11,11,2002),
-A.GetCreationDate() =', A.GetCreationDate()<br>
- print "A.IsModified() = ", A.IsModified()<br>
- A.SetLocked(1)<br>
- <br>
- <br>
- <big><b>boolean IsModified ()</b></big><br>
- <br>
- <u><i>Find if study is modified:</i></u><br>
- <br>
- IsModified = myStudy.IsModified()<br>
- <br>
- if IsModified == 1:<br>
- print "The study is modified and not saved"<br>
- <br>
- <br>
- <big><b>boolean IsEmpty ()</b></big><br>
- <br>
- <u><i>Find if study is empty:</i></u><br>
- <br>
- IsEmpty = myStudy.IsEmpty()<br>
- <br>
- if IsEmpty == 1:<br>
- print "The study is empty"<br>
- <br>
- <br>
- <br>
- <br>
-
-<div align="center"><small><small><u><big><big><a
- name="SALOMEDS::StudyBuilder_impl"></a><font color="#000000"
- face="Helvetica, Arial, sans-serif"><big><big><b>SALOMEDS::StudyBuilder
-interface</b></big></big></font></big></big></u></small></small><br>
- </div>
- <br>
- <br>
- <br>
- <big><b><a class="el" href="interfaceSALOMEDS_1_1SComponent.html">SComponent</a>
-NewComponent ( in string <i>ComponentDataType</i> )</b></big><br>
- <br>
- <u><i>Create Geometry SComponent:</i></u><br>
- <br>
- myBuilder = myStudy.NewBuilder()<br>
- father = myBuilder.NewComponent("GEOM")<br>
- <br>
- <big><b><br>
- void DefineComponentInstance ( in <a class="el"
- href="interfaceSALOMEDS_1_1SComponent.html">SComponent</a> <i>aComponent</i>,
-in Object <i>ComponentIOR</i> )</b></big><br>
- <br>
- <u><i>Define the instance to the created geometry component:</i></u><br>
- <br>
- <i># find geom component</i><br>
- myLCC = batchmode_salome.lcc<br>
- geom = myLCC.FindOrLoadComponent("FactoryServer", "Geometry")<br>
- geom = geom._narrow(GEOM.GEOM_Gen)<br>
- geom.GetCurrentStudy(myStudyId)<br>
- <br>
- myBuilder = myStudy.NewBuilder()<br>
- <br>
- father = myBuilder.NewComponent("GEOM")<br>
- myBuilder.DefineComponentInstance(father,geom)<br>
- <br>
- <br>
- <big><b><a class="el" href="interfaceSALOMEDS_1_1SObject.html">SObject</a>
-NewObject ( in <a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> <i>theFatherObject</i>
-)</b></big><br>
- <br>
- <u><i>Create box and add it to study:</i></u><br>
- <br>
- from batchmode_geompy import *<br>
- <br>
- <i># create a box</i><br>
- box = geom.MakeBox(0,0,0,100,100,150)<br>
- <br>
- ior = orb.object_to_string(box)<br>
- box._set_Name(ior) <br>
- <br>
- <i># create Geometry SComponent</i><br>
- father = myBuilder.NewComponent("GEOM")<br>
- A1 = myBuilder.FindOrCreateAttribute(father, "AttributeName");<br>
- FName = A1._narrow(SALOMEDS.AttributeName)<br>
- FName.SetValue("Geometry")<br>
- myBuilder.DefineComponentInstance(father,geom)<br>
- <br>
- <i># add box to Study</i><br>
- myBuilder.NewCommand()<br>
- newObj = myBuilder.NewObject(father)<br>
- A1 = myBuilder.FindOrCreateAttribute(newObj, "AttributeIOR");<br>
- ObjIOR = A1._narrow(SALOMEDS.AttributeIOR)<br>
- ObjIOR.SetValue(ior)<br>
- A2 = myBuilder.FindOrCreateAttribute(newObj, "AttributeName");<br>
- ObjName = A2._narrow(SALOMEDS.AttributeName)<br>
- ObjName.SetValue("Common_operation")<br>
- id = newObj.GetID()<br>
- box._set_StudyShapeId(id)<br>
- myBuilder.CommitCommand()<br>
- <br>
- <br>
- <b><big>void RemoveObject ( in <a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> <i>anObject</i> )</big></b><br>
- <br>
- <u><i># Remove CutPlanes SObject from the StudyBuilder (delete cutplanes):</i></u><br>
- <br>
- SObj=myStudy.FindObjectIOR(cutplanes.GetID())<br>
- myBuilder = newStudy.NewBuilder()<br>
- myBuilder.RemoveObject(SObj)<br>
- <br>
- <b><big><br>
- void LoadWith ( in <a class="el"
- href="interfaceSALOMEDS_1_1SComponent.html">SComponent</a><i> sco</i>, in
-<a class="el" href="interfaceSALOMEDS_1_1Driver.html">Driver</a> <i>Engine</i>
-) raises (<a class="el" href="exceptionSALOME_1_1SALOME__Exception.html">SALOME::SALOME_Exception</a>)</big></b><br>
- <br>
- <i><u># Load Visu component:</u></i><br>
- <br>
- myBuilder = openedStudy.NewBuilder()<br>
- SCom=openedStudy.FindComponent("VISU")<br>
- myBuilder.LoadWith(SCom ,myVisu)<br>
- <br>
- <br>
- <big><b><a class="el" href="interfaceSALOMEDS_1_1GenericAttribute.html">GenericAttribute</a>
-FindOrCreateAttribute ( in <a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> <i>anObject</i>,
-in string <i>aTypeOfAttribute</i>)</b></big><br>
- <br>
- <u><i>Create AttributeName attribute for created component an set value
-to it:</i></u><br>
- <br>
- myBuilder = myStudy.NewBuilder()<br>
- aComponent = myBuilder.NewComponent("User data")<br>
- <br>
- anAttr = myBuilder.FindOrCreateAttribute(aComponent, "AttributeName")<br>
- <br>
- anAttrName = anAttr._narrow(SALOMEDS.AttributeName) <br>
- anAttrName.SetValue("User data")<br>
- <br>
- <br>
- <big><b>boolean FindAttribute ( in <a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> <i>anObject,</i> out<i> </i><a
- class="el" href="interfaceSALOMEDS_1_1GenericAttribute.html">GenericAttribute</a><i>
-anAttribute</i>, in string <i>aTypeOfAttribute</i> )</b></big><br>
- <big><b><br>
- </b></big><i><u>Find AttributeName attribute of the field and print the
-field name:</u></i><br>
- <br>
- aFieldSObj = myStudy.FindObject("Head, -")<br>
- <br>
- myStudyBuilder.FindAttribute( aFieldSObj, anAttr, "AttributeName")<br>
- if res == 0:<br>
- raise RuntimeError, "Error: Attribute not
-found"<br>
- <br>
- anAttr = anAttr._narrow(SALOMEDS.AttributeName);<br>
- aFieldName = anAttr.Value()<br>
- print " ", aFieldName<br>
- <br>
- <br>
- <b><big>void RemoveAttribute ( in <a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> <i>anObject</i>, in
-string <i>aTypeOfAttribute</i> )</big></b><br>
- <big><b><br>
- </b><u><i><small>Remove AttributeSelectable attribute of the field SObject:</small></i></u><br>
- <b><br>
- </b></big>aFieldSObj = myStudy.FindObject("Head, -")<br>
- <br>
- myStudyBuilder.RemoveAttribute( aFieldSObj, "AttributeSelectable")<br>
- <big><b><br>
- <br>
- </b><b>void Addreference ( in <big> <small><a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a></small></big><small>
-</small><i>anObject</i>, in </b><b> <a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> <i>theReferencedObject</i>
-)</b></big><br>
- <br>
- <u><i>Create a reference between created SObject and the existing field:</i></u><br>
- <br>
- aFieldSObj = myStudy.FindObject("Head, -")<br>
- aNewSObj = myBuilder.NewObject(myVisu)<br>
- <br>
- myBuilder.Addreference(aFieldSObj, aNewSObj)<br>
- <big><b><br>
- <br>
- </b></big><big><small><i><u><a name="NewCommand_ex"></a></u></i></small></big><big><small><b><big>void
-NewCommand ()<br>
- <br>
- </big></b><i><u>Create new command wich containes actions for changing the
-properties of the study:</u></i><b><big><br>
- <br>
- </big></b></small></big>A = myStudy.GetProperties()<br>
- A = aProperties._narrow(SALOMEDS.AttributeStudyProperties)<br>
- <br>
- myBuilder = myStudy.NewBuilder()<br>
- <br>
- myBuilder.NewCommand() <i> # creates a new command</i><br>
- <br>
- <i># change the properties of the study</i><br>
- if A.IsLocked() == 0 :<br>
- A.SetUserName("tester"); print 'A.SetUserName("tester"),
-A.GetUserName() = ', A.GetUserName()<br>
- A.SetCreationDate(11,11,11,11,2002); print 'A.SetCreationDate(11,11,11,11,2002),
-A.GetCreationDate() =', A.GetCreationDate()<br>
- print "A.IsModified() = ", A.IsModified()<br>
- A.SetLocked(1)<br>
- <big><small><br>
- </small></big>myBuilder.CommitCommand() <i># commits all actions declared
-within the created command</i><big><br>
- <b><br>
- <br>
- void CommitCommand()<br>
- </b><small><br>
- </small><i><small>See the end of the <a href="#NewCommand_ex">previous example</a></small></i><b><br>
- <br>
- <br>
- void AbortCommand ()</b></big><br>
- <br>
- <big><small><i><u>Create new command wich containes actions for changing
-the properties of the study, cancel all declared actions:</u></i></small></big><br>
- <br>
- A = myStudy.GetProperties()<br>
- A = aProperties._narrow(SALOMEDS.AttributeStudyProperties)<br>
- <br>
- myBuilder = myStudy.NewBuilder()<br>
- <br>
- myBuilder.NewCommand() <i> # creates a new command</i><br>
- <br>
- <i># change the properties of the study</i><br>
- if A.IsLocked() == 0 :<br>
- A.SetUserName("tester"); print 'A.SetUserName("tester"),
-A.GetUserName() = ', A.GetUserName()<br>
- A.SetCreationDate(11,11,11,11,2002); print 'A.SetCreationDate(11,11,11,11,2002),
-A.GetCreationDate() =', A.GetCreationDate()<br>
- print "A.IsModified() = ", A.IsModified()<br>
- A.SetLocked(1)<br>
- <big><small><br>
- </small></big>myBuilder.AbortCommand() <i># abort all actions declared
-within the created command</i><br>
- <br>
- <br>
- <big><b>void Undo () raises (<a class="el"
- href="exceptionSALOMEDS_1_1StudyBuilder_1_1LockProtection.html">LockProtection</a>)</b><b>
-<small>, </small></b></big><br>
- <big><b>void Redo ()</b></big> <big><b>raises (<a class="el"
- href="exceptionSALOMEDS_1_1StudyBuilder_1_1LockProtection.html">LockProtection</a>)</b></big><br>
- <br>
- <big><small><i><u>Create new command wich containes actions for changing
-the properties of the study, <br>
- cancel all declared actions and then redo it with the help of undo/redo
-mechanism:</u></i></small></big><br>
- <br>
- A = myStudy.GetProperties()<br>
- A = aProperties._narrow(SALOMEDS.AttributeStudyProperties)<br>
- <br>
- myBuilder = myStudy.NewBuilder()<br>
- <br>
- myBuilder.NewCommand() <i> # creates a new command</i><br>
- <br>
- <i># change the properties of the study</i><br>
- if A.IsLocked() == 0 :<br>
- A.SetUserName("tester"); print 'A.SetUserName("tester"),
-A.GetUserName() = ', A.GetUserName()<br>
- A.SetCreationDate(11,11,11,11,2002); print 'A.SetCreationDate(11,11,11,11,2002),
-A.GetCreationDate() =', A.GetCreationDate()<br>
- print "A.IsModified() = ", A.IsModified()<br>
- A.SetLocked(1)<br>
- <big><small><br>
- </small></big>myBuilder.CommitCommand() <i># commits all actions declared
-within the created command</i><br>
- <big><small><br>
- </small></big>myBuilder.Undo() <i># cancels all actions of the command<br>
- <br>
- </i>myBuilder.Redo() <i># redoes all actions of the command</i><br>
- <i><br>
- <br>
- <br>
- </i>
-<div align="center"><small><small><u><big><big><a
- name="SALOMEDS::StudyManager_impl"></a><font color="#000000"
- face="Helvetica, Arial, sans-serif"><big><big><b>SALOMEDS::StudyManager
-interface</b></big></big></font></big></big></u></small></small><br>
- </div>
- <i><br>
- <br>
- <br>
- </i><big><b><a class="el" href="interfaceSALOMEDS_1_1Study.html">Study</a>
-NewStudy ( in string <i>study_name</i> )</b></big><br>
- <i><br>
- <u>Create the study with the name "Test_Study":</u></i><br>
- <br>
- myNewStudy = myStudyManager.NewStudy("Test_Study")<br>
- <br>
- <br>
- <big><b><a class="el" href="interfaceSALOMEDS_1_1Study.html">Study</a> Open
-( in </b></big><a class="el" href="namespaceSALOMEDS.html#a0">URL</a><big><b>
-<i>aStudyUrl</i> ) raises </b></big>(<a class="el"
- href="exceptionSALOME_1_1SALOME__Exception.html">SALOME::SALOME_Exception</a>)<br>
- <br>
- <i><u>Open the study saved in the HDF file:</u></i><br>
- <br>
- file = 'saved_study.hdf'<br>
- <br>
- openedStudy=myStudyManager.Open(file)<br>
- <br>
- if openedStudy == None:<br>
- raise RuntimeError, "Can't open saved study!"<br>
- <br>
- <br>
- <big><b>void Save (in <a class="el"
- href="interfaceSALOMEDS_1_1Study.html">Study</a> <i>aStudy</i>, in boolean
-<i>theMultifile</i> )</b></big><big><b><br>
- <br>
- </b><small><u><i>Open study, import med file into it and save with the old
-path and filename:</i></u></small><b><br>
- <br>
- </b></big>file = "saved_study.hdf"<br>
- myMedFile ="medfile.med"<br>
- <br>
- openedStudy=myStudyManager.Open(file)<br>
- <br>
- myVisu.SetCurrentStudy(openedStudy)<br>
- myResult = myVisu.ImportFile(myMedFile)<br>
- <br>
- myStudyManager.Save(openedStudy, 0)<br>
- <br>
- <big><b><br>
- void SaveAs ( in <small><a class="el" href="namespaceSALOMEDS.html#a0">URL</a></small>
-<i>aUrl</i>, in <small> <a class="el"
- href="interfaceSALOMEDS_1_1Study.html">Study</a> </small><i>aStudy</i>,
- <small><em></em></small></b></big><big><b>in boolean <i>theMultifile
-</i>)</b><br>
- <br>
- <small><u><i>Open study from the file and resave it in several files (using
-Multifile option while saving)</i></u></small><br>
- <br>
- </big>file = "saved_study.hdf"<br>
- newfile = "resaved_study.hdf"<br>
- <br>
- openedStudy=myStudyManager.Open(file)<br>
- myStudyManager.SaveAs(newfile, openedStudy, 1)<br>
- <big><br>
- <br>
- void Close ( in <a class="el"
- href="interfaceSALOMEDS_1_1Study.html">Study</a> aStudy )</big><br>
- <br>
- <u><i>Close just opened study:</i></u><br>
- <br>
- file = "saved_study.hdf"<br>
- <br>
- openedStudy=myStudyManager.Open(file)<br>
- myStudyManager.Close(openedStudy)<br>
- <br>
- <br>
- <br>
-
-<div align="center"><small><small><u><big><big><a
- name="SALOMEDS::SObject_impl"></a><font color="#000000"
- face="Helvetica, Arial, sans-serif"><big><big><b>SALOMEDS::SObject interface</b></big></big></font></big></big></u></small></small><br>
- </div>
- <br>
- <br>
- <br>
- <big><b><a class="el" href="namespaceSALOMEDS.html#a1">ID</a> GetID ()</b></big><br>
- <br>
- <u><i>Create new SObject and get its ID:</i></u><br>
- <br>
- mySObj = myBuilder.NewObject(myFather)<br>
- <br>
- myID = mySObj.GetID()<br>
- <br>
- <br>
- <big><b><a class="el" href="interfaceSALOMEDS_1_1SComponent.html">SComponent</a>
-GetFatherComponent ()</b></big><br>
- <br>
- <u><i>Get father component of the SObject:</i></u><br>
- <br>
- myFather = mySObj.GetFatherComponent();<br>
- <br>
- <br>
- <big><b>boolean FindAttribute ( out <a class="el"
- href="interfaceSALOMEDS_1_1GenericAttribute.html">GenericAttribute</a> <i>anAttribute</i>,
-in string <i>aTypeOfAttribute </i>)</b></big><br>
- <br>
- <u><i>Find the AttributeName attribute of the field:</i></u><br>
- <br>
- aFieldSObj = myStudy.FindObject("Head, -")<br>
- <br>
- res = aFieldSObj.FindAttribute( anAttr, "AttributeName")<br>
- if res == 0:<br>
- raise RuntimeError, "Error: Attribute not
-found"<br>
- <br>
- <br>
- <big><b><a class="el" href="namespaceSALOMEDS.html#a9">ListOfAttributes</a>
-GetAllAttributes ()</b></big><br>
- <br>
- <i><u>Get list of all attributes of the SObject, find the number of attributes:</u></i><br>
- <br>
- attrs = mySObj.GetAllAttributes()<br>
- aLen = len(attrs) <i># number of attributes</i><br>
- <br>
- <br>
- <br>
- <br>
-
-<div align="center"><small><small><u><big><big><a
- name="SALOMEDS::SComponent_impl"></a><font color="#000000"
- face="Helvetica, Arial, sans-serif"><big><big><b>SALOMEDS::SComponent interface</b></big></big></font></big></big></u></small></small><br>
- </div>
- <br>
- <br>
- <br>
- <big><b>string ComponentDataType ()</b></big><br>
- <br>
- <i><u><a name="ComponentIterator_ex"></a>Print names of all components wich
-the study contains:</u></i><br>
- <br>
- aCompItr = myStudy.NewComponentIterator() <br>
- <br>
- while aCompItr.More():<br>
- aComp = aCompItr.Value()<br>
- aName = aComp.ComponentDataType()<br>
- print "Component name = ", aName<br>
- aCompItr.Next()<br>
- <br>
- <br>
- <i><b>Other methods are inherited.</b></i><br>
- <br>
- <br>
- <br>
- <br>
-
-<div align="center"><small><small><u><big><big><a
- name="SALOMEDS::SComponentIterator_impl"></a><font color="#000000"
- face="Helvetica, Arial, sans-serif"><big><big><b>SALOMEDS::SComponentIterator
- interface</b></big></big></font></big></big></u></small></small><br>
- </div>
- <br>
- <br>
- <br>
- <big><b>boolean More (), </b><b>void Next (), </b></big><big><b><a
- class="el" href="interfaceSALOMEDS_1_1SComponent.html">SComponent</a> Value
-()</b></big><br>
- <br>
- <big><i><small>See <a href="examples_Study.html#ComponentIterator_ex">another
-example</a></small></i></big><br>
- <br>
- <br>
- <br>
-
-<div align="center"><small><small><u><big><big><a
- name="SALOMEDS::ChildIterator_impl"></a><font color="#000000"
- face="Helvetica, Arial, sans-serif"><big><big><b>SALOMEDS::ChildIterator
- interface</b></big></big></font></big></big></u></small></small><br>
- </div>
- <br>
- <br>
- <br>
- <big><b>boolean More () , void Next (), <a class="el"
- href="interfaceSALOMEDS_1_1SObject.html">SObject</a> Value ()</b></big><br>
- <br>
- <u><i>Print all mesh names of imported MED file with the help of ChildIterator:</i></u><br>
- <br>
- aResult = myVisu.ImportFile("MedFile.med")<br>
- <br>
- myStudy = theVisu.GetCurrentStudy()<br>
- aSObj = myLocalStudy.FindObjectIOR(aResult.GetID())<br>
- <br>
- aMeshIter = myLocalStudy.NewChildIterator(aSObj); <i> # creating new
-child iterator</i><br>
- <br>
- while aMeshIter.More() :
-
- <i># check if one more
-child level exists. </i><br>
- aMeshSObj = aMeshIter.Value()
-
- # <i>returns the SObject corresponding
-to the current object found by the iterator. </i> <br>
- aMeshIter.Next() <i>
-
-
- # passes the iterator to the next level. </i><br>
- anAttr = aMeshSObj.FindAttribute("AttributeName")[1]<br>
- if anAttr is None :<br>
-
-aMeshSObj = aMeshIter.Value()<br>
-
- aMeshIter.Next()<br>
-
-anAttr = aMeshSObj.FindAttribute("AttributeName")[1]<br>
- anAttr = anAttr._narrow(SALOMEDS.AttributeName);<br>
- aMeshName = anAttr.Value()<br>
- print " ", aMeshName<br>
- <br>
- <br>
- <br>
-
-<div align="center"><small><small><u><big><big><a
- name="SALOMEDS::AttributeComment_impl"
- href="#SALOMEDS::AttributeComment_impl"></a><font color="#000000"
- face="Helvetica, Arial, sans-serif"><big><big><b>SALOMEDS::AttributeComment
- interface</b></big></big></font></big></big></u></small></small><br>
- </div>
- <br>
- <br>
- <big><b>string Value (), void SetValue ( in string <i>value </i>)</b></big><br>
- <br>
- <u><i>Find the AttributeComment attribute of the "Head" field in the study,
-print it, then change it to "My Comment" string:</i></u><br>
- <br>
- aFieldSObj = myStudy.FindObject("Head, -")<br>
- anAttr = aFieldSObj.FindAttribute("AttributeComment")[1]<br>
-
-anAttr = anAttr._narrow(SALOMEDS.AttributeComment);<br>
-
-aFieldComment = anAttr.Value()<br>
- <br>
- print "AttributeComment", anAttr<br>
- <br>
- anAttr.SetValue ("My Comment")<br>
-
-<pre></pre>
- <br>
-</body>
-</html>
+++ /dev/null
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Main Page</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
-<body>
-
-<center><table WIDTH="96%" >
-<tr>
-<td><a href="http://www.opencascade.com"><img SRC="sources/logocorp.gif" BORDER=0 height=46 width=122></a></td>
-
-<td>
-<div align=right><a href="http://www.opencascade.org/SALOME/"><img SRC="sources/application.gif" BORDER=0 height=46 width=108></a></div>
-</td>
-</tr>
-</table></center>
-<a NAME="page1"></a>
-<h2>
-Mapping of IDL definitions to Python language.</h2>
-<a NAME="Intro"></a>
-<h2>
-Introduction</h2>
-SALOME 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.
-<p>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.
-<p>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 source
-files. The complete version of Python Language Mapping Specification can
-be found <a href="http://www.omg.org" target="top">here.</a>
-<br>
-<p><a NAME="contents"></a><b>CONTENTS:</b>
-<ul>
-<li>
-<a href="#subsection1">Using Scoped Names</a></li>
-
-<li>
-<a href="#subsection2">Mapping for Template and Array Types</a></li>
-
-<li>
-<a href="#subsection3">Mapping for Objects and Operations</a></li>
-
-<li>
-<a href="#subsection4">Narrowing Object References</a></li>
-
-<li>
-<a href="#subsection5">Mapping for Exceptions</a></li>
-
-<li>
-<a href="#subsection6">Mapping for Enumeration Types</a></li>
-
-<li>
-<a href="#subsection7">Mapping for Structured Types</a></li>
-</ul>
-<br>
-<a NAME="subsection1"></a>
-<h3>
-Using Scoped Names</h3>
-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.
-<p>Because of these constraints, scoped names are translated into Python
-using the following rules:
-<p>\95 An IDL module mapped into a Python module. Modules containing modules
-are mapped to packages (i.e., directories with an <b>__init__</b> 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.
-<p>\95 For all other scopes, a Python class is introduced that contains all
-the definitions inside this scope.
-<p>\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.
-<p>For instance,
-<div class="fragment">
-<pre>module SALOMEDS {
- interface StudyManager {
- void Close(in Study aStudy);
- };
-};</pre>
-</div>
-would introduce a module SALOMEDS.py, which contains the following definitions:
-<div class="fragment">
-<pre># module SALOMEDS.py
-class StudyManager:
- def _Close(self,aStudy):
- pass #interfaces are discussed later</pre>
-</div>
-To avoid conflicts, IDL names that are also Python identifiers are prefixed
-with an underscore (\91_\92).
-<p><b><i><a href="#contents">Back to the contents</a></i></b><b><i></i></b>
-<p><a NAME="subsection2"></a>
-<h3>
-Mapping for Template and Array Types</h3>
-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:
-<p>\95 For the wide string X and the integer n, X[n] returns the nth character,
-which is a wide string of length 1.
-<p>\95 len(X) returns the number of characters of wide string X.
-<p>\95 CORBA.wstr(c) returns a wide character with the code point c in an
-implementation-defined encoding.
-<p>\95 X+Y returns the concatenation of wide strings X and Y.
-<p>\95 CORBA.word(CORBA.wstr(c)) == c
-<p>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.
-<p>For example, given the IDL definitions
-<div class="fragment">
-<pre>module SALOMEDS {
- typedef sequence <string> StringSeq;
-
- interface AttributeTableOfInteger : GenericAttribute {
-
- void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
- };
-};</pre>
-</div>
-a client could invoke the operation
-<div class="fragment">
-<pre>print My_AttributeTableOfInteger.SetRowTitles(["X","F"])</pre>
-</div>
-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.
-<p>Another example with arrays. The following IDL definition
-<div class="fragment">
-<pre>module SALOMEDS {
- typedef sequence<GenericAttribute> ListOfAttributes;
- interface SObject {
- ListOfAttributes GetAllAttributes();
- };
-};</pre>
-</div>
-is equal to
-<div class="fragment">
-<pre>import SALOMEDS
-
-attributes=[]
-
-attributes = My_SObject.GetAllAttributes()
-
-length = len(attributes)
-
-print "Attributes number = ", length
-print attributes</pre>
-</div>
-<b><i><a href="#contents">Back to the contents</a></i></b>
-<p><a NAME="subsection3"></a>
-<h3>
-Mapping for Objects and Operations</h3>
-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.
-<p>The nil object is represented by <b>None</b>.
-<p>If an operation expects parameters of the IDL Object type, any Python
-object representing an object reference might be passed as actual argument.
-<p>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.
-<p>Operations of an interface map to methods available on the object references.
-Parameters with a parameter attribute of <b>in</b> or <b>inout</b> are
-passed from left to right tothe method, skipping <b>out</b> parameters.
-The return value of a method depends on the number of <b>out</b> parameters
-and the return type. If the operation returns a value, this value forms
-the first <i>result value</i>. All <b>inout</b> or <b>out</b> parameters
-form consecutive <i>result values</i>. The method result depends then on
-the number of <i>result values</i>:
-<p>\95 If there is no <i>result value</i>, the method returns None.
-<p>\95 If there is exactly one <i>result value</i>, it is returned as a single
-value.
-<p>\95 If there is more than one <i>result value</i>, all of them are packed
-into a tuple, and this tuple is returned.
-<p>Assuming the IDL definition
-<div class="fragment">
-<pre>module SALOMEDS{
- interface StudyBuilder{
- boolean FindAttribute ( in SObject anObject,
- out GenericAttribute anAttribute,
- in string aTypeOfAttribute );
- };
-};</pre>
-</div>
-a client could write
-<div class="fragment">
-<pre>from SALOMEDS import StudyBuilder;
-my_StudyBuilder=...
-
- res,A=my_StudyBuilder.FindAttribute(Sobj, "AttributeSequenceOfReal")</pre>
-</div>
-In this example <b>A</b> corresponds to the return value <b>anAttribute</b>
-and <b>res</b> to the <b>boolean</b> return value.
-<p>If an interface defines an <b>attribute name</b>, for example, the attribute
-is mapped into an operation <b>_get_name</b>. If the attribute is not <b>readonly</b>,
-there is an additional operation <b>_set_name</b>.
-<p>The IDL definition
-<div class="fragment">
-<pre>module SALOMEDS{
- interface Study{
- attribute string Name;
- };
-};</pre>
-</div>
-is equal to the following
-<div class="fragment">
-<pre>from SALOMEDS import Study
-My_Study=...
- Name=My_Study._get_name();
- Name=My_Study._set_name();</pre>
-</div>
-<b><i><a href="#contents">Back to the contents</a></i></b><b><i><a href="#contents"></a></i></b>
-<p><a NAME="subsection4"></a>
-<h3>
-Narrowing Object References</h3>
-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.
-<p>Since there is no efficient and reliable way of automatically creating
-the most specific type, explicit narrowing is necessary. To narrow an object
-reference <b>A</b> to an interface class <b>AttributeSequenceOfReal</b>,
-the client can use the following operation
-<div class="fragment">
-<pre>A = A._narrow(SALOMEDS.AttributeSequenceOfReal)</pre>
-</div>
-<b><i><a href="#contents">Back to the contents</a></i></b><b><i><a href="#contents"></a></i></b>
-<p><a NAME="subsection5"></a>
-<h3>
-Mapping for Exceptions</h3>
-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
-<div class="fragment">
-<pre>module SALOMEDS{
- interface StudyBuilder{
- exception LockProtection {};
- void CommitCommand() raises(LockProtection);
- };
-};</pre>
-</div>
-could be used caught as
-<div class="fragment">
-<pre>from SALOMEDS import StudyBuilder;
-my_StudyBuilder=...
-try:
- my_StudyBuilder.CommitCommand();
-except StudyBuilder.LockProtection,value:
- print "Error! Study is locked for modifications"</pre>
-</div>
-
-<p><br><b><i><a href="#contents">Back to the contents</a></i></b><b><i><a href="#contents"></a></i></b>
-<p><a NAME="subsection6"></a>
-<h3>
-Mapping for Enumeration Types</h3>
-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
-<div class="fragment">
-<pre>module VISU {
- interface PrsObject{
-
- enum PrsObjType{ TCURVE, TTABLE, TMESH, TCONTAINER,
- TSCALARMAP, TISOSURFACE, TDEFORMEDSHAPE,
- TCUTPLANES, TVECTORS };
- };
-};</pre>
-</div>
-introduces the objects
-<div class="fragment">
-<pre>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</pre>
-</div>
-<b><i><a href="#contents">Back to the contents</a></i></b>
-<p><a NAME="subsection7"></a>
-<h3>
-Mapping for Structured Types</h3>
-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
-<div class="fragment">
-<pre>struct SDate {
- short Second;
- short Minute;
- short Hour;
- short Day;
- short Month;
- short Year;
- };</pre>
-</div>
-could be used in the Python statements
-<div class="fragment">
-<pre>Date=SDate(30, 12, 15, 26, 1, 79)
-print Date.Second,Date.Minute,Date.Hour,Date.Day,Date.Month,Date.Year</pre>
-</div>
-
-<address>
-<b><i><a href="#contents">Back to the contents</a></i></b></address>
-
-</body>
-<!-- Generated by Doxygen 1.2.14 -->
-</html>
+++ /dev/null
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Main Page</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
-<body>
-
-<center><table WIDTH="96%" >
-<tr>
-<td><a href="http://www.opencascade.com"><img src="sources/logocorp.gif" BORDER=0 height=46 width=122></a></td>
-
-
-<td>
-<div align=right><a href="http://www.opencascade.org/SALOME/"><img src="sources/application.gif" BORDER=0 height=46 width=108></a></div>
-</td>
-</tr>
-</table></center>
-
-
-<h1><a name="page2">General overview</a>
-</h1>
-<a name="cont"></a><h2>Table of contents </h2>
-<b><i>
-<ul>
- <li><a href="#1">1. Introduction</a></li>
- <li><a href="#2">2. Basic principles </a></li>
-
- <li><a href="#3">3. Services and features of the SALOME kernel module</a></li>
- <ul>
- <li><a href="#3_1">3.1 Session service</a></li>
- <li><a href="#3_2">3.2 Registry service </a></li>
- <li><a href="#3_3">3.3 Notification service </a></li>
- <li><a href="#3_4">3.4 Module catalog service </a></li>
- <li><a href="#3_5">3.5 Data type catalog </a></li>
- <li><a href="#3_6">3.6 Resource catalog </a></li>
- <li><a href="#3_7">3.7 Engine </a></li>
- <ul>
- <li><a href="#3_7_1">3.7.1 Component class </a></li>
- <li><a href="#3_7_2">3.7.2 Container class </a></li>
- </ul>
- </ul>
-</ul>
-</i> </b> <br>
-<a name="1"></a><h2>1. Introduction</h2>
-<p>The kernel corresponds to the minimal set of services required for the use of SALOME components (Supervisor, IAPP).
-The kernel is also used by application software components (solver) and their container.
-The kernel is associated to a unique user who can launch only one kernel at once.
-The kernel is launched and destroyed by voluntary actions of the user. These functions are realized via the
-use of scripts.</p>
-<p>The list of the kernel services related to communication issues is:</p>
-<ul>
- <li>The Naming service</li>
- <li> The Session service </li>
- <li>The Life Cycle service </li>
- <li>The Registry service </li>
- <li>The Notification service </li>
-</ul>
-<p>This list is enlarged with CORBA independent services :</p>
-
-<ul>
- <li>The module catalog service </li>
- <li>The Data Type Catalog service </li>
- <li>The resource catalog service </li>
-</ul>
-<p> SALOME kernel module also encapsulates the Engine
-<i><a href="#cont">Back to the contents</a></i>
-<a name="2"></a><h2>2. Basic principles </h2>
-<p>The SALOME user's desktop is a process on a machine. This process includes:</p>
-<ul>
- <li>A graphic interface (based on Qt), </li>
- <li>A text interface (Python interpreter), </li>
- <li>A 3D visualization window shared by components.</li>
-</ul>
-<p>SALOME Modules decompose into an interface (widgets GUI, text mode TUI, 3D visualization V3D) and
-an engine.</p>
-<p>The description of a module and its components is obtained by consulting the module catalog.</p>
-<p>The interface is dynamically loaded in the process of the SALOME user's desktop. The engine is a CORBA
-server launched either on the local machine or on the distant machine.</p>
-<p>The engine (CORBA server) is created by a factory (or container).
-This factory is also a CORBA server. Several containers can be present on a machine.
-Some containers are specialized for types of components requiring a specific management.
-For example, a specific container is required for components performing parallel calculations.
-The engine includes at least a dynamically linked library in the container process.
-This library is the implementation of the CORBA server associated to the engine.
-If the engine is built from a pre-existent executable code, the library is simply a wrapper of the encapsulated code.
-It launches the code in a separate process. Wherever possible, the code is included into the dynamic library.
-<p>The container is one of the kernel services. If one needs to create a container on a distant machine, one creates a process resuming a part of the kernel services. The kernel can create other containers on distant machines via the trader (rsh). All the containers and the kernel share the same CORBA naming service with which they register.</p>
-<p>The user reaches the functions of various SALOME'S components, either in graphic interactive mode (GUI) or in command mode ( TUI), via a Python interpreter.</p>
-<i><a href="#cont">Back to the contents</a></i>
-<a name="3"></a>
-<h2>3. Services and features of the SALOME kernel module </h2>
-<p>This section gives a brief overview of the services composing the kernel module.
- The <a href="overview_Life_Cycle.html">Life Cycle</a> and <a href="overview_Naming.html">Naming</a>
- services are described in separate chapters of this reference manual.</p>
-
-<a name="3_1"></a><h3>3.1 Session service </h3>
-<p>SALOME session describes the period starting from the kernel creation and
- ending with its destruction. During this period the user can connect the session
- and disconnect from it without ending this session. One connection log could
- be written. A priori, no information resulting from another (past) session can
- be used by the current session. </p>
- <p>Implementation of this service in SALOME application is provided by the class
-<a href="interfaceSALOME_1_1Session.html">Session</a> encapsulated in the package
-<a href="namespaceSALOME.html">SALOME</a>.</p>
-
-<a name="3_2"></a><h3>3.2 Registry service </h3>
-<p> The active component registry should contain:</p>
-
-<ul>
- <li>The list of the active components</li>
- <li>The list of the active containers during a SALOME session.</li>
-</ul>
-<p>It should allow the state of a session. It also should allow to know if session can be stopped.</p>
-<p>The API reference for this service is not included in the current version of the reference manual.</p>
-
-<a name="3_3"></a><h3>3.3 Notification service </h3>
-<p>The notification service is a kernel function which allows exchanging of events between CORBA objects.</p>
-<p>In comparison with traditional CORBA event service, SALOME notification service allows to:</p>
-<ul>
- <li>Filter the events, </li>
- <li>Structure the events,</li>
- <li>Establish quality policies of services,</li>
- <li>Subscribe to various event channels.</li>
-</ul>
-<p>The API reference for this service is not included in the current version of the reference
- manual. </p>
-
-<a name="3_4"></a><h3>3.4 Module catalog service </h3>
-<p>There are two module catalogs in SALOME application:</p>
-<ul>
-<li>General module catalog : This first catalog is common to all SALOME users once the the platform is installed (for example for a particular company or a service). This catalog will be managed by the integrator or the administrator of the platform,
-<li>Personal module catalog : A specific catalog for every user (possibly empty). This catalog should notably allow the developers to test a new component before integrating it into the general catalog.
-</ul>
-<p>The objective of these two module catalogs is to:</p>
-<ul>
-<li>List the available modules;
-<li>Allow the addition, the modification and the deletion of a module in catalogs;
-<li>Look for a module and\or a service fulfilling some given criteria (in catalogs);
-</ul>
-<p><p>Implementation of this service in SALOME application is provided by two classes
-<a href="interfaceSALOME__ModuleCatalog_1_1ModuleCatalog.html">ModuleCatalog</a>and <a href="interfaceSALOME__ModuleCatalog_1_1AComponent.html">AComponent</a> encapsulated in the package
-<a href="namespaceSALOME__ModuleCatalog.html">SALOME_ModuleCatalog</a>.</p>
-
-<a name="3_5"></a><h3>3.5 Data type catalog </h3>
-
-<p>The data exchanged between components services have definite types. During description of input, output, and
-configuration parameters of components in the module catalog, the
-definition of the parameters types is taken from data type catalog. During the editing of execution of
-graphs, it is necessary to check that the connections output-input parameters are of compatible
-types.</p>
-<p>The data types correspond to CORBA object classes, including attributes and access methods (defined by their IDL).
-These types can be created by specialization of generic data types.</p>
-<p>The purpose of the data type catalog is to:</p>
-<ul>
-<li>List the available data types in the catalog;
-<li>Browse the type hierarchy to check the compatibility of types (specialized output toward generic input);
-<li>Allow the addition, the modification and the deletion of a data type in the catalog;
-</ul>
-<p>The API reference for this service is not included in the current version of the reference
- manual. </p>
- <a name="3_6"></a><h3>3.6 Resource catalog</h3>
-
-<p>This catalog describes machines, possible types of container on a machine, resources of machines... This catalog is used by the SALOME LifeCycle service.</p>
-<p>The API reference for this service is not included in the current version of the reference
- manual. </p>
-
-<a name="3_7"></a><h3>3.7 Engine</h3>
-<p>The engine represents a shared library which can be dynamically loaded by a container. The container can load this library,
-given an interface name and an implementation
-name. The container dynamically resolves an extern_C function in the library,
-which constructs the CORBA Engine servant object.</p>
-<p>The SALOME engine in
- the current version of the application is implemented
- as <b>Engines</b> package of interfaces. It encapsulates two classes: Component, Container.</p>
-<p>The API refernce for <b>Engines</b> package can be found <a href="namespaceEngines.html">here</a>.
-</p>
-<a name="3_7_1"></a><h4>3.7.1 Component class</h4>
-<p>This class is used for interaction between the container and the component and between the components inside the container.
-</p>
-<p>The API reference for this class can be found <a href="interfaceEngines_1_1Component.html">here</a>.</p>
-
-<a name="3_7_2"></a><h4>3.7.2 Container class</h4>
-<p>This class provides a set of methods which are necessary for definition of the process of loading and registration of new components in SALOME application.</p>
-<p>The API reference for this class can be found <a href="interfaceEngines_1_1Container.html">here</a>.</p>
-
-<i><a href="#cont">Back to the contents</a></i>
-</body>
-</html>
+++ /dev/null
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Life Cycle service Description</title>
-
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-
-</head>
-
-<body>
-
-<center><table WIDTH="96%" >
-<tr>
-<td><a href="http://www.opencascade.com"><img src="sources/logocorp.gif" BORDER=0 height=46 width=122></a></td>
-
-
-<td>
-<div align=right><a href="http://www.opencascade.org/SALOME/"><img src="sources/application.gif" BORDER=0 height=46 width=108></a></div>
-</td>
-</tr>
-</table></center>
-
-
-<h1><a name="page2">Life Cycle service Description</a> </h1>
-<h2>Introduction</h2>
-<p> The objective of this document is to give the users of SALOME
- application a brief overview of the Life Cycle service implemented in SALOME.
- A complete version of the LifeCycle service specification edited by the Object Management Group, Inc.(OMG) can be found <a href="http://www.omg.org" target="top">here.</a> <a name="#cont"></a>
- </p>
-<a name="cont"></a><h2>Table of contents </h2>
-<b><i><ul>
- <li><a href="#1">1. Overview</a></li>
-
-
- <li><a href="#2">2. SALOME Life Cycle service description</a></li>
-</ul>
-</i></b><br>
-
-<a name="1"></a><h2>1. Overview</h2>
-
-<p>Life Cycle service defines services and conventions for creating, deleting, copying and moving objects.
-Because CORBA-based environments support distributed objects, the Life Cycle service defines conventions that allow clients to perform
-life cycle operations on objects in different locations. This overview describes the life cycle problem for distributed object systems. </p>
-<br>
-
-
-<a name="2"></a><h2>2. SALOME Life Cycle service description</h2>
-<p>The SALOME Life Cycle service represents a partial implementation of the CORBA LifeCycle service. <p>
-<p>From general point of view, the SALOME Life Cycle service allows to <i>find</i> or <i>load</i> with the help of a given container a definte SALOME component with its further
-initialization and registration in the Naming service.</p>
-<p><b>Container</b> - it's a certain engine realizing the mechanism of loading a SALOME module.</p>
- <p><b>Component</b> - it's a certain abstract shell wrapping SALOME modules, performing all operations concerned with their initialization and registration. </p>
-<p>From the point of view of the service user, the Life Cycle provides a set of functions allowing to :</p>
-<ul>
-<li>Locate a machine (more generally a container) by a logical set of required features (of both container and
- machine);</li>
-<li>Load components on the obtained containers;</li>
-<li>Create a container;</li>
-<li>Obtain the container containing a given component;</li>
-<li>Treat the list of the active components;</li>
-<li>Treat the list of the available containers.</li>
-</ul>
-
-
-
-<p>The SALOME Life Cycle is a CORBA server. This server at its initialization is registered with the naming service.</p>
-<p>The Life Cycle service is invoked to find a container and use it to load a
-component. It supplies, as parameters, the type of container and the machine features required for loading
-a given component.
-</p>
-<p>The Life Cycle service then returns a CORBA reference of a launched container.</p>
-<p>Containers are launched on demand depending on components to be loaded. The Life Cycle service manages loading of containers.</p>
-<p>When there is no launched container matching the request the Life Cycle service invokes loading of the correct type of container on a correct machine via a rsh type command.</p>
-<p>The Life Cycle service interrogates containers to have information about the dynamic state of the machine (load). It contains (and update) the state of the active containers.</p>
-<p>The Life Cycle service can implement a loading strategy for new containers on new machines, depending on the state of the already launched containers.</p>
-<p>The Life Cycle service can stop containers at the end of session on
-demand.</p>
-
-<p>In SALOME platform the Life Cycle service is implemented in <b>SALOME_Life CycleCORBA</b> class. The API refernce for the methods of this class
-can be found <a href="classSALOME__LifeCycleCORBA.html"> here</a>.</p>
-<i><a href="#cont">Back to the contents</a></i>
-<br>
-
-
-<br>
-
-</body>
-</html>
+++ /dev/null
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Naming Service Description</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
-<body>
-
-<center><table WIDTH="96%" >
-<tr>
-<td><a href="http://www.opencascade.com"><img src="sources/logocorp.gif" BORDER=0 height=46 width=122></a></td>
-
-
-<td>
-<div align=right><a href="http://www.opencascade.org/SALOME/"><img src="sources/application.gif" BORDER=0 height=46 width=108></a></div>
-</td>
-</tr>
-</table></center>
-
-
-<h1><a name="page2">Naming Service Description </a></h1>
-<br>
-<h2>Introduction</h2>
-<p>This page contains an abridged version of the Naming Service specification
- edited by the Object Management Group, Inc.(OMG). The objective of this document is to give the users of SALOME
- application a brief overview of the Naming Service implemented in SALOME.
- A complete version of this document can be found <a href="http://www.omg.org" target="top">here.</a> <a name="#cont"></a>
- </p>
- <br>
-<a name="cont"></a><h2>Table of contents </h2>
-<b><i>
-<ul>
- <li><a href="#1">1. Overview</a></li>
- <li><a href="#2">2. SALOME Naming Service </a></li>
- <ul>
- <li><a href="#2_1">2.1 Introduction </a></li>
- <li><a href="#2_2">2.2 Definitions </a></li>
- <li><a href="#2_3">2.3 Partition of SALOME name directory hierarchy </a></li>
- <li><a href="#2_4">2.4 SALOME name directory persistence </a></li>
- <li><a href="#2_5">2.5 SALOME naming service features </a></li>
- </ul>
-
-</ul>
-</i> </b> <br>
-
-<a name="1"></a><h2>1. Overview</h2>
-<p>This chapter presents the OMG Naming Service and explains how the Naming Service can be used to decouple clients and servers by
-providing an external reference exchange mechanism. The chapter also covers how to solve the bootstrapping problem for clients and
-servers by controlling their configuration.
- </p>
-
-<p>In practice, copying stringified references from a server to all its clients is clumsy and does not scale. The Naming Service provides a way
-for servers to advertise references under a name, and for clients to retrieve them. The advantages are:
-</p>
-<ul>
- <li>Clients and servers can use meaningful names instead of having to deal with stringified references. </li>
- <li> By changing a reference in the service without changing its name, you can transparently direct clients to a different object.</li>
- <li> The Naming Service solves the bootstrapping problem because it provides a fixed point for clients and servers to rendezvous. </li>
-</ul>
-<p>The Naming Service is much like a white pages phone book. Given a name, it
- returns an object reference. </p>
-
-<p>The terminology used in description of NamigService is the following: </p>
-
-<ul>
- <li>A name-to-IOR association is called by a name binding. </li>
- <li>Each binding identifies exactly one object reference, but an object reference
- may be bound more than once (have more than one name). </li>
- <li><a name="graph"></a>A naming context is an object that contains name bindings.
- The names within a context must be unique. Naming contexts can contain bindings
- to other naming contexts, so naming contexts can form graphs. Binding contexts
- in other contexts creates a <i>naming graph</i> \97 a directed graph with nodes
- and labeled edges where the nodes are contexts. A naming graph allows more
- complex names to reference an object. Given a context in a naming graph, a
- sequence of names can reference an object. This sequence of names (called
- a <i>compound name</i>) defines a path in the naming graph to navigate the
- resolution process. Figure 1-1 shows an example of a naming graph. </li>
- <li>Binding a name to a context means to add a name\96IOR pair to a context. </li>
- <li>Resolving a name means to look for a name in a context and to obtain the
- IOR bound under that name.</li>
-</ul>
-
-
-<div align="center"><img src="ns_f3-1.jpg"> </div>
-<p align="center"><font size="-1"><i>Figure 1-1</i> A Naming Graph </font></p>
- <i><a href="#cont">Back to the contents</a></i>
- <br>
- <a name="2"></a>
-<h2>2. SALOME Naming Service </h2>
-<a name="2_1"></a>
-<h3>2.1 Introduction</h3
-
->
-<p>The SALOME Naming Service is a kernel function which supplies a name directory
- hierarchy for pointing out CORBA objects. This name directory hierarchy allows,
- from symbolic names, to dynamically find the references of distributed SALOME
- objects, without information about their location. SALOME objects which can
- be reached via the naming service are:</p>
-
-<ul>
- <li>The kernel services</li>
- <li>Containers
- <li>SALOME components instances
-</ul>
-<p>The name directory hierarchy in SALOME represents a graph of directories containing
- symbolic associations name-reference on objects. (It has been described in the
- <a href="#graph">previous section</a>)</p>
-<a name="2_2"></a>
-<h3>2.2 Definitions</h3>
-<dl>
-<dt><i><b>Directory</b></i></dt>
-<dd>Context of names containing symbolic associations name-reference on objects.</dd><br><br>
- <dt><i><b>"/"</b></i></dt>
- <dd>Character used in SALOME to separate two names of a directory</dd><br><br>
- <dt><i><b>Access path</b></i></dt>
- <dd>List of names (separated by "/" character representing the path to be followed
- in the graph to reach an association name-reference (the last name in the sequence).</dd>
-</dl>
-<blockquote><b>Note:</b>An object can be referenced by several symbolic names
- in one or several directories.</blockquote>
- <a name="2_3"></a>
-<h3>2.3 Partition of SALOME name directory hierarchy</h3>
-<p>The hierarchical organization of the SALOME name directory is not completely frozen .
-Because the framework allows the simultaneous opening of several studies, the following levels are determined:</p>
-<pre>
- /Kernel
- /Container/
- /Component
-</pre>
-<a name="2_4"></a>
-<h3>2.4 SALOME name directory persistence</h3>
-<p>During a SALOME session, stopping a server in charge of the Naming Service
- doesn't imply the loss of the contents of the SALOME name directory hierarchy.
- A backup file is produced and can be used to restart the Naming Service. So,
- one can recover the state of the SALOME name directory hierarchy at restart
- time. During such breakdown, every call to any function of the Naming Service
- invokes an exception of type <i>Unreachable service</i>.</p>
-<a name="2_5"></a>
-<h3>2.5 SALOME Naming Service features</h3>
-<p>Usage and administration of the name directory hierarchy is realized by means of the following functions:</p>
-<ul>
- <li>Recording and recovering of the reference of an object </li>
- <li>Searching for a symbolic name</li>
- <li>Creating of a directory, reading and modifying of the current directory</li>
- <li>Destructing of a symbolic name and a diredtory</li>
-</ul>
-<p>The access path used in these functions can be defined, either from the root, or from any
-directory of SALOME name directory hierarchy.</p>
-
-<p>In SALOME there is s standard interface of Naming Service, and any user can
- use it for binding and finding objects. How to use it, it's possible to find
- in any CORBA documentation. However in SALOME there is an additional layer which
- hides calls to standard interface. </p>
- <p>The precise API reference for these functions you can find <a href="classSALOME__Naming Service.html">here.</a> </p>
-<p>Here is a short list of public methods which are used for working with the SALOME Naming Service:</p>
-<dl>
-<dt><h4>Register</h4> </dt>
-<dd>Method which register object reference in the naming service with given name. It makes assignment between IOR and stringified name.
-Then it's possible to get object reference from name using "Resolve" method. </dd>
-<br><br>
-<dt><h4>Resolve</h4> </dt>
- <dd>Try to obtain object reference from name. It's necessary before publishing
- IOR in the Naming Service by Register method. </dd>
-<br><br>
-<dt><h4>Find</h4> </dt>
- <dd>The purpose of this method is to research a name from the current directory
- of the naming service. Then if there is occurrence the naming service changes
- directory to go to the directory where last occurrence is found. </dd>
-<br><br>
-<dt><h4>CreateDirectory</h4> </dt>
-<dd>This method allows to create one or several directories in the current directory</dd>
-<br><br>
-<dt><h4>ChangeDirectory</h4> </dt>
-<dd>Moves the current directory. The current directory is moved to the root directory if the input parameter <i>Name</i> is "/".</dd>
-<br><br>
-<dt><h4>CurrentDirectory</h4> </dt>
-<dd>Method allowing to get the current directory.</dd>
-<br><br>
-<dt><h4>list</h4> </dt>
-<dd>Method allowing to list and print the whole context beginning from the current context.</dd>
-<br><br>
-<dt><h4>list_directory</h4> </dt>
-<dd>Method to get all contexts contained in the current directory.</dd>
-<br><br>
-<dt><h4>DestroyName</h4> </dt>
-<dd>Destroys a symbolic name-object reference association.</dd>
-<br><br>
-<dt><h4>DestroyDirectory</h4> </dt>
-<dd>Destroys an empty directory.</dd>
-</dl>
-
-<i><a href="#cont">Back to the contents</a></i>
-<br>
-</body>
-</html>
+++ /dev/null
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Main Page</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
-<body>
-
-<center><table WIDTH="96%" >
-<tr>
-<td><a href="http://www.opencascade.com"><img src="sources/logocorp.gif" BORDER=0 height=46 width=122></a></td>
-
-
-<td>
-<div align=right><a href="http://www.opencascade.org/SALOME/"><img src="sources/application.gif" BORDER=0 height=46 width=108></a></div>
-</td>
-</tr>
-</table></center>
-
-
-<h1><a name="page2">General overview</a>
-</h1>
-<br>
-<h2><a name="cont"></a>Table of contents</h2>
-<ul>
- <li><i><b><a href="#1">1. Introduction</a></b></i></li>
- <li><i><b><a href="#2">2. Representation of the study</a></b></i></li>
- <ul>
- <li><i><b><a href="#2_1">2.1 Study in transient format</a></b></i></li>
- <li><i><b><a href="#2_2">2.2 Study in persistent format</a></b></i></li>
- <li><i><b><a href="#2_3">2.3 Link between transient and persistent formats</a></b></i></li>
- </ul>
- <li><i><b><a href="#3">3. Services and features of the study</a></b></i></li>
- <ul>
- <li><i><b><a href="#3_1">3.1 Study class </a></b></i></li>
- <li><i><b><a href="#3_2">3.2 StudyBuilder class </a></b></i></li>
- <li><i><b><a href="#3_3">3.3 StudyManager class </a></b></i></li>
- <li><i><b><a href="#3_4">3.4 SObject class </a></b></i></li>
- <li><i><b><a href="#3_5">3.5 SComponent class </a></b></i></li>
- <li><i><b><a href="#3_6">3.6 ChildIterator class </a></b></i></li>
- <li><i><b><a href="#3_7">3.7 SComponentIterator </a></b></i></li>
- <li><i><b><a href="#3_8">3.8 GenericAttribute class </a></b></i></li>
- <li><i><b><a href="#3_9">3.9 UseCaseBuilder class </a></b></i></li>
- <li><i><b><a href="#3_10">3.10 UseCaseIterator </a></b></i></li>
- <li><i><b><a href="#3_12">3.11 Callback class </a></b></i></li>
- <li><i><b><a href="#3_12">3.12 Driver class </a></b></i></li>
- </ul>
-</ul>
-<h2><a name="1"></a>1. Introduction</h2>
-<p>In SALOME application the Study module is used for management (creation, saving
- etc.) of studies. In the framework of the platform, a study represents a working
- document allowing to manage the data produced by various components which are
- integarted into SALOME.<br>
-</p>
-<h2><a name="2"></a>2. Representation of the study</h2>
-<p>The study represents a set of objects that we will call Study Objects or SObjects.
- The study can be represented as a tree, every node of that tree containing a
- SObject. SObjects in the study can be values or references towards data of calculation,
- graphs of calculation, trees of construction of detail(room), results. Every
- SOject of the study is characterised by a unique identifier in the study.</p>
-<p>The study allows to describe the following relations:</p>
-<ul>
- <li>The link between the transient and persistent values of an SObject.</li>
- <li>The relations between the SObjects produced by different components.</li>
- <li>The relations between the SObjects produced by the same component.</li>
- <li>The link between an object and its user name.</li>
- <li>The access to the definition of the component which produce an object of
- the study.</li>
- <li>The access to instance of the component (if this one exists) which has produced
- this SObject of the study.</li>
-</ul>
-
-<p>Every SObject in the study contains a set of attributes. These attributes represent
- a set of definitions associated to that object, they can contain values or corba
- references towards the data contained in the internal data structure of a component.</p>
-<p>As the structure of the study is tree-like it is possible to associate sub-objects
- to objects.</p>
-<p>As particular object, the study contains Component Data which are labels associated to the component
-which produce data in the study. It is to this object that we can associate attributes containing ID which
-we shall allow to identify the type of the component and also its instance. Objects produced by a
-component will be sub-objects of the coresponding Data Component.</p>
-<p>For example Component Data GEOM will contain the data produced by the component
- Geom.</p>
-<table width="100%" border="0">
- <tr>
- <td><img src="Study_Struct.gif"></td>
- <td>GEOM contains the data produced by the component GEOM. The component MESH
- contains a SObject Mesh_1 wich refers to the SObject identified
- by ID4 corresponding to Geometrie_1.</td>
- </tr>
-</table>
-<p>We distinguish two forms of the study, the study opened in a session SALOME and the study in the
-persistent format. These two formats are described in the following sections</p>
-<h3><a name="2_1"></a>2.1 Study in transient format</h3>
-<p>The representation of the study in memory will be based on the document OCAF (supplied by OCC).
-The document OCAF can be seen as a tree, every node of that tree is identified by <i>a tag</i> representing an integer value.</p>
-<p>The exploration of the tree from the root to a node supplies a sequence of tags which establishes a
-unique identifier <i>ID</i>. ID represents a character string containing the sequence of tags separated by
-one ':'.</p>
-<p>For example 0:1:12:4 </p>
-<p>To every node we can associate a set of attributes.</p>
-<p>The attributes which the study can contain can be of the following types:</p>
-<ul>
-<li>All standard attributes supplied by OCC (package TdataStd) which allow to define (integers,
-real, strings, identifiers, references etc.)</li>
-<li>Attributes which contain CORBA references.</li>
-<li>Attributes which contain the path HDF to reach the persistent datum. (Cf. the following chapter)</li>
-</ul>
-<p><b>Remark</b>: it is the study which takes care to build the attributes from the values which are passed to it, so
-an attribute is always in a study, and it knows the study object to which it is attached.</p>
-<p>Example of a Study Object as a set of various attributes.</p>
-<img src="SObject.gif">
-<h3><a name="2_2"></a>2.2 Study in persistent format</h3>
-<p>To store a study HDF format is used, this tool allows to represent persistent data in the form of a tree.</p>
-<p>Under the root of the persistent document, you can find a set of nodes:</p>
-<ul>
-<li>The first node contains the skeleton of the study. The skeleton consists of the identifiers of the
-objects, as well as the references among them.</li>
-<li>There is also one node for every component which has produced data during this SALOME session. Under each of these
-node there are values of the data produced by this component.</li>
-</ul>
-<h3><a name="2_3"></a>2.3 Link between transient and persistent formats</h3>
-<p>It will be possible to complete the definition of one object in the study by associating to it an attribute
-<i>HDFPath</i> which will contain the path to the persistent data.</p>
-<img src="Link.gif">
-<p><a href="#cont"><b><i>Back to the contents</i></b></a></p>
-<h2><a name="3"></a>3. Services and features of the study</h2>
-<p>The Study in SALOME application possess a wide functionality. This functionality is provided by a set of classes which are described
-below.
-<h3><a name="3_1"></a>3.1 Study class</h3>
-<p>The purpose of the Study class is to manage the data produced by various components
- of SALOME platform. Most of the Study operations are handled by the <a href="#3_3">StudyManager</a>
- and the <a href="#3_2">StudyBuilder</a>. What
- is left in the Study class are elementary inquiries. A Study is explored by
- a set of tools, mainly iterators , which are described further.</p>
- <p>Nevertheless, the Study class contains a set of methods providing: </p>
-
-<ul>
- <li>management of study properties
- <li> search for SObjects.
- <li>search for SComponents
- <li>creation of a new StudyBuilder, ComponentIterator, ChildIterator etc.
-</ul>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1Study.html">here</a>.</p>
-<h3><a name="3_2"></a>3.2 StudyBuilder class</h3>
-<p>StudyBuilder supplies basic services to edit the study. The edition of the study is made by the
-component. Every component will use the basic services of the StudyBuilder allowing to write and publish objects.</p>
-<p>StudyBulder provides the following functionality:</p>
-<ul>
- <li>creation, modification or deletetion of SObjects in the study</li>
- <li>creation or removal of SComponents </li>
- <li>undo/redo functionality. For that purpose it supplies the methods NewCommand,
- CommitCommand, AbortCommand. </li>
-</ul>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1StudyBuilder.html">here</a>.</p>
-<h3><a name="3_3"></a>3.3 StudyManager class</h3>
-<p>The purpose of the Manager is to manipulate Studies. Since SALOME is a multi-document
- application during a working session you can operate as many stadies as you
- wishes to create. </p>
-<p>For that purpose StudyManager provides the following functionality:</p>
-<ul>
- <li>creation, opening, closing and saving studies</li>
- <li>navigation through a set of studies present in the current working session</li>
- <li> copy/paste of the objects in the study functionality.</li>
-</ul>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1StudyManager.html">here</a>.</p>
-<h3><a name="3_4"></a>3.4 SObject class</h3>
-<p>The objects in the study are built by the StudyBuilder.
-The SObject class provides methods for elementary inquiries, like getting an object ID or its attribuites. </p>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1SObject.html">here</a>.</p>
-<h3><a name="3_5"></a>3.5 SComponent class</h3>
-<p>The SComponent class establishes in the study a permanent assocition to the components
-integrated into SALOME platform. The SComponent interface is a specialization of the SObject
- class. It inherits the most of its methods from the SObject class which are used for management of the SComponents.</p>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1SComponent.html">here</a>.</p>
-<h3><a name="3_6"></a>3.6 ChildIterator class</h3>
-<p>It is one of the tools destined for exploration of the study. This class contains a set of methods allowing to get
-the access to all identified objects which are sons of another identifiedobject.</p>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1ChildIterator.html">here</a>.</p>
-<h3><a name="3_7"></a>3.7 SComponentIterator</h3>
-<p>This is the second tool destined for exploration of the study. This interface contains the methods allowing to iterate over all SComponents in the list.
- The search is started from the first SComponent in the list. </p>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1SComponentIterator.html">here</a>.</p>
-
-<h3><a name="3_8"></a>3.8 GenericAttribute class </h3>
- <p>GenericAttribute represents a base class for all attributes which can be assigned to the SObjects created in the study. All attribute classes
- derive from this classe and inherit its methods. </p>
- <p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1GenericAttribute.html">here</a>.</p>
-
-<p>In SALOME application a SObject can possess the following attributes:</p>
-<table width="48%" border="0">
- <tr>
- <td width="44%" height="241">
- <ul>
- <li><a href="interfaceSALOMEDS_1_1AttributeName.html">AttributeName</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeComment.html">AttributeComment</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeIOR.html">AttributeIOR</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeReal.html">AttributeReal</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeInteger.html">AttributeInteger</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeSequenceOfReal.html">AttributeSequenceOfReal</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeSequenceOfInteger.html">AttributeSequenceOfInteger</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributePersistentRef.html">AttributePersistentRef</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeDrawable.html">AttributeDrawable</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeSelectable.html">AttributeSelectable</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeExpandable.html">AttributeExpandable</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeOpened.html">AttributeOpened</a></li>
- </ul></td>
- <td width="56%" height="241">
- <ul>
- <li><a href="interfaceSALOMEDS_1_1AttributeTextColor.html">AttributeTextColor </a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeTextHighlightColor.html">AttributeTextHighlightColor</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributePixMap.html">AttributePixMap</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeTreeNode.html">AttributeTreeNode</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeLocalID.html">AttributeLocalID</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeUserID.html">AttributeUserID</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeTarget.html">AttributeTarget</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeTableOfInteger.html">AttributeTableOfInteger</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeTableOfReal.html">AttributeTableOfReal</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeTableOfString.html">AttributeTableOfString</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributeStudyProperties.html">AttributeStudyProperties</a></li>
- <li><a href="interfaceSALOMEDS_1_1AttributePythonObject.html">AttributePythonObject</a></li>
- </ul></td>
- </tr>
-</table>
-<h3><a name="3_9"></a>3.9 UseCaseBuilder class</h3>
-<p>UseCase in the study represents a user-defined subtree, containing all or some of the objects which currently exist
-in the study. The UseCaseBuilder class contains a set of methods used for management (creation, deletion etc) of this sub-tree in the study. </p>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1UseCaseBuilder.html">here</a>.</p>
-
-<h3><a name="3_10"></a>3.10 UseCaseIterator</h3>
- <p>This class represents an exploration tool for the UseCase. It contains a set of methods used for iteration over the objects in the UseCase.</p>
- <p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1UseCaseIterator.html">here</a>.</p>
-
-<h3><a name="3_11"></a>3.11 Callback class</h3>
- <p>The StudyBuilder can be created with the method NewBuilder. While invocation of this method a new object of the class
- Callback is created and this object is assigned to the newly created Builder as callback which should be called
- when <i>adding</i> and <i>removing</i> the objects. </p>
- <p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1Callback.html">here</a>.</p>
-
-<h3><a name="3_12"></a>3.12 Driver class</h3>
-
-<p>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>
- <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>
- <li>transforming of the transient references into persistant references (or
- vice versa) of the SObjects when saving (or loading) a study</li>
- <li>copy/paste common functionality. These methods can be called by any component
- in order to copy/paste its object created in the study</li>
-</ul>
-<p>The API reference for this class can be found <a href="interfaceSALOMEDS_1_1Driver.html">here</a>.</p>
-<p><a href="#cont"><b><i>Back to the contents</i></b></a></p>
-</body>
-</html>
+++ /dev/null
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
- <title>Main Page</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-</head>
-<body>
-
-<center><table WIDTH="96%" >
-<tr>
-<td><a href="http://www.opencascade.com"><img src="sources/logocorp.gif" BORDER=0 height=46 width=122></a></td>
-
-
-<td>
-<div align=right><a href="http://www.opencascade.org/SALOME/"><img src="sources/application.gif" BORDER=0 height=46 width=108></a></div>
-</td>
-</tr>
-</table></center>
-
-
-</body>
-</html>
-<!-- Generated by Doxygen 1.3-rc2 -->
-<h1><a name="page2">Mapping of SALOME IDL definitions to Python language.</a>
-</h1><ul>
-<li><b>SALOME STUDY module</b><ul>
-<li><a href="HTML/SALOMEDS.html">Mapping of SALOMEDS functions</a></li><li><a href="HTML/SALOMEDS_Attributes.html">Mapping of SALOMEDS_Attributes functions</a></li></ul>
-</li><li><b>SAlOME KERNEL module</b><ul>
-<li><a href="HTML/SALOME_Session.html">Mapping of SALOME_Session functions</a></li><li><a href="HTML/SALOME_ModuleCatalog.html">Mapping of SALOME_ModuleCatalog functions</a></li><li><a href="HTML/SALOME_Exception.html">Mapping of SALOME_Exception functions</a></li><li><a href="HTML/SALOME_Component.html">Mapping of SALOME_Component functions</a></li></ul>
-</li></ul>
-</body>
-</html>
+++ /dev/null
-foldersTree = gFld("<b>SALOME v.@VERSION@ </b>", "", "")
- insDoc(foldersTree, gLnk("Main Page", "", "main.html"))
-
-aux1 = insFld(foldersTree, gFld("TUI Reference Guide", ""))
- aux2 = insFld(aux1, gFld("Modules", ""))
- aux3 = insFld(aux2, gFld("SALOME STUDY module", ""))
- insDoc(aux3, gLnk("Overview", "", "overview_Study.html"))
- aux4 = insFld(aux3, gFld("Packages", ""))
- insDoc(aux4, gLnk("SALOMEDS", "", "namespaceSALOMEDS.html"))
- insDoc(aux3, gLnk("Examples", "", "examples_Study.html"))
- aux3 = insFld(aux2, gFld("SALOME KERNEL module", ""))
- insDoc(aux3, gLnk("Overview", "", "overview_Kernel.html"))
- aux4 = insFld(aux3, gFld("Packages", ""))
- insDoc(aux4, gLnk("SALOME_ModuleCatalog", "", "namespaceSALOME__ModuleCatalog.html"))
- insDoc(aux4, gLnk("SALOME", "", "namespaceSALOME.html"))
- insDoc(aux4, gLnk("Engines", "", "namespaceEngines.html"))
- insDoc(aux3, gLnk("Examples", "", "examples_Kernel.html"))
-
-
-/*! Data structures
-*/
- insDoc(aux1, gLnk("Data Structures", "", "annotated.html"))
-
-/*! insDoc(aux1, gLnk("SALOME_ModuleCatalog::Acomponent", "", "interfaceSALOME__ModuleCatalog_1_1Acomponent.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeComment", "", "interfaceSALOMEDS_1_1AttributeComment.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeDrawable", "", "interfaceSALOMEDS_1_1AttributeDrawable.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeExpandable", "", "interfaceSALOMEDS_1_1AttributeExpandable.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeInteger", "", "interfaceSALOMEDS_1_1AttributeInteger.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeIOR", "", "interfaceSALOMEDS_1_1AttributeIOR.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeLocalID", "", "interfaceSALOMEDS_1_1AttributeLocalID.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeName", "", "interfaceSALOMEDS_1_1AttributeName.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeOpened", "", "interfaceSALOMEDS_1_1AttributeOpened.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributePersistentRef", "", "interfaceSALOMEDS_1_1AttributePersistentRef.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributePixMap", "", "interfaceSALOMEDS_1_1AttributePixMap.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributePythonObject", "", "interfaceSALOMEDS_1_1AttributePythonObject.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeReal", "", "interfaceSALOMEDS_1_1AttributeReal.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeSelectable", "", "interfaceSALOMEDS_1_1AttributeSelectable.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeSequenceOfInteger", "", "interfaceSALOMEDS_1_1AttributeSequenceOfInteger.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeSequenceOfReal", "", "interfaceSALOMEDS_1_1AttributeSequenceOfReal.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeStudyProperties", "", "interfaceSALOMEDS_1_1AttributeStudyProperties.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfInteger", "", "interfaceSALOMEDS_1_1AttributeTableOfInteger.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfInteger::IncorrectArgumentLength", "", "exceptionSALOMEDS_1_1AttributeTableOfInteger_1_1IncorrectArgumentLength.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfInteger::IncorrectIndex", "", "exceptionSALOMEDS_1_1AttributeTableOfInteger_1_1IncorrectIndex.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfReal", "", "interfaceSALOMEDS_1_1AttributeTableOfReal.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfReal::IncorrectArgumentLength", "", "exceptionSALOMEDS_1_1AttributeTableOfReal_1_1IncorrectArgumentLength.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfReal::IncorrectIndex", "", "exceptionSALOMEDS_1_1AttributeTableOfReal_1_1IncorrectIndex.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfString", "", "interfaceSALOMEDS_1_1AttributeTableOfString.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfString::IncorrectArgumentLength", "", "exceptionSALOMEDS_1_1AttributeTableOfString_1_1IncorrectArgumentLength.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfString::IncorrectIndex", "", "exceptionSALOMEDS_1_1AttributeTableOfString_1_1IncorrectIndex.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTarget", "", "interfaceSALOMEDS_1_1AttributeTarget.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTextColor", "", "interfaceSALOMEDS_1_1AttributeTextColor.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTextHighlightColor", "", "interfaceSALOMEDS_1_1AttributeTextHighlightColor.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTreeNode", "", "interfaceSALOMEDS_1_1AttributeTreeNode.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeUserID", "", "interfaceSALOMEDS_1_1AttributeUserID.html"))
- insDoc(aux1, gLnk("SALOMEDS::Callback", "", "interfaceSALOMEDS_1_1Callback.html"))
- insDoc(aux1, gLnk("SALOMEDS::ChildIterator", "", "interfaceSALOMEDS_1_1ChildIterator.html"))
- insDoc(aux1, gLnk("SALOMEDS::Color", "", "structSALOMEDS_1_1Color.html"))
- insDoc(aux1, gLnk("Engines::Component", "", "interfaceEngines_1_1Component.html"))
- insDoc(aux1, gLnk("Engines::Container", "", "interfaceEngines_1_1Container.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::DefinitionInterface", "", "structSALOME__ModuleCatalog_1_1DefinitionInterface.html"))
- insDoc(aux1, gLnk("SALOMEDS::Driver", "", "interfaceSALOMEDS_1_1Driver.html"))
- insDoc(aux1, gLnk("SALOME::ExceptionStruct", "", "structSALOME_1_1ExceptionStruct.html"))
- insDoc(aux1, gLnk("SALOMEDS::GenericAttribute", "", "interfaceSALOMEDS_1_1GenericAttribute.html"))
- insDoc(aux1, gLnk("SALOMEDS::GenericAttribute::LockProtection", "", "exceptionSALOMEDS_1_1GenericAttribute_1_1LockProtection.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::IAPP_Affich", "", "structSALOME__ModuleCatalog_1_1IAPP__Affich.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::ModuleCatalog", "", "interfaceSALOME__ModuleCatalog_1_1ModuleCatalog.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::NotFound", "", "exceptionSALOME__ModuleCatalog_1_1NotFound.html"))
- insDoc(aux1, gLnk("SALOMEDS::NotImplemented", "", "exceptionSALOMEDS_1_1NotImplemented.html"))
- insDoc(aux1, gLnk("SALOME::SALOME_Exception", "", "exceptionSALOME_1_1SALOME__Exception.html"))
- insDoc(aux1, gLnk("SALOMEDS::SComponent", "", "interfaceSALOMEDS_1_1SComponent.html"))
- insDoc(aux1, gLnk("SALOMEDS::SComponentIterator", "", "interfaceSALOMEDS_1_1SComponentIterator.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::Service", "", "structSALOME__ModuleCatalog_1_1Service.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::ServicesParameter", "", "structSALOME__ModuleCatalog_1_1ServicesParameter.html"))
- insDoc(aux1, gLnk("SALOME::Session", "", "interfaceSALOME_1_1Session.html"))
- insDoc(aux1, gLnk("SALOME::Session::GUIActive", "", "exceptionSALOME_1_1Session_1_1GUIActive.html"))
- insDoc(aux1, gLnk("SALOME::Session::RunningStudies", "", "exceptionSALOME_1_1Session_1_1RunningStudies.html"))
- insDoc(aux1, gLnk("SALOMEDS::SObject", "", "interfaceSALOMEDS_1_1SObject.html"))
- insDoc(aux1, gLnk("SALOME::StatSession", "", "structSALOME_1_1StatSession.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study", "", "interfaceSALOMEDS_1_1Study.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyCommentError", "", "exceptionSALOMEDS_1_1Study_1_1StudyCommentError.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyInvalidComponent", "", "exceptionSALOMEDS_1_1Study_1_1StudyInvalidComponent.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyInvalidContext", "", "exceptionSALOMEDS_1_1Study_1_1StudyInvalidContext.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyInvalidDirectory", "", "exceptionSALOMEDS_1_1Study_1_1StudyInvalidDirectory.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyNameAlreadyUsed", "", "exceptionSALOMEDS_1_1Study_1_1StudyNameAlreadyUsed.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyNameError", "", "exceptionSALOMEDS_1_1Study_1_1StudyNameError.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyObjectAlreadyExists", "", "exceptionSALOMEDS_1_1Study_1_1StudyObjectAlreadyExists.html"))
- insDoc(aux1, gLnk("SALOMEDS::StudyBuilder", "", "interfaceSALOMEDS_1_1StudyBuilder.html"))
- insDoc(aux1, gLnk("SALOMEDS::StudyBuilder::LockProtection", "", "exceptionSALOMEDS_1_1StudyBuilder_1_1LockProtection.html"))
- insDoc(aux1, gLnk("SALOMEDS::StudyManager", "", "interfaceSALOMEDS_1_1StudyManager.html"))
- insDoc(aux1, gLnk("SALOMEDS::UseCaseBuilder", "", "interfaceSALOMEDS_1_1UseCaseBuilder.html"))
- insDoc(aux1, gLnk("SALOMEDS::UseCaseIterator", "", "interfaceSALOMEDS_1_1UseCaseIterator.html"))
-*/
- insDoc(aux1, gLnk("Class Hierarchy", "", "hierarchy.html"))
-
-/*! insDoc(aux1, gLnk("SALOME_ModuleCatalog::Acomponent", "", "interfaceSALOME__ModuleCatalog_1_1Acomponent.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfInteger::IncorrectArgumentLength", "", "exceptionSALOMEDS_1_1AttributeTableOfInteger_1_1IncorrectArgumentLength.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfInteger::IncorrectIndex", "", "exceptionSALOMEDS_1_1AttributeTableOfInteger_1_1IncorrectIndex.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfReal::IncorrectArgumentLength", "", "exceptionSALOMEDS_1_1AttributeTableOfReal_1_1IncorrectArgumentLength.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfReal::IncorrectIndex", "", "exceptionSALOMEDS_1_1AttributeTableOfReal_1_1IncorrectIndex.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfString::IncorrectArgumentLength", "", "exceptionSALOMEDS_1_1AttributeTableOfString_1_1IncorrectArgumentLength.html"))
- insDoc(aux1, gLnk("SALOMEDS::AttributeTableOfString::IncorrectIndex", "", "exceptionSALOMEDS_1_1AttributeTableOfString_1_1IncorrectIndex.html"))
- insDoc(aux1, gLnk("SALOMEDS::Callback", "", "interfaceSALOMEDS_1_1Callback.html"))
- insDoc(aux1, gLnk("SALOMEDS::ChildIterator", "", "interfaceSALOMEDS_1_1ChildIterator.html"))
- insDoc(aux1, gLnk("SALOMEDS::Color", "", "structSALOMEDS_1_1Color.html"))
- aux2 = insFld(aux1, gFld("Engines::Component", "", "interfaceEngines_1_1Component.html"))
- insDoc(aux1, gLnk("Engines::Container", "", "interfaceEngines_1_1Container.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::DefinitionInterface", "", "structSALOME__ModuleCatalog_1_1DefinitionInterface.html"))
- aux2 = insFld(aux1, gFld("SALOMEDS::Driver", "", "interfaceSALOMEDS_1_1Driver.html"))
- insDoc(aux1, gLnk("SALOME::ExceptionStruct", "", "structSALOME_1_1ExceptionStruct.html"))
- aux2 = insFld(aux1, gFld("SALOMEDS::GenericAttribute", "", "interfaceSALOMEDS_1_1GenericAttribute.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeComment", "", "interfaceSALOMEDS_1_1AttributeComment.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeDrawable", "", "interfaceSALOMEDS_1_1AttributeDrawable.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeExpandable", "", "interfaceSALOMEDS_1_1AttributeExpandable.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeInteger", "", "interfaceSALOMEDS_1_1AttributeInteger.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeIOR", "", "interfaceSALOMEDS_1_1AttributeIOR.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeLocalID", "", "interfaceSALOMEDS_1_1AttributeLocalID.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeName", "", "interfaceSALOMEDS_1_1AttributeName.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeOpened", "", "interfaceSALOMEDS_1_1AttributeOpened.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributePersistentRef", "", "interfaceSALOMEDS_1_1AttributePersistentRef.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributePixMap", "", "interfaceSALOMEDS_1_1AttributePixMap.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributePythonObject", "", "interfaceSALOMEDS_1_1AttributePythonObject.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeReal", "", "interfaceSALOMEDS_1_1AttributeReal.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeSelectable", "", "interfaceSALOMEDS_1_1AttributeSelectable.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeSequenceOfInteger", "", "interfaceSALOMEDS_1_1AttributeSequenceOfInteger.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeSequenceOfReal", "", "interfaceSALOMEDS_1_1AttributeSequenceOfReal.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeStudyProperties", "", "interfaceSALOMEDS_1_1AttributeStudyProperties.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeTableOfInteger", "", "interfaceSALOMEDS_1_1AttributeTableOfInteger.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeTableOfReal", "", "interfaceSALOMEDS_1_1AttributeTableOfReal.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeTableOfString", "", "interfaceSALOMEDS_1_1AttributeTableOfString.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeTarget", "", "interfaceSALOMEDS_1_1AttributeTarget.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeTextColor", "", "interfaceSALOMEDS_1_1AttributeTextColor.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeTextHighlightColor", "", "interfaceSALOMEDS_1_1AttributeTextHighlightColor.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeTreeNode", "", "interfaceSALOMEDS_1_1AttributeTreeNode.html"))
- insDoc(aux2, gLnk("SALOMEDS::AttributeUserID", "", "interfaceSALOMEDS_1_1AttributeUserID.html"))
- insDoc(aux1, gLnk("SALOMEDS::GenericAttribute::LockProtection", "", "exceptionSALOMEDS_1_1GenericAttribute_1_1LockProtection.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::IAPP_Affich", "", "structSALOME__ModuleCatalog_1_1IAPP__Affich.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::ModuleCatalog", "", "interfaceSALOME__ModuleCatalog_1_1ModuleCatalog.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::NotFound", "", "exceptionSALOME__ModuleCatalog_1_1NotFound.html"))
- insDoc(aux1, gLnk("SALOMEDS::NotImplemented", "", "exceptionSALOMEDS_1_1NotImplemented.html"))
- insDoc(aux1, gLnk("SALOME::SALOME_Exception", "", "exceptionSALOME_1_1SALOME__Exception.html"))
- insDoc(aux1, gLnk("SALOMEDS::SComponentIterator", "", "interfaceSALOMEDS_1_1SComponentIterator.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::Service", "", "structSALOME__ModuleCatalog_1_1Service.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog::ServicesParameter", "", "structSALOME__ModuleCatalog_1_1ServicesParameter.html"))
- insDoc(aux1, gLnk("SALOME::Session", "", "interfaceSALOME_1_1Session.html"))
- insDoc(aux1, gLnk("SALOME::Session::GUIActive", "", "exceptionSALOME_1_1Session_1_1GUIActive.html"))
- insDoc(aux1, gLnk("SALOME::Session::RunningStudies", "", "exceptionSALOME_1_1Session_1_1RunningStudies.html"))
- aux2 = insFld(aux1, gFld("SALOMEDS::SObject", "", "interfaceSALOMEDS_1_1SObject.html"))
- insDoc(aux2, gLnk("SALOMEDS::SComponent", "", "interfaceSALOMEDS_1_1SComponent.html"))
- insDoc(aux1, gLnk("SALOME::StatSession", "", "structSALOME_1_1StatSession.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study", "", "interfaceSALOMEDS_1_1Study.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyCommentError", "", "exceptionSALOMEDS_1_1Study_1_1StudyCommentError.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyInvalidComponent", "", "exceptionSALOMEDS_1_1Study_1_1StudyInvalidComponent.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyInvalidContext", "", "exceptionSALOMEDS_1_1Study_1_1StudyInvalidContext.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyInvalidDirectory", "", "exceptionSALOMEDS_1_1Study_1_1StudyInvalidDirectory.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyNameAlreadyUsed", "", "exceptionSALOMEDS_1_1Study_1_1StudyNameAlreadyUsed.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyNameError", "", "exceptionSALOMEDS_1_1Study_1_1StudyNameError.html"))
- insDoc(aux1, gLnk("SALOMEDS::Study::StudyObjectAlreadyExists", "", "exceptionSALOMEDS_1_1Study_1_1StudyObjectAlreadyExists.html"))
- insDoc(aux1, gLnk("SALOMEDS::StudyBuilder", "", "interfaceSALOMEDS_1_1StudyBuilder.html"))
- insDoc(aux1, gLnk("SALOMEDS::StudyBuilder::LockProtection", "", "exceptionSALOMEDS_1_1StudyBuilder_1_1LockProtection.html"))
- insDoc(aux1, gLnk("SALOMEDS::StudyManager", "", "interfaceSALOMEDS_1_1StudyManager.html"))
- insDoc(aux1, gLnk("SALOMEDS::UseCaseBuilder", "", "interfaceSALOMEDS_1_1UseCaseBuilder.html"))
- insDoc(aux1, gLnk("SALOMEDS::UseCaseIterator", "", "interfaceSALOMEDS_1_1UseCaseIterator.html"))
-*/
- insDoc(aux1, gLnk("Class methods list", "", "functions.html"))
-/*!
-aux1 = insFld(foldersTree, gFld("Namespace List", "", "namespaces.html"))
- insDoc(aux1, gLnk("Engines", "", "namespaceEngines.html"))
- insDoc(aux1, gLnk("SALOME", "", "namespaceSALOME.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog", "", "namespaceSALOME__ModuleCatalog.html"))
- insDoc(aux1, gLnk("SALOMEDS", "", "namespaceSALOMEDS.html"))
-*/
- insDoc(aux1, gLnk("Namespace Members", "", "namespacemembers.html"))
-
- insDoc(aux1, gLnk("File List", "", "files.html"))
-
-/*!
- insDoc(aux1, gLnk("SALOME_Component.idl", "", "SALOME__Component_8idl.html"))
- insDoc(aux1, gLnk("SALOME_Exception.idl", "", "SALOME__Exception_8idl.html"))
- insDoc(aux1, gLnk("SALOME_ModuleCatalog.idl", "", "SALOME__ModuleCatalog_8idl.html"))
- insDoc(aux1, gLnk("SALOME_Session.idl", "", "SALOME__Session_8idl.html"))
- insDoc(aux1, gLnk("SALOMEDS.idl", "", "SALOMEDS_8idl.html"))
- insDoc(aux1, gLnk("SALOMEDS_Attributes.idl", "", "SALOMEDS__Attributes_8idl.html"))
-*/
-
-aux1 = insFld(foldersTree, gFld("IDL/Python mapping", ""))
- insDoc(aux1, gLnk("Mapping of IDL definitions to Python language", "", "mapping.html"))
- insDoc(aux1, gLnk("Mapping of SALOME IDL definitions to Python language", "", "page2.html"))
-
-/*! insDoc(foldersTree, gLnk("Graphical Class Hierarchy", "", "inherits.html"))
-*/
-aux1 = insFld(foldersTree, gFld("Naming service", ""))
- insDoc(aux1, gLnk("Naming Service Description ", "", "overview_Naming.html"))
- insDoc(aux1, gLnk("Salome_NamingService Class Reference", "", "classSALOME__NamingService.html"))
- insDoc(aux1, gLnk("Examples", "", "examples_Naming.html"))
-aux1 = insFld(foldersTree, gFld("Life Cycle", ""))
- insDoc(aux1, gLnk("Life Cycle Service Description ", "", "overview_Life_Cycle.html"))
- insDoc(aux1, gLnk("Salome_LifeCycleCorba Class Reference", "", "classSALOME__LifeCycleCORBA.html"))
- insDoc(aux1, gLnk("Examples", "", "examples_Life_cycle.html"))
-
-
+++ /dev/null
-//****************************************************************
-// You are free to copy the "Folder-Tree" script as long as you
-// keep this copyright notice:
-// Script found in: http://www.geocities.com/Paris/LeftBank/2178/
-// Author: Marcelino Alves Martins (martins@hks.com) December '97.
-//****************************************************************
-
-//Log of changes:
-// 17 Feb 98 - Fix initialization flashing problem with Netscape
-//
-// 27 Jan 98 - Root folder starts open; support for USETEXTLINKS;
-// make the ftien4 a js file
-//
-// DvH: Dec 2000 - Made some minor changes to support external
-// references
-
-// Definition of class Folder
-// *****************************************************************
-
-function Folder(folderDescription, tagName, hreference) //constructor
-{
- //constant data
- this.desc = folderDescription
- this.tagName = tagName
- this.hreference = hreference
- this.id = -1
- this.navObj = 0
- this.iconImg = 0
- this.nodeImg = 0
- this.isLastNode = 0
-
- //dynamic data
- this.isOpen = true
- this.iconSrc = "ftv2folderopen.png"
- this.children = new Array
- this.nChildren = 0
-
- //methods
- this.initialize = initializeFolder
- this.setState = setStateFolder
- this.addChild = addChild
- this.createIndex = createEntryIndex
- this.hide = hideFolder
- this.display = display
- this.renderOb = drawFolder
- this.totalHeight = totalHeight
- this.subEntries = folderSubEntries
- this.outputLink = outputFolderLink
-}
-
-function setStateFolder(isOpen)
-{
- var subEntries
- var totalHeight
- var fIt = 0
- var i=0
-
- if (isOpen == this.isOpen)
- return
-
- if (browserVersion == 2)
- {
- totalHeight = 0
- for (i=0; i < this.nChildren; i++)
- totalHeight = totalHeight + this.children[i].navObj.clip.height
- subEntries = this.subEntries()
- if (this.isOpen)
- totalHeight = 0 - totalHeight
- for (fIt = this.id + subEntries + 1; fIt < nEntries; fIt++)
- indexOfEntries[fIt].navObj.moveBy(0, totalHeight)
- }
- this.isOpen = isOpen
- propagateChangesInState(this)
-}
-
-function propagateChangesInState(folder)
-{
- var i=0
-
- if (folder.isOpen)
- {
- if (folder.nodeImg)
- if (folder.isLastNode)
- folder.nodeImg.src = "ftv2mlastnode.png"
- else
- folder.nodeImg.src = "ftv2mnode.png"
- folder.iconImg.src = "ftv2folderopen.png"
- for (i=0; i<folder.nChildren; i++)
- folder.children[i].display()
- }
- else
- {
- if (folder.nodeImg)
- if (folder.isLastNode)
- folder.nodeImg.src = "ftv2plastnode.png"
- else
- folder.nodeImg.src = "ftv2pnode.png"
- folder.iconImg.src = "ftv2folderclosed.png"
- for (i=0; i<folder.nChildren; i++)
- folder.children[i].hide()
- }
-}
-
-function hideFolder()
-{
- if (browserVersion == 1 || browserVersion == 3) {
- if (this.navObj.style.display == "none")
- return
- this.navObj.style.display = "none"
- } else {
- if (this.navObj.visibility == "hidden")
- return
- this.navObj.visibility = "hidden"
- }
-
- this.setState(0)
-}
-
-function initializeFolder(level, lastNode, leftSide)
-{
-var j=0
-var i=0
-var numberOfFolders
-var numberOfDocs
-var nc
-
- nc = this.nChildren
-
- this.createIndex()
-
- var auxEv = ""
-
- if (browserVersion > 0)
- auxEv = "<a href='javascript:clickOnNode("+this.id+")'>"
- else
- auxEv = "<a>"
-
- if (level>0)
- if (lastNode) //the last 'brother' in the children array
- {
- this.renderOb(leftSide + auxEv + "<img name='nodeIcon" + this.id + "' src='ftv2mlastnode.png' width=16 height=22 border=0></a>")
-// leftSide = leftSide + "<img src='ftv2blank.png' width=16 height=22>"
- this.isLastNode = 1
- }
- else
- {
- this.renderOb(leftSide + auxEv + "<img name='nodeIcon" + this.id + "' src='ftv2mnode.png' width=16 height=22 border=0></a>")
- leftSide = leftSide + "<img src='ftv2vertline.png' width=16 height=22>"
- this.isLastNode = 0
- }
- else
- this.renderOb("")
-
- if (nc > 0)
- {
- level = level + 1
- for (i=0 ; i < this.nChildren; i++)
- {
- if (i == this.nChildren-1)
- this.children[i].initialize(level, 1, leftSide)
- else
- this.children[i].initialize(level, 0, leftSide)
- }
- }
-}
-
-function drawFolder(leftSide)
-{
- if (browserVersion == 2) {
- if (!doc.yPos)
- doc.yPos=8
- doc.write("<layer id='folder" + this.id + "' top=" + doc.yPos + " visibility=hidden>")
- }
- if (browserVersion == 3)
- {
- doc.write("<div id='folder" + this.id + "' style='visibility:hide;'>")
- }
-
- doc.write("\n<table ")
- if (browserVersion == 1)
- doc.write(" id='folder" + this.id + "' style='position:block;' ")
- doc.write(" border=0 cellspacing=0 cellpadding=0>")
- doc.write("\n<tr><td>")
- doc.write(leftSide)
- this.outputLink()
- doc.write("<img name='folderIcon" + this.id + "' ")
- doc.write("src='" + this.iconSrc+"' border=0></a>")
- doc.write("</td>\n<td valign=middle nowrap>")
- if (USETEXTLINKS)
- {
- this.outputLink()
- doc.write(this.desc + "</a>")
- }
- else
- doc.write(this.desc)
-
-/*!
- if (this.tagName!="")
- {
- doc.write(" [external]")
- }
-*/
- doc.write("</td>")
- doc.write("\n</table>\n")
-
- if (browserVersion == 2) {
- doc.write("</layer>")
- }
- if (browserVersion == 3) {
- doc.write("</div>")
- }
-
- if (browserVersion == 1) {
- this.navObj = doc.all["folder"+this.id]
- this.iconImg = doc.all["folderIcon"+this.id]
- this.nodeImg = doc.all["nodeIcon"+this.id]
- } else if (browserVersion == 2) {
- this.navObj = doc.layers["folder"+this.id]
- this.iconImg = this.navObj.document.images["folderIcon"+this.id]
- this.nodeImg = this.navObj.document.images["nodeIcon"+this.id]
- doc.yPos=doc.yPos+this.navObj.clip.height
- } else if (browserVersion == 3) {
- this.navObj = doc.getElementById("folder"+this.id)
- this.iconImg = doc.images.namedItem("folderIcon"+this.id)
- this.nodeImg = doc.images.namedItem("nodeIcon"+this.id)
- }
-}
-
-function outputFolderLink()
-{
- if (this.hreference)
- {
- doc.write("<a ")
- if (this.tagName)
- {
- doc.write("doxygen='" + this.tagName + "' ");
- }
- doc.write("href='" + this.hreference + "' TARGET=\"basefrm\" ")
- if (browserVersion > 0)
- doc.write("onClick='javascript:clickOnFolder("+this.id+")'")
- doc.write(">")
- }
- else
- doc.write("<a>")
-}
-
-function addChild(childNode)
-{
- this.children[this.nChildren] = childNode
- this.nChildren++
- return childNode
-}
-
-function folderSubEntries()
-{
- var i = 0
- var se = this.nChildren
-
- for (i=0; i < this.nChildren; i++){
- if (this.children[i].children) //is a folder
- se = se + this.children[i].subEntries()
- }
-
- return se
-}
-
-
-// Definition of class Item (a document or link inside a Folder)
-// *************************************************************
-
-function Item(itemDescription, tagName, itemLink) // Constructor
-{
- // constant data
- this.desc = itemDescription
- this.tagName = tagName
- this.link = itemLink
- this.id = -1 //initialized in initalize()
- this.navObj = 0 //initialized in render()
- this.iconImg = 0 //initialized in render()
- this.iconSrc = "ftv2doc.png"
-
- // methods
- this.initialize = initializeItem
- this.createIndex = createEntryIndex
- this.hide = hideItem
- this.display = display
- this.renderOb = drawItem
- this.totalHeight = totalHeight
-}
-
-function hideItem()
-{
- if (browserVersion == 1 || browserVersion == 3) {
- if (this.navObj.style.display == "none")
- return
- this.navObj.style.display = "none"
- } else {
- if (this.navObj.visibility == "hidden")
- return
- this.navObj.visibility = "hidden"
- }
-}
-
-function initializeItem(level, lastNode, leftSide)
-{
- this.createIndex()
-
- if (level>0)
- if (lastNode) //the last 'brother' in the children array
- {
- this.renderOb(leftSide + "<img src='ftv2lastnode.png' width=16 height=22>")
- leftSide = leftSide + "<img src='ftv2blank.png' width=16 height=22>"
- }
- else
- {
- this.renderOb(leftSide + "<img src='ftv2node.png' width=16 height=22>")
- leftSide = leftSide + "<img src='ftv2vertline.png' width=16 height=22>"
- }
- else
- this.renderOb("")
-}
-
-function drawItem(leftSide)
-{
- if (browserVersion == 2)
- doc.write("<layer id='item" + this.id + "' top=" + doc.yPos + " visibility=hidden>")
- if (browserVersion == 3)
- doc.write("<div id='item" + this.id + "' style='display:block;'>")
-
- doc.write("\n<table ")
- if (browserVersion == 1)
- doc.write(" id='item" + this.id + "' style='position:block;' ")
- doc.write(" border=0 cellspacing=0 cellpadding=0>\n")
- doc.write("<tr><td>")
- doc.write(leftSide)
- if (this.link!="")
- {
- doc.write("<a href=" + this.link + ">")
- }
- doc.write("<img id='itemIcon"+this.id+"' ")
- doc.write("src='"+this.iconSrc+"' border=0>")
- if (this.link!="")
- {
- doc.write("</a>")
- }
- doc.write("</td>\n<td valign=middle nowrap>")
- if (USETEXTLINKS && this.link!="")
- doc.write("<a href=" + this.link + ">" + this.desc + "</a>")
- else
- doc.write(this.desc)
-/*!
- if (this.tagName!="")
- {
- doc.write(" [external]");
- }
-*/
- doc.write("\n</table>\n")
-
- if (browserVersion == 2)
- doc.write("</layer>")
- if (browserVersion == 3)
- doc.write("</div>")
-
- if (browserVersion == 1) {
- this.navObj = doc.all["item"+this.id]
- this.iconImg = doc.all["itemIcon"+this.id]
- } else if (browserVersion == 2) {
- this.navObj = doc.layers["item"+this.id]
- this.iconImg = this.navObj.document.images["itemIcon"+this.id]
- doc.yPos=doc.yPos+this.navObj.clip.height
- } else if (browserVersion == 3) {
- this.navObj = doc.getElementById("item"+this.id)
- this.iconImg = doc.images.namedItem("itemIcon"+this.id)
- }
-}
-
-
-// Methods common to both objects (pseudo-inheritance)
-// ********************************************************
-
-function display()
-{
- if (browserVersion == 1 || browserVersion == 3)
- this.navObj.style.display = "block"
- else
- this.navObj.visibility = "show"
-}
-
-function createEntryIndex()
-{
- this.id = nEntries
- indexOfEntries[nEntries] = this
- nEntries++
-}
-
-// total height of subEntries open
-function totalHeight() //used with browserVersion == 2
-{
- var h = this.navObj.clip.height
- var i = 0
-
- if (this.isOpen) //is a folder and _is_ open
- for (i=0 ; i < this.nChildren; i++)
- h = h + this.children[i].totalHeight()
-
- return h
-}
-
-
-// Events
-// *********************************************************
-
-function clickOnFolder(folderId)
-{
- var clicked = indexOfEntries[folderId]
-
- if (!clicked.isOpen)
- clickOnNode(folderId)
-
- return
-
- if (clicked.isSelected)
- return
-}
-
-function clickOnNode(folderId)
-{
- var clickedFolder = 0
- var state = 0
-
- clickedFolder = indexOfEntries[folderId]
- state = clickedFolder.isOpen
-
- clickedFolder.setState(!state) //open<->close
-}
-
-function initializeDocument()
-{
- doc = document;
- if (doc.all)
- browserVersion = 1 //IE4
- else
- if (doc.layers)
- browserVersion = 2 //NS4
- else if(navigator.userAgent.toLowerCase().indexOf('gecko') != -1)
- browserVersion = 3 //mozilla
- else
- browserVersion = 0 //other
-
- foldersTree.initialize(0, 1, "")
- foldersTree.display()
-
- if (browserVersion > 0)
- {
- if(browserVersion != 3)
- doc.write("<layer top="+indexOfEntries[nEntries-1].navObj.top+"> </layer>")
-
- // close the whole tree
- clickOnNode(0)
- // open the root folder
- clickOnNode(0)
- }
-}
-
-// Auxiliary Functions for Folder-Treee backward compatibility
-// *********************************************************
-
-function gFld(description, tagName, hreference)
-{
- folder = new Folder(description, tagName, hreference)
- return folder
-}
-
-function gLnk(description, tagName, linkData)
-{
- fullLink = ""
-
- if (linkData!="")
- {
- fullLink = "'"+linkData+"' target=\"basefrm\""
- }
-
- linkItem = new Item(description, tagName, fullLink)
- return linkItem
-}
-
-function insFld(parentFolder, childFolder)
-{
- return parentFolder.addChild(childFolder)
-}
-
-function insDoc(parentFolder, document)
-{
- parentFolder.addChild(document)
-}
-
-// Global variables
-// ****************
-
-USETEXTLINKS = 1
-indexOfEntries = new Array
-nEntries = 0
-doc = document
-browserVersion = 0
-selectedFolder=0
#
include $(top_srcdir)/salome_adm/unix/make_common_starter.am
-EXTRA_DIST = pythfilter.py
-
-dist-hook:
- cp -rf $(srcdir)/KERNEL $(distdir)
- if test -d "KERNEL"; then \
- find "KERNEL" -name "*.*" -exec cp -rf {} $(distdir)/KERNEL ';' ; \
- fi
- rm -rf `find $(distdir) -name CVS`
-
-clean-local:
- rm -rf KERNEL
- chmod -R +w INPUT
- @for filen in `find INPUT -type f` ; do \
- case $${filen} in \
- INPUT/doxydev | INPUT/doxyuser | INPUT/sources/static/tree.js ) ;; \
- . | .. ) ;; \
- *) echo "Removing $${filen}" ; rm -rf $${filen} ;; \
- esac ; \
- done ;
-
-KERNEL/main.html:../main.dox
- cp -fr $(srcdir)/KERNEL/* ./INPUT; \
- cd ./INPUT; \
- pwd; ls;\
+dev_docs:
echo "DOXYGEN SUPPORT PYTHON - $(DOXYGEN_WITH_PYTHON)"; \
if( test "x$(DOXYGEN_WITH_PYTHON)" = "xyes"); then \
- sed 's|python_extension_must_be_here|*.py|' ./doxyuser > ./doxyuser1; \
- $(DOXYGEN) -u ./doxyuser1; \
+ sed 's|python_extension_must_be_here|*.py|' ./doxyfile > ./doxyfile1; \
+ $(DOXYGEN) -u ./doxyfile1; \
else \
- sed 's|python_extension_must_be_here||' ./doxyuser > ./doxyuser1; \
+ sed 's|python_extension_must_be_here||' ./doxyfile > ./doxyfile1; \
fi; \
echo "DOXYGEN SUPPORT STL - $(DOXYGEN_WITH_STL)"; \
if( test "x$(DOXYGEN_WITH_STL)" = "xyes"); then \
- sed -e 's|BUILTIN_STL_SUPPORT = NO|BUILTIN_STL_SUPPORT = YES|' ./doxyuser1 > ./doxyuser2; \
- mv -f doxyuser2 doxyuser1; \
+ sed -e 's|BUILTIN_STL_SUPPORT = NO|BUILTIN_STL_SUPPORT = YES|' ./doxyfile1 > ./doxyfile2; \
+ mv -f doxyfile2 doxyfile1; \
fi; \
- $(DOXYGEN) ./doxyuser1; \
- cd ..;
+ $(DOXYGEN) ./doxyfile1
+
+clean-local:
+ -rm -fr KERNEL log.txt doxyfile1.bak doxyfile1
-usr_docs:KERNEL/main.html
- if test -d "KERNEL"; then b=; else b="$(srcdir)/"; fi; \
- cp -fr $(srcdir)/KERNEL/sources/static/*.* $(DESTDIR)$(docdir); \
- cp -fr $(srcdir)/KERNEL/sources/ $(DESTDIR)$(docdir); \
- find $$b"KERNEL" -name "*.*" -exec cp -rf {} $(DESTDIR)$(docdir) ';' ; \
- cp -fr $(srcdir)/KERNEL/HTML/ $(DESTDIR)$(docdir); \
- cp -f $(srcdir)/pythfilter.py $(DESTDIR)$(docdir); \
- cp -fr $(srcdir)/KERNEL/exemple/ $(DESTDIR)$(docdir);
+install-data-local:
+ if test -d KERNEL; then \
+ $(INSTALL) -d $(DESTDIR)$(docdir)/tui ; \
+ cp -rp KERNEL $(DESTDIR)$(docdir)/tui ; \
+ fi;
uninstall-local:
-# chmod +w $(DESTDIR)$(docdir)/sources
-# chmod +w $(DESTDIR)$(docdir)/sources/static
-# chmod +w $(DESTDIR)$(docdir)/HTML
- chmod -R +w $(DESTDIR)$(docdir)
- rm -rf $(DESTDIR)$(docdir)/pythfilter.py
- find $(DESTDIR)$(docdir) -name "*.html" -type f -exec rm -rf {} \;
- find $(DESTDIR)$(docdir) -name "*.jpg" -type f -exec rm -rf {} \;
- find $(DESTDIR)$(docdir) -name "*.map" -type f -exec rm -rf {} \;
- find $(DESTDIR)$(docdir) -name "*.md5" -type f -exec rm -rf {} \;
- find $(DESTDIR)$(docdir) -name "*.png" -type f -exec rm -rf {} \;
- find $(DESTDIR)$(docdir) -name "*.gif" -type f -exec rm -rf {} \;
- find $(DESTDIR)$(docdir) -name "*.css" -type f -exec rm -rf {} \;
- find $(DESTDIR)$(docdir) -name "*.js*" -type f -exec rm -rf {} \;
- rm -rf $(DESTDIR)$(docdir)/sources
- rm -rf $(DESTDIR)$(docdir)/HTML
- rm -rf $(DESTDIR)$(docdir)/exemple
- rm -rf $(DESTDIR)$(docdir)/*.in
+ rm -rf $(DESTDIR)$(docdir)/tui/KERNEL
+
+EXTRA_DIST=static KERNEL/exemple
+
+dist-hook:
+ rm -rf $(distdir)/static/CVS ; \
+ rm -rf $(distdir)/KERNEL/exemple/CVS
-dev_docs:
- cp -fr $(srcdir)/KERNEL/* ./INPUT; \
- cd ./INPUT; \
- pwd; ls;\
- echo "DOXYGEN SUPPORT PYTHON - $(DOXYGEN_WITH_PYTHON)"; \
- if( test "x$(DOXYGEN_WITH_PYTHON)" = "xyes"); then \
- sed 's|python_extension_must_be_here|*.py|' ./doxydev > ./doxydev1; \
- $(DOXYGEN) -u ./doxydev1; \
- else \
- sed 's|python_extension_must_be_here||' ./doxydev > ./doxydev1; \
- fi; \
- echo "DOXYGEN SUPPORT STL - $(DOXYGEN_WITH_STL)"; \
- if( test "x$(DOXYGEN_WITH_STL)" = "xyes"); then \
- sed -e 's|BUILTIN_STL_SUPPORT = NO|BUILTIN_STL_SUPPORT = YES|' ./doxydev1 > ./doxydev2; \
- mv -f doxydev2 doxydev1; \
- fi; \
- $(DOXYGEN) ./doxydev1; \
- cd ..;
- $(INSTALL) -d $(docdir)/tui/KERNEL;
-# cp -fr KERNEL $(docdir)/tui
-# cp -fr $(srcdir)/KERNEL/sources/static/*.* $(docdir)/tui/KERNEL;
-# cp -fr $(srcdir)/KERNEL/sources/ $(docdir)/tui/KERNEL;
-# cp -fr $(srcdir)/KERNEL/HTML/ $(docdir)/tui/KERNEL;
-# cp -f $(srcdir)/pythfilter.py $(docdir)/tui/KERNEL;
--- /dev/null
+# Doxyfile 1.4.6
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = "SALOME v.@VERSION@"
+PROJECT_NUMBER =
+OUTPUT_DIRECTORY = KERNEL
+CREATE_SUBDIRS = NO
+OUTPUT_LANGUAGE = English
+USE_WINDOWS_ENCODING = NO
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = NO
+ABBREVIATE_BRIEF =
+ALWAYS_DETAILED_SEC = YES
+INLINE_INHERITED_MEMB = YES
+FULL_PATH_NAMES = YES
+STRIP_FROM_PATH = @top_builddir@ @top_srcdir@
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = NO
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE = 5
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = YES
+OPTIMIZE_OUTPUT_JAVA = NO
+BUILTIN_STL_SUPPORT = NO
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = YES
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = YES
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = YES
+CASE_SENSE_NAMES = YES
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = YES
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = NO
+SORT_BRIEF_DOCS = NO
+SORT_BY_SCOPE_NAME = YES
+GENERATE_TODOLIST = NO
+GENERATE_TESTLIST = NO
+GENERATE_BUGLIST = NO
+GENERATE_DEPRECATEDLIST= NO
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 25
+SHOW_USED_FILES = NO
+SHOW_DIRECTORIES = NO
+FILE_VERSION_FILTER =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE = log.txt
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = \
+ @top_srcdir@/src/DSC
+FILE_PATTERNS = *.idl *.cxx *.hxx *.h *.hh *.i *c *.cc python_extension_must_be_here
+RECURSIVE = YES
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS =
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS =
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH =
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION = YES
+USE_HTAGS = NO
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 3
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = .
+HTML_FILE_EXTENSION = .html
+HTML_HEADER = @srcdir@/static/header.html
+HTML_FOOTER = @srcdir@/static/footer.html
+HTML_STYLESHEET =
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+BINARY_TOC = YES
+TOC_EXPAND = YES
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = NO
+TREEVIEW_WIDTH = 250
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = NO
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+HIDE_UNDOC_RELATIONS = NO
+HAVE_DOT = YES
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+GROUP_GRAPHS = NO
+UML_LOOK = YES
+TEMPLATE_RELATIONS = YES
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = NO
+CALL_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
+DOT_IMAGE_FORMAT = jpg
+DOT_PATH =
+DOTFILE_DIRS =
+MAX_DOT_GRAPH_WIDTH = 1024
+MAX_DOT_GRAPH_HEIGHT = 1200
+MAX_DOT_GRAPH_DEPTH = 0
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = NO
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO
+++ /dev/null
-# Copyright (C) 2007-2008 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
-#
-#!/usr/bin/env python
-#
-import getopt
-import glob
-import os.path
-import shutil
-import string
-import sys
-import token
-import tokenize
-
-from stat import *
-
-OUTSIDE = 0
-BUILD_COMMENT = 1
-BUILD_CLASS_DECL = 2
-BUILD_CLASS_BODY = 3
-BUILD_DEF_DECL = 4
-BUILD_DEF_BODY = 5
-IMPORT = 6
-IMPORT_OP = 7
-IMPORT_APPEND = 8
-
-# Output file stream
-outfile = sys.stdout
-
-# Output buffer
-outbuffer = []
-
-out_row = 0
-out_col = 0
-
-# Variables used by rec_name_n_param()
-name = ""
-param = ""
-doc_string = ""
-record_state = 0
-bracket_counter = 0
-
-# Tuple: (row,column)
-class_spos = (0,0)
-def_spos = (0,0)
-import_spos = (0,0)
-
-# Which import was used? ("import" or "from")
-import_token = ""
-
-# Comment block buffer
-comment_block = []
-comment_finished = 0
-
-# Imported modules
-modules = []
-
-# Program state
-stateStack = [OUTSIDE]
-
-# Keep track of whether module has a docstring
-module_has_docstring = False
-
-# Keep track of member protection
-protection_level = "public"
-private_member = False
-
-# Keep track of the module namespace
-namespace = ""
-
-######################################################################
-# Output string s. '\n' may only be at the end of the string (not
-# somewhere in the middle).
-#
-# In: s - String
-# spos - Startpos
-######################################################################
-def output(s,spos, immediate=0):
- global outbuffer, out_row, out_col, outfile
-
- os = string.rjust(s,spos[1]-out_col+len(s))
- if immediate:
- outfile.write(os)
- else:
- outbuffer.append(os)
- if (s[-1:]=="\n"):
- out_row = out_row+1
- out_col = 0
- else:
- out_col = spos[1]+len(s)
-
-
-######################################################################
-# Records a name and parameters. The name is either a class name or
-# a function name. Then the parameter is either the base class or
-# the function parameters.
-# The name is stored in the global variable "name", the parameters
-# in "param".
-# The variable "record_state" holds the current state of this internal
-# state machine.
-# The recording is started by calling start_recording().
-#
-# In: type, tok
-######################################################################
-def rec_name_n_param(type, tok):
- global record_state,name,param,doc_string,bracket_counter
- s = record_state
- # State 0: Do nothing.
- if (s==0):
- return
- # State 1: Remember name.
- elif (s==1):
- name = tok
- record_state = 2
- # State 2: Wait for opening bracket or colon
- elif (s==2):
- if (tok=='('):
- bracket_counter = 1
- record_state=3
- if (tok==':'): record_state=4
- # State 3: Store parameter (or base class) and wait for an ending bracket
- elif (s==3):
- if (tok=='*' or tok=='**'):
- tok=''
- if (tok=='('):
- bracket_counter = bracket_counter+1
- if (tok==')'):
- bracket_counter = bracket_counter-1
- if bracket_counter==0:
- record_state=4
- else:
- param=param+tok
- # State 4: Look for doc string
- elif (s==4):
- if (type==token.NEWLINE or type==token.INDENT or type==token.SLASHEQUAL):
- return
- elif (tok==":"):
- return
- elif (type==token.STRING):
- while tok[:1]=='r' or tok[:1]=='u':
- tok=tok[1:]
- while tok[:1]=='"':
- tok=tok[1:]
- while tok[-1:]=='"':
- tok=tok[:-1]
- doc_string=tok
- record_state=0
-
-######################################################################
-# Starts the recording of a name & param part.
-# The function rec_name_n_param() has to be fed with tokens. After
-# the necessary tokens are fed the name and parameters can be found
-# in the global variables "name" und "param".
-######################################################################
-def start_recording():
- global record_state,param,name, doc_string
- record_state=1
- name=""
- param=""
- doc_string=""
-
-######################################################################
-# Test if recording is finished
-######################################################################
-def is_recording_finished():
- global record_state
- return record_state==0
-
-######################################################################
-## Gather comment block
-######################################################################
-def gather_comment(type,tok,spos):
- global comment_block,comment_finished
- if (type!=tokenize.COMMENT):
- comment_finished = 1
- else:
- # Output old comment block if a new one is started.
- if (comment_finished):
- print_comment(spos)
- comment_finished=0
- if (tok[0:2]=="##" and tok[0:3]!="###"):
- comment_block.append(tok[2:])
-
-######################################################################
-## Output comment block and empty buffer.
-######################################################################
-def print_comment(spos):
- global comment_block,comment_finished
- if (comment_block!=[]):
- output("/**\n",spos)
- for c in comment_block:
- output(c,spos)
- output("*/\n",spos)
- comment_block = []
- comment_finished = 0
-
-######################################################################
-def set_state(s):
- global stateStack
- stateStack[len(stateStack)-1]=s
-
-######################################################################
-def get_state():
- global stateStack
- return stateStack[len(stateStack)-1]
-
-######################################################################
-def push_state(s):
- global stateStack
- stateStack.append(s)
-
-######################################################################
-def pop_state():
- global stateStack
- stateStack.pop()
-
-
-######################################################################
-def tok_eater(type, tok, spos, epos, line):
- global stateStack,name,param,class_spos,def_spos,import_spos
- global doc_string, modules, import_token, module_has_docstring
- global protection_level, private_member
-
- rec_name_n_param(type,tok)
- if (string.replace(string.strip(tok)," ","")=="##private:"):
- protection_level = "private"
- output("private:\n",spos)
- elif (string.replace(string.strip(tok)," ","")=="##protected:"):
- protection_level = "protected"
- output("protected:\n",spos)
- elif (string.replace(string.strip(tok)," ","")=="##public:"):
- protection_level = "public"
- output("public:\n",spos)
- else:
- gather_comment(type,tok,spos)
-
- state = get_state()
-
-# sys.stderr.write("%d: %s\n"%(state, tok))
-
- # OUTSIDE
- if (state==OUTSIDE):
- if (tok=="class"):
- start_recording()
- class_spos = spos
- push_state(BUILD_CLASS_DECL)
- elif (tok=="def"):
- start_recording()
- def_spos = spos
- push_state(BUILD_DEF_DECL)
- elif (tok=="import") or (tok=="from"):
- import_token = tok
- import_spos = spos
- modules = []
- push_state(IMPORT)
- elif (spos[1] == 0 and tok[:3] == '"""'):
- # Capture module docstring as namespace documentation
- module_has_docstring = True
- #comment_block.append("\\namespace %s\n" % namespace)
- comment_block.append(tok[3:-3])
- print_comment(spos)
-
- # IMPORT
- elif (state==IMPORT):
- if (type==token.NAME):
- modules.append(tok)
- set_state(IMPORT_OP)
- # IMPORT_OP
- elif (state==IMPORT_OP):
- if (tok=="."):
- set_state(IMPORT_APPEND)
- elif (tok==","):
- set_state(IMPORT)
- else:
- for m in modules:
- output('#include "'+m.replace('.',os.sep)+'.py"\n', import_spos, immediate=1)
- if import_token=="from":
- output('using namespace '+m.replace('.', '::')+';\n', import_spos)
- pop_state()
- # IMPORT_APPEND
- elif (state==IMPORT_APPEND):
- if (type==token.NAME):
- modules[len(modules)-1]+="."+tok
- set_state(IMPORT_OP)
- # BUILD_CLASS_DECL
- elif (state==BUILD_CLASS_DECL):
- if (is_recording_finished()):
- s = "class "+name
- if (param!=""): s = s+" : public "+param.replace('.','::')
- if (doc_string!=""): comment_block.append(doc_string)
- print_comment(class_spos)
- output(s+"\n",class_spos)
- output("{\n",(class_spos[0]+1,class_spos[1]))
- protection_level = "public"
- output(" public:\n",(class_spos[0]+2,class_spos[1]))
- set_state(BUILD_CLASS_BODY)
- # BUILD_CLASS_BODY
- elif (state==BUILD_CLASS_BODY):
- if (type!=token.INDENT and type!=token.NEWLINE and type!=40 and
- type!=tokenize.NL and type!=tokenize.COMMENT and
- (spos[1]<=class_spos[1])):
- output("}; // end of class\n",(out_row+1,class_spos[1]))
- pop_state()
- elif (tok=="def"):
- start_recording()
- def_spos = spos
- push_state(BUILD_DEF_DECL)
- # BUILD_DEF_DECL
- elif (state==BUILD_DEF_DECL):
- if (is_recording_finished()):
- s = ''
- # Do we document a class method? then remove the 'self' parameter
- if BUILD_CLASS_BODY in stateStack:
- params = param.split(",")
- if params[0] == 'self':
- param = string.join(params[1:], ",")
- else:
- s = 'static '
- if params[0] == 'cls':
- param = string.join(params[1:], ",")
- s = s+name+"("+param+");\n"
- if len(name) > 1 \
- and name[0:2] == '__' \
- and name[len(name)-2:len(name)] != '__' \
- and protection_level != 'private':
- private_member = True
- output(" private:\n",(def_spos[0]+2,def_spos[1]))
- else:
- s = name+"("+param+");\n"
- if (doc_string!=""): comment_block.append(doc_string)
- print_comment(def_spos)
- output(s,def_spos)
-# output("{\n",(def_spos[0]+1,def_spos[1]))
- set_state(BUILD_DEF_BODY)
- # BUILD_DEF_BODY
- elif (state==BUILD_DEF_BODY):
- if (type!=token.INDENT and type!=token.NEWLINE \
- and type!=40 and type!=tokenize.NL \
- and (spos[1]<=def_spos[1])):
-# output("} // end of method/function\n",(out_row+1,def_spos[1]))
- if private_member and protection_level != 'private':
- private_member = False
- output(" " + protection_level + ":\n",(def_spos[0]+2,def_spos[1]))
- pop_state()
-# else:
-# output(tok,spos)
-
-
-def dump(filename):
- f = open(filename)
- r = f.readlines()
- for s in r:
- sys.stdout.write(s)
-
-def filter(filename):
- global name, module_has_docstring
- global namespace,outbuffer
- outbuffer=[]
-
- path,name = os.path.split(filename)
- root,ext = os.path.splitext(name)
-
-
- if namespace:
- if root == "__init__":
- root=namespace
- else:
- root=namespace+"::"+root
- else:
- root=root
-
- output("namespace "+root+" {\n",(0,0))
-
- # set module name for tok_eater to use if there's a module doc string
- package=namespace
- name = root
- namespace = root
-
- sys.stderr.write("namespace: "+namespace+'\n')
- sys.stderr.write("root: "+root+'\n')
- sys.stderr.write('Filtering "'+filename+'"...')
-
- f = open(filename)
- tokenize.tokenize(f.readline, tok_eater)
- f.close()
- print_comment((0,0))
-
- output("\n",(0,0))
- output("} // end of namespace\n",(0,0))
-
- if not module_has_docstring:
- # Put in default namespace documentation
- output('/** \\namespace '+root+' \n',(0,0))
- output(' \\brief Module "%s" */\n'%(root),(0,0))
-
- for s in outbuffer:
- outfile.write(s)
- namespace=package
- module_has_docstring = False
-
-
-def filterFile(filename, out=sys.stdout):
- global outfile
-
- outfile = out
-
- try:
- root,ext = os.path.splitext(filename)
-
- if ext==".py":
- filter(filename)
- else:
- dump(filename)
-
- sys.stderr.write("OK\n")
- except IOError,e:
- sys.stderr.write(e[1]+"\n")
-
-
-######################################################################
-
-# preparePath
-def preparePath(path):
- """Prepare a path.
-
- Checks if the path exists and creates it if it does not exist.
- """
- if not os.path.exists(path):
- parent = os.path.dirname(path)
- if parent!="":
- preparePath(parent)
- os.mkdir(path)
-
-# isNewer
-def isNewer(file1,file2):
- """Check if file1 is newer than file2.
-
- file1 must be an existing file.
- """
- if not os.path.exists(file2):
- return True
- return os.stat(file1)[ST_MTIME]>os.stat(file2)[ST_MTIME]
-
-# convert
-def convert(srcpath, destpath):
- """Convert a Python source tree into a C+ stub tree.
-
- All *.py files in srcpath (including sub-directories) are filtered
- and written to destpath. If destpath exists, only the files
- that have been modified are filtered again. Files that were deleted
- from srcpath are also deleted in destpath if they are still present.
- The function returns the number of processed *.py files.
- """
- global namespace
- count=0
- l=os.listdir(srcpath)
- if "__init__.py" in l:
- if namespace:
- namespace=namespace+"::"+os.path.split(srcpath)[1]
- else:
- namespace=os.path.split(srcpath)[1]
- print "It's a package:",namespace
- sp = os.path.join(srcpath,"*")
- sfiles = glob.glob(sp)
- dp = os.path.join(destpath,"*")
- dfiles = glob.glob(dp)
- leftovers={}
- for df in dfiles:
- leftovers[os.path.basename(df)]=1
-
- for srcfile in sfiles:
- basename = os.path.basename(srcfile)
- if basename in leftovers:
- del leftovers[basename]
-
- # Is it a subdirectory?
- if os.path.isdir(srcfile):
- package=namespace
- sdir = os.path.join(srcpath,basename)
- ddir = os.path.join(destpath,basename)
- count+=convert(sdir, ddir)
- namespace=package
- continue
- # Check the extension (only *.py will be converted)
- root, ext = os.path.splitext(srcfile)
- if ext.lower()!=".py":
- continue
-
- destfile = os.path.join(destpath,basename)
- if destfile==srcfile:
- print "WARNING: Input and output names are identical!"
- sys.exit(1)
-
- count+=1
-# sys.stdout.write("%s\015"%(srcfile))
-
- if isNewer(srcfile, destfile):
- preparePath(os.path.dirname(destfile))
- out=open(destfile,"w")
- filterFile(srcfile, out)
- out.close()
-# os.system("python %s -f %s>%s"%(sys.argv[0],srcfile,destfile))
-
- # Delete obsolete files in destpath
- for df in leftovers:
- dname=os.path.join(destpath,df)
- if os.path.isdir(dname):
- try:
- shutil.rmtree(dname)
- except:
- print "Can't remove obsolete directory '%s'"%dname
- else:
- try:
- os.remove(dname)
- except:
- print "Can't remove obsolete file '%s'"%dname
-
- return count
-
-
-######################################################################
-######################################################################
-######################################################################
-
-filter_file = False
-
-try:
- opts, args = getopt.getopt(sys.argv[1:], "hf", ["help"])
-except getopt.GetoptError,e:
- print e
- sys.exit(1)
-
-for o,a in opts:
- if o=="-f":
- filter_file = True
-
-if filter_file:
- # Filter the specified file and print the result to stdout
- filename = string.join(args)
- filterFile(filename)
-else:
-
- if len(args)!=2:
- sys.stderr.write("%s options input output\n"%(os.path.basename(sys.argv[0])))
- sys.exit(1)
-
- # Filter an entire Python source tree
- print '"%s" -> "%s"\n'%(args[0],args[1])
- c=convert(args[0],args[1])
- print "%d files"%(c)
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+</head>
+<body>
+<hr style="width: 100%; height: 2px;">
+<div style="text-align: center;">Copyright © 2003-2007 CEA, EDF<br>
+</div>
+</body>
+</html>
--- /dev/null
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <title>$title</title>
+ <link href="tabs.css" rel="stylesheet" type="text/css">
+ <link href="doxygen.css" rel="stylesheet" type="text/css">
+</head>
+<hr>
+<center>
+SALOME documentation central
+</center>
+<hr>
\section S1_unit SALOME KERNEL source code structuration
-<ol>
-<li> <b>General structure of KERNEL_SRC</b>
+\subsection sub11 General structure of KERNEL_SRC
-- KERNEL_SRC :
+- KERNEL_SRC :\n
Some README files and configuration tools for build
-- KERNEL_SRC/adm_local :
+- KERNEL_SRC/adm_local :\n
Part of the configuration files, other modules have a directory with the
same name. Not used in KERNEL.
-- KERNEL_SRC/bin :
+- KERNEL_SRC/bin :\n
Python and shell scripts used at run time.
Kit to install a %SALOME Application.
-- KERNEL_SRC/doc :
+- KERNEL_SRC/doc :\n
Kit for KERNEL end user documentation production:
public interfaces, Python, CORBA.
Integrator and Developper documentation.
-- KERNEL_SRC/idl :
+- KERNEL_SRC/idl :\n
All CORBA interfaces from KERNEL are regrouped here.
-- KERNEL_SRC/resources :
+- KERNEL_SRC/resources :\n
Configuration files for servers (examples).
Interfaces definitions for KERNEL test components.
-- KERNEL_SRC/salome_adm :
+- KERNEL_SRC/salome_adm :\n
Configuration files used by autotools (M4 macros & co.)
-- KERNEL_SRC/src :
+- KERNEL_SRC/src :\n
The source code (C++ and Python)
-</li>
-<li>
-<b>Directory src: C++ and Python source code</b>
+\subsection sub12 Directory src: C++ and Python source code
<ol>
<li>
<b>Basic services non related to CORBA</b>
-- Basics
+- Basics\n
%A set of general purpose C++ services, not related to CORBA.
Some general purpose services that are in Utils directory (CORBA related),
are progressivley moved here, as they are not related to CORBA.
-- SALOMELocalTrace
+- SALOMELocalTrace\n
%A multithread trace system that allows message tracing on standard error
or a file.
-- CASCatch
+- CASCatch\n
Exceptions and signal handler.
-- HDFPersist
+- HDFPersist\n
%A C++ interface to HDF.
</li>
<li>
<b>Basic CORBA services</b>
-- Logger :
+- Logger :\n
%A CORBA %server that collects the trace messages from differents CORBA
process.
-- SALOMETraceCollector :
+- SALOMETraceCollector :\n
%A multithread trace system derived from SALOMELocalTrace, that sends messages
to Logger %server via CORBA.
-- Utils :
+- Utils :\n
%A set of general purpose services related to CORBA, such as basic CORBA
exception system. See also Basics directory above.
-- NamingService :
+- NamingService :\n
C++ and Python interfaces to name, store and retrieve CORBA objects
-- GenericObj :
+- GenericObj :\n
%A generic CORBA interface for CORBA objects, to count distributed references,
and to allow destruction by client.
<li>
<b>Miscellaneous CORBA servers</b>
-- %Registry :
+- %Registry :\n
Implements SALOME_registry.idl.
Provides a CORBA %server library and a separate %server program.
-- ModuleCatalog :
+- ModuleCatalog :\n
Implements SALOME_moduleCatalog.idl.
Provide a CORBA %server library and separate %server and client programs.
-- ModuleGenerator :
+- ModuleGenerator :\n
Tool to generate a module catalog from CORBA idl
-- ResourcesManager :
+- ResourcesManager :\n
library included in container %server
-- Notification :
+- Notification :\n
library included in differents servers (container)
- NOTIFICATION_SWIG
- SALOMEDSImpl
-- SALOMEDS
+- %SALOMEDS
</li>
<li>
\section S2_unit Tools and principles used for Unit testing
-<b>**TO BE COMPLETED**</b>
+<b>TO BE COMPLETED</b>
Unit Testing rely on cppunit package for C++ testing, and on unittest module
for Python. See these products for general principles of unit testing.
+++ /dev/null
-# Copyright (C) 2007-2008 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
-#
-#/bin/sh
-# ===================================================================
-# This shell script is provided for generating the html files
-# from the txt files (restructured text) in the source directory.
-# Usage: just execute the script where it stands in the source
-# directory. The file list has to be updated manually when adding
-# a new restructured text file.
-# Note that the building process executes a target rstdoc that
-# generates the html documentation without need of this script.
-# The autoconficuration (check_htmlgen.m4) set the correct generator
-# rst2html by replacing the @RST2HTML@ tag.
-# ===================================================================
-# (CSSI - gboulant - 25/10/05)
-# This must be updated manually in this script (for source usage only)
-#
-RST2HTML=rst2html
-
-FILELIST="index
- UnitTests
- SALOME_Application
- INSTALL
- kernel_resources
- userguide"
-
-STYLESHEET=rst.css
-RSTOPTS="--output-encoding=latin1 --stylesheet=$STYLESHEET"
-
-for file in $FILELIST; do
- bfn=`basename $file .txt`
- echo "Generating ${bfn}.html from ${bfn}.txt ..."
- $RST2HTML $RSTOPTS ${bfn}.txt ${bfn}.html
-done
-
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
-// File : SALOME_Ports.idl
+// File : Calcium_Ports.idl
// Author : Eric Fayolle, EDF
//
#ifndef _CALCIUM_PORTS_IDL_
#include "SALOME_Ports.idl"
+/*! \file Calcium_Ports.idl \brief interfaces for Calcium ports
+*/
+
module Ports {
+/*! \brief module that contains interfaces to define Calcium ports
+*/
module Calcium_Ports {
const long UNLIMITED_STORAGE_LEVEL = -70;
#include "SALOME_Component.idl"
#include "SALOME_Ports.idl"
-/*! \file
- This is a package that contains IDL interfaces that permits to add
- a dynamic port model to the SALOME object model.
+/*! \file DSC_Engines.idl
+ \brief interfaces that permits to add a dynamic port model to the SALOME object model.
*/
module Engines {
/*--------------------------------------------------------------------------------------------*/
/*-------------------------------------- Types Part ------------------------------------------*/
+ //! a uses port
/*!
This sequence is a uses port. It's a sequence since a uses port can be
connected with x provides port. Sometimes this kind of uses port is called multiple port.
*/
typedef sequence<Ports::Port> uses_port;
+ //! This enumeration is used when the connection of a port (uses or provides) is changed.
/*!
- This enumeration is used when the connection of a port (uses or provides)
- is changed. This information is for the component's user code.
+ This information is for the component's user code.
*/
enum Message {AddingConnection,
RemovingConnection,
ApplicationError};
- /*!
- This exception is raised when a port's name is gived before
- it is added to the component.
- */
+ //! This exception is raised when a port is used before it is added to the component.
exception PortNotDefined {};
- /*!
- This exception is raised if you try to add a port with the same
- name than a previous defined port.
- */
+ //! This exception is raised if you try to add a port with the same name than a previous defined port.
exception PortAlreadyDefined {};
- /*!
- This exception is raised when you try to use a port that is not connected.
- */
+ //! This exception is raised when you try to use a port that is not connected.
exception PortNotConnected {};
+ //! This exception is raised if the type of the provides port is bad.
/*!
- This exception is raised if the type of the provides port is bad.
This exception contains a string that gives what type is expected
and the type that the operation received.
*/
string received;
};
- /*!
- Port's reference is Nil !
- */
+ //! Port's reference is Nil !
exception NilPort {};
- /*!
- Port's reference is not the right reference.
- */
+ //! Port's reference is not the right reference.
exception BadPortReference {};
- /*!
- Object porperty is not good for the port
- */
+ //! Object property is not good for the port
exception BadProperty {};
/*--------------------------------------------------------------------------------------------*/
/*-------------------------------------- Operation Part --------------------------------------*/
+ //! This operation adds a provides port to the component.
/*!
- This operation adds a provides port to the component.
\param ref port's Corba reference.
\param provides_port_name port's name.
NilPort,
BadProperty);
+ //! This operation adds a uses port to the component.
/*!
- This operation adds a uses port to the component.
\param repository_id port's Corba repository id.
Eg : IDL:toto.tata/MODULE/INTERFACE_NAME:1.0
in Ports::PortProperties port_prop) raises(PortAlreadyDefined,
BadProperty);
+ //! Get a provides port of the component.
/*!
- This operation is used to get a provides port of the component.
It can be used by the framework or the component himself.
If it's the framework that wants the port, the reference has to be gived
PortNotConnected,
BadPortType);
+ //! Get a uses port of the component.
/*!
- This operation is used to get a uses port of the component.
It can be used by the framework or the component himself.
Actually, only the user layer of the component will use this operation.
A uses port could be obtained if and only if the uses port is connected. The sequence
BadPortType);
+ //! Connect a provides port with a uses port.
/*!
- This operation connects a provides port with a uses port.
\param provides_port_name provides port's name.
*/
void connect_provides_port(in string provides_port_name) raises(PortNotDefined);
+ //! Connect a uses port with a provides port.
/*!
- This operation connects a uses port with a provides port.
\param uses_port_name uses port's name.
\param provides_port_ref provides port's Corba reference.
in Ports::Port provides_port_ref) raises(PortNotDefined,
BadPortType,
NilPort);
+
+ //! Check if a port is connected.
/*!
- This operation tests if a port is connected. You can test
- a uses port or a provides port.
+ You can test a uses port or a provides port.
\param port_name port's name.
\return true if the uses port is connected.
*/
boolean is_connected(in string port_name) raises(PortNotDefined);
+ //! Disconnect a uses port from a provides port.
/*!
- This operation disconnects a uses port to a provides port.
\param provides_port_name provides port's name.
\param message state associated with the disconnection.
in Engines::DSC::Message message) raises(PortNotDefined,
PortNotConnected);
+ //! Disconnect a provides port from a uses port.
/*!
- This operation disconnects a provides port to a uses port.
\param uses_port_name uses port's name.
\param provides_port_ref CORBA reference of the provides port.
in Engines::DSC::Message message) raises(PortNotDefined,
PortNotConnected,
BadPortReference);
+ //! Get port's property object.
/*!
- This operation permits to get port's property object.
\param port_name port's name.
\return properties object's CORBA reference.
*/
interface ConnectionManager {
- /*!
- The Id gived to the disconnect method is bad.
- */
+ //! The Id given to the disconnect method is bad.
exception BadId {};
- /*!
- A connection Id. It's unique.
- */
+ //! A connection Id. It's unique.
typedef short connectionId;
+ //! Connect a uses port with a provides port.
/*!
- This operation connects a uses port with a provides port.
\param uses_component The component that have the uses port.
\param uses_port_name uses port's name.
Engines::DSC::BadPortType,
Engines::DSC::NilPort);
+ //! Release a connection that has been previously created by the ConnectionManager.
/*!
- This operation releases a connection that has been previously created by
- the ConnectionManager.
\param id The id of the connection previously gived by the connect operation
of the ConnectionManager.
Engines::DSC::PortNotConnected,
Engines::DSC::BadPortReference);
- /*!
- Shutdown the ConnectionManager process.
- */
+ //! Shutdown the ConnectionManager process.
oneway void ShutdownWithExit();
- /*!
- Returns the PID of the connection manager
- */
+ //! Return the PID of the connection manager
long getPID();
};
*/
interface Superv_Component : Engines::DSC {
+ //! Operation to create the service ports before it is executed
/*!
The SUPERV module call this method before starting the service. Thus the service
- can add is dynamics ports before it is started.
+ can add its dynamics ports before it is started.
\param service_name service's name.
\return true if the service is correctly initialised.
#define SALOME_LOGGER_IDL
#pragma prefix "opencascade.com"
+/*! \file Logger.idl \brief interfaces for %SALOME logger
+*/
+/*! \brief module that provides interface to %SALOME logger
+*/
module SALOME_Logger
{
+/*! \brief interface to use the %SALOME logger
+*/
interface Logger
{
- //put message into one special place for all servers using Logger
+ /*! \brief put message into one special place for all servers using %SALOME logger
+
+ \param message the message to send
+ */
oneway void putMessage (in string message);
+
+ //! check if the logger is running
void ping ();
+ //! shutdown the logger server
void shutdown();
};
};
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
-// File : SALOME_Ports.idl
+// File : Palm_Ports.idl
// Author : André RIBES, EDF
//
#ifndef _PALM_PORTS_IDL_
#include "SALOME_Ports.idl"
-/*! \file
- This file contains IDL palm ports declations.
+/*! \file Palm_Ports.idl
+ \brief This file contains IDL palm ports declarations.
*/
module Ports {
*/
interface Palm_Data_Short_Port : Ports::Data_Port {
- /*!
- This operation permits to transmit a short.
+ /*! \brief This operation permits to transmit a short.
\param data the short transmitted.
\param time time associated to the short.
/*! \brief Interface of a sequence of short port.
*/
interface Palm_Data_Seq_Short_Port : Ports::Data_Port {
- /*!
- This operation permits to transmit a sequence of short.
+ /*! \brief This operation permits to transmit a sequence of short.
\param data the sequence transmitted.
\param time time associated to the data.
// Author : Yves FRICAUD
// $Header$
//
-/*!
- \file SALOMEDS.idl This file contains a set of interfaces used for creation, managment
+/*! \file SALOMEDS.idl \brief This file contains a set of interfaces used for creation, management
and modification of the %Study
*/
#include "SALOME_Exception.idl"
#include "SALOME_GenericObj.idl"
-/*!
+/*! \brief
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.
-
+/*! \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 the names of studies which are currently open in this %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 a 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 ;
-/*! An unbounded sequence of sequence of strings
-*/
+//! An unbounded sequence of sequence of strings
typedef sequence<ListOfStrings> ListOfListOfStrings ;
-/*! A byte stream which is used for binary data transfer between different components
-*/
+//! 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 UseCaseIterator;
interface UseCaseBuilder;
-/*! List of attributes of %SObjects
-*/
+//! List of attributes of %SObjects
typedef sequence<GenericAttribute> ListOfAttributes;
-/*! Exception indicating that this feature hasn't been implemented in %SALOME PRO application.
-*/
+//! 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 the persistent reference to the %Study.
-*/
+//! Get the persistent reference to the %Study.
PersistentReference GetPersistentReference();
-/*!
- Gets a transient reference to the %Study.
-*/
+//! Get a transient reference to the %Study.
SalomeReference GetTransientReference();
-/*!
- Returns True if the %Study is empty
+/*! \brief indicate whether the %Study is empty
+
+ \return True if the %Study is empty
*/
boolean IsEmpty();
-/*!
- 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);
-/*!
- 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);
-/*!
- Allows to find a %SObject by the Name Attribute of this %SObject
+/*! \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
-<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>
*/
SObject FindObject (in string anObjectName);
-/*!
- 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);
-/*!
- Allows to create a %SObject by its ID
+/*! \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);
-/*!
- Allows to find a %SObject by IOR of the object belonging to this %SObject.
+/*! \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);
-/*!
- Finds in the study all %SObjects produced by a given %Component.
+/*! \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);
-/*!
- 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);
-/*!
- Returns the path to the %SObject.
+/*! \brief Get the path to the %SObject.
*/
string GetObjectPath(in Object theObject);
-/*!
- Sets the context of the %Study.
- \param thePath String parameter defining the context of the study.
+/*! \brief Set 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 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);
-/*!
- Gets the context of the %Study.
+/*! \brief Get 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>
-
+<em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
*/
string GetContext();
-/*!
- 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);
-/*!
- 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);
-/*!
- 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);
-/*!
- 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);
-/*!
- Creates a new iterator of child levels of the given %SObject.
+/*! \brief Create a new iterator of child levels of the given %SObject.
+
\param aSO The given %SObject
\return A new iterator of child levels of the given %SObject.
*/
ChildIterator NewChildIterator(in SObject aSO);
-/*!
- Creates a new iterator of the %SComponents.
+/*! \brief Create a new iterator of the %SComponents.
\return A new iterator of the %SComponents.
*/
SComponentIterator NewComponentIterator();
-/*!
- Creates a new %StudyBuilder to add or modify an object in the study.
- \return A new %StudyBuilder.
+/*! \brief Create 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() ;
/*! \brief Labels dependency
/*! \brief Getting properties of the study
- Returns the attriubte, which contains the properties of this study.
+ Returns the attribute, 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>
+<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
+/*! \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();
-/*!
- Marks the %study as being modified and not saved.
+/*! \brief Mark the %study as being modified and not saved.
*/
void Modified();
-/*!
- Determines the file where the %study has been saved
+/*! \brief Indicate the file where the %study has been saved
*/
attribute string URL;
\return An object
*/
Object ConvertIORToObject(in string theIOR);
-/*!
- Gets a new %UseCaseBuilder.
+/*! \brief Get a new %UseCaseBuilder.
*/
UseCaseBuilder GetUseCaseBuilder();
-/*!
- 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();
-/*!
- 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);
boolean DumpStudy(in string thePath, in string theBaseName, in boolean isPublished);
-/*!
- Returns an AttributeParameter used to store common parameters for given %theSavePoint.
+/*! \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);
-/*!
- Returns an AttributeParameter used to store parameters for given %theModuleName.
+/*! \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);
-/*!
- Returns a default Python script to restore visual parameters for given %theModuleName.
+/*! \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")
*/
long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
-/*!
- Marks this Study as being locked by the given locker. The lock status can be checked by method IsStudyLocked
+/*! \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);
-/*!
- Returns True if the Study was marked locked.
+/*! \brief Indicate if the Study is locked
+
+ Returns True if the Study was marked locked.
*/
boolean IsStudyLocked();
-/*!
- Marks this Study as being unlocked by the given locker. The lock status can be checked by method 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);
-/*!
- Returns the list iof IDs of the Study's lockers.
+/*! \brief Get the list of IDs of the Study's lockers.
*/
ListOfStrings GetLockerID();
-/*!
- Create real variable with Name theVarName value theValue
- (or set if variable value in to theValue already exists)
+/*! \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 );
-/*!
- Create integer variable with Name theVarName value theValue
- (or set if variable value in to theValue already exists)
+/*! \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 );
-/*!
- Create boolean variable with Name theVarName value theValue
- (or set if variable value in to theValue already exists)
+/*! \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 );
-/*!
- Return real value of the variable
+/*! \brief Get value of a real variable
+
\param theVarName is a name of the variable.
*/
double GetReal( in string theVarName );
-/*!
- Return integer value of the variable
+/*! \brief Get value of an integer variable
+
\param theVarName is a name of the variable.
*/
long GetInteger( in string theVarName );
-/*!
- Return boolean value of the variable
+/*! \brief Get value of a boolean variable
+
\param theVarName is a name of the variable.
*/
boolean GetBoolean( 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 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 );
-/*!
- Return names of all variables from the study.
+/*! \brief Get names of all variables from the study.
*/
ListOfStrings GetVariableNames();
-/*! \brief Removing variable
+/*! \brief Remove a variable
Remove variable with the specified name from the study with substitution of its value.
*/
boolean RemoveVariable( in string theVarName );
-/*! \brief Renaming variable
+/*! \brief Rename a variable
Rename variable with the specified name within the study.
*/
boolean RenameVariable( in string theVarName, in string theNewVarName );
-/*! \brief Checking variable usage
+/*! \brief Indicate whether variable is used
Check that variable is used in the study.
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) raises(LockProtection);
\param theFatherObject The father %SObject under which this one should be created.
\return New %SObject
-<BR><VAR>See also <A href="exemple/Example18.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
*/
/*!
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);
\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,
\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) raises(LockProtection);
Adds a directory in the %Study.
\param theName String parameter defining the name of the directory.
-<BR><VAR>See also <A href="exemple/Example23.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void AddDirectory(in string theName) raises(LockProtection);
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
\exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
-<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>
*/
void CommitCommand() raises(LockProtection); // command management
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
/*! \brief Undolimit
\exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
-<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>
*/
void Undo() raises (LockProtection);
\exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
- <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>
*/
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>
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
*/
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>
+<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean GetAvailableRedos();
\param study_name String parameter defining the name of the study
-<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>
*/
Study NewStudy(in string study_name);
\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);
\param theMultiFile If this parameter is True the study will be saved in several files.
-<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>
*/
boolean Save(in Study aStudy, in boolean theMultiFile);
\param aStudy The study which will be saved
\param theMultiFile If this parameter is True the study will be saved in several files.
- <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>
*/
boolean SaveAs(in URL aUrl, // if the file already exists
in Study aStudy,
\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.
-<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>
*/
boolean FindAttribute(out GenericAttribute anAttribute,
in string aTypeOfAttribute);
\return The list of all attributes of the given %SObject.
-<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>
*/
ListOfAttributes GetAllAttributes();
*/
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.
/*!
- 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
//==========================================================================
interface SComponent : SObject
{
-/*! Gets the data type of the given %SComponent
+/*! \brief Gets the data type of the given %SComponent
\return The data type of this %SComponent.
*/
string ComponentDataType();
-/*! Gets the IOR of the given component
+/*! \brief Gets the IOR of the given component
\return True (if there is an instance of the given component) and its IOR.
*/
interface SComponentIterator : SALOME::GenericObj
{
/*!
-Activates the %SComponentIterator.
+\brief Activates the %SComponentIterator.
*/
void Init();
-/*! Method More
+/*! \brief Method More
\return True if there is one more %SComponent in the list.
*/
boolean More();
/*!
-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.
+ \brief 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>
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
SComponent Value();
{
/*!
-Activates the %ChildIterator.
+\brief Activates the %ChildIterator.
*/
void Init();
/*!
-Activates the %ChildIterator 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);
-/*! Method More
+/*! \brief Method More
\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();
};
\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>
*/
\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
-<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 SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
-// File : SALOMEDS.idl
+// File : SALOMEDS_Attributes.idl
// Author : Yves FRICAUD
// $Header$
//
-/*! \file SALOMEDS_Attributes.idl This file contains a set of interfaces
+/*! \file SALOMEDS_Attributes.idl
+ \brief This file contains a set of interfaces
for the attributes which can be assigned to %SObject
*/
#ifndef _SALOMEDS_AttributesIDL_
module SALOMEDS
{
-/*! Sequence of double values
-*/
+//! Sequence of double values
typedef sequence <double> DoubleSeq;
-/*! Sequence of long values
-*/
+//! Sequence of long values
typedef sequence <long> LongSeq;
-/*! Sequence of string values
-*/
+//! Sequence of string values
typedef sequence <string> StringSeq;
-/*! \struct Color
- This structure stores a set of elements defining the color based on RGB palette. These elements are
+/*! \brief This structure stores a set of elements defining the color based on RGB palette.
+
+ These elements are
used as input parameters for methods necessary for color definition of different items.
*/
struct Color {
-/*! Red color
-*/
+//! Red color
double R;
-/*! Green color
-*/
+//! Green color
double G;
-/*! Blue color
-*/
+//! Blue color
double B;
};
//==========================================================================
interface AttributeReal : GenericAttribute
{
+//! Returns the value of this attribute.
/*!
- Returns the value of this 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>
*/
double Value();
+ //! Sets the value of this attribute.
/*!
- Sets the value of this 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>
*/
void SetValue(in double value);
//==========================================================================
interface AttributeInteger : GenericAttribute
{
+ //! Returns the value of this attribute
/*!
- Returns the value of this 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>
*/
long Value();
+
+ //! Sets the value of this attribute
/*!
- Sets the value of this 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>
*/
void SetValue(in long value);
};
//==========================================================================
interface AttributeSequenceOfReal : GenericAttribute
{
+ //! Initialization of the attribute with initial data.
/*!
- Initialization of the attribute with initial data.
\param other Initially assigned sequence of real numbers.
*/
void Assign (in DoubleSeq other);
-/*!
- Returns the sequence of real numbers stored in the attribute.
-*/
+//! Returns the sequence of real numbers stored in the attribute.
DoubleSeq CorbaSequence();
-/*!
- Adds to the end of the sequence a real number.
+/*! \brief Adds to the end of the sequence a real number.
\param value A real number added to the sequence.
-<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 Add (in double value);
-/*!
- Removes a real number with a definite index
+/*! \brief Removes a real number with a definite index
from the sequence of real numbers stored in the Attribute.
\param index The index of the given real number
*/
void Remove(in long index);
-/*!
- Substitutes a given real number with a definite index for another real number.
+/*! \brief Substitutes a given real number with a definite index for another real number.
+
\param index The index of the given real number.
\param value The value of another real number.
-<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 ChangeValue(in long index, in double value);
-/*!
- Returns a given real number with a definite index
- in the sequence of real numbers stored in the Attribute.
+/*! \brief Returns a given real number with a definite index in the sequence of real numbers stored in the Attribute.
+
\param index The index of the given real number.
-<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>
*/
double Value(in short index);
-/*!
- Returns the length of the sequence of real numbers stored in the Attribute.
+/*! \brief Returns the length of the sequence of real numbers stored in the Attribute.
-<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>
*/
long Length();
//==========================================================================
interface AttributeSequenceOfInteger : GenericAttribute
{
-/*!
- Initialisation of the attribute with initial data.
+/*! \brief Initialisation of the attribute with initial data.
\param other Initially assigned sequence of integer numbers.
*/
void Assign (in LongSeq other);
-/*!
- Returns the sequence of integer numbers stored in the Attribute.
-*/
+//! Returns the sequence of integer numbers stored in the Attribute.
LongSeq CorbaSequence();
-/*!
- Adds to the end of the sequence an integer number.
+/*! \brief Adds to the end of the sequence an integer number.
+
\param value An integer number added to the sequence.
-<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 Add (in long value);
-/*!
- Removes an integer number with a definite index
- from the sequence of integer numbers stored in the Attribute.
+/*! \brief Removes an integer number with a definite index from the sequence of integer numbers stored in the Attribute.
+
\param index The index of the given integer number.
-<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 Remove(in long index);
-/*!
- Substitutes an integer number with a definite index for another integer number.
+/*! \brief Substitutes an integer number with a definite index for another integer number.
+
\param index The index of the given integer number.
\param value The value of another integer number.
*/
void ChangeValue(in long index, in long value);
-/*!
- Returns a given integer number with a definite index
- in the sequence of integer numbers stored in the Attribute.
+/*! \brief Returns a given integer number with a definite index in the sequence of integer numbers stored in the Attribute.
\param index The index of the given integer number.
-<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>
*/
long Value(in short index);
-/*!
- Returns the length of the sequence of integer numbers stored in the Attribute.
+/*! \brief Returns the length of the sequence of integer numbers stored in the Attribute.
-<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>
*/
long Length();
interface AttributeName : GenericAttribute
{
-/*!
- Returns the value of this attribute
+/*! \brief Returns the value of this 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>
*/
string Value();
-/*!
- Sets the value of this attribute
+/*! \brief Sets the value of this attribute
\param value This parameter defines the value of this 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>
*/
void SetValue(in string value);
};
//==========================================================================
interface AttributeComment : GenericAttribute
{
-/*!
- Returns the value of this attribute
+/*! \brief Returns the value of this 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>
*/
string Value();
-/*!
- Sets the value of this attribute
+/*! \brief Sets the value of this attribute
\param value This string parameter defines the value of this attribute - a description of a %SObject.
-<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 SetValue(in string value);
};
/*!
Returns the value of this 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>
*/
string Value();
/*!
Sets the value of this attribute
\param value This parameter defines the value of this attribute - IOR of a %SObject.
-<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 SetValue(in string value);
};
/*!
Returns the value of this 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>
*/
string Value();
/*!
Sets the value of this attribute
\param value This parameter defines the value of this 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>
*/
void SetValue(in string value);
};
{
/*!
Returns the value of this 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>
*/
string Value();
/*!
Sets the value of this 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>
*/
void SetValue(in string value);
};
{
/*!
Returns the value of this 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>
*/
string Value();
/*!
Sets the value of this 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>
*/
void SetValue(in string value);
};
/*!
Returns TRUE if the item is drawable (as it is by default) and FALSE if it isn't.
-<BR><VAR>See also <A href="exemple/Example8.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example8 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean IsDrawable();
\param value If the value of this boolean parameter is TRUE (default) the item will be drawable.
-<BR><VAR>See also <A href="exemple/Example8.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example8 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void SetDrawable(in boolean value);
Returns TRUE if the item is selectable (as it is by default) and FALSE if it isn't.
-<BR><VAR>See also <A href="exemple/Example9.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example9 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean IsSelectable();
\param value If the value of this parameter is TRUE (the default) the item will be set as selectable.
-<BR><VAR>See also <A href="exemple/Example9.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example9 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void SetSelectable(in boolean value);
/*!
Returns TRUE if this item is expandable even when it has no children.
-<BR><VAR>See also <A href="exemple/Example10.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example10 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean IsExpandable();
\param value If the value of this boolean parameter is TRUE, this item will be set as expandable.
-<BR><VAR>See also <A href="exemple/Example10.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example10 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void SetExpandable(in boolean value);
/*!
Returns TRUE if this item is open (its children are visible) and FALSE if it isn't.
-<BR><VAR>See also <A href="exemple/Example11.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example11 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean IsOpened();
\param value If the value of this boolean parameter is TRUE this item will be set as open,
and as closed if FALSE.
-<BR><VAR>See also <A href="exemple/Example11.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example11 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void SetOpened(in boolean value);
/*!
Returns the color of an item.
-<BR><VAR>See also <A href="exemple/Example12.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example12 for an example of this method usage in batchmode of %SALOME application.</em>
*/
Color TextColor();
\param value This parameter defines the color of the item.
-<BR><VAR>See also <A href="exemple/Example12.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example12 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void SetTextColor(in Color value);
-<BR><VAR>See also <A href="exemple/Example13.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example13 for an example of this method usage in batchmode of %SALOME application.</em>
*/
Color TextHighlightColor();
Sets the highlight color of an item.
\param value This parameter defines the highlight color of the item.
-<BR><VAR>See also <A href="exemple/Example13.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example13 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void SetTextHighlightColor(in Color value);
/*!
Returns the name of the icon in the format of a string.
-<BR><VAR>See also <A href="exemple/Example14.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example14 for an example of this method usage in batchmode of %SALOME application.</em>
*/
string GetPixMap();
Sets the name of the icon.
\param value This string parameter defines the name of the icon.
-<BR><VAR>See also <A href="exemple/Example14.html"> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
+<em>See \ref example14 for an example of this method usage in batchmode of %SALOME application.</em>
*/
void SetPixMap(in string value);
tree whith its own structure and identifier. The quantity of such trees with different
identifiers can be arbitrary.
-<BR><VAR>See also <A href="exemple/Example18.html"> an example </A> of usage of the methods of this interface in batchmode of %SALOME application.</VAR>
+<em>See \ref example18 for an example of usage of the methods of this interface in batchmode of %SALOME application.</em>
*/
//==========================================================================
/*!
Deletes a tree node.
-<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 Remove();
/*!
Returns the value of this 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>
*/
long Value();
/*!
\param value This parameter defines the local ID which will be set.
-<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 SetValue(in long value);
};
/*!
Returns the value of this 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>
*/
string Value();
/*!
Sets the value of this 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>
*/
void SetValue(in string value);
};
/*!
Adds a %SObject to the list of %SObjects which refer to this %SObject.
-<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 Add(in SObject anObject);
/*!
Deletes a %SObject from the list of %SObjects which refer to this %SObject.
-<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 Remove(in SObject anObject);
This attribute allows to store a table of integers (indexing from 1 like in CASCADE)
and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href="exemple/Example21.html"> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
+<em>See \ref example21 for an example of usage of these methods in batchmode of %SALOME application.</em>
*/
//==========================================================================
interface AttributeTableOfInteger : GenericAttribute
{
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
+//! This exception is raised when an incorrect index is passed as parameter.
exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
+//! This exception is raised when an incorrect length of the argument is passed as parameter.
exception IncorrectArgumentLength {};
// titles: for table, for each row, for each column
This attribute allows to store a table of reals (indexing from 1 like in CASCADE)
and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href="exemple/Example21.html"> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
+<em>See \ref example21 for an example of usage of these methods in batchmode of %SALOME application.</em>
*/
//==========================================================================
interface AttributeTableOfReal : GenericAttribute
{
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
+//! This exception is raised when an incorrect index is passed as parameter.
exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
+//! This exception is raised when an incorrect length of the argument is passed as parameter.
exception IncorrectArgumentLength {};
// titles: for table, for each row, for each column
This attribute allows to store a table of strings (indexing from 1 like in CASCADE)
and string titles of this table, of each row, of each column.
-<BR><VAR>See also <A href="exemple/Example21.html"> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
+<em>See \ref example21 for an example of usage of these methods in batchmode of %SALOME application.</em>
*/
//==========================================================================
interface AttributeTableOfString : GenericAttribute
{
-/*!
- This exception is raised when an incorrect index is passed as parameter.
-*/
+//! This exception is raised when an incorrect index is passed as parameter.
exception IncorrectIndex {};
-/*!
- This exception is raised when an incorrect length of the argument is passed as parameter.
-*/
+//! This exception is raised when an incorrect length of the argument is passed as parameter.
exception IncorrectArgumentLength {};
// titles: for table, for each row, for each column
This attribute allows to store study properties: user name, creation date, creation
mode, modified flag, locked flag.
-<BR><VAR>See also <A href="exemple/Example20.html"> an example </A> of usage of these methods in batchmode of %SALOME application.</VAR>
+<em>See \ref example20 for an example of usage of these methods in batchmode of %SALOME application.</em>
*/
//==========================================================================
#include "SALOME_Exception.idl"
+/*!
+ \file SALOME_Comm.idl \brief This file contains a set of interfaces used for communication
+ between components
+ */
+
module SALOME {
enum TypeOfDataTransmitted { _DOUBLE_,_INT_ };
#include "SALOMEDS.idl"
#include "SALOME_Exception.idl"
+/*! \file SALOME_Component.idl \brief interfaces for Component and Container
+*/
+
/*! \brief
This is a package of interfaces used for connecting new components to %SALOME
application. It also contains a set of interfaces used for management of %MED
*/
typedef sequence<octet> TMPFile;
- /*!
- General Key Value Structure to set or get properties, for component
- */
+ //! General Key Value Structure to set or get properties, for component
struct KeyValuePair
{
string key;
interface Container
{
- /*!
- Loads a new component class (dynamic library).
+ /*! \brief Loads a new component class (dynamic library).
+
\param componentName like COMPONENT, (Python or C++ implementation)
try to make a Python import of COMPONENT,
then a lib open of libCOMPONENTEngine.so
*/
boolean load_component_Library(in string componentName);
+ //! Create a new servant instance of a component.
/*!
- Creates a new servant instance of a component.
Component library must be loaded.
\param componentName Name of the component which will be registered
in Registry and Name Service,
Engines::Component create_component_instance(in string componentName,
in long studyId);
+ //! Find a servant instance of a component
/*!
- Finds a servant instance of a component
\param registeredName Name of the component in Registry or Name Service,
without instance suffix number
\param studyId 0 if instance is not associated to a study,
Component find_component_instance(in string registeredName,
in long studyId);
+ //! Find a servant instance of a component, or create a new one.
/*!
- Find a servant instance of a component, or create a new one.
Loads the component library if needed.
Only applicable to multiStudy components.
\param nameToRegister Name of the component which will be registered
Component load_impl(in string nameToRegister,
in string componentName);
+ //! Remove the component servant, and deletes all related objects
/*!
- Stops the component servant, and deletes all related objects
\param component_i Component to be removed
*/
void remove_impl(in Component component_i);
- /*!
- Discharges all components from the container.
- */
+ //! Unload component libraries from the container.
void finalize_removal() ;
- /*!
- Determines whether the server has been loaded or not.
- */
+ //! Determines whether the server has been loaded or not.
void ping();
- /*!
- Name of the %container
- */
+ //! Name of the %container
readonly attribute string name ;
- /*!
- working directory of the %container
- */
+ //! working directory of the %container
readonly attribute string workingdir ;
- /*!
- name of the %container log file (this has been set by the launcher)
- */
+ //! name of the %container log file (this has been set by the launcher)
attribute string logfilename ;
- /*!
- Shutdown the Container process.
- */
+ //! Shutdown the Container process.
void Shutdown();
- /*!
- Returns the hostname of the container
- */
+ //! Returns the hostname of the container
string getHostName();
- /*!
- Returns the PID of the container
- */
+ //! Returns the PID of the container
long getPID();
+ //! Kill the container
/*!
Returns True if the %container has been killed.
Kept for Superv compilation but can't work, unless oneway...
*/
boolean Kill_impl() ;
+ //! Create a fileRef
/*!
returns a fileRef object if origFileName exists and is readable
else returns null object. Only one fileRef is created for a given
*/
fileRef createFileRef(in string origFileName);
+ //! Create a Salome_file
/*!
returns a Salome_file object if origFileName exists and is readable
else returns null object.
*/
Salome_file createSalome_file(in string origFileName);
+ //! Create a fileTransfer
/*!
returns a fileTransfer object used to copy files from the container
machine to the clients machines. Only one fileTransfer instance is
*/
interface Component
{
- /*!
- The name of the instance of the %Component
- */
+ //! The name of the instance of the %Component
readonly attribute string instanceName ;
- /*!
- The name of the interface of the %Component
- */
+ //! The name of the interface of the %Component
readonly attribute string interfaceName ;
- /*!
- Determines whether the server has already been loaded or not.
- */
+ //! Determines whether the server has already been loaded or not.
void ping();
-// /*!
+//
// Set study associated to component instance
// \param studyId
// (=0: multistudy component instance,
// >0: study id associated to this instance
// \return false if already set with a different value (change not possible)
-// */
+//
// boolean setStudyId(in long studyId);
+ //! Get study associated to component instance
/*!
get study associated to component instance
\return -1: not initialised (Internal Error)
*/
long getStudyId();
+ //! Remove component instance from container
/*!
Deactivates the %Component.
-- TO BE USED BY CONTAINER ONLY (Container housekeeping) --
*/
void destroy() ;
- /*!
- Returns the container that the %Component refers to.
- */
+ //! Returns the container that the %Component refers to.
Container GetContainerRef() ;
+ //! Set component instance properties
/*!
Gives a sequence of (key=string,value=any) to the component.
Base class component stores the sequence in a map.
*/
void setProperties(in FieldsDict dico);
+ //! Get component instance properties
/*!
returns a previously stored map (key=string,value=any) as a sequence.
See setProperties(in FieldsDict dico).
*/
FieldsDict getProperties();
+ //! Set name of a node in a graph (for %SUPERVISOR use)
/*!
This method is used by the %SUPERVISOR component. It sets the names of
the graph and of the node.
*/
void Names( in string aGraphName , in string aNodeName ) ;
+ //! Kill the component (if you can)
/*!
Returns True if the %Component has been killed.
*/
boolean Kill_impl() ;
+ //! Stop the component (if you can)
/*!
Returns True if the activity of the %Component has been stopped.
(It's action can't be resumed)
*/
boolean Stop_impl() ;
+ //! Suspend the component
/*!
Returns True if the activity of the %Component has been suspended.
(It's action can be resumed)
*/
boolean Suspend_impl() ;
+ //! Resume the component
/*!
Returns True if the activity of the %Component has been resumed.
*/
boolean Resume_impl() ;
+ //! Get the cpu used
/*!
- Returns the Cpu used (long does not run with python !...)
+ Returns the Cpu used
*/
long CpuUsed_impl() ;
+ //! Get a python dump
/*!
Returns a python script, which is being played back reproduces
the data model of component
out boolean isValidScript);
+ //! Returns a CORBA Ref of a input Salome_file managed by a service.
/*!
- Returns a CORBA Ref of a input Salome_file managed by a service.
\param service_name service's name.
\param file_name name of the requested file.
Engines::Salome_file getInputFileToService(in string service_name,
in string Salome_file_name) raises(SALOME::SALOME_Exception);
+ //! Check service input files (transfer them if needed)
/*!
This method is used before the activation of the service. It calls
recvFiles() on all the input Salome_file files of the service.
*/
void checkInputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
+ //! This method adds a input Salome_file to a service of the component.
/*!
- This method adds a input Salome_file to a service of the component.
\param service_name service's name.
\param Salome_file_name name of the Salome_file
Engines::Salome_file setInputFileToService(in string service_name,
in string Salome_file_name) raises(SALOME::SALOME_Exception);
+ //! Returns a CORBA Ref of a output Salome_file managed by a service.
/*!
- Returns a CORBA Ref of a output Salome_file managed by a service.
\param service_name service's name.
\param file_name name of the requested file.
Engines::Salome_file getOutputFileToService(in string service_name,
in string Salome_file_name) raises(SALOME::SALOME_Exception);
+ //! Check service output files (transfer them if needed)
/*!
This method is used at the end of the service. It calls
recvFiles() on all the output Salome_file files of the service.
*/
void checkOutputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
+ //! This method adds an output Salome_file to a service of the component.
/*!
- This method adds an output Salome_file to a service of the component.
\param service_name service's name.
\param Salome_file_name name of the Salome_file
*/
Engines::Salome_file setOutputFileToService(in string service_name,
in string Salome_file_name) raises(SALOME::SALOME_Exception);
+
+ //! Indicate if the component instance provides custom information about its objects.
/*!
Returns true if the component provides custom information about its objects, false otherwise.
Should be redefined in the certain component to return true in case of this
*/
boolean hasObjectInfo();
+ //! Get custom information about the given object.
/*!
This method is used to get the custom information about the given object.
Should be redefined in the certain component in case of this
void send_parallel_proxy_object(in Object proxy_ref);
};
- /*!
- A block of binary data used for file transfer. The maximum size of the
- block is defined on server side.
- */
+ //! A block of binary data used for file transfer. The maximum size of the block is defined on server side.
typedef sequence<octet> fileBlock;
/*! \brief Interface of fileTransfer.
*/
interface fileTransfer
{
+ //! Open the file transfer
/*!
open method returns a key (fileId) that identifies the structure
(ex: C FILE), associated to the original file on the server.
*/
long open(in string fileName);
+ //! Close the file transfer
/*!
when the file transfer is finished, close method releases structures
created by open method, identified by fileId.
*/
void close(in long fileId);
+ //! Get a file data block
/*!
Get successive blocks of octets from the original file.
The last block is empty, and identifies the end of file.
fileBlock getBlock(in long fileId);
};
- /*!
- This is a file managed by a Salome_file. It contains file's name, path and status.
- The status is : "present" or "notpresent".
- */
+ //! A file managed by a Salome_file.
struct file {
+ //! file name
string file_name;
- string path;
+ //! path name
+ string path;
string type;
string source_file_name;
- string status;
+ //! status ("present" or "notpresent")
+ string status;
long node;
Engines::Container container;
};
- /*!
- A sequence of Engines::file.
- */
+ //! A sequence of Engines::file.
typedef sequence<Engines::file> files;
- /*!
- It is the state of a Salome_file. It contains the Salome_file's name, the name
- of the hdf5 file where it can be saved, the number of files managed and the information
- if all the files are received.
- */
+ //! The state of a Salome_file.
struct SfState {
- string name;
- string hdf5_file_name;
- long number_of_files;
- boolean files_ok;
+ //! file name
+ string name;
+ //! hdf5 file where the file can be saved
+ string hdf5_file_name;
+ //! number of files managed
+ long number_of_files;
+ //! information if all the files are received
+ boolean files_ok;
+
};
/*! \brief Interface of a Salome_file managed
*/
interface Salome_file : Engines::fileTransfer
{
+ //! Load a Salome_file from a hdf5 file.
/*!
- Load a Salome_file from a hdf5 file.
\param hdf5_file name (with path) of the hdf5_file.
*/
void load(in string hdf5_file) raises (SALOME::SALOME_Exception);
+ //! Save a Salome_file into a hdf5_file.
/*!
- Save a Salome_file into a hdf5_file.
\param hdf5_file name (with path) of the hdf5_file.
*/
void save(in string hdf5_file) raises (SALOME::SALOME_Exception);
+ //! Save a Salome_file into a hdf5_file.
/*!
- Save a Salome_file into a hdf5_file. All files that are managed
- are saved into the hdf5_file
+ All files that are managed are saved into the hdf5_file
\param hdf5_file name (with path) of the hdf5_file.
/**************/
+ //! Add a Local file to the Salome_file.
/*!
- Add a Local file to the Salome_file.
\param file_name name of the file with the path.
*/
void setLocalFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
+ //! Add a Distributed file to the Salome_file.
/*!
- Add a Distributed file to the Salome_file.
\param comp_file_name name of the file with the path.
*/
void setDistributedFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
+ //! Connect a Salome_file with another Salome_file.
/*!
- Connect a Salome_file with another Salome_file.
It works only if the Salome_file managed only one file
\param source_Salome_file Salome_file that managed the distributed version of the file.
*/
void connect(in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
+ //! Connect the managed file file_name to a Salome_file.
/*!
- Connect the managed file file_name to a Salome_file.
\param file_name name of the file without the path.
\param source_Salome_file Salome_file that managed the distributed version of the file.
void connectDistributedFile(in string file_name,
in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
+ //! Connect the file_name with a Distributed file_name.
/*!
- Connect the file_name with a Distributed file_name.
\param file_name name of the file without the path.
\param source_file_name It's the name of the file managed by the distributed source Salome_file.
/**************/
+ //! Get all the distributed files managed by the Salome_file and check all the local files.
/*!
- Get all the distributed files managed by the Salome_file and
- check all the local files.
\exception raised if some of the files are not ok.
*/
/**************/
+ //! Remove a file of the Salome_file.
/*!
- Remove a file of the Salome_file.
\param file_name name of the file.
*/
void removeFile(in string file_name) raises (SALOME::SALOME_Exception);
- /*!
- Remove all the files of the Salome_file.
- */
+ //! Remove all the files of the Salome_file.
void removeFiles();
/**************/
+ //! Get the list of the files managed by the Salome_file.
/*!
- Get the list of the files managed by the Salome_file.
The list can be empty.
*/
Engines::files getFilesInfos();
+ //! Get a file managed by the Salome_file.
/*!
- Get a file managed by the Salome_file.
\param file_name the name of the file.
*/
Engines::file getFileInfos(in string file_name) raises (SALOME::SALOME_Exception);
- /*!
- Return the state of the Salome_file.
- */
+ //! Return the state of the Salome_file.
Engines::SfState getSalome_fileState();
+ //! Set the container where files are.
/*!
- Set the container where files are.
\param container container CORBA's reference.
*/
*/
interface fileRef
{
+ //! the original file
readonly attribute string origFileName;
+ //! the machine of the original file
readonly attribute string refMachine;
Container getContainer();
#include "SALOME_Exception.idl"
#include "SALOME_Component.idl"
+/*! \file SALOME_ContainerManager.idl \brief interfaces for %SALOME launcher and container manager
+*/
+
module Engines
{
-/*!
- Type to transmit list of machines.
-*/
+//! Type to transmit list of machines.
typedef sequence<string> MachineList;
+//! components list
typedef sequence<string> CompoList;
+//! files list
typedef sequence<string> FilesList;
+//! modules list
typedef sequence<string> ModulesList;
-/*!
- Type to describe properties of resource.
-*/
+//! Type to describe properties of a resource.
struct MachineParameters
{
string container_name;
long nb_component_nodes;
};
-/*!
- exception thrown if a computer is not found in the catalog
-*/
+//! exception thrown if a computer is not found in the catalog
exception NotFound {};
- enum policy {P_FIRST,P_CYCL,P_BEST};
+//! enumeration to set a resource management policy
+ enum policy {
+ //! first machine in the list of admissible computers
+ P_FIRST,
+ //! next machine in the list of admissible computers
+ P_CYCL,
+ //! best machine in the list of admissible computers
+ P_BEST};
+//! resource management policy
typedef policy ResPolicy;
-/*!
- Structure used for Salome Batch Job parameters
-*/
+//! Structure used for Salome Batch Job parameters
struct BatchParameters
{
- string batch_directory; // Where batch command will be launched
- // and log files will be created
- string expected_during_time; // Time for the batch
- // has to be like this : hh:mm
- string mem; // Minimum of memory needed
- // has to be like : 32gb or 512mb
- long nb_proc; // Number of processors requested
+ //! Where batch command will be launched and log files will be created
+ string batch_directory;
+ //! Time for the batch (has to be like this : hh:mm)
+ string expected_during_time;
+ //! Minimum of memory needed (has to be like : 32gb or 512mb)
+ string mem;
+ //! Number of processors requested
+ long nb_proc;
};
/*! \brief Interface of the %salomelauncher
*/
interface ContainerManager
{
+ //! Find an existing container satisfying the constraints given by input parameters or start a new one.
Container FindOrStartContainer( in MachineParameters params,
in MachineList possibleComputers);
- /*!
- This operation launches a PaCO++ container.
+ //! This operation launches a PaCO++ container.
+ /*!
\param Description of the container resquested.
\param List of computers ressources.
Container FindOrStartParallelContainer( in MachineParameters params,
in MachineList possibleComputers);
+ //! Start a new container satisfying the constraints given by input parameters.
Container StartContainer( in MachineParameters params,
in ResPolicy policy,
in CompoList componentList );
+ //! Same as StartContainer except that in batch all containers have already been launched
+ /*!
+
+ We are in batch if environment variable SALOME_BATCH is 1.
+ In this case, containers have been launched at the beginning of the Salome session and
+ the container manager picks one in the pool of existing containers.
+ */
Container GiveContainer( in MachineParameters params,
in ResPolicy policy,
in CompoList componentList );
+ //! Shutdown all containers that have been launched by the container manager
void ShutdownContainers();
} ;
*/
interface ResourcesManager
{
+ //! Find first available computer in a computers list
string FindFirst(in MachineList possibleComputers);
+ //! Get a list of computers that are best suited to launch a container given constraints
+ /*!
+
+ The constraints are resource constraints (params) and components constraints (componentList)
+ */
MachineList GetFittingResources( in MachineParameters params,
in CompoList componentList )
raises (SALOME::SALOME_Exception);
+ //! Get the current machine parameters of a computer
MachineParameters GetMachineParameters( in string hostname );
} ;
// Author : Paul RASCLE, EDF
// $Header$
//
-/*! \file SALOME_Exception.idl This file contains the objects defining the main exception used
-in %SALOME application. The idl SALOME_Exception provides a generic CORBA exception for SALOME,
+/*! \file SALOME_Exception.idl \brief This file contains the objects defining the main exception used
+in %SALOME application.
+
+The idl SALOME_Exception provides a generic CORBA exception for SALOME,
with an attribute that gives an exception type,a message, plus optional source file name and line number.
This idl is intended to serve for all user CORBA exceptions raised in SALOME code, as IDL specification
does not support exception inheritance. So, all the user CORBA exceptions from SALOME could be
#ifndef _SALOME_EXCEPTION_IDL_
#define _SALOME_EXCEPTION_IDL_
-/*!
-Module %SALOME regroups all idl definitions for %SALOME Kernel component
+/*! \brief
+Module %SALOME contains all base interfaces of %SALOME Kernel
+
*/
module SALOME
{
-/*!
-This enumeration contains the elements indicating the type of the exception
-which can be raised during %SALOME session.
-*/
+//! This enumeration contains the elements indicating the type of the exception which can be raised during %SALOME session.
enum ExceptionType
{
COMM, /*!< Communication problem */
BAD_PARAM, /*!< Bad User parameters */
INTERNAL_ERROR /*!< Application level problem, irrecoverable */
};
-/*!
-This struct contains a set of fields defining the structure of the exception.
-*/
+//! This struct contains a set of fields defining the structure of the exception.
struct ExceptionStruct
{
ExceptionType type; /*!<Type of the exception.*/
string sourceFile; /*!<The source file where the exception is raised.*/
unsigned long lineNumber; /*!<Number of the line of the source file where the exception is raised.*/
};
-/*!
-The main exception in %SALOME application.
+/*! \brief The main exception in %SALOME application.
+
+The idl SALOME_Exception provides a generic CORBA exception for SALOME,
+ with an attribute that gives an exception type,a message, plus optional source file name and line number.
+ This idl is intended to serve for all user CORBA exceptions raised in SALOME code, as IDL specification
+ does not support exception inheritance. So, all the user CORBA exceptions from SALOME could be
+ handled in a single catch.
*/
exception SALOME_Exception
{
//
#ifndef _SALOME_GENERICOBJ_IDL_
#define _SALOME_GENERICOBJ_IDL_
-/*!
-This is a package of interfaces used for providing of common bechavior
-of SALOME transient CORBA objects in %SALOME application.
+/*! \file SALOME_GenericObj.idl \brief interface for common behavior of %SALOME transient CORBA objects
*/
+
module SALOME{
+/*! \brief interface for common behavior of %SALOME transient CORBA objects
+*/
interface GenericObj{
- /*! Increase the reference count (mark as used by another object).*/
+ /*! \brief Increase the reference count (mark as used by another object).*/
void Register();
- /*! Decrease the reference count (release by another object).*/
+ /*! \brief Decrease the reference count (release by another object).*/
void Destroy();
};
};
#include "SALOME_Component.idl"
#include "SALOME_MPIObject.idl"
+/*! \file SALOME_MPIContainer.idl \brief interfaces for parallel container
+*/
+
module Engines
{
+ /*! \brief Interface of the MPI parallel container.
+ This interface defines the process of loading and registration
+ of new components in %SALOME application
+ */
+
interface MPIContainer:Container,MPIObject
{
// asynchronous version to load and remove parallel component in parallel
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
-// File : MPIObject.idl
+// File : SALOME_MPIObject.idl
//
#ifndef _SALOME_MPIOBJECT_IDL_
#define _SALOME_MPIOBJECT_IDL_
+/*! \file SALOME_MPIObject.idl \brief interfaces for parallel (MPI) objects
+*/
+
module Engines
{
typedef sequence<Object> IORTab;
+ /*! \brief Interface of a parallel %object for the MPI parallel container.
+ */
interface MPIObject
{
attribute IORTab tior;
// Author : Estelle Deville
// $Header$
//
-/*! \file SALOME_ModuleCatalog.idl This file conatins a set of interfaces used for
- creation of the catalog of components in %SALOME application
+/*! \file SALOME_ModuleCatalog.idl \brief interfaces used for
+ getting information from module catalog in %SALOME application
*/
-/*!
-The main package of interfaces used for creation of the module catalog in %SALOME application.
+/*! \brief
+The main package of interfaces used for the module catalog in %SALOME application.
+
Module catalog allows to manage components of %SALOME application, to call specified in the
xml files interfaces with the help of AComponent interface.
*/
module SALOME_ModuleCatalog
{
- // Type Definitions
-/*!
-This enumeration contains a current set of definitions of the components integrated
+/*! \brief This enumeration contains a current set of definitions of the components integrated
into %SALOME application.
*/
enum ComponentType { GEOM, /*!<Module %GEOM */
SUPERV, /*!<Module %SUPERVISION */
OTHER /*!<Any other type of module */
} ;
-/*!
-This struct contains fields defining the parameter of the service.
-*/
-
+//! This struct contains fields defining the parameter of the service.
struct ServicesParameter
{
- string Parametertype; /*!<Type of the parameter.*/
- string Parametername; /*!<Name of the parameter.*/
+ string Parametertype; /*!<Parameter type name.*/
+ string Parametername; /*!<Parameter name.*/
} ;
+//! enumeration to define datastream ports dependency
enum DataStreamDependency {
- DATASTREAM_UNDEFINED,
- DATASTREAM_TEMPORAL,
- DATASTREAM_ITERATIVE
+ DATASTREAM_UNDEFINED, /*!< dependency not defined */
+ DATASTREAM_TEMPORAL, /*!< time dependency */
+ DATASTREAM_ITERATIVE /*!< iterative dependency */
} ;
+//! struct to define datastream ports
struct ServicesDataStreamParameter
{
- string Parametertype; /*!<Type of the parameter.*/
- string Parametername; /*!<Name of the parameter.*/
+ string Parametertype; /*!<Parameter type name.*/
+ string Parametername; /*!<Parameter name.*/
DataStreamDependency Parameterdependency; /*!<Temporal or iterative dependency.*/
} ;
-/*!
-The list of the parameters of service.
-*/
-
+//! The list of the parameters of service.
typedef sequence<ServicesParameter> ListOfServicesParameter;
+//! The list of datastream parameters of service.
typedef sequence<ServicesDataStreamParameter> ListOfServicesDataStreamParameter;
+//! a string list
typedef sequence<string> ListOfString;
+
+//! enumeration to define data types used by services
enum TypeKind
{
NONE ,
- Dble ,
- Int ,
- Str ,
- Bool ,
- Objref ,
- Seq ,
- Array ,
- Struc
+ Dble , /*!< a double */
+ Int , /*!< an integer */
+ Str , /*!< a string */
+ Bool , /*!< a boolean */
+ Objref , /*!< an object reference */
+ Seq , /*!< a sequence of a content type */
+ Array , /*!< an array */
+ Struc /*!< a structure with named members */
};
+
+//! struct to define members of a Struc TypeKind
struct MemberDefinition
{
- string name; /*! Name of the member */
- string type; /*! Type of the member */
+ string name; /*!< Member name */
+ string type; /*!< Member type name */
};
+//! List of member definitions in a structure
typedef sequence<MemberDefinition> ListOfMemberDefinition;
-/*!
- * Struct to get the definition of types used in Salome catalogs
- */
+
+//! Struct to get the definition of types used in Salome catalogs
struct TypeDefinition
{
- string name; /*! Name of the type */
- TypeKind kind; /*! Kind of the type.*/
- string id; /*! id (if needed) */
- string content; /*! Content type (if needed) */
- ListOfString bases; /*! Content type (if needed) */
- ListOfMemberDefinition members; /*! Members types (if needed) */
+ string name; /*!< Type name*/
+ TypeKind kind; /*!< Type kind.*/
+ string id; /*!< id (if needed) */
+ string content; /*!< Content type (if needed) */
+ ListOfString bases; /*!< base types (if needed) */
+ ListOfMemberDefinition members; /*!< Member types (if needed) */
};
+//! list of type definitions
typedef sequence<TypeDefinition> ListOfTypeDefinition;
-/*!
-This struct contains fields completely defining each service.
-*/
-
+//! This struct contains fields defining each service.
struct Service
{
string ServiceName; /*!<Name of the service.*/
boolean Servicebydefault; /*!<True if the service is taken with its default fields.*/
boolean TypeOfNode; /*!<True is the service is a factory node. Otherwise, it's a compute node.*/
} ;
-/*!
-List of services of the interface.
-*/
+//! List of services of the interface.
typedef sequence<Service> ListOfInterfaceService;
-/*!
-List of services.
-*/
+//! List of services.
typedef sequence<string> ListOfServices ;
-/*!
-This struct contains fields defining each interface.
-*/
+//! This struct contains fields defining each interface.
struct DefinitionInterface
{
string interfacename ; /*!<Name of the interface.*/
ListOfInterfaceService interfaceservicelist ; /*!<List of services of the interface.*/
} ;
-/*!
-List of interface definitions.
-*/
+//! List of interface definitions.
typedef sequence<DefinitionInterface> ListOfDefInterface ;
-/*!
-List of names of interfaces.
-*/
+//! List of interface names.
typedef sequence<string> ListOfInterfaces ;
-/*!
-PathPrefix : association of a machine name and
+/*! \brief PathPrefix : association of a machine name and
a path to a component
*/
struct PathPrefix {
string path;
};
-/*!
-List of path prefixes
-*/
+//! List of path prefixes
typedef sequence<PathPrefix> PathPrefixes;
-/*!
-Implementation type
-*/
+//! Component implementation type
enum ImplType {
- SO, /* component implemented as a dynamic library loadable with dlopen */
- PY, /* component implemented as a python module loadable with import */
- EXE, /* component implemented as an executable */
- CEXE /* component to be loaded by a container which executable is given in the catalog */
+ SO, /*!< component implemented as a dynamic library loadable with dlopen */
+ PY, /*!< component implemented as a python module loadable with import */
+ EXE, /*!< component implemented as an executable */
+ CEXE /*!< component to be loaded by a container which executable is given in the catalog */
} ;
-/*!
-Description of a component
-*/
+//! Description of a component
struct ComponentDef
{
ComponentType type;
PathPrefixes paths;
};
-/*!
-List of names of components.
-*/
+//! List of component names.
typedef sequence<string> ListOfComponents ;
-/*!
-List of names of computers.
-*/
+//! List of computer names.
typedef sequence<string> ListOfComputers ;
-/*!
-This struct contains GUI elements used for representation of the module in %IAPP component.
-*/
+//! This struct contains GUI elements used for representation of the module in %IAPP component.
struct IAPP_Affich
{
string modulename; /*!<Name of the module.*/
string moduleversion; /*!<Version of the module.*/
string modulecomment; /*!<Comment to the module.*/
};
-/*!
-List of pair GUI elements (component name, component icone)
+/*! \brief List of pair GUI elements (component name, component icone)
+
used for representation of the module in %IAPP component.
*/
typedef sequence<IAPP_Affich> ListOfIAPP_Affich ;
-/*!
- This exception is raised when a %component, a %service or a % pathPrefix is not found.
-*/
+//! This exception is raised when a %component, a %service or a %pathPrefix is not found.
exception NotFound
{
string what ; /*!<Indicates if it's a %component, a %service or a % pathPrefix.*/
} ;
- /*!
- This interface provides the common funcionality information of corresponding component.
+ /*! \brief This interface provides the common functionality information of corresponding component.
+
Information is loaded from specific xml files.
*/
interface Acomponent
{
- // GetInterfaceList : operation to get a list of the interfaces name of
- // a component
- /*!
- Gets the list of names of interfaces of the component
+ /*! \brief Get the list of interface names of the component
+
\return a list of interfaces of the component
*/
ListOfInterfaces GetInterfaceList() ;
- // GetInterface : operation to get one interface of a component
-
- /*!
- Gets a definite interface of the component
+ /*! \brief Get an interface of the component
+
\note <BR>If the specified interface doesn't exist, Notfound exception is thrown
\param interfacename Name of the interface
\return Required interface
*/
DefinitionInterface GetInterface(in string interfacename) raises(NotFound);
- // GetServiceList : operation to get a list of the services name of
- // an interface of a component
- /*!
- Gets the list of names of services of a definite interface belonging to the component.
+ /*! \brief Get the list of service names of an interface belonging to the component.
+
\note <BR>If the specified interface doesn't exist, Notfound exception is thrown.
\param interfacename Name of the interface
\return List of services of the required interface
ListOfServices GetServiceList(in string interfacename) raises(NotFound);
- // GetService : operation to get one service of an interface of a component
-
- /*!
- Gets a definite service of an interface of the component.
+ /*! \brief Get a service of an interface of the component.
+
\note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
\param interfacename Name of the interface
\param servicename Name of the service
\return Required service
*/
-
Service GetService(in string interfacename,
in string servicename) raises(NotFound);
- // GetDefaultService : operation to get the default service
- // of an interface of a component
-/*!
- Gets the default service of an interface of the component.
+/*! \brief Get the default service of an interface of the component.
+
\note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
\param interfacename Name of the interface
\return Required service
*/
-
Service GetDefaultService(in string interfacename) raises(NotFound);
- // GetPathPrefix : operation to get the PathPrefix of a computer
- /*!
- Gets the prefix path of the computer containing the %component.
+ /*! \brief Get the prefix path of the computer containing the %component.
+
\note <BR>If the required computer doesn't exist, Notfound exception is thrown
\param machinename Name of the machine
\return Prefix path
*/
-
string GetPathPrefix(in string machinename) raises(NotFound);
-/*!
- Get the constraint affected to the component
- (to be resolved by LifeCycle for the computer choice)
+/*! \brief Get the constraint affected to the component
+
+ constraint to be resolved by LifeCycle for the computer choice
*/
readonly attribute string constraint ;
-/*!
-Get the name of the component
+/*! \brief Get the component name
*/
readonly attribute string componentname;
-/*!
-Get the user name of the component
+/*! \brief Get the user name of the component
*/
readonly attribute string componentusername;
-/*!
-Ask whether the component is multistudy or not
+/*! \brief Get whether the component is multistudy or not
*/
readonly attribute boolean multistudy;
-/*!
-Ask the type of the component
+/*! \brief Get the type of the component
*/
readonly attribute ComponentType component_type ;
-/*!
-Gets the icone of the component (for IAPP)
+/*! \brief Get the icone of the component (for IAPP)
*/
readonly attribute string component_icone;
-/*!
-Gets the implementation type of the component : C++ (dyn lib), Python (module) or executable
+/*! \brief Get the implementation type of the component
+
+ C++ (dyn lib), Python (module) or executable
*/
readonly attribute ImplType implementation_type;
-/*!
-Gets the implementation name of the component : name of the dyn lib or the python module or the executable
+/*! \brief Get the implementation name of the component
+
+ It's the name of the dyn lib or the python module or the executable
if the default naming scheme is not convenient.
*/
readonly attribute string implementation_name;
/*! \brief %Module catalog interface
-This interface is used for creation of the module catalog in %SALOME application.
+Interface to get information about components from the module catalog in %SALOME application.
*/
interface ModuleCatalog
{
+/*! \brief ping the ModuleCatalog server
+*/
void ping();
-/*!
- Returns the PID of the server
+/*! \brief Returns the PID of the ModuleCatalog server
*/
long getPID();
-/*!
- Shutdown the ModuleCatalog process.
+/*! \brief Shutdown the ModuleCatalog server
*/
oneway void ShutdownWithExit();
-/*!
- * Get the types of the catalog
+/*! \brief Get the types of the catalog
*/
ListOfTypeDefinition GetTypes();
-/*!
- Gets a list of names of computers of the catalog
+/*! \brief Get a list of computer names of the catalog
*/
ListOfComputers GetComputerList();
-/*!
-Gets the %PathPrefix of a computer
-*/
+//! Get the %PathPrefix of a computer
string GetPathPrefix(in string machinename) raises(NotFound);
-/*!
- Gets a list of names of components of the catalog
-*/
+
+//! Get a list of component names of the catalog
ListOfComponents GetComponentList();
-/*!
-Gets a list of pair GUI elements (component name, component icone)
+
+/*! \brief Get a list of pair GUI elements (component name, component icone)
used for representation of the module in %IAPP component.
*/
-
ListOfIAPP_Affich GetComponentIconeList();
-/*!
-Gets a list of names of components of a particular type, which belong to this catalog.
+
+/*! \brief Get a list of component names of a particular type, which belong to this catalog.
*/
- // GetComponentList : operation to get a list of the components name of
- // a particular type of the catalog
ListOfComponents GetTypedComponentList(in ComponentType _component_type);
-/*!
-Gets one component of the catalog.
+/*! \brief Get one component of the catalog.
*/
Acomponent GetComponent(in string componentname) raises(NotFound);
-/*!
-Gets the description of a component of the catalog.
+/*! \brief Get the description of a component of the catalog.
*/
ComponentDef GetComponentInfo(in string componentName) raises(NotFound);
-/*!
-Reads a xml file and imports new components from this file.
+/*! \brief Read a xml file and import new components from this file.
+
New components replace existing components with the same name.
*/
void ImportXmlCatalogFile(in string filename) raises(NotFound);
+/*! \brief Shutdown the module catalog server
+*/
void shutdown();
} ;
};
#ifndef _SALOME_PORTS_IDL_
#define _SALOME_PORTS_IDL_
-/*! \file
- This file contains the IDL declarations of the kind of ports provided by the
- SALOME component model.
+/*! \file SALOME_Ports.idl
+ \brief This file contains the IDL base interfaces for ports in the SALOME component model.
*/
+/*! \brief module that contains interfaces to define the kind of ports provided by the
+SALOME component model.
+*/
module Ports {
/*! \brief Interface of a DSC Port.
*/
interface Data_And_Control_Port : Ports::Port {};
- /*!
- This exception indicates that the property doesn't not exist.
- */
+ //! This exception indicates that the property doesn't not exist.
exception NotDefined {};
- /*!
- This exception indicates that the given value to the property is not
- of a good type.
- */
+ //! This exception indicates that the given value to the property is not of a good type.
exception BadType {};
- /*!
- This exception indicates that the given value to the property is not
- authorized.
- */
+ //! This exception indicates that the given value to the property is not authorized.
exception BadValue {};
/*! \brief Interface of a PortProperties.
*/
interface PortProperties {
+ //! This operation permits to set a value of a property.
/*!
- This operation permits to set a value of a property.
\param name property's name.
\param value value of the property.
Ports::BadValue,
Ports::NotDefined);
+ //! This operation permits to get property's value.
/*!
- This operation permits to get property's value.
\param name property's name.
\return value of the property.
a port in the DSC_User programming model.
*/
interface Data_Short_Port : Ports::Data_Port {
+ //! this operation can be used by a uses port to send me a short
void put(in short data);
};
};
# ifndef __registry_idl__
# define __registry_idl__
+/*! \file SALOME_Registry.idl \brief interfaces for %SALOME registry
+*/
+
+/*! \brief module that provides interface to %SALOME registry
+*/
module Registry
{
+ //! a struct to collect informations about servers (processes)
struct Infos
{
string name;
string ior; // client
};
+ //! a list of informations
typedef sequence<Infos> AllInfos;
+/*! \brief interface to use %SALOME registry
+*/
interface Components
{
+ //! check if registry is running
void ping();
- long getPID();
+ //! Get the pid of registry server
+ long getPID();
+ //! Add one information to the registry
unsigned long add ( in Infos lesInfos ) ;
+ //! Remove an information from the registry
void remove ( in unsigned long id ) ;
+ //! Get the size of the registry
unsigned long size() ;
+ //! Get all informations from registry
AllInfos getall () ;
+ //! Get history information from registry
AllInfos history () ;
+ //! Stop the registry (hard exit)
oneway void end() ;
+ //! Say hello to registry from process id
oneway void hello( in unsigned long id ) ;
- void Shutdown();
+ //! Shutdown registry server (CORBA exit)
+ void Shutdown();
} ;
} ;
// Author : Estelle Deville
// $Header$
//
+
+/*! \file SALOME_RessourcesCatalog.idl \brief interfaces for %SALOME Resources Catalog
+*/
+
+/*! \brief module that provides interface to manage the Resources Catalog of %SALOME
+*/
module SALOME_RessourcesCatalog{
- // Type Definitions
- //Proc_info : information about a processor
+ //! Information about a processor
struct proc_info{
+ //! processor number
long number;
+ //! model name
string model_name;
+ //! frequency in MHz
float cpu_mhz;
+ //! cache size in MB
float cache_size;
};
+ //! a list of processor informations
typedef sequence<proc_info> ListOfProc;
- //Computer_info : information about a computer
- // Os and informations about processors
+ //! Information about a computer
+ /*!
+ Os and informations about processors
+ */
struct computer_info{
+ //! computer name
string name;
+ //! OS name
string OS;
+ //! OS version
string OS_version;
+ //! processors list
ListOfProc procs;
};
- enum ContainerType {Cpp, python, NP};
+ //! Container type
+ enum ContainerType {
+ Cpp, /*!< C++ container */
+ python, /*!< python container */
+ NP /*!< NP container */
+ };
+ //! a list of container types
typedef sequence<ContainerType> ListOfContainerType;
+ //! a list of computer names
typedef sequence<string> ListOfComputer;
- // exception thrown if a computer is not found in the catalog
-
+ //! exception thrown if a computer is not found in the catalog
exception NotFound {};
//------------------------------------------------------------------
- //Interface
+/*! \brief interface to get information about Resources
+*/
interface RessourcesCatalog {
+ //! Get the catalog computers list
ListOfComputer GetComputerList();
+ //! Get the container types list for a given computer
ListOfContainerType GetContainerTypeList (in string computer) raises(NotFound);
+ //! Get computer information for a given computer
computer_info GetComputerInfo(in string computer) raises(NotFound);
};
};
//
#include "SALOME_Component.idl"
-/*!
- This package contains interfaces used for management of the session in %SALOME application.
-*/
+/*! \file SALOME_Session.idl \brief file that contains interface of the session
+ */
+
module SALOME
{
/*! \brief State of the session
This enumeration contains values defining the state of the session
*/
- enum SessionState {asleep, /*! Session is inactive */
- running /*! Session is running */
+ enum SessionState {asleep, /*!< Session is inactive */
+ running /*!< Session is running */
} ;
/*! \brief %Session State and Statistics
/*! \brief State of the session
It can be:
- * -# asleep : no running study
- * -# running : one or more running studies
+ -# asleep : no running study
+ -# running : one or more running studies
*/
SessionState state ;
-/*! Number of running studies
-*/
+//! Number of running studies
short runningStudies ;
-/*! It is True if GUI is active in the session
-*/
+//! It is True if GUI is active in the session
boolean activeGUI ;
} ;
+
/*! \brief Interface of the session
The %session Server launches and stops GUI (Graphical User Interface).
interface Session
{
-/*!
- This exception is raised when trying to stop the %session with active GUI
-*/
+//! This exception is raised when trying to stop the %session with active GUI
exception GUIActive {} ;
-/*!
- This exception is raised when trying to stop the %session with a number of running studies.
-*/
+//! This exception is raised when trying to stop the %session with a number of running studies.
exception RunningStudies {} ;
-/*!
- Launches GUI in the session
-*/
+//! Launches GUI in the session
void GetInterface();
-/*!
- Returns a standalone component
-*/
+//! Returns a standalone component
Engines::Component GetComponent(in string theLibraryName);
-/*!
- Stops the %Session (It must be idle)
-*/
+//! Stops the %Session (It must be idle)
void StopSession() raises(GUIActive, RunningStudies) ;
-/*!
- Gets Session State
-*/
+//! Gets Session State
StatSession GetStatSession() ;
-/*!
- Determines whether the server has already been loaded or not.
-*/
+
+//! Determines whether the server has already been loaded or not.
void ping();
-/*!
- Returns the PID of the server
-*/
+//! Returns the PID of the server
long getPID();
-/*!
- Get Active study ID
-*/
+//! Get Active study ID
long GetActiveStudyId();
-/*!
- Restores a state of the study at theSavePoint
-*/
+//! Restores a state of the study at theSavePoint
boolean restoreVisualState(in long theSavePoint);
+
+ //! Send a message to the session GUI desktop that will emit a qt signal
/*!
- Emit a qt signal from the session GUI desktop window.
This method can be used to send a message to the GUI from the standalone
container.
Caution: this method can block the Session and the calling container
In such a case it is recommended to use oneway method.
*/
void emitMessage(in string theMessage);
+
+ //! same as emitMessage but in a non blocking way
/*!
Emit a qt signal from the session GUI desktop window.
This method can be used to send a message to the GUI from the standalone
//
#include "SALOME_Component.idl"
+/*! \file SALOME_TestComponent.idl \brief an interface for testing Component and Container
+*/
+
module Engines
{
+/*! \brief a component with 2 operations (Coucou and Setenv)
+*/
interface TestComponent : Component
{
string Coucou(in long L);
};
};
+
#include "SALOME_Component.idl"
#include "SALOME_MPIObject.idl"
+/*! \file SALOME_TestMPIComponent.idl \brief interface to test MPIObject and MPIContainer
+*/
+
module Engines
{
#include "SALOME_Component.idl"
+/*! \file SALOME_TestModuleCatalog.idl \brief interfaces for %SALOME module catalog test
+*/
+
+/*! \brief module to test SALOME_ModuleCatalog
+*/
+
module SALOME_TestModuleCatalog {
interface Adder ;
# ifndef __TESTNOTIF_IDL_
# define __TESTNOTIF_IDL_
+/*! \file TestNotif.idl \brief for testing notification service
+*/
+
+/* \brief interface to test notification service
+*/
interface Solver
{
boolean Connect();
#ifndef _SALOME_TYPEDATA_IDL_
#define _SALOME_TYPEDATA_IDL_
+/*! \file TypeData.idl \brief data definition for tests
+*/
+
module Engines
{
#ifndef NSTEST_IDL
#define NSTEST_IDL
+/*! \file nstest.idl \brief interfaces for naming service test
+*/
+
+/*! \brief module with one interface to test naming service
+*/
module NSTEST
{
+/*! \brief small interface for test
+*/
interface echo
{
+/*! \brief operation that returns a long
+*/
long getId();
};
+/*! \brief factory interface for test
+*/
interface aFactory
{
+/*! \brief operation that creates a echo %object
+*/
echo createInstance();
};
};
-#endif
\ No newline at end of file
+#endif
bool Engines_Component_i::_isMultiStudy = true;
bool Engines_Component_i::_isMultiInstance = false;
+/*! \class Engines_Component_i
+ * \brief C++ implementation of Engines::Component interface
+ *
+ */
+
//=============================================================================
/*!
* Default constructor, not for use
}
//=============================================================================
-/*!
- * Standard Constructor for generic Component, used in derived class
+/*! \brief Standard Constructor for generic Component, used in derived class
+ *
* Connection to Registry and Notification
* \param orb Object Request broker given by Container
* \param poa Portable Object Adapter from Container (normally root_poa)
}
//=============================================================================
-/*!
- * Standard Constructor for standalone Component, used in derived class
+/*! \brief Standard Constructor for standalone Component, used in derived class
+ *
* Connection to Registry and Notification
* \param orb Object Request broker given by Container
* \param poa Portable Object Adapter from Container (normally root_poa)
//=============================================================================
-/*!
- * Standard constructor for parallel component
+/*! \brief Standard constructor for parallel component
+ *
* Connection Notification (no connection to Registry !)
* \param orb Object Request broker given by Container
* \param poa Portable Object Adapter from Container (normally root_poa)
int _ArgC ;
char ** _ArgV ;
-
-// Containers with name FactoryServer are started via rsh in LifeCycleCORBA
-// Other Containers are started via start_impl of FactoryServer
-
extern "C" {void ActSigIntHandler() ; }
#ifndef WIN32
extern "C" {void SigIntHandler(int, siginfo_t *, void *) ; }
map<std::string, void *> Engines_Container_i::_toRemove_map;
omni_mutex Engines_Container_i::_numInstanceMutex ;
+/*! \class Engines_Container_i
+ * \brief C++ implementation of Engines::Container interface
+ *
+ */
+
+
//=============================================================================
/*!
* Default constructor, not for use
}
//=============================================================================
+//! Get container name
/*!
* CORBA attribute: Container name (see constructor)
*/
}
//=============================================================================
+//! Get container working directory
/*!
* CORBA attribute: Container working directory
*/
}
//=============================================================================
+//! Get container log file name
/*!
* CORBA attribute: Container log file name
*/
return CORBA::string_dup(_logfilename.c_str()) ;
}
+//! Set container log file name
void Engines_Container_i::logfilename(const char* name)
{
_logfilename=name;
}
//=============================================================================
+//! Get container host name
/*!
* CORBA method: Get the hostName of the Container (without domain extensions)
*/
}
//=============================================================================
+//! Get container PID
/*!
* CORBA method: Get the PID (process identification) of the Container
*/
}
//=============================================================================
+//! Ping the servant to check it is still alive
/*!
* CORBA method: check if servant is still alive
*/
}
//=============================================================================
+//! Shutdown the container
/*!
* CORBA method, oneway: Server shutdown.
* - Container name removed from naming service,
//=============================================================================
+//! load a new component class
/*!
* CORBA method: load a new component class (Python or C++ implementation)
* \param componentName like COMPONENT
}
//=============================================================================
+//! Create a new component instance
/*!
* CORBA method: Creates a new servant instance of a component.
* The servant registers itself to naming service and Registry.
}
//=============================================================================
+//! Find an existing (in the container) component instance
/*!
* CORBA method: Finds a servant instance of a component
* \param registeredName Name of the component in Registry or Name Service,
}
//=============================================================================
+//! Find or create a new component instance
/*!
* CORBA method: find or create an instance of the component (servant),
* load a new component class (dynamic library) if required,
+*
* ---- FOR COMPATIBILITY WITH 2.2 ----
+*
* ---- USE ONLY FOR MULTISTUDY INSTANCES ! --------
+*
* The servant registers itself to naming service and Registry.
* \param genericRegisterName Name of the component to register
* in Registry & Name Service
//=============================================================================
+//! Remove the component instance from container
/*!
* CORBA method: Stops the component servant, and deletes all related objects
* \param component_i Component to be removed
}
//=============================================================================
+//! Unload component libraries from the container
/*!
* CORBA method: Discharges unused libraries from the container.
*/
}
//=============================================================================
+//! Kill the container
/*!
* CORBA method: Kill the container process with exit(0).
* To remove : never returns !
}
//=============================================================================
+//! Get or create a file reference object associated to a local file (to transfer it)
/*!
* CORBA method: get or create a fileRef object associated to a local file
* (a file on the computer on which runs the container server), which stores
}
//=============================================================================
+//! Get a fileTransfer reference
/*!
* CORBA method:
* \return a reference to the fileTransfer object
}
+//! Create a Salome file
Engines::Salome_file_ptr
Engines_Container_i::createSalome_file(const char* origFileName)
{
return theSalome_file;
}
//=============================================================================
+//! Finds an already existing component instance or create a new instance
/*!
* C++ method: Finds an already existing servant instance of a component, or
* create an instance.
* \return a loaded component
*
* example with names:
-* aGenRegisterName = COMPONENT (= first argument)
-* impl_name = libCOMPONENTEngine.so (= second argument)
-* _containerName = /Containers/cli76ce/FactoryServer
-* factoryName = COMPONENTEngine_factory
-* component_registerBase = /Containers/cli76ce/FactoryServer/COMPONENT
-*
-* instanceName = COMPONENT_inst_1
-* component_registerName = /Containers/cli76ce/FactoryServer/COMPONENT_inst_1
+* - aGenRegisterName = COMPONENT (= first argument)
+* - impl_name = libCOMPONENTEngine.so (= second argument)
+* - _containerName = /Containers/cli76ce/FactoryServer
+* - factoryName = COMPONENTEngine_factory
+* - component_registerBase = /Containers/cli76ce/FactoryServer/COMPONENT
+* - instanceName = COMPONENT_inst_1
+* - component_registerName = /Containers/cli76ce/FactoryServer/COMPONENT_inst_1
*/
//=============================================================================
Engines::Component_ptr
-Engines_Container_i::find_or_create_instance(string genericRegisterName,
- string componentLibraryName)
+Engines_Container_i::find_or_create_instance(std::string genericRegisterName,
+ std::string componentLibraryName)
{
string aGenRegisterName = genericRegisterName;
string impl_name = componentLibraryName;
}
//=============================================================================
+//! Create a new component instance
/*!
* C++ method: create a servant instance of a component.
* \param genericRegisterName Name of the component instance to register
* \return a loaded component
*
* example with names:
-* aGenRegisterName = COMPONENT (= first argument)
-* _containerName = /Containers/cli76ce/FactoryServer
-* factoryName = COMPONENTEngine_factory
-* component_registerBase = /Containers/cli76ce/FactoryServer/COMPONENT
-* instanceName = COMPONENT_inst_1
-* component_registerName = /Containers/cli76ce/FactoryServer/COMPONENT_inst_1
+* - aGenRegisterName = COMPONENT (= first argument)
+* - _containerName = /Containers/cli76ce/FactoryServer
+* - factoryName = COMPONENTEngine_factory
+* - component_registerBase = /Containers/cli76ce/FactoryServer/COMPONENT
+* - instanceName = COMPONENT_inst_1
+* - component_registerName = /Containers/cli76ce/FactoryServer/COMPONENT_inst_1
*/
//=============================================================================
Engines::Component_ptr
-Engines_Container_i::createInstance(string genericRegisterName,
+Engines_Container_i::createInstance(std::string genericRegisterName,
void *handle,
int studyId)
{
}
//=============================================================================
+//! Decrement component instance reference count
/*!
*
*/
//=============================================================================
-void Engines_Container_i::decInstanceCnt(string genericRegisterName)
+void Engines_Container_i::decInstanceCnt(std::string genericRegisterName)
{
if(_cntInstances_map.count(genericRegisterName)==0)
return;
}
//=============================================================================
+//! Indicate if container is a python one
/*!
* Retrieves only with container naming convention if it is a python container
*/
# Module : SALOME
# $Header$
#
+## @package SALOME_ComponentPy
+# \brief python implementation of component interface for Kernel
+#
+#
+
import os
import sys
import time
_Sleeping = 0
-#define an implementation of the component interface
-
+## define an implementation of the component interface Engines::Component
+#
+#
class SALOME_ComponentPy_i (Engines__POA.Component):
_orb = None
_poa = None
# Module : SALOME
# $Header$
#
+## @package SALOME_Container
+# \brief python implementation of container interface for Kernel
+#
+#
+
import os
import sys
import string
#include "SALOME_FileTransfer_i.hxx"
#include "utilities.h"
+/*! \class fileTransfer_i
+ \brief A class to manage file transfer in SALOME
+
+*/
+
//=============================================================================
/*!
* Default constructor,
//=============================================================================
-/*!
- * CORBA method: try to open the file given. If the file is readable, return
+/*! \brief open the given file
+ *
+ * CORBA method: try to open the file. If the file is readable, return
* a positive integer else return 0;
* \param fileName path to the file to be transfered
* \return fileId = positive integer > 0 if open OK.
}
//=============================================================================
-/*!
+/*! \brief close a file
+ *
* CORBA method: close the file associated to the fileId given at open.
* \param fileId got in return from open method
*/
else fclose(fp);
}
+#define FILEBLOCK_SIZE 256*1024
+
//=============================================================================
-/*!
+/*! \brief get a data block from a file
+ *
* CORBA method: get a block of data from the file associated to the fileId
* given at open.
* \param fileId got in return from open method
*/
//=============================================================================
-#define FILEBLOCK_SIZE 256*1024
-
Engines::fileBlock* fileTransfer_i::getBlock(CORBA::Long fileId)
{
MESSAGE("fileTransfer_i::getBlock");
# include <windows.h>
#endif
+/*! \class Salome_file_i
+ * \brief A class to manage file transfer in %SALOME
+ *
+ */
+
//=============================================================================
/*!
/*! \class DSC_Callbacks
* \brief This is an abstract class that defines methods that the component
- * uses to prevent the component user code that the state of the component has changed.
+ * uses to notify the component user code that the state of the component has changed.
+ *
* Currently only port's connection modifications are signaled.
*/
class DSC_BASIC_EXPORT DSC_Callbacks
DSC_Callbacks() {}
virtual ~DSC_Callbacks() {}
- /*!
- * This method is used by the component when the number of connection
- * on a provides port changes. This information helps the user code to detect
- * operation on its ports.
- *
+ /*! \brief This method is used by the component when the number of connection
+ * on a provides port changes.
+ *
+ * This information helps the user code to detect operation on its ports.
*
* \param provides_port_name the name of the provides name that has changed.
* \param connection_nbr the new number of connection on the provides port.
int connection_nbr,
const Engines::DSC::Message message) = 0;
- /*!
- * This method is used by the component when the number of connection
- * on a uses port changes. This information helps the user code to detect
- * operation on its ports.
- *
+ /*! \brief This method is used by the component when the number of connection
+ * on a uses port changes.
+ *
+ * This information helps the user code to detect operation on its ports.
*
* \param uses_port_name the name of the uses name that has changed.
* \param new_uses_port the new sequence representing the uses port.
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## @package dsccalcium
+# \brief Module that provides the base class for DSC components implemented in python
+#
+#
+
import calcium
import SALOME_ComponentPy
import SALOME_DriverPy
import Engines
+## The SALOME base class for all DSC components implemented in python (interface Engines::Superv_Component).
+#
+#
class PyDSCComponent(SALOME_ComponentPy.SALOME_ComponentPy_i,
SALOME_DriverPy.SALOME_DriverPy_i):
"""
- A Python SALOME component is implemented by a Python class that has
+ A Python DSC component is implemented by a Python class that has
the name of the component and is located in a python module that has the
name of the component.
- This class is a base class for Python DSC components.
-
You must derive it and implement init_service and those methods
that are services of the component.
"""
# Module : SALOME
# $Header$
#
-"""
+"""
Module salome gives access to Salome ressources.
variables:
- salome.orb : CORBA
- salome.naming_service : instance of naming Service class
- methods:
- Resolve(name) : find a CORBA object (ior) by its pathname
- Register(name) : register a CORBA object under a pathname
- salome.lcc : instance of lifeCycleCORBA class
- methods:
- FindOrLoadComponent(server,name) :
+ - salome.orb : CORBA
+ - salome.naming_service : instance of naming Service class
+ - methods:
+ - Resolve(name) : find a CORBA object (ior) by its pathname
+ - Register(name) : register a CORBA object under a pathname
+
+ - salome.lcc : instance of lifeCycleCORBA class
+ - methods:
+ - FindOrLoadComponent(server,name) :
obtain an Engine (CORBA object)
or launch the Engine if not found,
with a Server name and an Engine name
- salome.sg
- methods:
- updateObjBrowser(bool):
- getActiveStudyId():
- getActiveStudyName():
- SelectedCount(): returns number of selected objects
- getSelected(i): returns entry of selected object number i
- getAllSelected(): returns list of entry of selected objects
- AddIObject(Entry): select an existing Interactive object
- RemoveIObject(Entry): remove object from selection
- ClearIObjects(): clear selection
+ - salome.sg : salome object to communicate with the graphical user interface (if any)
+ - methods:
+ - updateObjBrowser(bool):
+ - getActiveStudyId():
+ - getActiveStudyName():
+
+ - SelectedCount(): returns number of selected objects
+ - getSelected(i): returns entry of selected object number i
+ - getAllSelected(): returns list of entry of selected objects
+ - AddIObject(Entry): select an existing Interactive object
+ - RemoveIObject(Entry): remove object from selection
+ - ClearIObjects(): clear selection
- Display(*Entry):
- DisplayOnly(Entry):
- Erase(Entry):
- DisplayAll():
- EraseAll():
+ - Display(*Entry):
+ - DisplayOnly(Entry):
+ - Erase(Entry):
+ - DisplayAll():
+ - EraseAll():
- IDToObject(Entry): returns CORBA reference from entry
+ - IDToObject(Entry): returns CORBA reference from entry
- salome.myStudyName : active Study Name
- salome.myStudyId : active Study Id
- salome.myStudy : the active Study itself (CORBA ior)
- methods : defined in SALOMEDS.idl
+ - salome.myStudyName : active Study Name
+ - salome.myStudyId : active Study Id
+ - salome.myStudy : the active Study itself (CORBA ior)
+ - methods : defined in SALOMEDS.idl
"""
+## @package salome
+# Module salome gives access to Salome ressources.
+#
+# \param salome.orb : CORBA orb object
+# \param salome.naming_service : instance of naming Service class (SALOME_NamingServicePy::SALOME_NamingServicePy_i)
+# \param salome.lcc : instance of lifeCycleCORBA class (SALOME_LifeCycleCORBA)
+# \param salome.sg : Salome object to communicate with the graphical user interface, if running (see interface in salome_iapp::SalomeOutsideGUI)
+# \param salome.myStudyName : active Study Name
+# \param salome.myStudyId : active Study Id
+# \param salome.myStudy : the active Study (interface SALOMEDS::Study)
+
from salome_kernel import *
from salome_study import *
# Module : SALOME
# $Header$
#
+## @package salome_iapp
+# Module salome gives access to Salome GUI ressources (if GUI has been launched).
+#
+
import salome_ComponentGUI
#--------------------------------------------------------------------------
global myStudyId, myStudyName
def hasDesktop(self):
+ """Indicate if GUI is running"""
return False
def updateObjBrowser(self, bid):
+ """update the GUI object browser"""
print "SalomeOutsideGUI: no objectBrowser update outside GUI"
pass
def getActiveStudyId(self):
+ """Get the active study id"""
print "SalomeOutsideGUI.getActiveStudyId: avoid use outside GUI"
return myStudyId
def getActiveStudyName(self):
+ """Get the active study name"""
print "SalomeOutsideGUI.getActiveStudyName: avoid use outside GUI"
return myStudyName
def SelectedCount(self):
+ """Get the number of active selections"""
print "SalomeOutsideGUI: no selection mecanism available outside GUI"
return 0
def getSelected(self, i):
+ """Get the selection number i """
print "SalomeOutsideGUI: no selection mecanism available outside GUI"
return none
def AddIObject(self, Entry):
+ """Add an entry"""
print "SalomeOutsideGUI.AddIOObject: not available outside GUI"
pass
def RemoveIObject(self, Entry):
+ """Remove an entry"""
print "SalomeOutsideGUI.REmoveIOObject: not available outside GUI"
pass
def ClearIObjects(self):
+ """Clear entries"""
print "SalomeOutsideGUI.ClearIOObject: not available outside GUI"
pass
def Display(self, Entry):
+ """Display an entry"""
print "SalomeOutsideGUI.Display: not available outside GUI"
pass
def DisplayOnly(self, Entry):
+ """Display only an entry"""
print "SalomeOutsideGUI.DisplayOnly: not available outside GUI"
pass
def Erase(self, Entry):
+ """Erase en entry"""
print "SalomeOutsideGUI.Erase: not available outside GUI"
pass
def DisplayAll(self):
+ """Display all"""
print "SalomeOutsideGUI.Erase: not available outside GUI"
pass
def EraseAll(self):
+ """Erase all"""
print "SalomeOutsideGUI.EraseAll: not available outside GUI"
pass
def IsInCurrentView(self, Entry):
+ """Indicate if an entry is in current view"""
print "SalomeOutsideGUI.IsIncurentView: not available outside GUI"
return False
def getComponentName(self, ComponentUserName ):
+ """Get component name from component user name"""
print "SalomeOutsideGUI.getComponentName: not available outside GUI"
return ""
def getComponentUserName( self, ComponentName ):
+ """Get component user name from component name"""
print "SalomeOutsideGUI.getComponentUserName: not available outside GUI"
return ""
using namespace std;
+/*! \class SALOME_FileTransferCORBA
+ \brief A class to manage file transfer in SALOME (CORBA context)
+
+*/
+
//=============================================================================
/*!
* Default constructor, not for use.
}
//=============================================================================
-/*!
- * Constructor to use when we get a fileRef CORBA object from a component.
+/*! \brief Constructor to use when we get a fileRef CORBA object from a component
+ *
* \param aFileRef file reference CORBA object
*/
//=============================================================================
}
//=============================================================================
-/*!
- * Constructor to use when we have the file name and machine from which to
- * copy, plus an optional Container name on the machine.
+/*! \brief Constructor to use when we have the file name and machine from which to
+ * copy, plus an optional Container name on the machine.
+ *
* \param refMachine the machine on which is the file to transfer
* \param origFileName abolute file path on refMachine
* \param containerName default container name used (FactoryServer) if empty
}
//=============================================================================
-/*!
- * CORBA method: get a local copy of the reference file.
+/*! \brief Get a local copy of the reference file
+ *
+ * CORBA method
* \param localFile optional absolute path to store the copy
* \return the file name (absolute path) of the copy, may be different from
* localFile parameter if the copy was already done before the call
{
}
+/*! \class SALOME_LifeCycleCORBA
+ \brief A class to manage life cycle of SALOME components.
+
+*/
+
//=============================================================================
/*!
* Constructor
}
//=============================================================================
-/*! Public -
- * Find and aready existing and registered component instance.
+/*! \brief Find an already existing and registered component instance.
+ *
* \param params machine parameters like type or name...
* \param componentName the name of component class
* \param studyId default = 0 : multistudy instance
* \return a CORBA reference of the component instance, or _nil if not found
*/
//=============================================================================
-
Engines::Component_ptr
SALOME_LifeCycleCORBA::FindComponent(const Engines::MachineParameters& params,
const char *componentName,
}
//=============================================================================
-/*! Public -
- * Load a component instance on a container defined by machine parameters
+/*! \brief Load a component instance on a container defined by machine parameters
+ *
* \param params machine parameters like type or name...
* \param componentName the name of component class
* \param studyId default = 0 : multistudy instance
}
//=============================================================================
-/*! Public -
- * Find and aready existing and registered component instance or load a new
- * component instance on a container defined by machine parameters.
+/*! \brief Find an already existing and registered component instance or load a new
+ * component instance on a container defined by machine parameters.
+ *
* \param params machine parameters like type or name...
* \param componentName the name of component class
* \param studyId default = 0 : multistudy instance
}
//=============================================================================
-/*! Public -
- * Find and aready existing and registered component instance or load a new
- * component instance on a container defined by name
+/*! \brief Find an already existing and registered component instance or load a new
+ * component instance on a container defined by name
+ *
* \param containerName the name of container, under one of the forms
* - 1 aContainer (local container)
* - 2 machine/aContainer (container on hostname = machine)
}
//=============================================================================
-/*! Public -
- * Check if the component class is known in module catalog
+/*! \brief Check if the component class is known in module catalog
+ *
* \param componentName the name of component class
* \return true if found, false otherwise
*/
}
//=============================================================================
-/*! Public -
+/*!
* Not so complex... useful ?
*/
//=============================================================================
//=============================================================================
-/*! Public -
- * Pre initialisation of a given Engines::MachineParameters with default
- * values.
+/*! \brief Initialisation of a given Engines::MachineParameters with default values.
+ *
* - container_name = "" : not relevant
* - hostname = "" : not relevant
* - OS = "" : not relevant
}
//=============================================================================
-/*! Public -
+/*!
* \return a number of processors not 0, only for MPI containers
*/
//=============================================================================
}
//=============================================================================
-/*! Public -
+/*! \brief Get the container manager
+ *
* \return the container Manager
*/
//=============================================================================
}
//=============================================================================
-/*! Public -
+/*! \brief Get the resources manager
+ *
* \return the container Manager
*/
//=============================================================================
}
//=============================================================================
-/*! Public -
- * shutdown all the SALOME servers except SALOME_Session_Server, omniNames and notifd
+/*! \brief shutdown all the SALOME servers except SALOME_Session_Server, omniNames and notifd
*/
//=============================================================================
}
//=============================================================================
-/*! Public -
- * shutdown omniNames and notifd
+/*! \brief shutdown omniNames and notifd
*/
//=============================================================================
}
//=============================================================================
-/*! Protected -
- * Find and aready existing and registered component instance.
+/*! \brief Find an already existing and registered component instance.
+ *
+ * - build a list of machines on which an instance of the component is running,
+ * - find the best machine among the list
+ *
* \param params machine parameters like type or name...
* \param componentName the name of component class
* \param studyId default = 0 : multistudy instance
* \param listOfMachines list of machine address
* \return a CORBA reference of the component instance, or _nil if not found
- * - build a list of machines on which an instance of the component is running,
- * - find the best machine among the list
*/
//=============================================================================
}
//=============================================================================
-/*! Protected -
- * Load a component instance.
+/*! \brief Load a component instance.
+ *
+ * - Finds a container in the list of machine or start one.
+ * - Try to load the component library in the container,
+ * - then create an instance of the component.
+ *
* \param params machine parameters like type or name...
* \param componentName the name of component class
* \param studyId default = 0 : multistudy instance
* \param listOfMachines list of machine address
* \return a CORBA reference of the component instance, or _nil if problem
- * - Finds a container in the list of machine or start one.
- * - Try to load the component library in the container,
- * - then create an instance of the component.
*/
//=============================================================================
return myInstance._retn();
}
+//=============================================================================
+/*! \brief Load a parallel component instance.
+ *
+ * \param params machine parameters like type or name...
+ * \param componentName the name of component class
+ * \param studyId default = 0 : multistudy instance
+ * \return a CORBA reference of the parallel component instance, or _nil if problem
+ */
+//=============================================================================
Engines::Component_ptr
SALOME_LifeCycleCORBA::Load_ParallelComponent(const Engines::MachineParameters& params,
const char *componentName,
using namespace std;
+/*! \class SALOME_NamingService
+ \brief A class to manage the SALOME naming service
+
+*/
+
// ============================================================================
/*! \brief Default Constructor without ORB reference.
*
# Module : SALOME
# $Header$
#
+## @package SALOME_NamingServicePy
+# \brief Module to manage SALOME naming service from python
+#
+#
+
import sys
import time
from omniORB import CORBA
#=============================================================================
class SALOME_NamingServicePy_i(object):
+ """
+ A class to manage SALOME naming service from python code
+ """
_orb = None
_root_context=None
_current_context=None
#-------------------------------------------------------------------------
def __init__(self, orb):
+ """
+ Standard Constructor, with ORB reference.
+
+ Initializes the naming service root context
+ """
#MESSAGE ( "SALOME_NamingServicePy_i::__init__" )
self._orb = orb
# initialize root context and current context
- ok = 0
- steps = 240
- while steps > 0 and ok == 0:
- try:
+ ok = 0
+ steps = 240
+ while steps > 0 and ok == 0:
+ try:
obj =self._orb.resolve_initial_references("NameService")
self._root_context =obj._narrow(CosNaming.NamingContext)
self._current_context = self._root_context
if self._root_context is None :
#MESSAGE ( "Name Service Reference is invalid" )
#sys.exit(1)
- MESSAGE(" Name service not found")
- else:
- ok = 1
- except (CORBA.TRANSIENT,CORBA.OBJECT_NOT_EXIST,CORBA.COMM_FAILURE):
- MESSAGE(" Name service not found")
- time.sleep(0.25)
- steps = steps - 1
+ MESSAGE(" Name service not found")
+ else:
+ ok = 1
+ except (CORBA.TRANSIENT,CORBA.OBJECT_NOT_EXIST,CORBA.COMM_FAILURE):
+ MESSAGE(" Name service not found")
+ time.sleep(0.25)
+ steps = steps - 1
if steps == 0 and self._root_context is None:
MESSAGE ( "Name Service Reference is invalid" )
sys.exit(1)
#-------------------------------------------------------------------------
def Create_Directory(self,ObjRef, Path):
+ """ ns.Create_Directory(ObjRef, Path)
+
+ create a sub directory
+ """
MESSAGE ( "SALOME_NamingServicePy_i::Create_Directory" )
_not_exist = 0
path_list = list(Path)
MESSAGE ( "Create_Directory : CORBA.TRANSIENT,CORBA.OBJECT_NOT_EXIST,CORBA.COMM_FAILURE" )
def Destroy_Name(self,Path):
+ """ ns.Destroy_Name(Path)
+
+ remove a name in naming service
+ """
resolve_path=string.split(Path,'/')
if resolve_path[0] == '': del resolve_path[0]
dir_path=resolve_path[:-1]
return
def Destroy_FullDirectory(self,Path):
+ """ ns.Destroy_FullDirectory(Path)
+
+ remove recursively a directory
+ """
context_name=[]
for e in string.split(Path,'/'):
if e == '':continue
#
# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
+## @package SALOME_DriverPy
+# \brief python implementation of SALOMEDS::Driver interface
+#
+#
import SALOMEDS__POA
+## Python implementation of generic SALOMEDS::Driver.
+#
+#
class SALOME_DriverPy_i(SALOMEDS__POA.Driver):
"""
- Python implementation of generic SALOMEDS driver.
Should be inherited by any Python module's engine
to provide persistence mechanism.
"""
# Module : SALOME
# $Header$
#
+## @package Utils_Identity
+# \brief Module to get information about user and version
+#
+#
+
import sys
import os
import socket
if not sys.platform == "win32":
import pwd
-
+ def getUserName(uid):
+ return pwd.getpwuid(uid)[0]
+else
+ def getUserName(uid):
+ return os.environ["USER"]
+
import time
import string
def getShortHostName():
"""
gives Hostname without domain extension.
+
SALOME naming service needs short Hostnames (without domain extension).
HOSTNAME is not allways defined in environment,
socket.gethostname() gives short or complete Hostname, depending on
self._name = name
self._pid = os.getpid()
self._machine = socket.gethostname()
- self._adip = socket.gethostbyname(self._machine) # IP adress
- if sys.platform == "win32":
- self._uid = os.getpid()
- self._pwname = os.environ["USER"]
- else:
- self._uid = os.getuid()
- list = pwd.getpwuid(self._uid)
- self._pwname = list[0] # user name
-
- self._tc_start = time.time()
+ self._adip = socket.gethostbyname(self._machine) # IP adress
+ self._uid = os.getpid()
+ self._pwname = getUserName(self._uid)
+ self._tc_start = time.time()
self._cstart = time.ctime(self._tc_start)
- self._cdir = os.getcwd()
+ self._cdir = os.getcwd()
def getapplipath():
"""
