Package net.simplace.sim.model

Class FWSimModel

java.lang.Object

net.simplace.sim.model.FWSimModel

All Implemented Interfaces:

Callable<FWSimVarMap>

public class FWSimModel
extends Object
implements Callable<FWSimVarMap>

Implemented as Callable so that more than one can be run in same time Can access resources via Resource Manager Singleton Manages the VarMap Manages the state in time and the settings of the model run Can write outputs via Output Manager Singleton Implemented simulation modules Model parts are implemented from abstract simulation modules (init, clone (mit reset), process)

Author:

Andreas Enders

Constructor Summary

Constructors

Constructor	Description
FWSimModel(HashMap<String,FWSimVariable<?>> aFieldMap, FWSimVarMap aVarMap, org.jdom2.Element aSimModelElement)	creating Template Model - called for creating the model in the beginning

Method Summary

Modifier and Type	Method	Description
FWSimVarMap	call()
FWSimModel	clone(FWSimVarMap aMap)
LocalDateTime	getCurrentDate()
LocalDateTime	getEndDate()
HashMap<String,FWSimVariable<?>>	getFieldMap()
FWSimComponent	getSimComponent(String aComponentName)
List<FWSimComponent>	getSimComponents()
MultiHashMap<FWSimFieldContainer,SimVarLink>	getSimLinks()
LocalDateTime	getStartDate()
FWSimVarMap	getVarMap()
void	init()	Initialize Model and the FWSimComponent registered in this model
void	reset(FWSimVarMap aNextVarMap)
boolean	step()	Run all model components for one day, step time and return new current date The current date from the FWSimVarMap
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FWSimModel

public FWSimModel(HashMap<String,FWSimVariable<?>> aFieldMap,
 FWSimVarMap aVarMap,
 org.jdom2.Element aSimModelElement)
           throws SimLinkInvalidException

creating Template Model - called for creating the model in the beginning

Parameters:

aFieldMap -

aVarMap -

aSimModelElement -

Throws:

SimLinkInvalidException

Method Details

init

public void init()

Initialize Model and the FWSimComponent registered in this model

call

public FWSimVarMap call()

Specified by:

call in interface Callable<FWSimVarMap>

See Also:

• Callable.call()

step

public boolean step()

Run all model components for one day, step time and return new current date The current date from the FWSimVarMap

Returns:

is simulation continuing

clone

public FWSimModel clone(FWSimVarMap aMap)

Parameters:

aMap -

Returns:

the cloned model instance using an already cloned new VarMap

reset

public void reset(FWSimVarMap aNextVarMap)

Parameters:

aNextVarMap -

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

getCurrentDate

public LocalDateTime getCurrentDate()

Returns:

the current model date

getStartDate

public LocalDateTime getStartDate()

Returns:

start date

getEndDate

public LocalDateTime getEndDate()

Returns:

end date

getSimComponent

public FWSimComponent getSimComponent(String aComponentName)

Parameters:

aComponentName -

Returns:

the SimComponent instance registered within this model

getFieldMap

public HashMap<String,FWSimVariable<?>> getFieldMap()

Returns:

the global fieldMap - same for all model instances

getVarMap

public FWSimVarMap getVarMap()

Returns:

the individual VarMap - different for each model instance

getSimComponents

public List<FWSimComponent> getSimComponents()

Returns:

all FWSimComponent registered within this model

getSimLinks

public MultiHashMap<FWSimFieldContainer,SimVarLink> getSimLinks()

Returns:

a Map including all SimLinks