Back to index

salome-kernel  6.5.0
Public Member Functions | Public Attributes
Engines::MPIContainer Interface Reference

Interface of the MPI parallel container. More...

import "SALOME_MPIContainer.idl";

Inheritance diagram for Engines::MPIContainer:
Inheritance graph
[legend]
Collaboration diagram for Engines::MPIContainer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

boolean load_component_Library (in string componentName, out string reason)
 Loads a new component class (dynamic library).
Engines::EngineComponent create_component_instance (in string componentName, in long studyId)
 Create a new servant instance of a component.
Engines::EngineComponent create_component_instance_env (in string componentName, in long studyId, in FieldsDict env, out string reason)
 Create a new servant instance of a component with environment variables specified.
EngineComponent find_component_instance (in string registeredName, in long studyId)
 Find a servant instance of a component.
EngineComponent load_impl (in string nameToRegister, in string componentName)
 Find a servant instance of a component, or create a new one.
void remove_impl (in EngineComponent component_i)
 Remove the component servant, and deletes all related objects.
void finalize_removal ()
 Unload component libraries from the container.
void ping ()
 Determines whether the server has been loaded or not.
void Shutdown ()
 Shutdown the Container process.
string getHostName ()
 Returns the hostname of the container.
long getPID ()
 Returns the PID of the container.
boolean Kill_impl ()
 Kill the container.
fileRef createFileRef (in string origFileName)
 Create a fileRef.
Salome_file createSalome_file (in string origFileName)
 Create a Salome_file.
fileTransfer getFileTransfer ()
 Create a fileTransfer.
void copyFile (in Container contai, in string remoteFile, in string localFile)
 Copy a file from a remote host (container) to a local file.
PyNode createPyNode (in string nodeName, in string code) raises (SALOME::SALOME_Exception)
 Create a PyNode in the container.
PyScriptNode createPyScriptNode (in string nodeName, in string code) raises (SALOME::SALOME_Exception)
 Create a PyScriptNode in the container.

Public Attributes

readonly attribute string name
 Name of the container.
readonly attribute string workingdir
 working directory of the container
attribute string logfilename
 name of the container log file (this has been set by the launcher)
attribute IORTab tior

Detailed Description

Interface of the MPI parallel container.

This interface defines the process of loading and registration of new components in SALOME application

Definition at line 41 of file SALOME_MPIContainer.idl.


Member Function Documentation

void Engines::Container::copyFile ( in Container  contai,
in string  remoteFile,
in string  localFile 
) [inherited]

Copy a file from a remote host (container) to a local file.

Parameters:
contaithe remote container
remoteFilethe file on the remote host to copy
localFilethe local file to create by copy
Engines::EngineComponent Engines::Container::create_component_instance ( in string  componentName,
in long  studyId 
) [inherited]

Create a new servant instance of a component.

Component library must be loaded.

Parameters:
componentNameName of the component which will be registered in Registry and Name Service, (instance number suffix added to the registered name)
studyId0 if instance is not associated to a study, >0 otherwise (== study id)
Returns:
a loaded component

Here is the caller graph for this function:

Engines::EngineComponent Engines::Container::create_component_instance_env ( in string  componentName,
in long  studyId,
in FieldsDict  env,
out string  reason 
) [inherited]

Create a new servant instance of a component with environment variables specified.

Component library must be loaded.

Parameters:
componentNameName of the component which will be registered in Registry and Name Service, (instance number suffix added to the registered name)
studyId0 if instance is not associated to a study, >0 otherwise (== study id)
enva dict of env variables
reasonin case of error (return nil) a string explaining the error
Returns:
a loaded component
fileRef Engines::Container::createFileRef ( in string  origFileName) [inherited]

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 file name, so, several calls with the same file name returns the same object.

PyNode Engines::Container::createPyNode ( in string  nodeName,
in string  code 
) raises (SALOME::SALOME_Exception) [inherited]

Create a PyNode in the container.

Parameters:
nodeNamethe name of the PyNode
codepython code as text to load in the node
PyScriptNode Engines::Container::createPyScriptNode ( in string  nodeName,
in string  code 
) raises (SALOME::SALOME_Exception) [inherited]

Create a PyScriptNode in the container.

Parameters:
nodeNamethe name of the PyScriptNode
codepython code as text to load in the node
Salome_file Engines::Container::createSalome_file ( in string  origFileName) [inherited]

Create a Salome_file.

returns a Salome_file object if origFileName exists and is readable else returns null object.

Parameters:
origFileNamename of the file to be managed (can contain the path).
Returns:
Salome_file CORBA reference.

Unload component libraries from the container.

EngineComponent Engines::Container::find_component_instance ( in string  registeredName,
in long  studyId 
) [inherited]

Find a servant instance of a component.

Parameters:
registeredNameName of the component in Registry or Name Service, without instance suffix number
studyId0 if instance is not associated to a study, >0 otherwise (== study id)
Returns:
the first instance found with same studyId

Create a fileTransfer.

returns a fileTransfer object used to copy files from the container machine to the clients machines. Only one fileTransfer instance is created in a container.

string Engines::Container::getHostName ( ) [inherited]

Returns the hostname of the container.

long Engines::Container::getPID ( ) [inherited]

Returns the PID of the container.

boolean Engines::Container::Kill_impl ( ) [inherited]

Kill the container.

Returns True if the container has been killed. Kept for Superv compilation but can't work, unless oneway... TO REMOVE !

boolean Engines::Container::load_component_Library ( in string  componentName,
out string  reason 
) [inherited]

Loads a new component class (dynamic library).

Parameters:
componentNamelike COMPONENT, (Python or C++ implementation) try to make a Python import of COMPONENT, then a lib open of libCOMPONENTEngine.so
reasonin case of error (return false) a string explaining the error
Returns:
true if load successfull or already done, false otherwise
EngineComponent Engines::Container::load_impl ( in string  nameToRegister,
in string  componentName 
) [inherited]

Find a servant instance of a component, or create a new one.

Loads the component library if needed. Only applicable to multiStudy components.

Parameters:
nameToRegisterName of the component which will be registered in Registry (or Name Service)
componentNameName of the constructed library of the component (not used any more, give empty string)
Returns:
a loaded component
void Engines::Container::ping ( ) [inherited]

Determines whether the server has been loaded or not.

void Engines::Container::remove_impl ( in EngineComponent  component_i) [inherited]

Remove the component servant, and deletes all related objects.

Parameters:
component_iComponent to be removed
void Engines::Container::Shutdown ( ) [inherited]

Shutdown the Container process.


Member Data Documentation

attribute string Engines::Container::logfilename [inherited]

name of the container log file (this has been set by the launcher)

Definition at line 158 of file SALOME_Component.idl.

readonly attribute string Engines::Container::name [inherited]

Name of the container.

Definition at line 152 of file SALOME_Component.idl.

attribute IORTab Engines::MPIObject::tior [inherited]

Definition at line 38 of file SALOME_MPIObject.idl.

readonly attribute string Engines::Container::workingdir [inherited]

working directory of the container

Definition at line 155 of file SALOME_Component.idl.


The documentation for this interface was generated from the following file: