General KERNEL Documentation     End User KERNEL Services  

SALOME_ContainerPy::SALOME_ContainerPy_i

SALOME_ContainerPy::SALOME_ContainerPy_i Class Reference

Inheritance diagram for SALOME_ContainerPy::SALOME_ContainerPy_i:

Inheritance graph
Collaboration diagram for SALOME_ContainerPy::SALOME_ContainerPy_i:

Collaboration graph

Public Member Functions

def __init__
def start_impl
def instance
def load_impl
def import_component
def load_component_Library
def create_component_instance
def find_component_instance
def remove_impl
def finalize_removal
def ping
def getPID
def _get_name
def getHostName
def _get_machineName
def Shutdown
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

Private Attributes

 _containerName
 _naming_service
 _numInstance
 _machineName

Static Private Attributes

 _orb = None
 _poa = None
int _numInstance = 0
dictionary _listInstances_map = {}

Member Function Documentation

def SALOME_ContainerPy::SALOME_ContainerPy_i::__init__ (    self,
  orb,
  poa,
  containerName
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::start_impl (    self,
  ContainerName
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::instance (    self,
  nameToRegister,
  componentName
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::load_impl (    self,
  nameToRegister,
  componentName
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::import_component (    self,
  componentName
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::load_component_Library (    self,
  componentName
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::create_component_instance (    self,
  componentName,
  studyId
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::find_component_instance (    self,
  registeredName,
  studyId
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::remove_impl (    self,
  component
) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::finalize_removal (    self  ) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::ping (    self  ) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::getPID (    self  ) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::_get_name (    self  ) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::getHostName (    self  ) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::_get_machineName (    self  ) 
 

def SALOME_ContainerPy::SALOME_ContainerPy_i::Shutdown (    self  ) 
 

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

SALOME_ContainerPy::SALOME_ContainerPy_i::_orb = None [static, private]
 

SALOME_ContainerPy::SALOME_ContainerPy_i::_poa = None [static, private]
 

int SALOME_ContainerPy::SALOME_ContainerPy_i::_numInstance = 0 [static, private]
 

dictionary SALOME_ContainerPy::SALOME_ContainerPy_i::_listInstances_map = {} [static, private]
 

SALOME_ContainerPy::SALOME_ContainerPy_i::_containerName [private]
 

SALOME_ContainerPy::SALOME_ContainerPy_i::_naming_service [private]
 

SALOME_ContainerPy::SALOME_ContainerPy_i::_numInstance [private]
 

SALOME_ContainerPy::SALOME_ContainerPy_i::_machineName [private]
 

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

Name of the container

  General KERNEL Documentation     End User KERNEL Services  

Generated on Wed Jul 26 15:42:10 2006 for SALOME v.3.2.1 by doxygen 1.4.6