Interface of the Container. More...
import "SALOME_Component.idl";
Public Member Functions | |
boolean | load_component_Library (in string componentName, out string reason) |
Loads a new component class (dynamic library). More... | |
Engines::EngineComponent | create_component_instance (in string componentName, in long studyId) |
Create a new servant instance of a component. More... | |
string | create_python_service_instance (in string serviceName, out string reason) |
Create a new Python servant instance of a generic service. More... | |
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. More... | |
EngineComponent | find_component_instance (in string registeredName, in long studyId) |
Find a servant instance of a component. More... | |
EngineComponent | load_impl (in string nameToRegister, in string componentName) |
Find a servant instance of a component, or create a new one. More... | |
void | remove_impl (in EngineComponent component_i) |
Remove the component servant, and deletes all related objects. More... | |
void | finalize_removal () |
Unload component libraries from the container. More... | |
void | ping () |
Determines whether the server has been loaded or not. More... | |
void | Shutdown () |
Shutdown the Container process. More... | |
string | getHostName () |
Returns the hostname of the container. More... | |
long | getPID () |
Returns the PID of the container. More... | |
boolean | Kill_impl () |
Kill the container. More... | |
fileRef | createFileRef (in string origFileName) |
Create a fileRef. More... | |
Salome_file | createSalome_file (in string origFileName) |
Create a Salome_file. More... | |
fileTransfer | getFileTransfer () |
Create a fileTransfer. More... | |
void | copyFile (in Container contai, in string remoteFile, in string localFile) |
Copy a file from a remote host (container) to a local file. More... | |
PyNode | createPyNode (in string nodeName, in string code) raises (SALOME::SALOME_Exception) |
Create a PyNode in the container. More... | |
PyNode | getDefaultPyNode (in string nodeName) |
Retrieves the last created PyNode instance with createPyNode. More... | |
PyScriptNode | createPyScriptNode (in string nodeName, in string code) raises (SALOME::SALOME_Exception) |
Create a PyScriptNode in the container. More... | |
PyScriptNode | getDefaultPyScriptNode (in string nodeName) |
Retrieves the last created PyScriptNode instance with createPyScriptNode. More... | |
Data Fields | |
readonly attribute string | name |
Name of the container. More... | |
readonly attribute string | workingdir |
working directory of the container More... | |
attribute string | logfilename |
name of the container log file (this has been set by the launcher) More... | |
Interface of the Container.
This interface defines the process of loading and registration of new components in SALOME application
void Engines::Container::copyFile | ( | in Container | contai, |
in string | remoteFile, | ||
in string | localFile | ||
) |
Copy a file from a remote host (container) to a local file.
contai | the remote container |
remoteFile | the file on the remote host to copy |
localFile | the local file to create by copy |
Engines::EngineComponent Engines::Container::create_component_instance | ( | in string | componentName, |
in long | studyId | ||
) |
Create a new servant instance of a component.
Component library must be loaded.
componentName | Name of the component which will be registered in Registry and Name Service, (instance number suffix added to the registered name) |
studyId | 0 if instance is not associated to a study, >0 otherwise (== study id) |
Engines::EngineComponent Engines::Container::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.
Component library must be loaded.
componentName | Name of the component which will be registered in Registry and Name Service, (instance number suffix added to the registered name) |
studyId | 0 if instance is not associated to a study, >0 otherwise (== study id) |
env | a dict of env variables |
reason | in case of error (return nil) a string explaining the error |
string Engines::Container::create_python_service_instance | ( | in string | serviceName, |
out string | reason | ||
) |
Create a new Python servant instance of a generic service.
This simply loads the service in the current container by importing the corresponding Python module. Warning: no internal registration is done, so it is up to the caller to manage the various instanciation.
serviceName | Name of the service >0 otherwise (== study id) |
reason | in case of error (return void string) a string explaining the error |
fileRef Engines::Container::createFileRef | ( | in string | origFileName | ) |
PyNode Engines::Container::createPyNode | ( | in string | nodeName, |
in string | code | ||
) | raises (SALOME::SALOME_Exception) |
PyScriptNode Engines::Container::createPyScriptNode | ( | in string | nodeName, |
in string | code | ||
) | raises (SALOME::SALOME_Exception) |
Create a PyScriptNode in the container.
nodeName | the name of the PyScriptNode |
code | python code as text to load in the node |
Salome_file Engines::Container::createSalome_file | ( | in string | origFileName | ) |
Create a Salome_file.
returns a Salome_file object if origFileName exists and is readable else returns null object.
origFileName | name of the file to be managed (can contain the path). |
void Engines::Container::finalize_removal | ( | ) |
Unload component libraries from the container.
EngineComponent Engines::Container::find_component_instance | ( | in string | registeredName, |
in long | studyId | ||
) |
Find a servant instance of a component.
registeredName | Name of the component in Registry or Name Service, without instance suffix number |
studyId | 0 if instance is not associated to a study, >0 otherwise (== study id) |
PyNode Engines::Container::getDefaultPyNode | ( | in string | nodeName | ) |
Retrieves the last created PyNode instance with createPyNode.
PyScriptNode Engines::Container::getDefaultPyScriptNode | ( | in string | nodeName | ) |
Retrieves the last created PyScriptNode instance with createPyScriptNode.
fileTransfer Engines::Container::getFileTransfer | ( | ) |
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 | ( | ) |
Returns the hostname of the container.
long Engines::Container::getPID | ( | ) |
Returns the PID of the container.
boolean Engines::Container::Kill_impl | ( | ) |
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 | ||
) |
Loads a new component class (dynamic library).
componentName | like COMPONENT, (Python or C++ implementation) try to make a Python import of COMPONENT, then a lib open of libCOMPONENTEngine.so |
reason | in case of error (return false) a string explaining the error |
EngineComponent Engines::Container::load_impl | ( | in string | nameToRegister, |
in string | componentName | ||
) |
Find a servant instance of a component, or create a new one.
Loads the component library if needed. Only applicable to multiStudy components.
nameToRegister | Name of the component which will be registered in Registry (or Name Service) |
componentName | Name of the constructed library of the component (not used any more, give empty string) |
void Engines::Container::ping | ( | ) |
Determines whether the server has been loaded or not.
void Engines::Container::remove_impl | ( | in EngineComponent | component_i | ) |
Remove the component servant, and deletes all related objects.
component_i | Component to be removed |
void Engines::Container::Shutdown | ( | ) |
Shutdown the Container process.
attribute string Engines::Container::logfilename |
name of the container log file (this has been set by the launcher)
readonly attribute string Engines::Container::name |
Name of the container.
readonly attribute string Engines::Container::workingdir |
working directory of the container