Version: 8.3.0
Public Member Functions | Protected Attributes
Launcher::Job Class Referenceabstract

#include <Launcher_Job.hxx>

Inheritance diagram for Launcher::Job:
Inheritance graph
[legend]

Public Member Functions

 Job ()
 
virtual ~Job ()
 
void setState (const std::string &state)
 
std::string getState () const
 
std::string getAssignedHostnames ()
 
void setNumber (const int &number)
 
int getNumber ()
 
virtual void setResourceDefinition (const ParserResourcesType &resource_definition)
 
ParserResourcesType getResourceDefinition () const
 
void setJobName (const std::string &job_name)
 
virtual void setJobFile (const std::string &job_file)
 
void setWorkDirectory (const std::string &work_directory)
 
void setLocalDirectory (const std::string &local_directory)
 
void setResultDirectory (const std::string &result_directory)
 
void add_in_file (const std::string &file)
 
void add_out_file (const std::string &file)
 
void setMaximumDuration (const std::string &maximum_duration)
 
void setResourceRequiredParams (const resourceParams &resource_required_params)
 
void setQueue (const std::string &queue)
 
void setEnvFile (const std::string &env_file)
 
void setExclusive (bool exclusive)
 
void setExclusiveStr (const std::string &exclusiveStr)
 
void setMemPerCpu (unsigned long mem_per_cpu)
 
void setWCKey (const std::string &wckey)
 
void setExtraParams (const std::string &extra_params)
 
void setReference (const std::string &reference)
 
void setLauncherFile (const std::string &launcher_file)
 
void setLauncherArgs (const std::string &launcher_args)
 
std::string getJobName () const
 
std::string getJobFile () const
 
std::string getWorkDirectory () const
 
std::string getLocalDirectory () const
 
std::string getResultDirectory () const
 
const std::list< std::string > & get_in_files () const
 
const std::list< std::string > & get_out_files () const
 
std::string getMaximumDuration () const
 
resourceParams getResourceRequiredParams () const
 
std::string getQueue () const
 
std::string getEnvFile () const
 
std::string getJobType () const
 
bool getExclusive () const
 
std::string getExclusiveStr () const
 
unsigned long getMemPerCpu () const
 
std::string getWCKey () const
 
std::string getExtraParams () const
 
std::string getReference () const
 
std::string getLauncherFile () const
 
std::string getLauncherArgs () const
 
std::string updateJobState ()
 
void addSpecificParameter (const std::string &name, const std::string &value)
 
const std::map< std::string,
std::string > & 		getSpecificParameters () const
 
virtual void checkSpecificParameters ()
 
void checkMaximumDuration (const std::string &maximum_duration)
 
void checkResourceRequiredParams (const resourceParams &resource_required_params)
 
long convertMaximumDuration (const std::string &maximum_duration)
 
std::string getLaunchDate () const
 
void stopJob ()
 
void removeJob ()
 
virtual void update_job ()=0
 

Protected Attributes

int _number
 
std::string _job_type
 
std::string _state
 
std::string _assigned_hostnames
 
std::string _launch_date
 
std::string _env_file
 
ParserResourcesType _resource_definition
 
std::string _job_name
 
std::string _job_file
 
std::string _job_file_name
 
std::string _job_file_name_complete
 
std::string _work_directory
 
std::string _local_directory
 
std::string _result_directory
 
std::list< std::string > _in_files
 
std::list< std::string > _out_files
 
std::map< std::string,
std::string > 		_specific_parameters
 
std::string _maximum_duration
 
long _maximum_duration_in_second
 
resourceParams _resource_required_params
 
std::string _queue
 
bool _exclusive
 
unsigned long _mem_per_cpu
 
std::string _wckey
 
std::string _extra_params
 
std::string _reference
 
std::string _launcher_file
 Reference of the job for the batch manager. More...
 
std::string _launcher_args
 

Constructor & Destructor Documentation

Launcher::Job::Job ( )
Launcher::Job::~Job ( )
virtual

References LAUNCHER_MESSAGE.

Member Function Documentation

void Launcher::Job::add_in_file ( const std::string &  file)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::add_out_file ( const std::string &  file)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::addSpecificParameter ( const std::string &  name,
const std::string &  value 
)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::checkMaximumDuration ( const std::string &  maximum_duration)
void Launcher::Job::checkResourceRequiredParams ( const resourceParams &  resource_required_params)

References resourceParams::nb_proc.

void Launcher::Job::checkSpecificParameters ( )
virtual

Reimplemented in Launcher::Job_YACSFile.

Referenced by SALOME_Launcher::createJob().

long Launcher::Job::convertMaximumDuration ( const std::string &  maximum_duration)
const std::list< std::string > & Launcher::Job::get_in_files ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

const std::list< std::string > & Launcher::Job::get_out_files ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getAssignedHostnames ( )
std::string Launcher::Job::getEnvFile ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

bool Launcher::Job::getExclusive ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getExclusiveStr ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument().

std::string Launcher::Job::getExtraParams ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getJobFile ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getJobName ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getJobType ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getLaunchDate ( ) const
std::string Launcher::Job::getLauncherArgs ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getLauncherFile ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getLocalDirectory ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getMaximumDuration ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

unsigned long Launcher::Job::getMemPerCpu ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

int Launcher::Job::getNumber ( )

Referenced by Launcher_cpp::addJobDirectlyToMap(), Launcher_cpp::createBatchManagerForJob(), SALOME_Launcher::createJob(), and Launcher_cpp::loadJobs().

std::string Launcher::Job::getQueue ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getReference ( ) const

Referenced by Launcher_cpp::addJobDirectlyToMap(), Launcher::XML_Persistence::addJobToXmlDocument(), and Launcher_cpp::loadJobs().

ParserResourcesType Launcher::Job::getResourceDefinition ( ) const
resourceParams Launcher::Job::getResourceRequiredParams ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), Launcher_cpp::createBatchManagerForJob(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getResultDirectory ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

const std::map< std::string, std::string > & Launcher::Job::getSpecificParameters ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getState ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and Launcher_cpp::loadJobs().

std::string Launcher::Job::getWCKey ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

std::string Launcher::Job::getWorkDirectory ( ) const

Referenced by Launcher::XML_Persistence::addJobToXmlDocument(), and SALOME_Launcher::getJobParameters().

void Launcher::Job::removeJob ( )

References LAUNCHER_INFOS, and LAUNCHER_MESSAGE.

void Launcher::Job::setEnvFile ( const std::string &  env_file)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setExclusive ( bool  exclusive)

Referenced by SALOME_Launcher::createJob().

void Launcher::Job::setExclusiveStr ( const std::string &  exclusiveStr)

Referenced by Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setExtraParams ( const std::string &  extra_params)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setJobFile ( const std::string &  job_file)
virtual

Reimplemented in Launcher::Job_PythonSALOME, and Launcher::Job_YACSFile.

Referenced by SALOME_Launcher::createJob(), Launcher::XML_Persistence::parseUserNode(), Launcher::Job_PythonSALOME::setJobFile(), and Launcher::Job_YACSFile::setJobFile().

void Launcher::Job::setJobName ( const std::string &  job_name)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::createJobFromXmlNode().

void Launcher::Job::setLauncherArgs ( const std::string &  launcher_args)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setLauncherFile ( const std::string &  launcher_file)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setLocalDirectory ( const std::string &  local_directory)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setMaximumDuration ( const std::string &  maximum_duration)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setMemPerCpu ( unsigned long  mem_per_cpu)

Referenced by SALOME_Launcher::createJob(), Launcher::XML_Persistence::parseResourceNode(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setNumber ( const int &  number)

Referenced by Launcher_cpp::addJobDirectlyToMap().

void Launcher::Job::setQueue ( const std::string &  queue)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setReference ( const std::string &  reference)

Referenced by Launcher::XML_Persistence::parseRunNode().

void Launcher::Job::setResourceDefinition ( const ParserResourcesType &  resource_definition)
virtual

Reimplemented in Launcher::Job_SALOME.

References ParserResourcesType::UserName.

Referenced by Launcher_cpp::createBatchManagerForJob(), and Launcher::Job_SALOME::setResourceDefinition().

void Launcher::Job::setResourceRequiredParams ( const resourceParams &  resource_required_params)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseResourceNode().

void Launcher::Job::setResultDirectory ( const std::string &  result_directory)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setState ( const std::string &  state)

Referenced by Launcher_cpp::createBatchManagerForJob(), Launcher_cpp::loadJobs(), and Launcher::XML_Persistence::parseRunNode().

void Launcher::Job::setWCKey ( const std::string &  wckey)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::setWorkDirectory ( const std::string &  work_directory)

Referenced by SALOME_Launcher::createJob(), and Launcher::XML_Persistence::parseUserNode().

void Launcher::Job::stopJob ( )

References LAUNCHER_INFOS, and LAUNCHER_MESSAGE.

virtual void Launcher::Job::update_job ( )
pure virtual

Implemented in Launcher::Job_SALOME, and Launcher::Job_Command.

std::string Launcher::Job::updateJobState ( )

References LAUNCHER_MESSAGE.

Field Documentation

std::string Launcher::Job::_assigned_hostnames
protected
std::string Launcher::Job::_env_file
protected
bool Launcher::Job::_exclusive
protected
std::string Launcher::Job::_extra_params
protected
std::list<std::string> Launcher::Job::_in_files
protected
std::string Launcher::Job::_job_file
protected
std::string Launcher::Job::_job_file_name
protected
std::string Launcher::Job::_job_file_name_complete
protected
std::string Launcher::Job::_job_name
protected
std::string Launcher::Job::_job_type
protected

Referenced by Launcher::Job_Command::Job_Command(), Launcher::Job_PythonSALOME::Job_PythonSALOME(), and Launcher::Job_YACSFile::Job_YACSFile().

std::string Launcher::Job::_launch_date
protected
std::string Launcher::Job::_launcher_args
protected
std::string Launcher::Job::_launcher_file
protected

Reference of the job for the batch manager.

std::string Launcher::Job::_local_directory
protected
std::string Launcher::Job::_maximum_duration
protected
long Launcher::Job::_maximum_duration_in_second
protected
unsigned long Launcher::Job::_mem_per_cpu
protected
int Launcher::Job::_number
protected
std::list<std::string> Launcher::Job::_out_files
protected
std::string Launcher::Job::_queue
protected
std::string Launcher::Job::_reference
protected
ParserResourcesType Launcher::Job::_resource_definition
protected
resourceParams Launcher::Job::_resource_required_params
protected
std::string Launcher::Job::_result_directory
protected
std::map<std::string, std::string> Launcher::Job::_specific_parameters
protected
std::string Launcher::Job::_state
protected
std::string Launcher::Job::_wckey
protected
std::string Launcher::Job::_work_directory
protected