fr.liglab.adele.icasa.simulator.script.executor

Interface ScriptExecutor

public interface ScriptExecutor

Interface of service responsible for script execution into the platform

Author:

Gabriel Pedraza Ferreira

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScriptExecutor.State Enumeration representing the state of scripts

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ScriptExecutorListener listener) Adds a listener to the script executor.
void	execute(String scriptName) Executes the script having this name
void	execute(String scriptName, Date startDate, int factor) Executes the script having this name
int	getActionsNumber(String scriptName) Get the number of actions contained into the script
String	getCurrentScript() Gets the current script in execution
ScriptExecutor.State	getCurrentScriptState() Gets the execution estate of the current script (if there is one)
float	getExecutedPercentage() Returns percentage of completed instructions of current script.
int	getExecutionTime(String scriptName) Gets the execution time in (virtual) minutes of the script file
int	getFactor(String scriptName) Gets the factor defined in the script file
List<String>	getScriptList() Gets a lists of scripts in the platform
long	getStartDate(String scriptName) Gets the start date defined in the script file
ScriptExecutor.State	getState(String scriptName) Gets the current state of the script file
void	pause() Pauses the execution of the current script (if there is one)
void	removeListener(ScriptExecutorListener listener) Removes a listener to the script executor.
void	resume() Resumes the execution of the current script (if there is one)
void	saveSimulationScript(String fileName) Saves the current state into a script having the name use as argument
void	stop() Stops the script execution

Method Detail

addListener

void addListener(ScriptExecutorListener listener)

Adds a listener to the script executor.

Parameters:

listener - the listener to be added.

removeListener

void removeListener(ScriptExecutorListener listener)

Removes a listener to the script executor.

Parameters:

listener - the listener to be removed.

getScriptList

List<String> getScriptList()

Gets a lists of scripts in the platform

Returns:

getCurrentScript

String getCurrentScript()

Gets the current script in execution

Returns:

execute

void execute(String scriptName)

Executes the script having this name

Parameters:

scriptName -

execute

void execute(String scriptName,
           Date startDate,
           int factor)

Executes the script having this name

Parameters:

scriptName -

startDate -

factor -

stop

void stop()

Stops the script execution

pause

void pause()

Pauses the execution of the current script (if there is one)

resume

void resume()

Resumes the execution of the current script (if there is one)

getCurrentScriptState

ScriptExecutor.State getCurrentScriptState()

Gets the execution estate of the current script (if there is one)

Returns:

getExecutedPercentage

float getExecutedPercentage()

Returns percentage of completed instructions of current script.

Returns:

percentage of completed instructions of current script.

saveSimulationScript

void saveSimulationScript(String fileName)

Saves the current state into a script having the name use as argument

Parameters:

fileName - the name of the script file

getFactor

int getFactor(String scriptName)

Gets the factor defined in the script file

Parameters:

scriptName - the script file name

Returns:

the factor

getStartDate

long getStartDate(String scriptName)

Gets the start date defined in the script file

Parameters:

scriptName - the script file name

Returns:

the start date

getActionsNumber

int getActionsNumber(String scriptName)

Get the number of actions contained into the script

Parameters:

scriptName - the script file name

Returns:

the number of actions

getExecutionTime

int getExecutionTime(String scriptName)

Gets the execution time in (virtual) minutes of the script file

Parameters:

scriptName - the script file name

Returns:

the execution time in (virtual) minutes

getState

ScriptExecutor.State getState(String scriptName)

Gets the current state of the script file

Parameters:

scriptName - the script file name

Returns:

the state