EnvironmentController (Agent.Workbench

java.lang.Object
- java.util.Observable
- - agentgui.core.environment.EnvironmentController

All Implemented Interfaces:

java.util.Observer
```
public abstract class EnvironmentController
extends java.util.Observable
implements java.util.Observer
```
This class has to be extended if you are writing your own environment model and visualisation. This class manages the environment model and notifies the observers about the changes to the environment model.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EnvironmentController.PersistenceStrategy` The enumeration PersistenceStrategy helps to differentiate when an environment model should be opened or saved.

Constructor Summary

Constructors
Constructor and Description
`EnvironmentController()` Constructor for a new environment controller for handling and displaying the current environment model during a running simulation.
`EnvironmentController(Project project)` Constructor for a controller within the Agent.GUI application.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`callLoadEnvironment(EnvironmentController.PersistenceStrategy invokedFrom)` Call to load the environment model.
`void`	`callSaveEnvironment(EnvironmentController.PersistenceStrategy invokedFrom)` Call to save the environment model.
`protected abstract EnvironmentPanel`	`createEnvironmentPanel()` Creates here the EnvironmentPanel, which allows to display the current data model of the environment model.
`abstract AbstractEnvironmentModel`	`getAbstractEnvironmentModel()` Returns the abstract (and individual) environment object of the EnvironmentModel
`abstract AbstractEnvironmentModel`	`getAbstractEnvironmentModelCopy()` Returns a copy of the abstract (and individual) environment object of the EnvironmentModel
`javax.swing.DefaultListModel<AgentClassElement4SimStart>`	`getAgents2Start()` Gets the list of agents to start.
`AgentClassElement4SimStart[]`	`getAgents2StartFromAgentName(java.lang.String agentName)` Gets the description instances of the agents to start, identified by the agent name
`protected SimulationSetup`	`getCurrentSimulationSetup()` Returns the current simulation setup
`AbstractDisplayAgent`	`getDisplayAgent()` Returns the `AbstractDisplayAgent` that is using this EnvironmentController in case that the agency is executed.
`abstract DisplaytEnvironmentModel`	`getDisplayEnvironmentModel()` Returns the displayable environment object of the EnvironmentModel
`abstract DisplaytEnvironmentModel`	`getDisplayEnvironmentModelCopy()` Returns a copy of the displayable environment object of the EnvironmentModel
`int`	`getEmptyPosition4Agents2Start()` Returns an empty position for the Agents2Start.
`java.lang.String`	`getEnvFolderPath()` Gets the environment folder path.
`EnvironmentModel`	`getEnvironmentModel()` Returns the current instances of the EnvironmentModel.
`EnvironmentPanel`	`getEnvironmentPanel()` Gets the environment panel for displaying the data model.
`EnvironmentPanel`	`getOrCreateEnvironmentPanel()` Gets the environment panel for displaying the data model or creates it new.
`protected abstract EnvironmentController.PersistenceStrategy`	`getPersistenceStrategy()` Has to return which strategy is to be used to load or save an `EnvironmentModel`.
`Project`	`getProject()` Gets the current project.
`TimeModel`	`getTimeModel()` Returns the TimeModel.
`TimeModel`	`getTimeModelCopy()` Returns the TimeModel copy.
`protected abstract void`	`handleProjectNotification(java.lang.Object updateObject)` Invoked by the observer for the current `Project` you can react on changes within the Project.
`protected abstract void`	`handleSimulationSetupNotification(SimulationSetupNotification sscn)` Invoked by the projects observer if the simulation setup change event occurs.
`abstract void`	`loadEnvironment()` Has to load the environment model (e.g. from file).
`protected void`	`registerDefaultListModel4SimulationStart(java.lang.String listName)` With this method the list of Agents `agents2Start`, which has to be started with the environment can be registered at the `SimulationSetup`
`void`	`reNumberAgents2Start()` Renumber the list of agents to start.
`abstract void`	`saveEnvironment()` Has to save the environment model (e.g. to to file).
`abstract void`	`setAbstractEnvironmentModel(AbstractEnvironmentModel abstractEnvironmentModel)` Set the abstract (and individual) environment object of the EnvironmentModel
`void`	`setAgents2Start(javax.swing.DefaultListModel<AgentClassElement4SimStart> agents2Start)` Sets the list of agents to start.
`void`	`setDisplayAgent(AbstractDisplayAgent newDisplayAgent)` Sets the `AbstractDisplayAgent` that is using this `EnvironmentController` In case that the agency is executed.
`abstract void`	`setDisplayEnvironmentModel(DisplaytEnvironmentModel displayEnvironmentModel)` Set the displayable environment object of the EnvironmentModel
`void`	`setEnvFolderPath(java.lang.String envFolderPath)` Sets the environment folder path.
`void`	`setEnvironmentModel(EnvironmentModel environmentModel)` Sets the environment model.
`void`	`setEnvironmentPanel(EnvironmentPanel environmentPanel)` Sets the environment panel for displaying the data model.
`void`	`setProject(Project currProject)` Sets the project.
`void`	`setTimeModel(TimeModel mewTimeModel)` Sets the TimeModel.
`void`	`update(java.util.Observable observable, java.lang.Object updateObject)`

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

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

- Constructor Detail
  - EnvironmentController
```
public EnvironmentController()
```
    Constructor for a new environment controller for handling and displaying the current environment model during a running simulation.
  - EnvironmentController
```
public EnvironmentController(Project project)
```
    Constructor for a controller within the Agent.GUI application.
    
    Parameters:
    
    project - the current project
- Method Detail
  - setEnvironmentPanel
```
public void setEnvironmentPanel(EnvironmentPanel environmentPanel)
```
    Sets the environment panel for displaying the data model.
    
    Parameters:
    
    environmentPanel - the EnvironmentPanel to set
  - getEnvironmentPanel
```
public EnvironmentPanel getEnvironmentPanel()
```
    Gets the environment panel for displaying the data model.
    
    Returns:
    
    the myEnvironmentPanel
  - getOrCreateEnvironmentPanel
```
public EnvironmentPanel getOrCreateEnvironmentPanel()
```
    Gets the environment panel for displaying the data model or creates it new.
    
    Returns:
    
    the myEnvironmentPanel
  - createEnvironmentPanel
```
protected abstract EnvironmentPanel createEnvironmentPanel()
```
    Creates here the EnvironmentPanel, which allows to display the current data model of the environment model.
    
    Returns:
    
    the environment panel
  - getCurrentSimulationSetup
```
protected SimulationSetup getCurrentSimulationSetup()
```
    Returns the current simulation setup
    
    Returns:
    
    the current simulation setup
  - getProject
```
public Project getProject()
```
    Gets the current project.
    
    Returns:
    
    the project
  - setProject
```
public void setProject(Project currProject)
```
    Sets the project.
    
    Parameters:
    
    currProject - the new project
  - setEnvFolderPath
```
public void setEnvFolderPath(java.lang.String envFolderPath)
```
    Sets the environment folder path.
    
    Parameters:
    
    envFolderPath - the new environment folder path
  - getEnvFolderPath
```
public java.lang.String getEnvFolderPath()
```
    Gets the environment folder path.
    
    Returns:
    
    the environment folder path
  - getPersistenceStrategy
```
protected abstract EnvironmentController.PersistenceStrategy getPersistenceStrategy()
```
    Has to return which strategy is to be used to load or save an EnvironmentModel. Hereby, it can be adjusted when the methods loadEnvironment() and saveEnvironment() will be called from Agent.Workbench.
    
    Returns:
    
    the persistence strategy
    
    See Also:
    
    EnvironmentController.PersistenceStrategy
  - loadEnvironment
```
public abstract void loadEnvironment()
```
    Has to load the environment model (e.g. from file).
    Will explicitly be invoked if a project will be opened.
  - saveEnvironment
```
public abstract void saveEnvironment()
```
    Has to save the environment model (e.g. to to file).
    Will explicitly be invoked if a project will be saved.
  - callLoadEnvironment
```
public final void callLoadEnvironment(EnvironmentController.PersistenceStrategy invokedFrom)
```
    Call to load the environment model.
    
    Parameters:
    
    invokedFrom - indicates if the method was called during open a project or a setup
  - callSaveEnvironment
```
public final void callSaveEnvironment(EnvironmentController.PersistenceStrategy invokedFrom)
```
    Call to save the environment model.
    
    Parameters:
    
    invokedFrom - indicates if the method was called during open a project or a setup
  - getAgents2Start
```
public javax.swing.DefaultListModel<AgentClassElement4SimStart> getAgents2Start()
```
    Gets the list of agents to start.
    
    Returns:
    
    the agents2 start
  - setAgents2Start
```
public void setAgents2Start(javax.swing.DefaultListModel<AgentClassElement4SimStart> agents2Start)
```
    Sets the list of agents to start.
    
    Parameters:
    
    agents2Start - the new agents2 start
  - getEmptyPosition4Agents2Start
```
public int getEmptyPosition4Agents2Start()
```
    Returns an empty position for the Agents2Start.
    
    Returns:
    
    the empty position4 agents2 start
  - getAgents2StartFromAgentName
```
public AgentClassElement4SimStart[] getAgents2StartFromAgentName(java.lang.String agentName)
```
    Gets the description instances of the agents to start, identified by the agent name
    
    Parameters:
    
    agentName - the agent name
    
    Returns:
    
    the array of AgentClassElement4SimStart depending on the agent name
  - reNumberAgents2Start
```
public void reNumberAgents2Start()
```
    Renumber the list of agents to start.
  - registerDefaultListModel4SimulationStart
```
protected void registerDefaultListModel4SimulationStart(java.lang.String listName)
```
    With this method the list of Agents agents2Start, which has to be started with the environment can be registered at the SimulationSetup
    
    Parameters:
    
    listName - Consider the use of the constant value SimulationSetup.AGENT_LIST_EnvironmentConfiguration or just use an individual name
  - update
```
public final void update(java.util.Observable observable,
                         java.lang.Object updateObject)
```
    Specified by:
    
    update in interface java.util.Observer
  - handleProjectNotification
```
protected abstract void handleProjectNotification(java.lang.Object updateObject)
```
    Invoked by the observer for the current Project you can react on changes within the Project. Normally, the provided updateObject will be one of the constants specified in the class Project. For example the 'SAVED' constant of that class.
    
    Parameters:
    
    updateObject - the update object that informs about the type of change within the current project
  - handleSimulationSetupNotification
```
protected abstract void handleSimulationSetupNotification(SimulationSetupNotification sscn)
```
    Invoked by the projects observer if the simulation setup change event occurs.
    
    Parameters:
    
    sscn - the SimulationSetupsChangeNotification that can be differentiated by its globals
  - setEnvironmentModel
```
public void setEnvironmentModel(EnvironmentModel environmentModel)
```
    Sets the environment model.
    
    Parameters:
    
    environmentModel - the new environment model
  - getEnvironmentModel
```
public EnvironmentModel getEnvironmentModel()
```
    Returns the current instances of the EnvironmentModel.
    
    Returns:
    
    the environment model
  - setTimeModel
```
public void setTimeModel(TimeModel mewTimeModel)
```
    Sets the TimeModel.
    
    Parameters:
    
    mewTimeModel - the new TimeModel
  - getTimeModel
```
public TimeModel getTimeModel()
```
    Returns the TimeModel.
    
    Returns:
    
    the TimeModel
  - getTimeModelCopy
```
public TimeModel getTimeModelCopy()
```
    Returns the TimeModel copy.
    
    Returns:
    
    the TimeModel copy
  - setDisplayEnvironmentModel
```
public abstract void setDisplayEnvironmentModel(DisplaytEnvironmentModel displayEnvironmentModel)
```
    Set the displayable environment object of the EnvironmentModel
    
    Parameters:
    
    displayEnvironmentModel - the environment model
  - getDisplayEnvironmentModel
```
public abstract DisplaytEnvironmentModel getDisplayEnvironmentModel()
```
    Returns the displayable environment object of the EnvironmentModel
    
    Returns:
    
    the current instance of the environment model
  - getDisplayEnvironmentModelCopy
```
public abstract DisplaytEnvironmentModel getDisplayEnvironmentModelCopy()
```
    Returns a copy of the displayable environment object of the EnvironmentModel
    
    Returns:
    
    a copy of the environment model
  - setAbstractEnvironmentModel
```
public abstract void setAbstractEnvironmentModel(AbstractEnvironmentModel abstractEnvironmentModel)
```
    Set the abstract (and individual) environment object of the EnvironmentModel
    
    Parameters:
    
    abstractEnvironmentModel - the environment model
  - getAbstractEnvironmentModel
```
public abstract AbstractEnvironmentModel getAbstractEnvironmentModel()
```
    Returns the abstract (and individual) environment object of the EnvironmentModel
    
    Returns:
    
    the current instance of the environment model
  - getAbstractEnvironmentModelCopy
```
public abstract AbstractEnvironmentModel getAbstractEnvironmentModelCopy()
```
    Returns a copy of the abstract (and individual) environment object of the EnvironmentModel
    
    Returns:
    
    a copy of the environment model
  - setDisplayAgent
```
public void setDisplayAgent(AbstractDisplayAgent newDisplayAgent)
```
    Sets the AbstractDisplayAgent that is using this EnvironmentController In case that the agency is executed. Using this instance you're able to translate user interactions into ACLMessage and SimulationService-notifications that can change settings and parameters during the runtime of the agency.
    
    Parameters:
    
    newDisplayAgent - the new, extended AbstractDisplayAgent
  - getDisplayAgent
```
public AbstractDisplayAgent getDisplayAgent()
```
    Returns the AbstractDisplayAgent that is using this EnvironmentController in case that the agency is executed. Using this instance you're able to translate user interactions into ACLMessage and SimulationService-notifications that can change settings and parameters during the runtime of the agency.
    
    Returns:
    
    the environment controller agent

Class EnvironmentController

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

EnvironmentController

EnvironmentController

Method Detail

setEnvironmentPanel

getEnvironmentPanel

getOrCreateEnvironmentPanel

createEnvironmentPanel

getCurrentSimulationSetup

getProject

setProject

setEnvFolderPath

getEnvFolderPath

getPersistenceStrategy

loadEnvironment

saveEnvironment

callLoadEnvironment

callSaveEnvironment

getAgents2Start

setAgents2Start

getEmptyPosition4Agents2Start

getAgents2StartFromAgentName

reNumberAgents2Start

registerDefaultListModel4SimulationStart

update

handleProjectNotification

handleSimulationSetupNotification

setEnvironmentModel

getEnvironmentModel

setTimeModel

getTimeModel

getTimeModelCopy

setDisplayEnvironmentModel

getDisplayEnvironmentModel

getDisplayEnvironmentModelCopy

setAbstractEnvironmentModel

getAbstractEnvironmentModel

getAbstractEnvironmentModelCopy

setDisplayAgent

getDisplayAgent