Engines::MPIContainer Interface Reference

import "SALOME_MPIContainer.idl";

Inheritance diagram for Engines::MPIContainer:

Collaboration diagram for Engines::MPIContainer:


Public Member Functions
oneway void	Asload_component_Library (in string componentName)
oneway void	Ascreate_component_instance (in string componentName, in long studyId)
oneway void	Asload_impl (in string nameToRegister, in string componentName)
oneway void	Asremove_impl (in Component component_i)
oneway void	Asfinalize_removal ()
boolean	load_component_Library (in string componentName)
Component	create_component_instance (in string componentName, in long studyId)
Component	find_component_instance (in string registeredName, in long studyId)
Component	load_impl (in string nameToRegister, in string componentName)
void	remove_impl (in Component component_i)
void	finalize_removal ()
void	ping ()
oneway void	Shutdown ()
string	getHostName ()
long	getPID ()
boolean	Kill_impl ()
fileRef	createFileRef (in string origFileName)
fileTransfer	getFileTransfer ()
Data Fields
readonly attribute string	name
attribute IORTab	tior

Member Function Documentation

oneway void Engines::MPIContainer::Asload_component_Library ( in string componentName )

oneway void Engines::MPIContainer::Ascreate_component_instance ( in string componentName,

in long studyId

)

oneway void Engines::MPIContainer::Asload_impl ( in string nameToRegister,

in string componentName

)

oneway void Engines::MPIContainer::Asremove_impl ( in Component component_i )

oneway void Engines::MPIContainer::Asfinalize_removal ( )

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

Loads a new component class (dynamic library).
Parameters:

componentName like COMPONENT, (Python or C++ implementation) try to make a Python import of COMPONENT, then a lib open of libCOMPONENTEngine.so

Returns:
true if load successfull or already done, false otherwise

Component Engines::Container::create_component_instance ( in string componentName,

in long studyId

) [inherited]

Creates a new servant instance of a component. Component library must be loaded.
Parameters:

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)

Returns:
a loaded component

Component Engines::Container::find_component_instance ( in string registeredName,

in long studyId

) [inherited]

Finds a servant instance of a component
Parameters:

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)

Returns:
the first instance found with same studyId

Component 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:

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)

Returns:
a loaded component

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

Stops the component servant, and deletes all related objects
Parameters:

component_i Component to be removed

void Engines::Container::finalize_removal ( ) [inherited]

Discharges all components from the container.

void Engines::Container::ping ( ) [inherited]

Determines whether the server has been loaded or not.

oneway void Engines::Container::Shutdown ( ) [inherited]

Shutdown the Container process.

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]

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

fileRef Engines::Container::createFileRef ( in string origFileName ) [inherited]

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.

fileTransfer Engines::Container::getFileTransfer ( ) [inherited]

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.

Field Documentation

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

Name of the container

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

Engines::MPIContainer Interface Reference

Public Member Functions

Data Fields

Member Function Documentation

Field Documentation