Job Class Reference

Job class (JMAG-Scheduler) is used to handle a job in the JMAG-Scheduler.
The class can be called from JobApplication class.
. More...

Public Member Functions
void	Cancel ()
	Cancels the job.
String	ErrorMessage ()
	Returns content of error message. More...
bool	HasError ()
	Returns True as the return value when a job is canceled due to an error. More...
bool	HasErrorMessage ()
	Returns True as the return value when there is an error message. More...
bool	IsFinished ()
	Returns True as the return value when a job is finished. More...
bool	IsValid ()
	Returns True if an object is valid. More...
double	PercentComplete ()
	Returns progress in job calculation in real number. More...
void	Restart (int restartSteps, int initialOutputStep=-1)
	Resumes the job. More...
void	RestartAdaptive (int restartStages)
	Resumes the job using the adaptive mesh function. More...
void	Resubmit ()
	Resubmits job calculation for a canceled or error job.
String	Status ()
	Returns job status. More...

Detailed Description

Job class (JMAG-Scheduler) is used to handle a job in the JMAG-Scheduler.
The class can be called from JobApplication class.
.

Example of calling the class object:

jobApp.GetJobByFolder("results_folder_path")

Member Function Documentation

String Job::ErrorMessage

(

)

Returns content of error message.

Returns

Error message

bool Job::HasError

(

)

Returns True as the return value when a job is canceled due to an error.

Returns

Whether or not a job is canceled

bool Job::HasErrorMessage

(

)

Returns True as the return value when there is an error message.

Returns

Existence of an error message

bool Job::IsFinished

(

)

Returns True as the return value when a job is finished.

Returns

Whether or not a job is finished

bool Job::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the Job objects in the list are valid

double Job::PercentComplete

(

)

Returns progress in job calculation in real number.

Returns

Progress in job calculation

void Job::Restart	(	int	restartSteps,
		int	initialOutputStep = -1
	)

Resumes the job.

Parameters

restartSteps	The number of steps to calculate
initialOutputStep	The first output step

If initialOutputStep is omitted, all steps are output.

void Job::RestartAdaptive

(

int

restartStages

)

Resumes the job using the adaptive mesh function.

Parameters

restartStages

The maximum number of stages of adaptive mesh.

String Job::Status

(

)

Returns job status.

Returns

Job status (Wait, Queued, Solving Matrix (generate a mesh, calculate the matrix, etc.), Error, Canceled, and Finished)