energy

Class OptionModelControllerBase

java.lang.Object

java.util.Observable

energy.OptionModelControllerBase

All Implemented Interfaces:

EomController

Direct Known Subclasses:

OptionModelController

public abstract class OptionModelControllerBase
extends java.util.Observable
implements EomController

The Class OptionModelControllerBase is the abstract super class for the OptionModelController and covers the methods for handling TechnicalSystem's file and the access to diverse help classes as the classes SelectionModel, GlobalInfo, ObjectFactory, OntologyHelper, AbstractOptionModelCalculation and the class AbstractEvaluationStrategy.

Constructor Summary

Constructors

Constructor and Description
OptionModelControllerBase() Instantiates a new option model controller.

Method Summary

Modifier and Type	Method and Description
void	adjustEnergyFlowMeasuredToMilliseconds(EnergyFlowMeasured efm, long milliseconds) Adjust energy flow measured to the specified milliseconds.
void	adjustGoodFlowMeasuredToMilliseconds(GoodFlowMeasured gfm, long milliseconds) Adjust good flow measured to the specified milliseconds.
EnergyAmount	copyEnergyAmount(EnergyAmount energyAmount) Copies the specified energy amount into a new instance.
EnergyFlowInWatt	copyEnergyFlowInWatt(EnergyFlowInWatt energyFlowInWatt) Copies the specified EnergyFlowInWatt into a new instance.
GoodFlow	copyGoodFlow(GoodFlow goodFlow) Copies the specified GoodFlow into a new instance.
AbstractEvaluationStrategy	createEvaluationStrategy() Creates and returns a new instance of the configured evaluation strategy.
AbstractEvaluationStrategy	createEvaluationStrategy(java.lang.String evaluationStrategyClassName) Creates and returns a new instance of the configured evaluation strategy.
AbstractOptionModelCalculation	createOptionModelCalculation() Returns the a new instance of an option model calculation.
State	createState(TechnicalInterfaceConfiguration tic) Creates a new State in compliance to the given TechnicalInterfaceConfiguration.
AbstractStaticModel	createStaticModel(SystemVariableDefinitionStaticModel sysVarDefStaticModel) Creates and returns the AbstractStaticModel instance that is defined with the specified SystemVariableDefinitionStaticModel.
TechnicalInterface	createTechnicalInterface(TechnicalInterfaceConfiguration tic) Creates a new EnergyInterface in compliance to the given TechnicalInterfaceConfiguration.
TechnicalInterfaceConfiguration	createTechnicalInterfaceConfiguration() Creates a new TechnicalInterfaceConfiguration.
AbstractStaticModel	getAbstractStaticModel(SystemVariableDefinitionStaticModel sysVarDefStaticModel) Returns the abstract static model, if specified, and will remind the instance for a further access.
jade.core.Agent	getControllingAgent() Returns the controlling agent of this option model controller..
java.lang.Object	getControllingEntity() Returns the controlling entity of this option model controller.
CostModel	getCostModel() Returns the CostModel for the current TechnicalSystem.
java.io.File	getCurrentFile() Has to return the file object that is currently open in the controller.
java.lang.String	getDomain(java.lang.String configID, java.lang.String interfaceID) Returns the domain (String) for the specified ID's of TechnicalInterfaceConfiguration and TechnicalInterface.
java.lang.String	getDomain(TechnicalInterfaceConfiguration tic, java.lang.String interfaceID) Returns the domain (String) for the specified TechnicalInterfaceConfiguration and the TechnicalInterface named by the interfaceID.
Duration	getDuration(AbstractOptionModelCalculation.DurationType durationType, AbstractDuration abstractDuration, TechnicalSystemStateEvaluation tsse) Returns the actual Duration from the specified AbstractDuration in the context of the current system state, specified by the TechnicalSystemStateEvaluation.
Duration	getDurationAsIntegerDuration(Duration duration, TimeUnit highestTimeUnitToStartAt) Returns the specified duration with the maximum TimUnit in order to have the number value of the Duration as an integer.
EnergyCarrier	getEnergyCarrier(java.lang.String configID, java.lang.String interfaceID) Returns the EnergyCarrier for the specified ID's of TechnicalInterfaceConfiguration and EnergyInterface.
EnergyCarrier	getEnergyCarrier(TechnicalInterfaceConfiguration tic, java.lang.String interfaceID) Returns the EnergyCarrier for the specified TechnicalInterfaceConfiguration and the EnergyInterface named by the interfaceID.
EnergyFlowInWatt	getEnergyFlowInWattAverage(EnergyFlowMeasured efm) Returns the average EnergyFlowInWatt.
EnergyFlowInWatt	getEnergyFlowInWattForEnergyFlowMeasuredAtRelativeTime(EnergyFlowMeasured efm, long relativePointInTime) Returns the EnergyFlowInWatt for the specified EnergyFlowMeasured at the time relative to the EnergyFlowMeasured.
AbstractEvaluationCalculation	getEvaluationCalculation(java.lang.String evalCalcClass) Returns the specified instance of an AbstractEvaluationCalculation.
EvaluationClass	getEvaluationClassByClassName(java.lang.String className) Returns the EvaluationClass from the current EvaluationSettings that corresponds to the specified class name.
EvaluationClass	getEvaluationClassByStrategyID(java.lang.String strategyID) Returns the EvaluationClass from the current EvaluationSettings that corresponds to the specified strategy ID.
EvaluationProcess	getEvaluationProcess() Returns or initiates the EvaluationProcess.
EvaluationSettings	getEvaluationSettings() Returns the EvaluationSettings for the current TechnicalSystem.
AbstractEvaluationStrategy	getEvaluationStrategy() Returns the actual configured instance of an AbstractEvaluationStrategy.
AbstractEvaluationStrategy	getEvaluationStrategyRT() Returns the instance of an extended AbstractEvaluationStrategy in case that the strategy is a real time strategy.
AbstractFlow	getFlow(State state, java.lang.String interfaceID) Returns the flow for the specified interface.
GlobalInfo	getGlobalInfo() Returns the global info instance.
GoodFlow	getGoodFlowAverage(GoodFlowMeasured gfm, java.lang.String domainUnit) Returns the average GoodFlow.
GoodFlow	getGoodFlowForGoodFlowMeasuredAtRelativeTime(GoodFlowMeasured efm, long relativePointInTime) Returns the GoodFlow for the specified GoodFlowMeasured at the time relative to the GoodFlowMeasured.
GroupController	getGroupController() Returns the GroupController, if used in a context of a group of TechnicalSystem's.
java.util.Vector<StateToStateTransition>	getIncomingStateTransitions(State state) Returns the incoming StateTransitions for a specified State including the self-reference of a State.
java.util.Vector<StateToStateTransition>	getIncomingStateTransitions(State state, boolean includeSelfReferences) Returns the incoming StateTransitions for a specified State.
int	getIndexOfFlow(State state, java.lang.String interfaceID) Gets the index of the specified flow.
int	getIndexOfInputMeasurement(java.lang.String variableID) Gets the index of the AbstractInputMeasurement for the specified input measurement.
int	getIndexOfState(TechnicalInterfaceConfiguration tic, java.lang.String stateID) Returns the index of a State according to the specified TechnicalInterfaceConfiguration and the stateID.
int	getIndexOfStateTransition(State state, java.lang.String nextStateID) Returns the index of the specified state transition of a state.
int	getIndexOfTechnicalInterface(TechnicalInterfaceConfiguration tic, java.lang.String interfaceID) Returns the index of a TechnicalInterface according to the specified TechnicalInterfaceConfiguration and the interfaceID.
int	getIndexOfTechnicalInterfaceConfiguration(java.lang.String configID) Returns the index of a TechnicalInterfaceConfiguration according to the specified configID.
AbstractInputMeasurement	getInputMeasurement(java.lang.String variableID) Returns the specified input measurement if available.
java.util.List<AbstractInputMeasurement>	getInputMeasurements() Returns the list of AbstractInputMeasurement for the Evaluation.
java.util.Vector<java.lang.String>	getNewStateTransitionOpportunities(TechnicalInterfaceConfiguration tic, State currentState) Returns all remaining States-IDs that can be used for new StateTransitions.
ObjectFactory	getObjectFactory() Returns the object factory for the option model.
AbstractOptionModelCalculation	getOptionModelCalculation() Returns the actual configured instance of an AbstractOptionModelCalculation.
java.util.Vector<StateToStateTransition>	getOutgoingStateTransitions(State state) Returns the outgoing StateTransitions for a specified State including the self-reference of a State.
java.util.Vector<StateToStateTransition>	getOutgoingStateTransitions(State state, boolean includeSelfReferences) Returns the outgoing StateTransitions for a specified State.
SelectionModel	getSelectionModel() Returns the current selection model.
State	getState(TechnicalInterfaceConfiguration tic, java.lang.String stateID) Gets the specified state form a TechnicalInterfaceConfiguration.
Duration	getStateDuration(State state) Returns (and maybe creates and sets also) the duration of a given state.
long	getStateDurationFromTechnicalSystemState(TechnicalSystemState tss) Derives the state duration (in milliseconds) from a technical system state (with the current option model controller).
java.lang.Long	getStateDurationMax(java.lang.String configID) Returns the maximum state duration of the specified TechnicalInterfaceConfiguration.
java.lang.Long	getStateDurationMax(TechnicalInterfaceConfiguration tic) Returns the maximum state duration of the specified TechnicalInterfaceConfiguration.
static TimeUnit	getStateFormatTimeUnit(State state) Returns (and maybe creates and sets also) the format time unit from the specified state.
StateTransition	getStateTransition(State state, java.lang.String nextStateID) Gets the specified state transition.
java.io.Serializable	getStaticModelInstance(SystemVariableDefinitionStaticModel sysVarDefStaticModel) Returns the serializable, static model instance.
java.util.Vector<TechnicalInterface>	getStorageInterfaces(TechnicalInterfaceConfiguration tic) Returns all EnergyStorageInterface's or GoodStorageInterface's that are defined by the specified TechnicalInterfaceConfiguration.
TechnicalInterface	getTechnicalInterface(java.lang.String configID, java.lang.String interfaceID) Returns the TechnicalInterface for the specified ID's of the current TechnicalInterfaceConfiguration and the EnergyInterface.
TechnicalInterface	getTechnicalInterface(TechnicalInterfaceConfiguration tic, java.lang.String interfaceID) Gets the specified TechnicalInterface form a TechnicalInterfaceConfiguration.
TechnicalInterfaceConfiguration	getTechnicalInterfaceConfiguration(State state) Returns the appropriate TechnicalInterfaceConfiguration for a specified State.
TechnicalInterfaceConfiguration	getTechnicalInterfaceConfiguration(java.lang.String configID) Gets the technical interface configuration by the specified configID.
java.util.Vector<TechnicalInterface>	getTechnicalInterfacesByDomain(TechnicalInterfaceConfiguration tic, java.lang.String domain) Returns a Vector of TechnicalInterfaces that have the same domain.
java.util.Vector<TechnicalInterface>	getTechnicalInterfacesByDomainAndDomainModel(TechnicalInterfaceConfiguration tic, java.lang.String domain, AbstractDomainModel domainModel) Returns a Vector of TechnicalInterfaces that have the same domain and the same domain model.
java.util.Vector<EnergyInterface>	getTechnicalInterfacesByEnergyCarrier(TechnicalInterfaceConfiguration tic, EnergyCarrier energyCarrier) Returns a Vector of EnergyInterfaces that have the same EnergyCarrier.
TechnicalSystem	getTechnicalSystem() Gets the current TechnicalSystem.
TechnicalSystem	getTechnicalSystemCopy() Returns a copied instance of the current TechnicalSystem.
boolean	hasConfigurationErrors() Checks if the TechnicalSystem has configuration errors.
boolean	hasTechnicalSystemChanged() Checks if the TechnicalSystem has changed.
boolean	isClosable(java.awt.Component parentComponent) Checks and return if the current controller and its open file is closable.
void	loadTechnicalSystem(java.io.File fileToLoad, java.awt.Component parentComponent) Loads a TechnicalSystem file to this OptionModelController.
void	loadTechnicalSystemFromBundle(java.lang.String bundleName, java.lang.String fileReference, java.awt.Component parentComponent) Loads a TechnicalSystem from a bundle to this OptionModelController.
AbstractFlow	removeFlow(State state, AbstractFlow abstractFlow) Removes the specified flow.
AbstractFlow	removeFlow(State state, java.lang.String interfaceID) Removes the specified flow.
State	removeState(TechnicalInterfaceConfiguration tic, State state) Removes the specified state.
State	removeState(TechnicalInterfaceConfiguration tic, java.lang.String stateID) Removes the specified state from the TechnicalInterfaceConfiguration.
StateTransition	removeStateTransition(State state, StateTransition stateTransition) Removes a state transition.
StateTransition	removeStateTransition(State state, java.lang.String nextStateID) Removes the state transition.
TechnicalInterface	removeTechnicalInterface(TechnicalInterfaceConfiguration tic, java.lang.String interfaceID) Removes the specified TechnicalInterface from the TechnicalInterfaceConfiguration.
TechnicalInterface	removeTechnicalInterface(TechnicalInterfaceConfiguration tic, TechnicalInterface technicalInterface) Removes the specified TechnicalInterface from the TechnicalInterfaceConfiguration.
TechnicalInterfaceConfiguration	removeTechnicalInterfaceConfiguration(java.lang.String configID) Removes the specified technical interface configuration.
TechnicalInterfaceConfiguration	removeTechnicalInterfaceConfiguration(TechnicalInterfaceConfiguration tic) Removes the given TechnicalInterfaceConfiguration form the list of configurations.
boolean	renameState(TechnicalInterfaceConfiguration tic, java.lang.String oldStateID, java.lang.String newStateID) Renames a state at all points of the current TechnnicalSystem..
boolean	renameTechnicalInterface(TechnicalInterfaceConfiguration tic, java.lang.String oldInterfaceID, java.lang.String newInterfaceID, boolean instanceWasAlreadyRenamed) Renames a TechnicalInterface at all points of the current TechnnicalSystem.
boolean	renameTechnicalInterfaceConfiguration(java.lang.String oldConfigID, java.lang.String newConfigID) Renames a TechnicalInterfaceConfiguration at all points of the current TechnnicalSystem.
void	resetEvaluationCalculations() Resets the reminded AbstractEvaluationCalculation.
void	resetEvaluationProcess() Resets the current EvaluationProcess.
void	resetEvaluationProcess(boolean completeReset) Reset evaluation process.
void	resetEvaluationStrategy() Resets the current AbstractEvaluationStrategy
void	resetOptionModel() Resets the option model.
void	resetOptionModelCalculation() Resets the option model calculation.
void	resetSelectionModel() Resets the current SelectionModel to null.
void	resetStaticModelHash() Resets the static model hash that is a reminder for AbstractStaticModel instances.
boolean	saveechnicalSystemAs(java.awt.Container parentComponent) Save the current TechnicalSystem with an user interaction for choosing a file location.
boolean	saveTechnicalSystem(java.awt.Component parentComponent) Saves the current TechnicalSystem to the file specified in getCurrentFile().
void	setChangedAndNotifyObservers(java.lang.Object notification) Sets the current state to changed and notifies all observers in one step.
void	setConfigurationErrors(boolean configurationErrors) Sets that the current TechnicalSystem has configuration errors or not.
void	setControllingAgent(jade.core.Agent controllingAgent) Sets the controlling agent of this option model controller.
void	setControllingEntity(java.lang.Object controllingEntity) Sets the controlling entity of this option model controller.
void	setCostModel(CostModel newCostModel) Sets a new CostModel to the current TechnicalSystem.
void	setCurrentFile(java.io.File currentFile) Sets the current file.
void	setGroupController(GroupController groupController) Sets the current GroupController instance.
void	setInitialSelection() Sets the initial selection.
void	setInputMeasurement(AbstractInputMeasurement aim) Replaces or adds the specified input measurement.
boolean	setStateDuration(java.awt.Frame owner, State state, Duration newStateDuration, boolean adjustFormat) Sets the state duration.
boolean	setStateDuration(java.awt.Frame owner, State state, Duration newStateDuration, boolean adjustFormat, EnergyFlowMeasured currentEnergyFlowMeasured) Sets the state duration.
boolean	setStateDuration(java.awt.Frame owner, State state, Duration newStateDuration, boolean adjustFormat, GoodFlowMeasured currentGoodFlowMeasured) Sets the state duration.
void	setStaticModelInstance(SystemVariableDefinitionStaticModel sysVarDefStaticModel, java.io.Serializable newStaticModelValue) Sets the specified serializable, static model instance to a SystemVariableDefinitionStaticModel.
void	setTechnicalSystem(TechnicalSystem technicalSystem) Sets the technical system.
void	setTechnicalSystemReminder() Sets the technical system reminder in order to recognise changes in the model later on.
EnergyAmount	subtractEnergyAmount(EnergyAmount ea2SubbtractFrom, EnergyAmount eaSubtract) Subtracts the EnergyAmount instances.
EnergyAmount	sumUpEnergyAmounts(EnergyAmount ea2AddTo, EnergyAmount eaAddition) Sums up the two specified EnergyAmount's.
EnergyFlowInWatt	sumUpEnergyFlowInWatt(EnergyFlowInWatt ef2AddTo, EnergyFlowInWatt efAddition) Sums up the two specified EnergyFlowInWatt.
GoodFlow	sumUpGoodFlow(GoodFlow gf2AddTo, GoodFlow gfAddition) Sums up the two specified GoodFlow.
java.lang.String	toString()

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, wait, wait, wait

Constructor Detail

OptionModelControllerBase

public OptionModelControllerBase()

Instantiates a new option model controller.

Method Detail

getGroupController

public GroupController getGroupController()

Returns the GroupController, if used in a context of a group of TechnicalSystem's.

Returns:

the group controller

setGroupController

public void setGroupController(GroupController groupController)

Sets the current GroupController instance. This is only used in the context of an aggregation of several TechnicalSystem's.

Parameters:

groupController - the new group controller

setChangedAndNotifyObservers

public void setChangedAndNotifyObservers(java.lang.Object notification)

Description copied from interface: EomController

Sets the current state to changed and notifies all observers in one step.

Specified by:

setChangedAndNotifyObservers in interface EomController

Parameters:

notification - the new changed and notify observers

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getGlobalInfo

public GlobalInfo getGlobalInfo()

Returns the global info instance.

Returns:

the global info instance

getObjectFactory

public ObjectFactory getObjectFactory()

Returns the object factory for the option model.

Returns:

the object factory

getSelectionModel

public SelectionModel getSelectionModel()

Returns the current selection model.

Returns:

the selection model

resetSelectionModel

public void resetSelectionModel()

Resets the current SelectionModel to null.

setInitialSelection

public void setInitialSelection()

Sets the initial selection.

getEvaluationProcess

public EvaluationProcess getEvaluationProcess()

Returns or initiates the EvaluationProcess.

Returns:

the current evaluation process

resetEvaluationProcess

public void resetEvaluationProcess()

Resets the current EvaluationProcess.

resetEvaluationProcess

public void resetEvaluationProcess(boolean completeReset)

Reset evaluation process.

Parameters:

completeReset - the complete reset

setControllingEntity

public void setControllingEntity(java.lang.Object controllingEntity)

Sets the controlling entity of this option model controller.

Parameters:

controllingEntity - the new controlling entity

getControllingEntity

public java.lang.Object getControllingEntity()

Returns the controlling entity of this option model controller.

Returns:

the controlling entity instance

setControllingAgent

public void setControllingAgent(jade.core.Agent controllingAgent)

Sets the controlling agent of this option model controller.

Parameters:

controllingAgent - the new controlling agent

getControllingAgent

public jade.core.Agent getControllingAgent()

Returns the controlling agent of this option model controller..

Returns:

the controlling agent instance

loadTechnicalSystemFromBundle

public void loadTechnicalSystemFromBundle(java.lang.String bundleName,
                                          java.lang.String fileReference,
                                          java.awt.Component parentComponent)

Loads a TechnicalSystem from a bundle to this OptionModelController.

Parameters:

bundleName - the symbolic bundle name

fileReference - the file reference within the bundle

parentComponent - the parent component (may be null)

loadTechnicalSystem

public void loadTechnicalSystem(java.io.File fileToLoad,
                                java.awt.Component parentComponent)

Loads a TechnicalSystem file to this OptionModelController.

Parameters:

fileToLoad - the file to load

parentComponent - the parent component (may be null)

saveTechnicalSystem

public boolean saveTechnicalSystem(java.awt.Component parentComponent)

Saves the current TechnicalSystem to the file specified in getCurrentFile().

Parameters:

parentComponent - the parent component (may be null)

Returns:

true, if successful

See Also:

getCurrentFile(), setCurrentFile(File)

saveechnicalSystemAs

public boolean saveechnicalSystemAs(java.awt.Container parentComponent)

Save the current TechnicalSystem with an user interaction for choosing a file location.

Parameters:

parentComponent - the parent component (may be null)

Returns:

true, if successful

resetOptionModel

public void resetOptionModel()

Resets the option model.

setTechnicalSystemReminder

public void setTechnicalSystemReminder()

Sets the technical system reminder in order to recognise changes in the model later on.

hasTechnicalSystemChanged

public boolean hasTechnicalSystemChanged()

Checks if the TechnicalSystem has changed.

Returns:

true, if the TechnicalSystem has changed

isClosable

public boolean isClosable(java.awt.Component parentComponent)

Description copied from interface: EomController

Checks and return if the current controller and its open file is closable.

Specified by:

isClosable in interface EomController

Parameters:

parentComponent - the parent component that has the current focus (for user requests)

Returns:

true, if the current controller is closable

hasConfigurationErrors

public boolean hasConfigurationErrors()

Checks if the TechnicalSystem has configuration errors.

Returns:

true, if there are configuration errors

setConfigurationErrors

public void setConfigurationErrors(boolean configurationErrors)

Sets that the current TechnicalSystem has configuration errors or not.

Parameters:

configurationErrors - the new value configuration errors

setTechnicalSystem

public void setTechnicalSystem(TechnicalSystem technicalSystem)

Sets the technical system.

Parameters:

technicalSystem - the new technical system

getTechnicalSystem

public TechnicalSystem getTechnicalSystem()

Gets the current TechnicalSystem.

Returns:

the TechnicalSystem

getTechnicalSystemCopy

public TechnicalSystem getTechnicalSystemCopy()

Returns a copied instance of the current TechnicalSystem.

Returns:

the TechnicalSystem copy

setCurrentFile

public void setCurrentFile(java.io.File currentFile)

Sets the current file.

Parameters:

currentFile - the new current file

getCurrentFile

public java.io.File getCurrentFile()

Description copied from interface: EomController

Has to return the file object that is currently open in the controller.

Specified by:

getCurrentFile in interface EomController

Returns:

the file object

getEvaluationSettings

public EvaluationSettings getEvaluationSettings()

Returns the EvaluationSettings for the current TechnicalSystem.

Returns:

the evaluation settings

getEvaluationClassByClassName

public EvaluationClass getEvaluationClassByClassName(java.lang.String className)

Returns the EvaluationClass from the current EvaluationSettings that corresponds to the specified class name.

Parameters:

className - the class name

Returns:

the evaluation class by class name

getEvaluationClassByStrategyID

public EvaluationClass getEvaluationClassByStrategyID(java.lang.String strategyID)

Returns the EvaluationClass from the current EvaluationSettings that corresponds to the specified strategy ID.

Parameters:

strategyID - the strategy id

Returns:

the evaluation class by strategy id

setCostModel

public void setCostModel(CostModel newCostModel)

Sets a new CostModel to the current TechnicalSystem.

Parameters:

newCostModel - the new cost model

getCostModel

public CostModel getCostModel()

Returns the CostModel for the current TechnicalSystem.

Returns:

the cost model

getInputMeasurements

public java.util.List<AbstractInputMeasurement> getInputMeasurements()

Returns the list of AbstractInputMeasurement for the Evaluation.

Returns:

the input measurements

setInputMeasurement

public void setInputMeasurement(AbstractInputMeasurement aim)

Replaces or adds the specified input measurement.

Parameters:

aim - the new input measurement

getInputMeasurement

public AbstractInputMeasurement getInputMeasurement(java.lang.String variableID)

Returns the specified input measurement if available.

Parameters:

variableID - the variable ID

Returns:

the input measurement

getIndexOfInputMeasurement

public int getIndexOfInputMeasurement(java.lang.String variableID)

Gets the index of the AbstractInputMeasurement for the specified input measurement.

Parameters:

variableID - the variable ID

Returns:

the index of input measurement

createStaticModel

public AbstractStaticModel createStaticModel(SystemVariableDefinitionStaticModel sysVarDefStaticModel)

Creates and returns the AbstractStaticModel instance that is defined with the specified SystemVariableDefinitionStaticModel.

Parameters:

sysVarDefStaticModel - the SystemVariableDefinitionStaticModel to use

Returns:

the abstract static model

resetStaticModelHash

public void resetStaticModelHash()

Resets the static model hash that is a reminder for AbstractStaticModel instances.

getAbstractStaticModel

public AbstractStaticModel getAbstractStaticModel(SystemVariableDefinitionStaticModel sysVarDefStaticModel)

Returns the abstract static model, if specified, and will remind the instance for a further access.

Parameters:

sysVarDefStaticModel - the actual SystemVariableDefinitionStaticModel

Returns:

the abstract static model

getStaticModelInstance

public java.io.Serializable getStaticModelInstance(SystemVariableDefinitionStaticModel sysVarDefStaticModel)

Returns the serializable, static model instance.

Parameters:

sysVarDefStaticModel - the SystemVariableDefinitionStaticModel

Returns:

the static model instance as Object

setStaticModelInstance

public void setStaticModelInstance(SystemVariableDefinitionStaticModel sysVarDefStaticModel,
                                   java.io.Serializable newStaticModelValue)

Sets the specified serializable, static model instance to a SystemVariableDefinitionStaticModel.

Parameters:

sysVarDefStaticModel - the SystemVariableDefinitionStaticModel

newStaticModelValue - the new static model value as general Object

createOptionModelCalculation

public AbstractOptionModelCalculation createOptionModelCalculation()

Returns the a new instance of an option model calculation.

Returns:

new the option model calculation

getOptionModelCalculation

public AbstractOptionModelCalculation getOptionModelCalculation()

Returns the actual configured instance of an AbstractOptionModelCalculation.

Returns:

the options model calculation

resetOptionModelCalculation

public void resetOptionModelCalculation()

Resets the option model calculation.

getEvaluationStrategy

public AbstractEvaluationStrategy getEvaluationStrategy()

Returns the actual configured instance of an AbstractEvaluationStrategy.

Returns:

the evaluation strategy

resetEvaluationStrategy

public void resetEvaluationStrategy()

Resets the current AbstractEvaluationStrategy

createEvaluationStrategy

public AbstractEvaluationStrategy createEvaluationStrategy()

Creates and returns a new instance of the configured evaluation strategy.

Returns:

the evaluation strategy extending the class AbstractEvaluationCalculation

createEvaluationStrategy

public AbstractEvaluationStrategy createEvaluationStrategy(java.lang.String evaluationStrategyClassName)

Creates and returns a new instance of the configured evaluation strategy.

Parameters:

evaluationStrategyClassName - the class name of the evaluation strategy

Returns:

the evaluation strategy extending the class AbstractEvaluationCalculation

getEvaluationStrategyRT

public AbstractEvaluationStrategy getEvaluationStrategyRT()

Returns the instance of an extended AbstractEvaluationStrategy in case that the strategy is a real time strategy.
That means, for single TechnicalSystem's the class AbstractEvaluationStrategyRT had to be extended, while for TechnicalSystemGroup's, or aggregations respectively, an AbstractGroupEvaluationStrategyRT had to be extended. Further, those classes should be configured as default evaluation class for the system (group).

Returns:

the real time evaluation strategy, if configured as default evaluation strategy

getEvaluationCalculation

public AbstractEvaluationCalculation getEvaluationCalculation(java.lang.String evalCalcClass)

Returns the specified instance of an AbstractEvaluationCalculation.

Parameters:

evalCalcClass - the string reference to the extended AbstractEvaluationCalculation

Returns:

the initialised class for a calculated cost function

resetEvaluationCalculations

public void resetEvaluationCalculations()

Resets the reminded AbstractEvaluationCalculation.

createTechnicalInterfaceConfiguration

public TechnicalInterfaceConfiguration createTechnicalInterfaceConfiguration()

Creates a new TechnicalInterfaceConfiguration.

Returns:

a new TechnicalInterfaceConfiguration

getIndexOfTechnicalInterfaceConfiguration

public int getIndexOfTechnicalInterfaceConfiguration(java.lang.String configID)

Returns the index of a TechnicalInterfaceConfiguration according to the specified configID.

Parameters:

configID - the configuration id

Returns:

the index of the TechnicalInterfaceConfiguration

getTechnicalInterfaceConfiguration

public TechnicalInterfaceConfiguration getTechnicalInterfaceConfiguration(java.lang.String configID)

Gets the technical interface configuration by the specified configID.

Parameters:

configID - the configuration-id

Returns:

the technical interface configuration

getTechnicalInterfaceConfiguration

public TechnicalInterfaceConfiguration getTechnicalInterfaceConfiguration(State state)

Returns the appropriate TechnicalInterfaceConfiguration for a specified State.

Parameters:

state - the State

Returns:

the TechnicalInterfaceConfiguration

removeTechnicalInterfaceConfiguration

public TechnicalInterfaceConfiguration removeTechnicalInterfaceConfiguration(java.lang.String configID)

Removes the specified technical interface configuration.

Parameters:

configID - the configuration-id

Returns:

the technical interface configuration

removeTechnicalInterfaceConfiguration

public TechnicalInterfaceConfiguration removeTechnicalInterfaceConfiguration(TechnicalInterfaceConfiguration tic)

Removes the given TechnicalInterfaceConfiguration form the list of configurations.

Parameters:

tic - the TechnicalInterfaceConfiguration

Returns:

the removed TechnicalInterfaceConfiguration

renameTechnicalInterfaceConfiguration

public boolean renameTechnicalInterfaceConfiguration(java.lang.String oldConfigID,
                                                     java.lang.String newConfigID)

Renames a TechnicalInterfaceConfiguration at all points of the current TechnnicalSystem.

Parameters:

oldConfigID - the old config id

newConfigID - the new config id

Returns:

true, if successful

createTechnicalInterface

public TechnicalInterface createTechnicalInterface(TechnicalInterfaceConfiguration tic)

Creates a new EnergyInterface in compliance to the given TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

Returns:

the new TechnicalInterface

getIndexOfTechnicalInterface

public int getIndexOfTechnicalInterface(TechnicalInterfaceConfiguration tic,
                                        java.lang.String interfaceID)

Returns the index of a TechnicalInterface according to the specified TechnicalInterfaceConfiguration and the interfaceID.

Parameters:

tic - the TechnicalInterfaceConfiguration

interfaceID - the interface id

Returns:

the index of the TechnicalInterface

getTechnicalInterface

public TechnicalInterface getTechnicalInterface(TechnicalInterfaceConfiguration tic,
                                                java.lang.String interfaceID)

Gets the specified TechnicalInterface form a TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

interfaceID - the interface-id

Returns:

the state

getTechnicalInterface

public TechnicalInterface getTechnicalInterface(java.lang.String configID,
                                                java.lang.String interfaceID)

Returns the TechnicalInterface for the specified ID's of the current TechnicalInterfaceConfiguration and the EnergyInterface.

Parameters:

configID - the configID of the TechnicalInterfaceConfiguration

interfaceID - the interfaceID of the EnergyInterface

Returns:

the technical interface

removeTechnicalInterface

public TechnicalInterface removeTechnicalInterface(TechnicalInterfaceConfiguration tic,
                                                   java.lang.String interfaceID)

Removes the specified TechnicalInterface from the TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

interfaceID - the state id

Returns:

the removed state

removeTechnicalInterface

public TechnicalInterface removeTechnicalInterface(TechnicalInterfaceConfiguration tic,
                                                   TechnicalInterface technicalInterface)

Removes the specified TechnicalInterface from the TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

technicalInterface - the technical interface

Returns:

the removed state

renameTechnicalInterface

public boolean renameTechnicalInterface(TechnicalInterfaceConfiguration tic,
                                        java.lang.String oldInterfaceID,
                                        java.lang.String newInterfaceID,
                                        boolean instanceWasAlreadyRenamed)

Renames a TechnicalInterface at all points of the current TechnnicalSystem.

Parameters:

tic - the TechnicalInterfaceConfiguration

oldInterfaceID - the old interface id

newInterfaceID - the new interface id

instanceWasAlreadyRenamed - true, if the instance of the TechnnicalSystem was already renamed

Returns:

true, if successful

getTechnicalInterfacesByDomain

public java.util.Vector<TechnicalInterface> getTechnicalInterfacesByDomain(TechnicalInterfaceConfiguration tic,
                                                                           java.lang.String domain)

Returns a Vector of TechnicalInterfaces that have the same domain.

Parameters:

tic - the TechnicalInterfaceConfiguration

domain - the domain to search for

Returns:

the technical interfaces by the domain

getTechnicalInterfacesByEnergyCarrier

public java.util.Vector<EnergyInterface> getTechnicalInterfacesByEnergyCarrier(TechnicalInterfaceConfiguration tic,
                                                                               EnergyCarrier energyCarrier)

Returns a Vector of EnergyInterfaces that have the same EnergyCarrier.

Parameters:

tic - the TechnicalInterfaceConfiguration

energyCarrier - the EnergyCarrier

Returns:

the technical interface by energy carrier

getTechnicalInterfacesByDomainAndDomainModel

public java.util.Vector<TechnicalInterface> getTechnicalInterfacesByDomainAndDomainModel(TechnicalInterfaceConfiguration tic,
                                                                                         java.lang.String domain,
                                                                                         AbstractDomainModel domainModel)

Returns a Vector of TechnicalInterfaces that have the same domain and the same domain model.

Parameters:

tic - the TechnicalInterfaceConfiguration

domain - the domain to search for

domainModel - the domain model

Returns:

the technical interfaces by the domain

getDomain

public java.lang.String getDomain(TechnicalInterfaceConfiguration tic,
                                  java.lang.String interfaceID)

Returns the domain (String) for the specified TechnicalInterfaceConfiguration and the TechnicalInterface named by the interfaceID.

Parameters:

tic - the TechnicalInterfaceConfiguration

interfaceID - the interfaceID of the EnergyInterface

Returns:

the technical interface

getDomain

public java.lang.String getDomain(java.lang.String configID,
                                  java.lang.String interfaceID)

Returns the domain (String) for the specified ID's of TechnicalInterfaceConfiguration and TechnicalInterface.

Parameters:

configID - the configID of the TechnicalInterfaceConfiguration

interfaceID - the interfaceID of the EnergyInterface

Returns:

the technical interface

getEnergyCarrier

public EnergyCarrier getEnergyCarrier(TechnicalInterfaceConfiguration tic,
                                      java.lang.String interfaceID)

Returns the EnergyCarrier for the specified TechnicalInterfaceConfiguration and the EnergyInterface named by the interfaceID.

Parameters:

tic - the TechnicalInterfaceConfiguration

interfaceID - the interfaceID of the EnergyInterface

Returns:

the technical interface

getEnergyCarrier

public EnergyCarrier getEnergyCarrier(java.lang.String configID,
                                      java.lang.String interfaceID)

Returns the EnergyCarrier for the specified ID's of TechnicalInterfaceConfiguration and EnergyInterface.

Parameters:

configID - the configID of the TechnicalInterfaceConfiguration

interfaceID - the interfaceID of the EnergyInterface

Returns:

the technical interface

getStorageInterfaces

public java.util.Vector<TechnicalInterface> getStorageInterfaces(TechnicalInterfaceConfiguration tic)

Returns all EnergyStorageInterface's or GoodStorageInterface's that are defined by the specified TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

Returns:

the vector of defined EnergyStorageInterface's or GoodStorageInterface's

createState

public State createState(TechnicalInterfaceConfiguration tic)

Creates a new State in compliance to the given TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

Returns:

the new state

getIndexOfState

public int getIndexOfState(TechnicalInterfaceConfiguration tic,
                           java.lang.String stateID)

Returns the index of a State according to the specified TechnicalInterfaceConfiguration and the stateID.

Parameters:

tic - the TechnicalInterfaceConfiguration

stateID - the state id

Returns:

the index of the State

getState

public State getState(TechnicalInterfaceConfiguration tic,
                      java.lang.String stateID)

Gets the specified state form a TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

stateID - the state-id

Returns:

the state

removeState

public State removeState(TechnicalInterfaceConfiguration tic,
                         java.lang.String stateID)

Removes the specified state from the TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

stateID - the state id

Returns:

the removed state

removeState

public State removeState(TechnicalInterfaceConfiguration tic,
                         State state)

Removes the specified state.

Parameters:

tic - the TechnicalInterfaceConfiguration

state - the State

Returns:

the removed state

renameState

public boolean renameState(TechnicalInterfaceConfiguration tic,
                           java.lang.String oldStateID,
                           java.lang.String newStateID)

Renames a state at all points of the current TechnnicalSystem..

Parameters:

tic - the TechnicalInterfaceConfiguration

oldStateID - the old state id

newStateID - the new state id

Returns:

true, if successful

getIncomingStateTransitions

public java.util.Vector<StateToStateTransition> getIncomingStateTransitions(State state)

Returns the incoming StateTransitions for a specified State including the self-reference of a State.

Parameters:

state - the State

Returns:

the incoming StateToStateTransition

See Also:

getIncomingStateTransitions(State, boolean)

getIncomingStateTransitions

public java.util.Vector<StateToStateTransition> getIncomingStateTransitions(State state,
                                                                            boolean includeSelfReferences)

Returns the incoming StateTransitions for a specified State.

Parameters:

state - the State

includeSelfReferences - set true, if you want to include the self-reference of a State

Returns:

the incoming StateToStateTransition

getOutgoingStateTransitions

public java.util.Vector<StateToStateTransition> getOutgoingStateTransitions(State state)

Returns the outgoing StateTransitions for a specified State including the self-reference of a State.

Parameters:

state - the State

Returns:

the incoming StateToStateTransition

See Also:

getIncomingStateTransitions(State, boolean)

getOutgoingStateTransitions

public java.util.Vector<StateToStateTransition> getOutgoingStateTransitions(State state,
                                                                            boolean includeSelfReferences)

Returns the outgoing StateTransitions for a specified State.

Parameters:

state - the State

includeSelfReferences - set true, if you want to include the self-reference of a State

Returns:

the outgoing StateToStateTransition

getDuration

public Duration getDuration(AbstractOptionModelCalculation.DurationType durationType,
                            AbstractDuration abstractDuration,
                            TechnicalSystemStateEvaluation tsse)

Returns the actual Duration from the specified AbstractDuration in the context of the current system state, specified by the TechnicalSystemStateEvaluation. The system state may be null in case of a request for the type AbstractOptionModelCalculation.DurationType.StateDuration

Parameters:

durationType - the AbstractOptionModelCalculation.DurationType

abstractDuration - the actual AbstractDuration

tsse - the TechnicalSystemStateEvaluation

Returns:

the specified or calculated Duration

getNewStateTransitionOpportunities

public java.util.Vector<java.lang.String> getNewStateTransitionOpportunities(TechnicalInterfaceConfiguration tic,
                                                                             State currentState)

Returns all remaining States-IDs that can be used for new StateTransitions.

Parameters:

tic - the TechnicalInterfaceConfiguration

currentState - the current State

Returns:

the state transition opportunities

getIndexOfStateTransition

public int getIndexOfStateTransition(State state,
                                     java.lang.String nextStateID)

Returns the index of the specified state transition of a state.

Parameters:

state - the state

nextStateID - the next state id

Returns:

the index of state transition

getStateTransition

public StateTransition getStateTransition(State state,
                                          java.lang.String nextStateID)

Gets the specified state transition.

Parameters:

state - the state

nextStateID - the next state id

Returns:

the state transition

removeStateTransition

public StateTransition removeStateTransition(State state,
                                             java.lang.String nextStateID)

Removes the state transition.

Parameters:

state - the state

nextStateID - the next state id

Returns:

the state

removeStateTransition

public StateTransition removeStateTransition(State state,
                                             StateTransition stateTransition)

Removes a state transition.

Parameters:

state - the state

stateTransition - the state transition

Returns:

the state

getIndexOfFlow

public int getIndexOfFlow(State state,
                          java.lang.String interfaceID)

Gets the index of the specified flow.

Parameters:

state - the state

interfaceID - the interface id

Returns:

the index of the flow

getFlow

public AbstractFlow getFlow(State state,
                            java.lang.String interfaceID)

Returns the flow for the specified interface.

Parameters:

state - the state

interfaceID - the interface id

Returns:

the energy flow

removeFlow

public AbstractFlow removeFlow(State state,
                               java.lang.String interfaceID)

Removes the specified flow.

Parameters:

state - the state

interfaceID - the interface id

Returns:

the removed flow

removeFlow

public AbstractFlow removeFlow(State state,
                               AbstractFlow abstractFlow)

Removes the specified flow.

Parameters:

state - the state

abstractFlow - the energy flow

Returns:

the removed flow

copyEnergyFlowInWatt

public EnergyFlowInWatt copyEnergyFlowInWatt(EnergyFlowInWatt energyFlowInWatt)

Copies the specified EnergyFlowInWatt into a new instance.

Parameters:

energyFlowInWatt - the energy flow in watt

Returns:

the energy flow in watt

copyGoodFlow

public GoodFlow copyGoodFlow(GoodFlow goodFlow)

Copies the specified GoodFlow into a new instance.

Parameters:

goodFlow - the good flow to copy

Returns:

the energy flow in watt

sumUpEnergyFlowInWatt

public EnergyFlowInWatt sumUpEnergyFlowInWatt(EnergyFlowInWatt ef2AddTo,
                                              EnergyFlowInWatt efAddition)

Sums up the two specified EnergyFlowInWatt. For this, the specified EnergyUnitFactorPrefixSI of the second argument will be adjusted to the same values of the first argument.

Parameters:

ef2AddTo - the EnergyFlowInWatt where the addition value has to be added to

efAddition - the EnergyFlowInWatt which has to be added

Returns:

the summarised EnergyFlowInWatt

sumUpGoodFlow

public GoodFlow sumUpGoodFlow(GoodFlow gf2AddTo,
                              GoodFlow gfAddition)

Sums up the two specified GoodFlow. For this, the specified TimeUnit of the second argument will be adjusted to the same values of the first argument.

Parameters:

gf2AddTo - the GoodFlow where the addition value has to be added to

gfAddition - the GoodFlow which has to be added

Returns:

the summarised GoodFlow

copyEnergyAmount

public EnergyAmount copyEnergyAmount(EnergyAmount energyAmount)

Copies the specified energy amount into a new instance.

Parameters:

energyAmount - the energy amount

Returns:

the energy amount

sumUpEnergyAmounts

public EnergyAmount sumUpEnergyAmounts(EnergyAmount ea2AddTo,
                                       EnergyAmount eaAddition)

Sums up the two specified EnergyAmount's. For this, the specified EnergyUnitFactorPrefixSI and the TimeUnit of the second argument will be adjusted to the same values of the first argument.

Parameters:

ea2AddTo - the EnergyAmount where the addition value has to be added to

eaAddition - the EnergyAmount which has to be added

Returns:

the summarised EnergyAmount

subtractEnergyAmount

public EnergyAmount subtractEnergyAmount(EnergyAmount ea2SubbtractFrom,
                                         EnergyAmount eaSubtract)

Subtracts the EnergyAmount instances.

Parameters:

ea2SubbtractFrom - the EnergyAmount to subtract from

eaSubtract - the EnergyAmount that has to be subtracted

Returns:

the difference EnergyAmount

adjustEnergyFlowMeasuredToMilliseconds

public void adjustEnergyFlowMeasuredToMilliseconds(EnergyFlowMeasured efm,
                                                   long milliseconds)

Adjust energy flow measured to the specified milliseconds.

Parameters:

efm - the EnergyFlowMeasured

milliseconds - the milliseconds

adjustGoodFlowMeasuredToMilliseconds

public void adjustGoodFlowMeasuredToMilliseconds(GoodFlowMeasured gfm,
                                                 long milliseconds)

Adjust good flow measured to the specified milliseconds.

Parameters:

gfm - the GoodFlowMeasured

milliseconds - the milliseconds

getEnergyFlowInWattForEnergyFlowMeasuredAtRelativeTime

public EnergyFlowInWatt getEnergyFlowInWattForEnergyFlowMeasuredAtRelativeTime(EnergyFlowMeasured efm,
                                                                               long relativePointInTime)

Returns the EnergyFlowInWatt for the specified EnergyFlowMeasured at the time relative to the EnergyFlowMeasured.

Parameters:

efm - the EnergyFlowMeasured

relativePointInTime - the relative point in time

Returns:

the EnergyFlowInWatt for energy flow measured at relative time

getGoodFlowForGoodFlowMeasuredAtRelativeTime

public GoodFlow getGoodFlowForGoodFlowMeasuredAtRelativeTime(GoodFlowMeasured efm,
                                                             long relativePointInTime)

Returns the GoodFlow for the specified GoodFlowMeasured at the time relative to the GoodFlowMeasured.

Parameters:

efm - the GoodFlowMeasured

relativePointInTime - the relative point in time

Returns:

the GoodFlow for energy flow measured at relative time

getEnergyFlowInWattAverage

public EnergyFlowInWatt getEnergyFlowInWattAverage(EnergyFlowMeasured efm)

Returns the average EnergyFlowInWatt.

Parameters:

efm - the EnergyFlowMeasured

Returns:

the energy flow in watt average

getGoodFlowAverage

public GoodFlow getGoodFlowAverage(GoodFlowMeasured gfm,
                                   java.lang.String domainUnit)

Returns the average GoodFlow.

Parameters:

gfm - the GoodFlowMeasured

Returns:

the average good flow

setStateDuration

public boolean setStateDuration(java.awt.Frame owner,
                                State state,
                                Duration newStateDuration,
                                boolean adjustFormat)

Sets the state duration. The duration will always be saved in milliseconds, while the specified TimeUnit of the newStateDuration will change the appearance of the duration by using State.setFormatTimeUnit(TimeUnit).

Parameters:

owner - the owner frame, where messages are to be displayed. Can be set to null, too.

state - the state

newStateDuration - the new state duration

adjustFormat - the adjust format. If true, the format of the duration will be adjusted according to the TimeUnit of newStateDuration

Returns:

true, if successful

setStateDuration

public boolean setStateDuration(java.awt.Frame owner,
                                State state,
                                Duration newStateDuration,
                                boolean adjustFormat,
                                GoodFlowMeasured currentGoodFlowMeasured)

Sets the state duration. The duration will always be saved in milliseconds, while the specified TimeUnit of the newStateDuration will change the appearance of the duration by using State.setFormatTimeUnit(TimeUnit).

Parameters:

owner - the owner frame, where messages are to be displayed. Can be set to null, too.

state - the state

newStateDuration - the new state duration

adjustFormat - the adjust format. If true, the format of the duration will be adjusted according to the TimeUnit of newStateDuration

currentGoodFlowMeasured - the current GoodFlowMeasured, if this applies. Can be null

Returns:

true, if successful

setStateDuration

public boolean setStateDuration(java.awt.Frame owner,
                                State state,
                                Duration newStateDuration,
                                boolean adjustFormat,
                                EnergyFlowMeasured currentEnergyFlowMeasured)

Sets the state duration. The duration will always be saved in milliseconds, while the specified TimeUnit of the newStateDuration will change the appearance of the duration by using State.setFormatTimeUnit(TimeUnit).

Parameters:

owner - the owner frame, where messages are to be displayed. Can be set to null, too.

state - the state

newStateDuration - the new state duration

adjustFormat - the adjust format. If true, the format of the duration will be adjusted according to the TimeUnit of newStateDuration

currentEnergyFlowMeasured - the current EnergyFlowMeasured, if this applies. Can be null

Returns:

true, if successful

getStateDuration

public Duration getStateDuration(State state)

Returns (and maybe creates and sets also) the duration of a given state.

Parameters:

state - the state

Returns:

the state duration

getStateFormatTimeUnit

public static TimeUnit getStateFormatTimeUnit(State state)

Returns (and maybe creates and sets also) the format time unit from the specified state.

Parameters:

state - the state

Returns:

the state format time unit

getDurationAsIntegerDuration

public Duration getDurationAsIntegerDuration(Duration duration,
                                             TimeUnit highestTimeUnitToStartAt)

Returns the specified duration with the maximum TimUnit in order to have the number value of the Duration as an integer. As worst case this methods returns the Duration in milliseconds

Parameters:

duration - the duration

highestTimeUnitToStartAt - the highest time unit to start at

Returns:

the duration as integer duration

getStateDurationMax

public java.lang.Long getStateDurationMax(java.lang.String configID)

Returns the maximum state duration of the specified TechnicalInterfaceConfiguration.

Parameters:

configID - the configID of the TechnicalInterfaceConfiguration

Returns:

the maximum state duration

getStateDurationMax

public java.lang.Long getStateDurationMax(TechnicalInterfaceConfiguration tic)

Returns the maximum state duration of the specified TechnicalInterfaceConfiguration.

Parameters:

tic - the TechnicalInterfaceConfiguration

Returns:

the maximum state duration

getStateDurationFromTechnicalSystemState

public long getStateDurationFromTechnicalSystemState(TechnicalSystemState tss)

Derives the state duration (in milliseconds) from a technical system state (with the current option model controller).

Parameters:

tss - the technical system state

Returns:

the duration of the tss' state as milliseconds