SALOME_Launcher Class Reference

#include <SALOME_Launcher.hxx>

Inheritance diagram for SALOME_Launcher:

Public Member Functions
	SALOME_Launcher (CORBA::ORB_ptr orb, PortableServer::POA_var poa)
	Constructor. More...
	SALOME_Launcher (CORBA::ORB_ptr orb, PortableServer::POA_var poa, SALOME_NamingService_Abstract *externalNS)
virtual	~SALOME_Launcher ()
	destructor More...
CORBA::Long	createJob (const Engines::JobParameters &job_parameters)
void	launchJob (CORBA::Long job_id)
char *	getJobState (CORBA::Long job_id)
char *	getAssignedHostnames (CORBA::Long job_id)
void	exportInputFiles (CORBA::Long job_id)
void	getJobResults (CORBA::Long job_id, const char *directory)
void	clearJobWorkingDir (CORBA::Long job_id)
CORBA::Boolean	getJobDumpState (CORBA::Long job_id, const char *directory)
CORBA::Boolean	getJobWorkFile (CORBA::Long job_id, const char *work_file, const char *directory)
void	stopJob (CORBA::Long job_id)
void	removeJob (CORBA::Long job_id)
char *	dumpJob (CORBA::Long job_id)
CORBA::Long	restoreJob (const char *dumpedJob)
CORBA::Long	createJobWithFile (const char *xmlExecuteFile, const char *clusterName)
	CORBA Method: Create a job in the launcher with a file. More...
CORBA::Boolean	testBatch (const Engines::ResourceParameters &params)
	CORBA Method: the test batch configuration. More...
void	Shutdown ()
	CORBA method: shutdown all the containers, then the ContainerManager servant. More...
CORBA::Long	getPID ()
	CORBA Method: Returns the PID of the process. More...
virtual void	addObserver (Engines::SalomeLauncherObserver_ptr observer)
	CORBA Method: Add a new observer to the launcher. More...
virtual void	removeObserver (Engines::SalomeLauncherObserver_ptr observer)
	CORBA Method: Add a new observer to the launcher. More...
virtual Engines::JobsList *	getJobsList ()
	CORBA Method: Returns current launcher jobs list. More...
virtual Engines::JobParameters *	getJobParameters (CORBA::Long job_id)
	CORBA Method: Returns the job description. More...
virtual void	loadJobs (const char *jobs_file)
	CORBA Method: Loads jobs saved in jobs_file. More...
virtual void	saveJobs (const char *jobs_file)
	CORBA Method: Save jobs of Launcher (in any steps) in file jobs_file. More...
void	DeclareUsingSalomeSession ()
SALOME_ResourcesManager *	getResourcesManager () const

Static Public Member Functions
static JobParameters_cpp	JobParameters_CORBA2CPP (const Engines::JobParameters &job_parameters)
static Engines::JobParameters_var	JobParameters_CPP2CORBA (const JobParameters_cpp &job_parameters)

Static Public Attributes
static const char *	_LauncherNameInNS = "/SalomeLauncher"

Protected Member Functions
virtual void	notifyObservers (const std::string &event_name, const std::string &event_data)
	Internal Method: Notify observers on a new event. More...
void	init (CORBA::ORB_ptr orb, PortableServer::POA_var poa)

Protected Attributes
CORBA::ORB_var	_orb
PortableServer::POA_var	_poa
SALOME_ContainerManager *	_ContManager
SALOME_ResourcesManager *	_ResManager
SALOME_NamingService_Abstract *	_NS = nullptr
std::list< Engines::SalomeLauncherObserver_var >	_observers
Launcher_cpp	_l

Constructor & Destructor Documentation

SALOME_Launcher() [1/2]

SALOME_Launcher::SALOME_Launcher	(	CORBA::ORB_ptr	orb,
		PortableServer::POA_var	poa
	)

Constructor.

Parameters

orb

References MESSAGE, salome::orb, and SALOME_ContainerPy::poa.

SALOME_Launcher() [2/2]

SALOME_Launcher::SALOME_Launcher	(	CORBA::ORB_ptr	orb,
		PortableServer::POA_var	poa,
		SALOME_NamingService_Abstract *	externalNS
	)

References init(), salome::orb, and SALOME_ContainerPy::poa.

~SALOME_Launcher()

SALOME_Launcher::~SALOME_Launcher ( )

virtual

destructor

References _NS, and MESSAGE.

Member Function Documentation

addObserver()

void SALOME_Launcher::addObserver ( Engines::SalomeLauncherObserver_ptr  observer )

virtual

CORBA Method: Add a new observer to the launcher.

References _l, _observers, _orb, Launcher_cpp::getJobs(), launcher_use_case::job_id, and MESSAGE.

clearJobWorkingDir()

void SALOME_Launcher::clearJobWorkingDir

(

CORBA::Long

job_id

)

References _l, SALOME::BAD_PARAM, Launcher_cpp::clearJobWorkingDir(), INFOS, launcher_use_case::job_id, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

createJob()

CORBA::Long SALOME_Launcher::createJob

(

const Engines::JobParameters &

job_parameters

)

References _l, SALOME::BAD_PARAM, Launcher_cpp::createJob(), INFOS, launcher_use_case::job_id, JobParameters_CORBA2CPP(), LauncherException::msg, notifyObservers(), and THROW_SALOME_CORBA_EXCEPTION.

createJobWithFile()

CORBA::Long SALOME_Launcher::createJobWithFile	(	const char *	xmlExecuteFile,
		const char *	clusterName
	)

CORBA Method: Create a job in the launcher with a file.

Parameters

xmlExecuteFile	: .xml to parse that contains job description
clusterName	: machine chosen

References _l, Launcher_cpp::createJobWithFile(), INFOS, SALOME::INTERNAL_ERROR, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

DeclareUsingSalomeSession()

void SALOME_Launcher::DeclareUsingSalomeSession

(

)

References _ContManager, and SALOME_ContainerManager::DeclareUsingSalomeSession().

Referenced by main().

dumpJob()

char * SALOME_Launcher::dumpJob

(

CORBA::Long

job_id

)

References _l, SALOME::BAD_PARAM, Launcher_cpp::dumpJob(), INFOS, launcher_use_case::job_id, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

exportInputFiles()

void SALOME_Launcher::exportInputFiles

(

CORBA::Long

job_id

)

References _l, SALOME::BAD_PARAM, Launcher_cpp::exportInputFiles(), INFOS, launcher_use_case::job_id, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

getAssignedHostnames()

char * SALOME_Launcher::getAssignedHostnames

(

CORBA::Long

job_id

)

References _l, SALOME::BAD_PARAM, Launcher_cpp::getAssignedHostnames(), INFOS, launcher_use_case::job_id, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

getJobDumpState()

CORBA::Boolean SALOME_Launcher::getJobDumpState	(	CORBA::Long	job_id,
		const char *	directory
	)

References _l, SALOME::BAD_PARAM, Launcher_cpp::getJobDumpState(), INFOS, launcher_use_case::job_id, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

getJobParameters()

Engines::JobParameters * SALOME_Launcher::getJobParameters ( CORBA::Long  job_id )

virtual

CORBA Method: Returns the job description.

References _l, SALOME::BAD_PARAM, Launcher_cpp::getJobParameters(), INFOS, launcher_use_case::job_id, JobParameters_CPP2CORBA(), LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

Referenced by getJobsList().

getJobResults()

void SALOME_Launcher::getJobResults	(	CORBA::Long	job_id,
		const char *	directory
	)

References _l, SALOME::BAD_PARAM, Launcher_cpp::getJobResults(), INFOS, launcher_use_case::job_id, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

getJobsList()

Engines::JobsList * SALOME_Launcher::getJobsList ( )

virtual

CORBA Method: Returns current launcher jobs list.

References _l, getJobParameters(), and Launcher_cpp::getJobs().

getJobState()

char * SALOME_Launcher::getJobState

(

CORBA::Long

job_id

)

References _l, SALOME::BAD_PARAM, Launcher_cpp::getJobState(), INFOS, launcher_use_case::job_id, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

getJobWorkFile()

CORBA::Boolean SALOME_Launcher::getJobWorkFile	(	CORBA::Long	job_id,
		const char *	work_file,
		const char *	directory
	)

References _l, SALOME::BAD_PARAM, Launcher_cpp::getJobWorkFile(), INFOS, launcher_use_case::job_id, LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

getPID()

CORBA::Long SALOME_Launcher::getPID

(

)

CORBA Method: Returns the PID of the process.

getResourcesManager()

SALOME_ResourcesManager* SALOME_Launcher::getResourcesManager

(

)

const

init()

void SALOME_Launcher::init ( CORBA::ORB_ptr  orb, PortableServer::POA_var  poa  )

protected

References _ContManager, _l, _LauncherNameInNS, _NS, _orb, _poa, _ResManager, SALOME_ResourcesManager::GetImpl(), KERNEL_PY.batchmode_salome::obj, salome::orb, SALOME_ContainerPy::poa, SALOME_NamingService_Container_Abstract::Register(), and Launcher_cpp::SetResourcesManager().

Referenced by SALOME_Launcher().

JobParameters_CORBA2CPP()

JobParameters_cpp SALOME_Launcher::JobParameters_CORBA2CPP ( const Engines::JobParameters &  job_parameters )

static

References Engines::JobParameters::env_file, JobParameters_cpp::env_file, Engines::JobParameters::exclusive, JobParameters_cpp::exclusive, Engines::JobParameters::extra_params, JobParameters_cpp::extra_params, Engines::JobParameters::in_files, JobParameters_cpp::in_files, Engines::JobParameters::job_file, JobParameters_cpp::job_file, Engines::JobParameters::job_name, JobParameters_cpp::job_name, Engines::JobParameters::job_type, JobParameters_cpp::job_type, Engines::JobParameters::launcher_args, JobParameters_cpp::launcher_args, Engines::JobParameters::launcher_file, JobParameters_cpp::launcher_file, Engines::JobParameters::local_directory, JobParameters_cpp::local_directory, Engines::JobParameters::maximum_duration, JobParameters_cpp::maximum_duration, Engines::JobParameters::mem_per_cpu, JobParameters_cpp::mem_per_cpu, Engines::JobParameters::out_files, JobParameters_cpp::out_files, Engines::JobParameters::partition, JobParameters_cpp::partition, Engines::JobParameters::pre_command, JobParameters_cpp::pre_command, Engines::JobParameters::queue, JobParameters_cpp::queue, Engines::JobParameters::resource_required, JobParameters_cpp::resource_required, resourceParameters_CORBAtoCPP(), Engines::JobParameters::result_directory, JobParameters_cpp::result_directory, Engines::JobParameters::specific_parameters, JobParameters_cpp::specific_parameters, Engines::JobParameters::wckey, JobParameters_cpp::wckey, Engines::JobParameters::work_directory, and JobParameters_cpp::work_directory.

Referenced by createJob().

JobParameters_CPP2CORBA()

Engines::JobParameters_var SALOME_Launcher::JobParameters_CPP2CORBA ( const JobParameters_cpp &  job_parameters )

static

< TODO: conversion from size_t to CORBA::ULong

< TODO: conversion from size_t to CORBA::ULong

< TODO: conversion from size_t to CORBA::ULong

References JobParameters_cpp::env_file, JobParameters_cpp::exclusive, JobParameters_cpp::extra_params, JobParameters_cpp::in_files, JobParameters_cpp::job_file, Engines::JobParameters::job_name, JobParameters_cpp::job_name, JobParameters_cpp::job_type, JobParameters_cpp::launcher_args, JobParameters_cpp::launcher_file, JobParameters_cpp::local_directory, JobParameters_cpp::maximum_duration, JobParameters_cpp::mem_per_cpu, Engines::Parameter::name, JobParameters_cpp::out_files, JobParameters_cpp::partition, JobParameters_cpp::pre_command, JobParameters_cpp::queue, JobParameters_cpp::resource_required, resourceParameters_CPPtoCORBA(), JobParameters_cpp::result_directory, JobParameters_cpp::specific_parameters, JobParameters_cpp::wckey, and JobParameters_cpp::work_directory.

Referenced by getJobParameters().

launchJob()

void SALOME_Launcher::launchJob

(

CORBA::Long

job_id

)

References _l, SALOME::BAD_PARAM, INFOS, launcher_use_case::job_id, Launcher_cpp::launchJob(), LauncherException::msg, and THROW_SALOME_CORBA_EXCEPTION.

loadJobs()

void SALOME_Launcher::loadJobs ( const char *  jobs_file )

virtual

CORBA Method: Loads jobs saved in jobs_file.

References _l, INFOS, SALOME::INTERNAL_ERROR, Launcher_cpp::loadJobs(), LauncherException::msg, notifyObservers(), and THROW_SALOME_CORBA_EXCEPTION.

notifyObservers()

void SALOME_Launcher::notifyObservers ( const std::string &  event_name, const std::string &  event_data  )

protectedvirtual

Internal Method: Notify observers on a new event.

References _observers, and MESSAGE.

Referenced by createJob(), loadJobs(), removeJob(), restoreJob(), saveJobs(), and stopJob().

removeJob()

void SALOME_Launcher::removeJob

(

CORBA::Long

job_id

)

References _l, SALOME::BAD_PARAM, INFOS, launcher_use_case::job_id, LauncherException::msg, notifyObservers(), Launcher_cpp::removeJob(), and THROW_SALOME_CORBA_EXCEPTION.

removeObserver()

void SALOME_Launcher::removeObserver ( Engines::SalomeLauncherObserver_ptr  observer )

virtual

CORBA Method: Add a new observer to the launcher.

References _observers, and _orb.

restoreJob()

CORBA::Long SALOME_Launcher::restoreJob

(

const char *

dumpedJob

)

References _l, INFOS, SALOME::INTERNAL_ERROR, LauncherException::msg, notifyObservers(), Launcher_cpp::restoreJob(), and THROW_SALOME_CORBA_EXCEPTION.

saveJobs()

void SALOME_Launcher::saveJobs ( const char *  jobs_file )

virtual

CORBA Method: Save jobs of Launcher (in any steps) in file jobs_file.

References _l, notifyObservers(), and Launcher_cpp::saveJobs().

Shutdown()

void SALOME_Launcher::Shutdown

(

)

CORBA method: shutdown all the containers, then the ContainerManager servant.

References _ContManager, _LauncherNameInNS, _NS, _orb, _poa, _ResManager, SALOME_NamingService_Container_Abstract::Destroy_Name(), MESSAGE, SALOME_ContainerManager::Shutdown(), and SALOME_ResourcesManager::Shutdown().

stopJob()

void SALOME_Launcher::stopJob

(

CORBA::Long

job_id

)

References _l, SALOME::BAD_PARAM, INFOS, launcher_use_case::job_id, LauncherException::msg, notifyObservers(), Launcher_cpp::stopJob(), and THROW_SALOME_CORBA_EXCEPTION.

testBatch()

CORBA::Boolean SALOME_Launcher::testBatch

(

const Engines::ResourceParameters &

params

)

CORBA Method: the test batch configuration.

Parameters

params

: The batch cluster

References _ResManager, Engines::ResourceParameters::can_launch_batch_jobs, SALOME_ResourcesManager::GetFittingResources(), SALOME_ResourcesManager::GetResourceDefinition(), INFOS, SALOME::INTERNAL_ERROR, MESSAGE, LauncherException::msg, Engines::ResourceDefinition::name, BatchTest::test(), and THROW_SALOME_CORBA_EXCEPTION.

Field Documentation

_ContManager

SALOME_ContainerManager* SALOME_Launcher::_ContManager

protected

Referenced by DeclareUsingSalomeSession(), init(), and Shutdown().

_l

Launcher_cpp SALOME_Launcher::_l

protected

Referenced by addObserver(), clearJobWorkingDir(), createJob(), createJobWithFile(), dumpJob(), exportInputFiles(), getAssignedHostnames(), getJobDumpState(), getJobParameters(), getJobResults(), getJobsList(), getJobState(), getJobWorkFile(), init(), launchJob(), loadJobs(), removeJob(), restoreJob(), saveJobs(), and stopJob().

_LauncherNameInNS

const char * SALOME_Launcher::_LauncherNameInNS = "/SalomeLauncher"

static

Referenced by init(), and Shutdown().

_NS

SALOME_NamingService_Abstract* SALOME_Launcher::_NS = nullptr

protected

Referenced by init(), Shutdown(), and ~SALOME_Launcher().

_observers

std::list<Engines::SalomeLauncherObserver_var> SALOME_Launcher::_observers

protected

Referenced by addObserver(), notifyObservers(), and removeObserver().

_orb

CORBA::ORB_var SALOME_Launcher::_orb

protected

Referenced by SALOME_Container.SALOME_Container_i::__init__(), SALOME_ContainerPy.SALOME_ContainerPy_Gen_i::__init__(), SALOME_ContainerPy.SALOME_ContainerPy_i::__init__(), SALOME_ComponentPy.SALOME_ComponentPy_Gen_i::__init__(), SALOME_NamingServicePy.SALOME_NamingServicePy_i::__init__(), addObserver(), SALOME_ContainerPy.SALOME_ContainerPy_Gen_i::create_component_instance(), SALOME_Container.SALOME_Container_i::create_component_instance(), SALOME_Container.SALOME_Container_i::create_pynode(), SALOME_Container.SALOME_Container_i::create_pyscriptnode(), init(), SALOME_Embedded_NamingService_ClientPy.SALOME_Embedded_NamingService_ClientPy::Register(), removeObserver(), SALOME_Embedded_NamingService_ClientPy.SALOME_Embedded_NamingService_ClientPy::Resolve(), Shutdown(), and SALOME_ContainerPy.SALOME_ContainerPy_Gen_i::Shutdown().

_poa

PortableServer::POA_var SALOME_Launcher::_poa

protected

Referenced by SALOME_Container.SALOME_Container_i::__init__(), SALOME_ContainerPy.SALOME_ContainerPy_Gen_i::__init__(), SALOME_ComponentPy.SALOME_ComponentPy_Gen_i::__init__(), SALOME_ContainerPy.SALOME_ContainerPy_Gen_i::create_component_instance(), SALOME_Container.SALOME_Container_i::create_component_instance(), SALOME_Container.SALOME_Container_i::create_pynode(), SALOME_Container.SALOME_Container_i::create_pyscriptnode(), SALOME_ComponentPy.SALOME_ComponentPy_Gen_i::destroy(), init(), and Shutdown().

_ResManager

SALOME_ResourcesManager* SALOME_Launcher::_ResManager

protected

Referenced by init(), Shutdown(), and testBatch().