com.xilinx.rapidwright.util

Class Job

Object

com.xilinx.rapidwright.util.Job

Direct Known Subclasses:

LocalJob, LSFJob

public abstract class Job
extends Object

A parent class for all task jobs types. Created on: Jan 26, 2018

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COMMAND_LOG_FILE
static String	DEFAULT_COMMAND_NAME
static String	DEFAULT_LOG_EXTENSION
static String	DEFAULT_SCRIPT_LOG_FILE
static String	DEFAULT_SCRIPT_NAME

Constructor Summary

Constructors

Constructor and Description
Job()

Method Summary

Modifier and Type	Method and Description
Pair<String,String>	createLaunchScript()
String	getCommand()
long	getJobNumber()
abstract JobState	getJobState()
Optional<List<String>>	getLastLogLines()
String	getLogFilename()
String	getRunDir()
boolean	isFinished()
abstract boolean	jobWasSuccessful()
abstract void	killJob()
abstract long	launchJob()
void	setCommand(String command)
void	setJobNumber(long jobNumber)
void	setRapidWrightCommand(Class<?> mainClass, int memoryLimitMB, String arguments) Set the command to run a RapidWright main class
void	setRunDir(String runDir)
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SCRIPT_NAME

public static final String DEFAULT_SCRIPT_NAME

See Also:

Constant Field Values

DEFAULT_COMMAND_NAME

public static final String DEFAULT_COMMAND_NAME

See Also:

Constant Field Values

DEFAULT_LOG_EXTENSION

public static final String DEFAULT_LOG_EXTENSION

See Also:

Constant Field Values

DEFAULT_SCRIPT_LOG_FILE

public static final String DEFAULT_SCRIPT_LOG_FILE

See Also:

Constant Field Values

DEFAULT_COMMAND_LOG_FILE

public static final String DEFAULT_COMMAND_LOG_FILE

See Also:

Constant Field Values

Constructor Detail

Job

public Job()

Method Detail

launchJob

public abstract long launchJob()

getJobState

public abstract JobState getJobState()

isFinished

public final boolean isFinished()

jobWasSuccessful

public abstract boolean jobWasSuccessful()

killJob

public abstract void killJob()

createLaunchScript

public Pair<String,String> createLaunchScript()

getCommand

public String getCommand()

Returns:

the command

setCommand

public void setCommand(String command)

Parameters:

command - the command to set

setRapidWrightCommand

public void setRapidWrightCommand(Class<?> mainClass,
                                  int memoryLimitMB,
                                  String arguments)

Set the command to run a RapidWright main class

Parameters:

mainClass - the main class to use

memoryLimitMB - maximum memory in MB

arguments - command arguments as single string

getJobNumber

public long getJobNumber()

Returns:

the jobNumber

setJobNumber

public void setJobNumber(long jobNumber)

Parameters:

jobNumber - the jobNumber to set

getRunDir

public String getRunDir()

Returns:

the runDir

setRunDir

public void setRunDir(String runDir)

Parameters:

runDir - the runDir to set

toString

public String toString()

Overrides:

toString in class Object

getLastLogLines

public Optional<List<String>> getLastLogLines()

getLogFilename

public String getLogFilename()