energy.samples.calculations

Class ATestEvaluationCalculation

java.lang.Object

energy.calculations.AbstractEvaluationCalculation

energy.samples.calculations.ATestEvaluationCalculation

public class ATestEvaluationCalculation
extends AbstractEvaluationCalculation

This is just an example and test class for the EOM development.

Constructor Summary

Constructors

Constructor and Description
ATestEvaluationCalculation()

Method Summary

Modifier and Type	Method and Description
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.
CostFunctionDataSeries	getCostFunctionDataSeries(java.lang.String domain, Connectivity connectivity) Returns the actual CostFunctionDataSeries for the specified combination of EnergyCarrier and Connectivity.
InputMeasurement	getInputMeasurement(SystemVariableDefinition sysVarDef) Has to returns the actual InputMeasurement for the specified SystemVariableDefinition and within the current time range that is specified by AbstractEvaluationCalculation.getEvaluationTimeStart() and AbstractEvaluationCalculation.getEvaluationTimeEnd().
double	getStateCosts(TechnicalSystemStateEvaluation tsse) Returns the state costs for the specified TechnicalSystemStateEvaluation.
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 energy.calculations.AbstractEvaluationCalculation

getEvaluationTimeEnd, getEvaluationTimeStart, getNodeStateResolver, getOptionModelController, getOrCreateVariable, getVariable, setOptionModelController, setVariable

Methods inherited from class java.lang.Object

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

Constructor Detail

ATestEvaluationCalculation

public ATestEvaluationCalculation()

Method Detail

getInputMeasurement

public InputMeasurement getInputMeasurement(SystemVariableDefinition sysVarDef)

Description copied from class: AbstractEvaluationCalculation

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

Specified by:

getInputMeasurement in class AbstractEvaluationCalculation

Parameters:

sysVarDef - the SystemVariableDefinition

Returns:

the input measurement

See Also:

AbstractEvaluationCalculation.getOptionModelController(), AbstractEvaluationCalculation.getEvaluationTimeStart(), AbstractEvaluationCalculation.getEvaluationTimeEnd()

updateInputMeasurement

public void updateInputMeasurement(TechnicalSystemState tss,
                                   FixedVariable variableToUpdate)

Description copied from class: AbstractEvaluationCalculation

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.

Specified by:

updateInputMeasurement in class AbstractEvaluationCalculation

Parameters:

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

variableToUpdate - the variable to update

getCostFunctionDataSeries

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

Description copied from class: AbstractEvaluationCalculation

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

Specified by:

getCostFunctionDataSeries in class AbstractEvaluationCalculation

Parameters:

domain - the domain

connectivity - the Connectivity

Returns:

the CostFunctionDataSeries

See Also:

AbstractEvaluationCalculation.getOptionModelController(), AbstractEvaluationCalculation.getEvaluationTimeStart(), AbstractEvaluationCalculation.getEvaluationTimeEnd()

getAmountCosts

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

Description copied from class: AbstractEvaluationCalculation

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

Specified by:

getAmountCosts in class AbstractEvaluationCalculation

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 double getStateCosts(TechnicalSystemStateEvaluation tsse)

Description copied from class: AbstractEvaluationCalculation

Returns the state costs for the specified TechnicalSystemStateEvaluation.

Specified by:

getStateCosts in class AbstractEvaluationCalculation

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()