energy.calculations

Class AbstractEvaluationCalculation

java.lang.Object

energy.calculations.AbstractEvaluationCalculation

Direct Known Subclasses:

ATestEvaluationCalculation

public abstract class AbstractEvaluationCalculation
extends java.lang.Object

The Class AbstractEvaluationCalculation can be extended in order to define one or several InputMeasurementCalculatedSeries as function for the evaluation settings for a TechnicalSystem.

Additionally, the class can be extended in order to define one or several CostFunctionCalculated as cost function for the CostModel and specific combinations of EnergyCarrier and Connectivity.

See Also:

TechnicalSystem, TechnicalSystem.getEvaluationSettings(), EvaluationSettings, EvaluationSettings.getInputMeasurements(), AbstractInputMeasurement, InputMeasurementCalculatedSeries, EvaluationSettings.getCostModel(), CostModel.getCostFunctions(), EnergyCarrier, Connectivity

Constructor Summary

Constructors

Constructor and Description
AbstractEvaluationCalculation()

Method Summary

Modifier and Type	Method and Description
abstract double	getAmountCosts(TechnicalInterface ti, Connectivity connectivity, long time1, long time2, double flowValue1, double flowValue2) Should return the costs for the amount of energy or a good/commodity of the specified TechnicalInterface.
abstract CostFunctionDataSeries	getCostFunctionDataSeries(java.lang.String domain, Connectivity connectivity) Returns the actual CostFunctionDataSeries for the specified combination of EnergyCarrier and Connectivity.
protected long	getEvaluationTimeEnd() Returns the configured evaluation end time.
protected long	getEvaluationTimeStart() Returns the configured evaluation start time.
abstract InputMeasurement	getInputMeasurement(SystemVariableDefinition sysVarDef) Has to returns the actual InputMeasurement for the specified SystemVariableDefinition and within the current time range that is specified by getEvaluationTimeStart() and getEvaluationTimeEnd().
NodeStatesResolver	getNodeStateResolver() Gets the node state resolver.
OptionModelController	getOptionModelController() Returns the current OptionModelController.
protected FixedVariable	getOrCreateVariable(java.util.List<FixedVariable> fixedVariableList, java.lang.String variableID) Gets or creates the specified variable.
abstract double	getStateCosts(TechnicalSystemStateEvaluation tsse) Returns the state costs for the specified TechnicalSystemStateEvaluation.
protected FixedVariable	getVariable(java.util.List<FixedVariable> fixedVariableList, java.lang.String variableID) Returns the specified FixedVariable out of the list of FixedVariable's.
void	setOptionModelController(OptionModelController optionModelController) Sets the current OptionModelController.
protected void	setVariable(java.util.List<FixedVariable> fixedVariableList, java.lang.String variableID, FixedVariable newValue) Sets a new value for the specified FixedVariable.
abstract void	updateInputMeasurement(TechnicalSystemState tss, FixedVariable variableToUpdate) Will be invoked in case that a predicted value should be updated depending on time and the actual state of a system.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEvaluationCalculation

public AbstractEvaluationCalculation()

Method Detail

setOptionModelController

public void setOptionModelController(OptionModelController optionModelController)

Sets the current OptionModelController.

Parameters:

optionModelController - the new option model controller

getOptionModelController

public OptionModelController getOptionModelController()

Returns the current OptionModelController.

Returns:

the option model controller

getNodeStateResolver

public NodeStatesResolver getNodeStateResolver()

Gets the node state resolver.

Returns:

the node state resolver

getEvaluationTimeStart

protected long getEvaluationTimeStart()

Returns the configured evaluation start time.

Returns:

the evaluation start time

getEvaluationTimeEnd

protected long getEvaluationTimeEnd()

Returns the configured evaluation end time.

Returns:

the evaluation end time

getVariable

protected FixedVariable getVariable(java.util.List<FixedVariable> fixedVariableList,
                                    java.lang.String variableID)

Returns the specified FixedVariable out of the list of FixedVariable's.

Parameters:

fixedVariableList - the list of FixedVariable'

variableID - the ID of the variable

Returns:

the fixed variable found or null

getOrCreateVariable

protected FixedVariable getOrCreateVariable(java.util.List<FixedVariable> fixedVariableList,
                                            java.lang.String variableID)

Gets or creates the specified variable.

Parameters:

fixedVariableList - the fixed variable list

variableID - the variable ID

Returns:

the or create variable

setVariable

protected void setVariable(java.util.List<FixedVariable> fixedVariableList,
                           java.lang.String variableID,
                           FixedVariable newValue)

Sets a new value for the specified FixedVariable.

Parameters:

fixedVariableList - the list of FixedVariable'

variableID - the ID of the variable

newValue - the new value as FixedVariable

getInputMeasurement

public abstract InputMeasurement getInputMeasurement(SystemVariableDefinition sysVarDef)

Has to returns the actual InputMeasurement for the specified SystemVariableDefinition and within the current time range that is specified by getEvaluationTimeStart() and getEvaluationTimeEnd().

Parameters:

sysVarDef - the SystemVariableDefinition

Returns:

the input measurement

See Also:

getOptionModelController(), getEvaluationTimeStart(), getEvaluationTimeEnd()

updateInputMeasurement

public abstract void updateInputMeasurement(TechnicalSystemState tss,
                                            FixedVariable variableToUpdate)

Will be invoked in case that a predicted value should be updated depending on time and the actual state of a system. Such configuration can be done within the setup for the evaluation process.

Parameters:

tss - the current TechnicalSystemState containing time, current I/O settings and other

variableToUpdate - the variable to update

getCostFunctionDataSeries

public abstract CostFunctionDataSeries getCostFunctionDataSeries(java.lang.String domain,
                                                                 Connectivity connectivity)

Returns the actual CostFunctionDataSeries for the specified combination of EnergyCarrier and Connectivity.

Parameters:

domain - the domain

connectivity - the Connectivity

Returns:

the CostFunctionDataSeries

See Also:

getOptionModelController(), getEvaluationTimeStart(), getEvaluationTimeEnd()

getAmountCosts

public abstract double getAmountCosts(TechnicalInterface ti,
                                      Connectivity connectivity,
                                      long time1,
                                      long time2,
                                      double flowValue1,
                                      double flowValue2)

Should return the costs for the amount of energy or a good/commodity of the specified TechnicalInterface.

Parameters:

ti - the TechnicalInterface to consider

connectivity - the connectivity that describes the actual flow direction

time1 - the time range start (possibly not required)

time2 - the time range final (possibly not required)

flowValue1 - the flow value at start time (possibly not required)

flowValue2 - the flow value at final time (possibly not required)

Returns:

the costs for the specified energy flow over time

getStateCosts

public abstract double getStateCosts(TechnicalSystemStateEvaluation tsse)

Returns the state costs for the specified TechnicalSystemStateEvaluation.

Parameters:

tsse - the TechnicalSystemStateEvaluation

Returns:

the state costs as double value (think of the defined cost unit in the cost model here!)

See Also:

CostModel, CostModel.getStateCostFunction(), CostModel.getCostUnit()