org.ginsim.service.tool.avatar.service

Class FirefrontServiceFacade

java.lang.Object

org.ginsim.service.tool.avatar.service.FirefrontServiceFacade

All Implemented Interfaces:

Service

@MetaInfServices(value=Service.class)
 @Alias(value="firefrontservice")
 @ServiceStatus(value=DEVELOPMENT)
public class FirefrontServiceFacade
extends Object
implements Service

Facade of a Firefront simulation.
Instantiates a Firefront simulation from arguments within a command line, provides soundness checks, and outputs statistics and help tips.

Author:

Pedro T. Monteiro, Rui Henriques

Constructor Summary

Constructors

Constructor and Description
FirefrontServiceFacade()

Method Summary

Modifier and Type	Method and Description
static Simulation	addModel(Simulation sim, String filename)
String	getHelp() Provides help on the parameters of firefront simulations
static Simulation	getSimulation(String args) Creates a firefront simulation from a string command
static Simulation	getSimulation(String[] args) Creates a firefront simulation from a given set of arguments
static Result	run(FirefrontSimulation sim) Runs a firefront simulation
static Result	run(String[] args) Runs a firefront simulation from a given set of arguments

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FirefrontServiceFacade

public FirefrontServiceFacade()

Method Detail

run

public static Result run(FirefrontSimulation sim)
                  throws Exception

Runs a firefront simulation

Parameters:

sim - the parameterized firefront simulation

Returns:

the discovered attractors, their reachability, and remaining contextual information

Throws:

Exception - thrown due to errors while reading and writing files, conflicting parameters and unexpected behavior of the simulation

run

public static Result run(String[] args)
                  throws Exception

Runs a firefront simulation from a given set of arguments

Parameters:

args - textual arguments specifying the input model and the parameters of the firefront simulation

Returns:

the discovered attractors, their reachability, and remaining contextual information

Throws:

Exception - thrown due to errors while reading and writing files, conflicting parameters and unexpected behavior of the simulation

getSimulation

public static Simulation getSimulation(String args)
                                throws Exception

Creates a firefront simulation from a string command

Parameters:

args - command specifying the input model and the parameters of the firefront simulation

Returns:

the firefront simulation to be executed

Throws:

Exception - thrown due to errors while reading and writing files, conflicting parameters and unexpected behavior of the simulation

getSimulation

public static Simulation getSimulation(String[] args)
                                throws Exception

Creates a firefront simulation from a given set of arguments

Parameters:

args - textual arguments specifying the input model and the parameters of the firefront simulation

Returns:

the firefront simulation to be executed

Throws:

Exception - thrown due to errors while reading and writing files, conflicting parameters and unexpected behavior of the simulation

addModel

public static Simulation addModel(Simulation sim,
                                  String filename)
                           throws Exception

Throws:

Exception

getHelp

public String getHelp()

Provides help on the parameters of firefront simulations

Returns:

description of the parameters of firefront simulations