Engines::PACO_Container Interface Reference

Inheritance diagram for Engines::PACO_Container:

Public Member Functions
void	create_paco_component_node_instance (in string registeredName, in string proxy_containerName, in long studyId) raises (SALOME::SALOME_Exception)
void	updateInstanceNumber ()
boolean	load_component_Library (in string componentName)
	Loads a new component class (dynamic library).
Engines::Component	create_component_instance (in string componentName, in long studyId)
	Create a new servant instance of a component.
Component	find_component_instance (in string registeredName, in long studyId)
	Find a servant instance of a component.
Component	load_impl (in string nameToRegister, in string componentName)
	Find a servant instance of a component, or create a new one.
void	remove_impl (in Component 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.
Data Fields
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)

---

Member Function Documentation

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

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

	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]

Find 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]

Remove the component servant, and deletes all related objects.

Parameters:

component_i

Component to be removed

void Engines::Container::finalize_removal

(

)

[inherited]

Unload component libraries from the container.

void Engines::Container::ping

(

)

[inherited]

Determines whether the server has been loaded or not.

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]

Kill the container.

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]

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.

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:

origFileName

name of the file to be managed (can contain the path).

Returns:

Salome_file CORBA reference.

fileTransfer Engines::Container::getFileTransfer

(

)

[inherited]

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.

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:

	contai	the remote container
	remoteFile	the file on the remote host to copy
	localFile	the local file to create by copy

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

Create a PyNode in the container.

Parameters:

	nodeName	the name of the PyNode
	code	python code as text to load in the node

---

Field Documentation

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

Name of the container.

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

working directory of the container

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

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