agentgui.core.project.setup

Class SimulationSetup

java.lang.Object

agentgui.core.project.setup.SimulationSetup

public class SimulationSetup
extends java.lang.Object

This is the model class for a simulation setup.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimulationSetup.CHANGED Lists the possible reasons why a SimulationSetup can be changed and unsaved
static class	SimulationSetup.SetupFileType The possible indicator for setup file types.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AGENT_LIST_EnvironmentConfiguration
static java.lang.String	AGENT_LIST_ManualConfiguration
static java.lang.String	USER_MODEL_BIN_FileSuffix
static java.lang.String	USER_MODEL_XML_FileSuffix
static java.lang.String	XML_FileSuffix

Constructor Summary

Constructors

Constructor and Description
SimulationSetup() Constructor without arguments (This is first of all for the JAXB-Context and should not be used by any other context).
SimulationSetup(Project project) Default Constructor of this class.

Method Summary

Modifier and Type	Method and Description
void	clearAgentDefaultListModels() Clear the agent default list models.
void	createHashMap4AgentDefaulListModelsFromAgentList() This method will create all DefaultListModels which will be used within the visible application as for example for the manual agent configuration (tab 'Simulation-Setup' => 'Agent-Start') or the configuration of the environment model (tab 'Simulation-Setup' => 'Simulation Environment').
javax.swing.DefaultListModel<AgentClassElement4SimStart>	getAgentDefaultListModel(javax.swing.DefaultListModel<AgentClassElement4SimStart> newDefaultListModel4AgentStarts, java.lang.String listName) This method can be used in order to add an individual agent start list to the SimulationSetup.
javax.swing.DefaultListModel<AgentClassElement4SimStart>	getAgentDefaultListModel(java.lang.String listName) This method can be used in order to get an agents start list for the simulation, given by.
java.util.ArrayList<AgentClassElement4SimStart>	getAgentList() Gets the agent list.
java.lang.String	getAgentNameUnique(java.lang.String agentNameSuggestion) Will find a new unique name for an agent, if the suggestion is not already unique.
javax.swing.DefaultComboBoxModel<java.lang.String>	getComboBoxModel4AgentLists() Gets the combo box model4 agent lists.
java.lang.String	getEnvironmentFileName() Gets the environment file name.
static java.io.File	getSetupBaseFile(java.io.File fileToCheck) Returns the nominal base setup file from the specified file, but without garanty that the file really exists.
static java.io.File	getSetupFile(java.io.File xmlBaseFile, SimulationSetup.SetupFileType setupFileType) Returns, based on the specified base XML file, the specified setup file (especially for user runtime objects).
static java.util.List<java.io.File>	getSetupFiles(java.io.File xmlBaseFile) Returns, based on the specified base XML file, all possible setup file (e.g. also for user runtime objects).
java.util.HashMap<java.lang.String,java.lang.String>	getTimeModelSettings() Gets the time model settings.
java.io.Serializable	getUserRuntimeObject() Gets the user runtime object.
boolean	isAgentNameExists(java.lang.String localAgentName) Checks if an agent name already exists in the current agent configuration.
boolean	isAgentNameExists(java.lang.String agentName2Check, boolean mergeListModels) Checks if an agent name already exists in the current agent configuration.
static SimulationSetup	load(java.io.File setupXmlFile, boolean loadUserRuntimeObject) Loads a SimulationSetup from the specified XML file.
boolean	saveSetupFiles() This method saves the current SimulationSetup and it files to the default location for setups.
boolean	saveSetupFiles(java.io.File setupXmlFile, boolean saveUserRuntimeObject) This method saves the current SimulationSetup to the specified location.
void	setAgentDefaultListModel(java.lang.String listName, javax.swing.DefaultListModel<AgentClassElement4SimStart> defaultListModel4AgentStarts) Here a complete agent start list (DefaultListModel) can be added to the simulation setup.
void	setAgentList(java.util.ArrayList<AgentClassElement4SimStart> agentList) Sets the agent list.
void	setComboBoxModel4AgentLists(javax.swing.DefaultComboBoxModel<java.lang.String> comboBoxModel4AgentLists) Sets the ComboBoxModel for agent lists.
void	setEnvironmentFileName(java.lang.String environmentFile) Sets the environment file name.
void	setProject(Project project) Sets the current project.
void	setTimeModelSettings(java.util.HashMap<java.lang.String,java.lang.String> newTimeModelSettings) Sets the time model settings.
void	setUserRuntimeObject(java.io.Serializable userRuntimeObject) Sets the user runtime object.

Methods inherited from class java.lang.Object

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

Field Detail

XML_FileSuffix

public static final java.lang.String XML_FileSuffix

See Also:

Constant Field Values

USER_MODEL_BIN_FileSuffix

public static final java.lang.String USER_MODEL_BIN_FileSuffix

See Also:

Constant Field Values

USER_MODEL_XML_FileSuffix

public static final java.lang.String USER_MODEL_XML_FileSuffix

See Also:

Constant Field Values

AGENT_LIST_ManualConfiguration

public static final java.lang.String AGENT_LIST_ManualConfiguration

See Also:

Constant Field Values

AGENT_LIST_EnvironmentConfiguration

public static final java.lang.String AGENT_LIST_EnvironmentConfiguration

See Also:

Constant Field Values

Constructor Detail

SimulationSetup

public SimulationSetup()

Constructor without arguments (This is first of all for the JAXB-Context and should not be used by any other context).

SimulationSetup

public SimulationSetup(Project project)

Default Constructor of this class.

Parameters:

project - the project

Method Detail

setProject

public void setProject(Project project)

Sets the current project.

Parameters:

project - the currProject to set

saveSetupFiles

public boolean saveSetupFiles()

This method saves the current SimulationSetup and it files to the default location for setups.
Note: this methods only saves the files without further notification to the setups observer.

Returns:

true, if saving was successful

saveSetupFiles

public boolean saveSetupFiles(java.io.File setupXmlFile,
                              boolean saveUserRuntimeObject)

This method saves the current SimulationSetup to the specified location. If the user runtime object should not be saved, set the according parameter.
Note: this methods only saves the files without further notification to the setups observer.

Parameters:

setupXmlFile - The setup xml file (other file paths are derived)

saveUserRuntimeObject - set true, if user runtime object should be saved in its separate file

Returns:

true, if saving was successful

load

public static SimulationSetup load(java.io.File setupXmlFile,
                                   boolean loadUserRuntimeObject)

Loads a SimulationSetup from the specified XML file.

Parameters:

setupXmlFile - the setup xml file

Returns:

the simulation setup, or null if loading failed

getAgentList

public java.util.ArrayList<AgentClassElement4SimStart> getAgentList()

Gets the agent list.

Returns:

the agentList

setAgentList

public void setAgentList(java.util.ArrayList<AgentClassElement4SimStart> agentList)

Sets the agent list.

Parameters:

agentList - the agentList to set

createHashMap4AgentDefaulListModelsFromAgentList

public void createHashMap4AgentDefaulListModelsFromAgentList()

This method will create all DefaultListModels which will be used within the visible application
as for example for the manual agent configuration (tab 'Simulation-Setup' => 'Agent-Start')
or the configuration of the environment model (tab 'Simulation-Setup' => 'Simulation Environment').
The resulting ListModels can be get by using getAgentDefaultListModel(String)

setAgentDefaultListModel

public void setAgentDefaultListModel(java.lang.String listName,
                                     javax.swing.DefaultListModel<AgentClassElement4SimStart> defaultListModel4AgentStarts)

Here a complete agent start list (DefaultListModel) can be added to the simulation setup.

Parameters:

listName - the list name

defaultListModel4AgentStarts - the default list model4 agent starts

clearAgentDefaultListModels

public void clearAgentDefaultListModels()

Clear the agent default list models.

setComboBoxModel4AgentLists

public void setComboBoxModel4AgentLists(javax.swing.DefaultComboBoxModel<java.lang.String> comboBoxModel4AgentLists)

Sets the ComboBoxModel for agent lists.

Parameters:

comboBoxModel4AgentLists - the comboBoxModel4AgentLists to set

getComboBoxModel4AgentLists

public javax.swing.DefaultComboBoxModel<java.lang.String> getComboBoxModel4AgentLists()

Gets the combo box model4 agent lists.

Returns:

the comboBoxModel4AgentLists

getAgentDefaultListModel

public javax.swing.DefaultListModel<AgentClassElement4SimStart> getAgentDefaultListModel(java.lang.String listName)

This method can be used in order to get an agents start list for the simulation, given by.

Parameters:

listName - the list name

Returns:

the agentListModel

getAgentDefaultListModel

public javax.swing.DefaultListModel<AgentClassElement4SimStart> getAgentDefaultListModel(javax.swing.DefaultListModel<AgentClassElement4SimStart> newDefaultListModel4AgentStarts,
                                                                                         java.lang.String listName)

This method can be used in order to add an individual agent start list to the SimulationSetup.
The list will be filled with elements of the type AgentClassElement4SimStart coming from the stored setup file and will be later on also stored in the file of the simulation setup.

Parameters:

newDefaultListModel4AgentStarts - the new DefaultListModel to set

listName - the name of the list to be assigned. Consider the use of one of the constants AGENT_LIST_ManualConfiguration or AGENT_LIST_EnvironmentConfiguration or just use an individual name

Returns:

the DefaultListModel of agents to be started for the specified list

See Also:

AgentClassElement4SimStart - The type to use within a concrete list model

getEnvironmentFileName

public java.lang.String getEnvironmentFileName()

Gets the environment file name.

Returns:

the environment file name

setEnvironmentFileName

public void setEnvironmentFileName(java.lang.String environmentFile)

Sets the environment file name.

Parameters:

environmentFile - the new environment file name

setUserRuntimeObject

public void setUserRuntimeObject(java.io.Serializable userRuntimeObject)

Sets the user runtime object.

Parameters:

userRuntimeObject - the userRuntimeObject to set

getUserRuntimeObject

public java.io.Serializable getUserRuntimeObject()

Gets the user runtime object.

Returns:

the userRuntimeObject

isAgentNameExists

public boolean isAgentNameExists(java.lang.String localAgentName)

Checks if an agent name already exists in the current agent configuration.

Parameters:

localAgentName - The agent name to search for

Returns:

true, if the agent name already exists

isAgentNameExists

public boolean isAgentNameExists(java.lang.String agentName2Check,
                                 boolean mergeListModels)

Checks if an agent name already exists in the current agent configuration.

Parameters:

agentName2Check - The agent name to search for

mergeListModels - indicates if the over all agentList has to be build new

Returns:

true, if the agent name already exists

getAgentNameUnique

public java.lang.String getAgentNameUnique(java.lang.String agentNameSuggestion)

Will find a new unique name for an agent, if the suggestion is not already unique.

Parameters:

agentNameSuggestion - the agent name suggestion

Returns:

unique agent name for the simulation setup

setTimeModelSettings

public void setTimeModelSettings(java.util.HashMap<java.lang.String,java.lang.String> newTimeModelSettings)

Sets the time model settings.

Parameters:

newTimeModelSettings - the new time model settings

getTimeModelSettings

public java.util.HashMap<java.lang.String,java.lang.String> getTimeModelSettings()

Gets the time model settings.

Returns:

the time model settings

getSetupFile

public static java.io.File getSetupFile(java.io.File xmlBaseFile,
                                        SimulationSetup.SetupFileType setupFileType)

Returns, based on the specified base XML file, the specified setup file (especially for user runtime objects).

Parameters:

xmlBaseFile - the XML base file

setupFileType - the setup file type

Returns:

the setup file

getSetupFiles

public static java.util.List<java.io.File> getSetupFiles(java.io.File xmlBaseFile)

Returns, based on the specified base XML file, all possible setup file (e.g. also for user runtime objects).

Parameters:

xmlBaseFile - the XML base file

Returns:

the setup file

getSetupBaseFile

public static java.io.File getSetupBaseFile(java.io.File fileToCheck)

Returns the nominal base setup file from the specified file, but without garanty that the file really exists.

Parameters:

fileToCheck - the file to check

Returns:

the base setup file