energy.evaluation

Class EvaluationTimeRangeReminder

java.lang.Object

energy.evaluation.EvaluationTimeRangeReminder

public class EvaluationTimeRangeReminder
extends java.lang.Object

The Class EvaluationTimeRangeReminder is a reminder class for InputMeasurement's and CostFunctionDataSeries's that are used within the evaluation of a TechnicalSystem. Especially if the DataRepetition in the EvaluationSettings is set to DataRepetition.DAILY this class will prevent recalculating an usable set of discrete values by applying a daily shift again and again. Overall, this will accelerate the evaluation process.

Constructor Summary

Constructors

Constructor and Description
EvaluationTimeRangeReminder(OptionModelController optionModelController, long evalStartTime, long evalEndTime) Instantiates a new evaluation range values.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Long>	getChangeEventTimesForMeasurements(long timeFrom, long timeTo) Returns the change event times for the measurements within the specified time range.
AbstractCostFunction	getCostFunction(java.lang.String domain, Connectivity connectivity) Returns the AbstractCostFunction for the specified domain in connection with the Connectivity.
CostFunctionDataSeries	getCostFunctionHistory(java.lang.String domain, Connectivity connectivity) Returns the CostFunctionDataSeries for the specified EnergyCarrier and the Connectivity.
long	getEvalEndTime() Returns the evaluation end time for this reminder instance.
long	getEvalStartTime() Returns the evaluation start time for this reminder instance.
AbstractInputMeasurement	getInputMeasurement(java.lang.String variableID) Returns the InputMeasurement of the current TechnicalSystem for the specified ID of a SystemVariableDefinition.
AbstractInputMeasurement	getInputMeasurement(SystemVariableDefinition sysVarDef) Returns the InputMeasurement for the specified SystemVariableDefinition.
FixedVariable	getInputMeasurement4PointInTime(TechnicalSystemState tss, java.lang.String variableID) Gets the measurement for the specified SystemVariableDefinition for the specified point in time in case that the variable is indeed a measurement value (SystemVariableDefinition.isSetPoint()==false).
java.util.List<FixedVariable>	getInputMeasurements(TechnicalSystemState technicalSystemState, boolean addDefaultMeasurementValueIfPredictionIsNotAvailable) Returns the list of FixedVariable's that contain the current InputMeasurement's for the specified TechnicalSystemState's global time.
void	setInputMeasurement(java.lang.String variableID, AbstractInputMeasurement aim) Sets the input measurement of the current system for the specified ID of a SystemVariableDefinition.
void	updateInputMeasurementsInIOList(TechnicalSystemState technicalSystemState) Updates the values for InputMeasurement's (measurements and user set points) in the specified TechnicalSystemState.

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluationTimeRangeReminder

public EvaluationTimeRangeReminder(OptionModelController optionModelController,
                                   long evalStartTime,
                                   long evalEndTime)

Instantiates a new evaluation range values.

Parameters:

optionModelController - the option model controller

evalStartTime - the evaluation start time

evalEndTime - the evaluation end time

Method Detail

getEvalStartTime

public long getEvalStartTime()

Returns the evaluation start time for this reminder instance.

Returns:

the evalStartTime

getEvalEndTime

public long getEvalEndTime()

Returns the evaluation end time for this reminder instance.

Returns:

the evalEndTime

setInputMeasurement

public void setInputMeasurement(java.lang.String variableID,
                                AbstractInputMeasurement aim)

Sets the input measurement of the current system for the specified ID of a SystemVariableDefinition.

Parameters:

variableID - the variable ID of the SystemVariableDefinition

aim - the actual instance input measurement

getInputMeasurement

public AbstractInputMeasurement getInputMeasurement(java.lang.String variableID)

Returns the InputMeasurement of the current TechnicalSystem for the specified ID of a SystemVariableDefinition.

Parameters:

variableID - the variable ID of the SystemVariableDefinition

Returns:

the input measurement

getInputMeasurement

public AbstractInputMeasurement getInputMeasurement(SystemVariableDefinition sysVarDef)

Returns the InputMeasurement for the specified SystemVariableDefinition.

Parameters:

sysVarDef - the SystemVariableDefinition

Returns:

the input measurement

getChangeEventTimesForMeasurements

public java.util.List<java.lang.Long> getChangeEventTimesForMeasurements(long timeFrom,
                                                                         long timeTo)

Returns the change event times for the measurements within the specified time range.

Parameters:

timeFrom - the time from

timeTo - the time to

Returns:

the change events for measurements

getCostFunction

public AbstractCostFunction getCostFunction(java.lang.String domain,
                                            Connectivity connectivity)

Returns the AbstractCostFunction for the specified domain in connection with the Connectivity.

Parameters:

domain - the domain

connectivity - the connectivity

Returns:

the cost function

getCostFunctionHistory

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

Returns the CostFunctionDataSeries for the specified EnergyCarrier and the Connectivity.

Parameters:

domain - the domain

connectivity - the connectivity

Returns:

the cost function

updateInputMeasurementsInIOList

public void updateInputMeasurementsInIOList(TechnicalSystemState technicalSystemState)

Updates the values for InputMeasurement's (measurements and user set points) in the specified TechnicalSystemState. Values will be updated with respect to the global time.

Parameters:

technicalSystemState - the technical system state

getInputMeasurements

public java.util.List<FixedVariable> getInputMeasurements(TechnicalSystemState technicalSystemState,
                                                          boolean addDefaultMeasurementValueIfPredictionIsNotAvailable)

Returns the list of FixedVariable's that contain the current InputMeasurement's for the specified TechnicalSystemState's global time.

Parameters:

technicalSystemState - the TechnicalSystemState

addDefaultMeasurementValueIfPredictionIsNotAvailable - set true, if a default value should be added in case of missing predictions for measurements

Returns:

the State IOList of FixedVariable.

getInputMeasurement4PointInTime

public FixedVariable getInputMeasurement4PointInTime(TechnicalSystemState tss,
                                                     java.lang.String variableID)

Gets the measurement for the specified SystemVariableDefinition for the specified point in time in case that the variable is indeed a measurement value (SystemVariableDefinition.isSetPoint()==false).

Parameters:

tss - the TechnicalSystemState

variableID - the variable id

Returns:

the measurement value as FixedVariable

See Also:

SystemVariableDefinition.isSetPoint(), FixedVariable, FixedBoolean, FixedInteger, FixedDouble