GisScenario

java.lang.Object
- gis2.GisScenario

All Implemented Interfaces:

CollapseSimCompatibaleScenarioV1_1, Scenario
```
public class GisScenario
extends java.lang.Object
implements Scenario, CollapseSimCompatibaleScenarioV1_1
```
This class knows how to read scenario files and apply them to StandardWorldModels.

Constructor Summary

Constructors
Constructor and Description

GisScenario()
Create an empty scenario.

GisScenario(org.dom4j.Document doc)
Create a scenario from an XML document.

Constructors
Constructor and Description
`GisScenario()` Create an empty scenario.
`GisScenario(org.dom4j.Document doc)` Create a scenario from an XML document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAmbulanceCentre(int location)` Add an ambulance centre.
`void`	`addAmbulanceTeam(int location)` Add an ambulance team.
`void`	`addCivilian(int location)` Add a civilian.
`void`	`addFire(int location)` Add a fire.
`void`	`addFireBrigade(int location)` Add a fire brigade.
`void`	`addFireStation(int location)` Add a fire station.
`void`	`addGasStation(int location)` Add a GasStation.
`void`	`addHydrant(int location)` Add a hydrant.
`void`	`addPoliceForce(int location)` Add a police force.
`void`	`addPoliceOffice(int location)` Add a police office.
`void`	`addRefuge(int location)` Add a refuge.
`void`	`apply(StandardWorldModel model, Config config)` Apply this scenario to a world model.
`java.util.HashMap<java.lang.Integer,java.lang.Float>`	`getAftershocks()`
`java.util.Collection<java.lang.Integer>`	`getAmbulanceCentres()` Get the list of ambulance centre locations.
`java.util.Collection<java.lang.Integer>`	`getAmbulanceTeams()` Get the list of ambulance team locations.
`java.util.Collection<java.lang.Integer>`	`getCivilians()` Get the list of civilian locations.
`java.util.Collection<java.lang.Integer>`	`getFireBrigades()` Get the list of fire brigade locations.
`java.util.Set<java.lang.Integer>`	`getFires()` Get the set of fire locations.
`java.util.Collection<java.lang.Integer>`	`getFireStations()` Get the list of fire station locations.
`java.util.Set<java.lang.Integer>`	`getGasStations()` Get the set of GasStations locations.
`java.util.Set<java.lang.Integer>`	`getHydrants()` Get the set of hydrant locations.
`java.util.Collection<java.lang.Integer>`	`getPoliceForces()` Get the list of police force locations.
`java.util.Collection<java.lang.Integer>`	`getPoliceOffices()` Get the list of police office locations.
`java.util.Set<java.lang.Integer>`	`getRefuges()` Get the set of refuge locations.
`void`	`read(org.dom4j.Document doc)` Read scenario data from an XML document.
`void`	`removeAmbulanceCentre(int location)` Remove an ambulance centre.
`void`	`removeAmbulanceTeam(int location)` Remove an ambulance team.
`void`	`removeCivilian(int location)` Remove a civilian.
`void`	`removeFire(int location)` Remove a fire.
`void`	`removeFireBrigade(int location)` Remove a fire brigade.
`void`	`removeFireStation(int location)` Remove a fire station.
`void`	`removeGasStation(int location)` Remove a GasStation.
`void`	`removeHydrant(int location)` Remove a hydrant.
`void`	`removePoliceForce(int location)` Remove a police force.
`void`	`removePoliceOffice(int location)` Remove a police office.
`void`	`removeRefuge(int location)` Remove a refuge.
`void`	`setAmbulanceCentres(java.util.Collection<java.lang.Integer> newLocations)` Set the list of ambulance centre locations.
`void`	`setAmbulanceTeams(java.util.Collection<java.lang.Integer> newLocations)` Set the list of ambulance team locations.
`void`	`setCivilians(java.util.Collection<java.lang.Integer> newLocations)` Set the list of civilian locations.
`void`	`setFireBrigades(java.util.Collection<java.lang.Integer> newLocations)` Set the list of fire brigade locations.
`void`	`setFires(java.util.Set<java.lang.Integer> newLocations)` Set the set of fire locations.
`void`	`setFireStations(java.util.Collection<java.lang.Integer> newLocations)` Set the list of fire station locations.
`void`	`setPoliceForces(java.util.Collection<java.lang.Integer> newLocations)` Set the list of police force locations.
`void`	`setPoliceOffices(java.util.Collection<java.lang.Integer> newLocations)` Set the list of police office locations.
`void`	`setRefuges(java.util.Set<java.lang.Integer> newLocations)` Set the set of refuge locations.
`void`	`write(org.dom4j.Document doc)` Write scenario data to an XML document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GisScenario
```
public GisScenario()
```
    Create an empty scenario.
  - GisScenario
```
public GisScenario(org.dom4j.Document doc)
            throws ScenarioException
```
    Create a scenario from an XML document.
    
    Parameters:
    
    doc - The document to read.
    
    Throws:
    
    ScenarioException - If the scenario is invalid.
    
    ScenarioException
- Method Detail
  - read
```
public void read(org.dom4j.Document doc)
          throws ScenarioException
```
    Read scenario data from an XML document.
    
    Parameters:
    
    doc - The document to read.
    
    Throws:
    
    ScenarioException - If the scenario is invalid.
    
    ScenarioException
  - write
```
public void write(org.dom4j.Document doc)
```
    Write scenario data to an XML document.
    
    Parameters:
    
    doc - The document to write to.
  - apply
```
public void apply(StandardWorldModel model,
                  Config config)
           throws ScenarioException
```
    Apply this scenario to a world model.
    
    Parameters:
    
    model - The world model to alter.
    
    config - The configuration.
    
    Throws:
    
    ScenarioException - if this scenario is invalid.
    
    ScenarioException
  - getFires
```
public java.util.Set<java.lang.Integer> getFires()
```
    Get the set of fire locations.
    
    Returns:
    
    The set of fire locations.
  - getRefuges
```
public java.util.Set<java.lang.Integer> getRefuges()
```
    Get the set of refuge locations.
    
    Returns:
    
    The set of refuge locations.
  - getGasStations
```
public java.util.Set<java.lang.Integer> getGasStations()
```
    Get the set of GasStations locations.
    
    Returns:
    
    The set of GasStations locations.
  - getHydrants
```
public java.util.Set<java.lang.Integer> getHydrants()
```
    Get the set of hydrant locations.
    
    Returns:
    
    The set of hydrant locations.
  - getCivilians
```
public java.util.Collection<java.lang.Integer> getCivilians()
```
    Get the list of civilian locations.
    
    Returns:
    
    The list of civilian locations.
  - getFireBrigades
```
public java.util.Collection<java.lang.Integer> getFireBrigades()
```
    Get the list of fire brigade locations.
    
    Returns:
    
    The list of fire brigade locations.
  - getFireStations
```
public java.util.Collection<java.lang.Integer> getFireStations()
```
    Get the list of fire station locations.
    
    Returns:
    
    The list of fire station locations.
  - getPoliceForces
```
public java.util.Collection<java.lang.Integer> getPoliceForces()
```
    Get the list of police force locations.
    
    Returns:
    
    The list of police force locations.
  - getPoliceOffices
```
public java.util.Collection<java.lang.Integer> getPoliceOffices()
```
    Get the list of police office locations.
    
    Returns:
    
    The list of police office locations.
  - getAmbulanceTeams
```
public java.util.Collection<java.lang.Integer> getAmbulanceTeams()
```
    Get the list of ambulance team locations.
    
    Returns:
    
    The list of ambulance team locations.
  - getAmbulanceCentres
```
public java.util.Collection<java.lang.Integer> getAmbulanceCentres()
```
    Get the list of ambulance centre locations.
    
    Returns:
    
    The list of ambulance centre locations.
  - setFires
```
public void setFires(java.util.Set<java.lang.Integer> newLocations)
```
    Set the set of fire locations.
    
    Parameters:
    
    newLocations - The new set of locations.
  - setRefuges
```
public void setRefuges(java.util.Set<java.lang.Integer> newLocations)
```
    Set the set of refuge locations.
    
    Parameters:
    
    newLocations - The new set of locations.
  - setCivilians
```
public void setCivilians(java.util.Collection<java.lang.Integer> newLocations)
```
    Set the list of civilian locations.
    
    Parameters:
    
    newLocations - The new list of locations.
  - setFireBrigades
```
public void setFireBrigades(java.util.Collection<java.lang.Integer> newLocations)
```
    Set the list of fire brigade locations.
    
    Parameters:
    
    newLocations - The new list of locations.
  - setFireStations
```
public void setFireStations(java.util.Collection<java.lang.Integer> newLocations)
```
    Set the list of fire station locations.
    
    Parameters:
    
    newLocations - The new list of locations.
  - setPoliceForces
```
public void setPoliceForces(java.util.Collection<java.lang.Integer> newLocations)
```
    Set the list of police force locations.
    
    Parameters:
    
    newLocations - The new list of locations.
  - setPoliceOffices
```
public void setPoliceOffices(java.util.Collection<java.lang.Integer> newLocations)
```
    Set the list of police office locations.
    
    Parameters:
    
    newLocations - The new list of locations.
  - setAmbulanceTeams
```
public void setAmbulanceTeams(java.util.Collection<java.lang.Integer> newLocations)
```
    Set the list of ambulance team locations.
    
    Parameters:
    
    newLocations - The new list of locations.
  - setAmbulanceCentres
```
public void setAmbulanceCentres(java.util.Collection<java.lang.Integer> newLocations)
```
    Set the list of ambulance centre locations.
    
    Parameters:
    
    newLocations - The new list of locations.
  - addFire
```
public void addFire(int location)
```
    Add a fire.
    
    Parameters:
    
    location - The new fire location.
  - removeFire
```
public void removeFire(int location)
```
    Remove a fire.
    
    Parameters:
    
    location - The fire location to remove.
  - addRefuge
```
public void addRefuge(int location)
```
    Add a refuge.
    
    Parameters:
    
    location - The new refuge location.
  - removeRefuge
```
public void removeRefuge(int location)
```
    Remove a refuge.
    
    Parameters:
    
    location - The refuge location to remove.
  - addHydrant
```
public void addHydrant(int location)
```
    Add a hydrant.
    
    Parameters:
    
    location - The new hydrant location.
  - removeHydrant
```
public void removeHydrant(int location)
```
    Remove a hydrant.
    
    Parameters:
    
    location - The hydrant location to remove.
  - removeGasStation
```
public void removeGasStation(int location)
```
    Remove a GasStation.
    
    Parameters:
    
    location - The GasStation location to remove.
  - addGasStation
```
public void addGasStation(int location)
```
    Add a GasStation.
    
    Parameters:
    
    location - The new GasStation location.
  - addCivilian
```
public void addCivilian(int location)
```
    Add a civilian.
    
    Parameters:
    
    location - The new civilian location.
  - removeCivilian
```
public void removeCivilian(int location)
```
    Remove a civilian.
    
    Parameters:
    
    location - The civilian location to remove.
  - addFireBrigade
```
public void addFireBrigade(int location)
```
    Add a fire brigade.
    
    Parameters:
    
    location - The new fire brigade location.
  - removeFireBrigade
```
public void removeFireBrigade(int location)
```
    Remove a fire brigade.
    
    Parameters:
    
    location - The fire brigade location to remove.
  - addFireStation
```
public void addFireStation(int location)
```
    Add a fire station.
    
    Parameters:
    
    location - The new fire station location.
  - removeFireStation
```
public void removeFireStation(int location)
```
    Remove a fire station.
    
    Parameters:
    
    location - The fire station location to remove.
  - addPoliceForce
```
public void addPoliceForce(int location)
```
    Add a police force.
    
    Parameters:
    
    location - The new police force location.
  - removePoliceForce
```
public void removePoliceForce(int location)
```
    Remove a police force.
    
    Parameters:
    
    location - The police force location to remove.
  - addPoliceOffice
```
public void addPoliceOffice(int location)
```
    Add a police office.
    
    Parameters:
    
    location - The new police office location.
  - removePoliceOffice
```
public void removePoliceOffice(int location)
```
    Remove a police office.
    
    Parameters:
    
    location - The police office location to remove.
  - addAmbulanceTeam
```
public void addAmbulanceTeam(int location)
```
    Add an ambulance team.
    
    Parameters:
    
    location - The new ambulance team location.
  - removeAmbulanceTeam
```
public void removeAmbulanceTeam(int location)
```
    Remove an ambulance team.
    
    Parameters:
    
    location - The ambulance team location to remove.
  - addAmbulanceCentre
```
public void addAmbulanceCentre(int location)
```
    Add an ambulance centre.
    
    Parameters:
    
    location - The new ambulance centre location.
  - removeAmbulanceCentre
```
public void removeAmbulanceCentre(int location)
```
    Remove an ambulance centre.
    
    Parameters:
    
    location - The ambulance centre location to remove.
  - getAftershocks
```
public java.util.HashMap<java.lang.Integer,java.lang.Float> getAftershocks()
```
    Specified by:
    
    getAftershocks in interface CollapseSimCompatibaleScenarioV1_1

Class GisScenario

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GisScenario

GisScenario

Method Detail

read

write

apply

getFires

getRefuges

getGasStations

getHydrants

getCivilians

getFireBrigades

getFireStations

getPoliceForces

getPoliceOffices

getAmbulanceTeams

getAmbulanceCentres

setFires

setRefuges

setCivilians

setFireBrigades

setFireStations

setPoliceForces

setPoliceOffices

setAmbulanceTeams

setAmbulanceCentres

addFire

removeFire

addRefuge

removeRefuge

addHydrant

removeHydrant

removeGasStation

addGasStation

addCivilian

removeCivilian

addFireBrigade

removeFireBrigade

addFireStation

removeFireStation

addPoliceForce

removePoliceForce

addPoliceOffice

removePoliceOffice

addAmbulanceTeam

removeAmbulanceTeam

addAmbulanceCentre

removeAmbulanceCentre

getAftershocks