VANET Simulator
 All Classes Functions Variables
Public Member Functions | Static Public Member Functions | List of all members
vanetsim.scenario.Scenario Class Reference

Public Member Functions

void initNewScenario ()
 
void load (File file, boolean zip)
 
void setReadyState (boolean ready)
 
void save (File file, boolean zip)
 
boolean getReadyState ()
 
String getScenarioName ()
 
void setScenarioName (String scenarioName)
 

Static Public Member Functions

static Scenario getInstance ()
 

Detailed Description

A scenario saves the vehicles and events.

Member Function Documentation

static Scenario vanetsim.scenario.Scenario.getInstance ( )
inlinestatic

Gets the single instance of this scenario.

Returns
single instance of this scenario
boolean vanetsim.scenario.Scenario.getReadyState ( )
inline

Returns if the scenario is currently being loaded. While loading, simulation and rendering should not be done because not all simulation elements are already existing!

Returns
true if loading has finished, else false
void vanetsim.scenario.Scenario.initNewScenario ( )
inline

Initializes a new (empty) scenario.

void vanetsim.scenario.Scenario.load ( File  file,
boolean  zip 
)
inline

Load a scenario.

Parameters
filethe file to load
ziptrue if the file given is zipped, else false
void vanetsim.scenario.Scenario.save ( File  file,
boolean  zip 
)
inline

Save the scenario.

Parameters
filethe file in which to save
zipif true, file is saved in a compressed zip file (extension .zip is added to file!). If false, no compression is made.
void vanetsim.scenario.Scenario.setReadyState ( boolean  ready)
inline

Sets the ready state of the scenario.

Parameters
readytrue to signal that this scenario is ready with loading, else false

The documentation for this class was generated from the following file: