SAGA C++ API 1.6
saga::job::attributes Namespace Reference

Available attributes defined for the Job Management API package. More...

Variables

char const *const jobid = "JobID"
 [r] SAGA representation of the job identifier (format: [backend url]-[native id])
char const *const execution_hosts = "ExecutionHosts"
 [r] List of host names or IP addresses allocated to run this job
char const *const created = "Created"
 [r] Time stamp of the job creation in the resource manager
char const *const started = "Started"
 [r] Time stamp indicating when the job started running
char const *const finished = "Finished"
 [r] Time stamp indicating when the job completed
char const *const working_directory = "WorkingDirectory"
 [r] Working directory on the execution host
char const *const exitcode = "ExitCode"
 [r] Process exit code as collected by the wait(2) series of system calls
char const *const termsig = "Termsig"
 [r] Signal number which caused the job to exit


char const *const job_service = "JobService"
 [r] url of job service instance which started this job


char const *const job_state_unknown = saga::attributes::task_state_unknown
char const *const job_state_new = saga::attributes::task_state_new
char const *const job_state_running = saga::attributes::task_state_running
char const *const job_state_done = saga::attributes::task_state_done
char const *const job_state_canceled = saga::attributes::task_state_canceled
char const *const job_state_failed = saga::attributes::task_state_failed
char const *const job_state_suspended = "Suspended"
char const *const description_executable = "Executable"
 [rw] Command to execute (this is the only required attribute for a job description object)
char const *const description_arguments = "Arguments"
 [rw] Positional parameters for the command
char const *const description_environment = "Environment"
 [rw] Set of environment variables for the job (format: 'key=value').
char const *const description_working_directory = "WorkingDirectory"
 [rw] Working directory for the job
char const *const description_interactive = "Interactive"
 [rw] Run the job in interactive mode
char const *const description_input = "Input"
 [rw] Pathname of the standard input file
char const *const description_output = "Output"
 [rw] Pathname of the standard output file
char const *const description_error = "Error"
 [rw] Pathname of the standard error file
char const *const description_file_transfer = "FileTransfer"
 [rw] A list of file transfer directives
char const *const description_cleanup = "Cleanup"
 [rw] Defines if output files get removed after the job finishes
char const *const description_job_start_time = "JobStartTime"
 [rw] Time at which a job should be scheduled
char const *const description_total_cpu_time = "TotalCPUTime"
 [rw] ?!?
char const *const description_wall_time_limit = "WallTimeLimit"
 [rw] ?!?
char const *const description_total_physical_memory = "TotalPhysicalMemory"
 [rw] Estimated amount of memory the job requires
char const *const description_cpu_architecture = "CPUArchitecture"
 [rw] Compatible processor for job submission
char const *const description_operating_system_type = "OperatingSystemType"
 [rw] Compatible operating system for job submission
char const *const description_candidate_hosts = "CandidateHosts"
 [rw] List of host names which are to be considered by the resource manager as candidate targets
char const *const description_queue = "Queue"
 [rw] Name of a queue to place the job into
char const *const description_job_contact = "JobContact"
 [rw] Set of endpoints describing where to report job state transitions
char const *const description_job_project = "JobProject"
 [rw]
char const *const description_spmd_variation = "SPMDVariation"
 [rw] SPMD job type and startup mechanism
char const *const description_total_cpu_count = "TotalCPUCount"
 [rw] Total number of cpus requested for this job
char const *const description_number_of_processes = "NumberOfProcesses"
 [rw] Number of process instances to start
char const *const description_processes_per_host = "ProcessesPerHost"
 [rw] Number of processes to start per host
char const *const description_threads_per_process = "ThreadsPerProcess"
 [rw] Expected number of threads per process
 

char const *const description_cpuarchitecture_sparc = "sparc"
 [r] SPARC CPU type
char const *const description_cpuarchitecture_powerpc = "powerpc"
 [r] PowerPC CPU type
char const *const description_cpuarchitecture_x86 = "x86"
 [r] x86 CPU type
char const *const description_cpuarchitecture_x86_32 = "x86_32"
 [r] x86 (32bit) CPU type
char const *const description_cpuarchitecture_x86_64 = "x86_64"
 [r] x86 (64bit) CPU type
char const *const description_cpuarchitecture_parisc = "parisc"
 [r] PARISC CPU type
char const *const description_cpuarchitecture_mips = "mips"
 [r] MIPS CPU type
char const *const description_cpuarchitecture_ia64 = "ia64"
 [r] IA64 CPU type
char const *const description_cpuarchitecture_arm = "arm"
 [r] ARM CPU type
char const *const description_cpuarchitecture_other = "other"
 [r] Other CPU type
char const *const description_spmdvariation_none = "None"
 [r] None
char const *const description_spmdvariation_mpi = "MPI"
 [r] Generic MPI
char const *const description_spmdvariation_gridmpi = "GridMPI"
 [r] GridMPI
char const *const description_spmdvariation_intelmpi = "IntelMPI"
 [r] Intel's MPI implementation
char const *const description_spmdvariation_lammpi = "LAM-MPI"
 [r] LAN MPI
char const *const description_spmdvariation_mpich1 = "MPICH1"
 [r] MPICH 1
char const *const description_spmdvariation_mpich2 = "MPICH2"
 [r] MPICH 2
char const *const description_spmdvariation_mpichgm = "MPICH-GM"
 [r] MPICH GM
char const *const description_spmdvariation_mpichmx = "MPICH-MX"
 [r] MPICH MX
char const *const description_spmdvariation_mvapich = "MVAPICH"
 [r] MVAPICH
char const *const description_spmdvariation_mvapich2 = "MVAPICH2"
 [r] MVAPICH 2
char const *const description_spmdvariation_openmp = "OpenMP"
 [r] OpenMP
char const *const description_spmdvariation_poe = "POE"
 [r] POE
char const *const description_spmdvariation_pvm = "PVM"
 [r] PVM

Detailed Description

Available attributes defined for the Job Management API package.

NOTE: Attributes with a description_prefix are read/write attributes and belong to a saga::job::description instance. The rest are read-only attributes and available for saga::job::job instances.

Although JSDL based attribute names are used for the job description attributes, the API uses no explicit representation of JSDL (i.e. JSDL compliant XML).

Usage example:

saga::job::service js("localhost");

saga::job::description jd();
jd.set_attribute("description_executable", "/bin/uname");

saga::job::job j1 = js.create_job(jd);
std::cout << j1.get_attribute("executionhosts") << std::endl;


Variable Documentation

char const* const saga::job::attributes::jobid = "JobID"

[r] SAGA representation of the job identifier (format: [backend url]-[native id])

Definition at line 80 of file packages/job/job.hpp.

char const* const saga::job::attributes::execution_hosts = "ExecutionHosts"

[r] List of host names or IP addresses allocated to run this job

Definition at line 83 of file packages/job/job.hpp.

char const* const saga::job::attributes::created = "Created"

[r] Time stamp of the job creation in the resource manager

Definition at line 86 of file packages/job/job.hpp.

char const* const saga::job::attributes::started = "Started"

[r] Time stamp indicating when the job started running

Definition at line 89 of file packages/job/job.hpp.

char const* const saga::job::attributes::finished = "Finished"

[r] Time stamp indicating when the job completed

Definition at line 92 of file packages/job/job.hpp.

char const* const saga::job::attributes::working_directory = "WorkingDirectory"

[r] Working directory on the execution host

Definition at line 95 of file packages/job/job.hpp.

char const* const saga::job::attributes::exitcode = "ExitCode"

[r] Process exit code as collected by the wait(2) series of system calls

Definition at line 99 of file packages/job/job.hpp.

char const* const saga::job::attributes::termsig = "Termsig"

[r] Signal number which caused the job to exit

Definition at line 102 of file packages/job/job.hpp.

char const* const saga::job::attributes::job_service = "JobService"

[r] url of job service instance which started this job

Definition at line 105 of file packages/job/job.hpp.

char const* const saga::job::attributes::job_state_suspended = "Suspended"

Definition at line 157 of file packages/job/job.hpp.

char const* const saga::job::attributes::description_executable = "Executable"

[rw] Command to execute (this is the only required attribute for a job description object)

Definition at line 39 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_arguments = "Arguments"

[rw] Positional parameters for the command

Definition at line 42 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_environment = "Environment"

[rw] Set of environment variables for the job (format: 'key=value').

Definition at line 45 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_working_directory = "WorkingDirectory"

[rw] Working directory for the job

Definition at line 48 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_interactive = "Interactive"

[rw] Run the job in interactive mode

Definition at line 51 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_input = "Input"

[rw] Pathname of the standard input file

Definition at line 54 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_output = "Output"

[rw] Pathname of the standard output file

Definition at line 57 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_error = "Error"

[rw] Pathname of the standard error file

Definition at line 60 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_file_transfer = "FileTransfer"

[rw] A list of file transfer directives

Definition at line 63 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_cleanup = "Cleanup"

[rw] Defines if output files get removed after the job finishes

Definition at line 66 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_job_start_time = "JobStartTime"

[rw] Time at which a job should be scheduled

Definition at line 69 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_total_cpu_time = "TotalCPUTime"

[rw] ?!?

Definition at line 72 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_wall_time_limit = "WallTimeLimit"

[rw] ?!?

Definition at line 75 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_total_physical_memory = "TotalPhysicalMemory"

[rw] Estimated amount of memory the job requires

Definition at line 78 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_cpu_architecture = "CPUArchitecture"

[rw] Compatible processor for job submission

Definition at line 81 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_operating_system_type = "OperatingSystemType"

[rw] Compatible operating system for job submission

Definition at line 85 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_candidate_hosts = "CandidateHosts"

[rw] List of host names which are to be considered by the resource manager as candidate targets

Definition at line 89 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_queue = "Queue"

[rw] Name of a queue to place the job into

Definition at line 92 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_job_contact = "JobContact"

[rw] Set of endpoints describing where to report job state transitions

Definition at line 95 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_job_project = "JobProject"

[rw]

Definition at line 98 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_spmd_variation = "SPMDVariation"

[rw] SPMD job type and startup mechanism

Definition at line 101 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_total_cpu_count = "TotalCPUCount"

[rw] Total number of cpus requested for this job

Definition at line 104 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_number_of_processes = "NumberOfProcesses"

[rw] Number of process instances to start

Definition at line 107 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_processes_per_host = "ProcessesPerHost"

[rw] Number of processes to start per host

Definition at line 110 of file job_description.hpp.

Referenced by saga::job::description::description().

char const* const saga::job::attributes::description_threads_per_process = "ThreadsPerProcess"

[rw] Expected number of threads per process
 

Definition at line 113 of file job_description.hpp.

Referenced by saga::job::description::description().

[r] SPARC CPU type

Definition at line 116 of file job_description.hpp.

[r] PowerPC CPU type

Definition at line 118 of file job_description.hpp.

[r] x86 CPU type

Definition at line 120 of file job_description.hpp.

[r] x86 (32bit) CPU type

Definition at line 122 of file job_description.hpp.

[r] x86 (64bit) CPU type

Definition at line 124 of file job_description.hpp.

[r] PARISC CPU type

Definition at line 126 of file job_description.hpp.

[r] MIPS CPU type

Definition at line 128 of file job_description.hpp.

[r] IA64 CPU type

Definition at line 130 of file job_description.hpp.

[r] ARM CPU type

Definition at line 132 of file job_description.hpp.

[r] Other CPU type

Definition at line 134 of file job_description.hpp.

[r] None

Definition at line 138 of file job_description.hpp.

[r] Generic MPI

Definition at line 141 of file job_description.hpp.

[r] GridMPI

Definition at line 144 of file job_description.hpp.

[r] Intel's MPI implementation

Definition at line 147 of file job_description.hpp.

[r] LAN MPI

Definition at line 150 of file job_description.hpp.

[r] MPICH 1

Definition at line 153 of file job_description.hpp.

[r] MPICH 2

Definition at line 156 of file job_description.hpp.

[r] MPICH GM

Definition at line 159 of file job_description.hpp.

[r] MPICH MX

Definition at line 162 of file job_description.hpp.

[r] MVAPICH

Definition at line 165 of file job_description.hpp.

[r] MVAPICH 2

Definition at line 168 of file job_description.hpp.

[r] OpenMP

Definition at line 171 of file job_description.hpp.

[r] POE

Definition at line 174 of file job_description.hpp.

[r] PVM

Definition at line 177 of file job_description.hpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines