energy.evaluation

Class EvaluationProcess

java.lang.Object

energy.evaluation.EvaluationProcess

public class EvaluationProcess
extends java.lang.Object

The Class EvaluationProcess is the central class for the evaluation. Here the results will be recorded. Additionally, the process can execute a number of EvaluationThreads that can be used in order to accelerate the evaluation process.

Constructor Summary

Constructors

Constructor and Description
EvaluationProcess(OptionModelController optionModelController) Instantiates a new evaluation process.

Method Summary

Modifier and Type	Method and Description
void	addEvaluationProcessListener(EvaluationProcessListener epl) Adds an EvaluationProcessÖistener to the current Evaluation Process.
void	addEvaluationResult(Schedule schedule) Adds a result Schedule to the list of results.
void	addSubSchedules(Schedule resultSchedule, java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,Schedule> subScheduleHash) Adds/Reminds the sub results for the specified result schedule.
void	addTechnicalSystemStateEvaluationVectorToGraphForCostsOverTime(java.util.Vector<TechnicalSystemStateEvaluation> tsseSeriesVector, EvaluationGraph graph, EvaluationGraphNode sourceNode, AbstractEvaluationStrategy evalStrategy) Adds the subsequent states as specified in the given vector to the graph for costs over time.
long	getEndTime() Returns the evaluation end time.
EnergyAmount	getEnergyStorageLoadFromOptionModelCalculation(EnergyAmount storageLoadOld, DomainInterfaceFlows domainInterfaceFlows, long duration, TechnicalSystemStateEvaluation initialTSSE, TechnicalSystemStateEvaluation newTSSE) Returns the energy storage load from the OptionModelCalculation, if defined.
ScheduleList	getEvaluationResults() Returns the evaluation results as Vector of TechnicalSystemStateEvaluation.
EvaluationSettings	getEvaluationSettings() Returns the current EvaluationSettings.
java.util.List<TechnicalSystemStateTime>	getEvaluationStateList() Returns the evaluation state list.
protected java.util.Vector<EvaluationThread>	getEvaluationThreadsRunning() Gets the evaluation threads running.
EvaluationTimeRangeReminder	getEvaluationTimeRangeReminder() Returns the EvaluationTimeRangeReminder that contains CostFunctionDataSeries's and InputMeasurement's for the current evaluation time range.
java.lang.Double	getGoodStorageLoadFromOptionModelCalculation(java.lang.Double storageLoadOld, DomainInterfaceFlows domainInterfaceFlows, long duration, TechnicalSystemStateEvaluation initialTSSE, TechnicalSystemStateEvaluation newTSSE) Returns the energy storage load from the OptionModelCalculation, if defined.
EvaluationGraph	getGraphForDeltaCosts() Returns the graph for delta costs.
EvaluationGraph	getGraphForStateVariability() Returns the graph for state variability.
TechnicalSystemState	getInitialTechnicalSystemState() Gets the initial TechnicalSystemState.
TechnicalSystemStateEvaluation	getInitialTechnicalSystemStateEvaluation() Returns the initial TechnicalSystemStateEvaluation derived from the graph for costs over time, where the further evaluation has to start at.
TechnicalSystemStateEvaluation	getNextTechnicalSystemStateEvaluation(TechnicalSystemStateEvaluation tsseOld, TechnicalSystemStateDeltaEvaluation tssDeltaEvaluation) Applies, based on the specified old TechnicalSystemStateDeltaEvaluation, the given TechnicalSystemStateDeltaEvaluation and returns the resulting new TechnicalSystemStateEvaluation.
int	getNumberOfThreads() Gets the number of threads.
ScheduleController	getScheduleController() Returns the ScheduleSontroller that is responsible for the result of the evaluation process.
long	getStartTime() Returns the evaluation start time.
java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,Schedule>	getSubSchedules(Schedule resultSchedule) Returns the sub schedules for the specified resultSchedule.
java.util.Vector<TechnicalSystemStateEvaluation>	getTechnicalSystemStateEvaluationVector(TechnicalSystemState tssBluePrint, long newGlobalTime, long newStateTime, java.util.List<java.lang.Long> changeEvents, TechnicalSystemStateEvaluation startTSSE) Creates and returns a system state vector that is a vector of TechnicalSystemStateEvaluation over time.
java.lang.String	hasConfigurationErrors() Checks, if the current configuration has errors.
boolean	isReuseExistingResults() Checks if a new execution of EvaluationThread's can reuse already existing results.
boolean	isRunning() Checks if the Evaluation is running.
void	removeEvaluationProcessListener(EvaluationProcessListener epl) Removes an EvaluationProcessListener.
void	removeEvaluationResult(Schedule schedule) Removes the evaluation result.
void	resetEvaluationProcess() Reset evaluation process.
void	resetEvaluationProcess(boolean completeReset) Resets the current EvaluationProcess.
void	resetEvaluationResults() Resets the evaluation results.
void	resetInitialTechnicalSystemStateEvaluation() Resets the initial TechnicalSystemStateEvaluation that were derived from the graph for costs over time.
void	setEvaluationThreadFinished(EvaluationThread etFinished) Sets the evaluation thread finished.
void	setGraphForDeltaCosts(EvaluationGraph newGraphForEvaluationByDeltaCosts) Sets the graph for delta costs.
void	setGraphForStateVariability(EvaluationGraph newGraphForStateVariability) Sets the graph for state variability.
void	setInitialTechnicalSystemState(TechnicalSystemState newInitialTSS) Sets the initial technical system state.
void	setInitialTechnicalSystemStateEvaluation(TechnicalSystemStateEvaluation newInitialTechnicalSystemStateEvaluation) Sets the initial technical system state evaluation.
void	setNumberOfThreads(int numberOfThreads) Sets the number of threads.
void	setReuseExistingResults(boolean reuseExistingResults) Sets if a new execution of EvaluationThread's can reuse existing results.
protected void	setRunning(boolean running) Sets the running.
void	startEvaluation() Starts the evaluation process by using the default strategy and the number of threads that can be configured.
void	startEvaluationByEvaluationClasses(java.util.Vector<EvaluationClass> evaluationClassVector) Starts the evaluation process with the specified strategy classes.
void	startEvaluationByStrategyClasses(java.util.Vector<java.lang.String> strategyClassVector) Starts the evaluation process with the specified strategy classes.
void	startEvaluationByStrategyIDs(java.util.Vector<java.lang.String> strategyIdVector) Starts the evaluation process with the specified vector of strategy ID's.
void	startEvaluationThread() Starts an EvaluationThread that uses the default evaluation strategy .
void	startEvaluationThread(java.lang.String strategyClassReference) Starts an EvaluationThread that uses the specified class of the type AbstractEvaluationStrategy.
void	stopEvaluation() Stops the evaluation process.
boolean	updateToValidStorageLoadsForStateIdentificationIfNeeded(TechnicalSystemStateDeltaEvaluation deltaStep) Updates the storage loads for the state identification, if needed.

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluationProcess

public EvaluationProcess(OptionModelController optionModelController)

Instantiates a new evaluation process.

Parameters:

optionModelController - the option model controller

Method Detail

addEvaluationProcessListener

public void addEvaluationProcessListener(EvaluationProcessListener epl)

Adds an EvaluationProcessÖistener to the current Evaluation Process.

Parameters:

epl - the new EvaluationProcessListener

removeEvaluationProcessListener

public void removeEvaluationProcessListener(EvaluationProcessListener epl)

Removes an EvaluationProcessListener.

Parameters:

epl - the EvaluationProcessListener

isReuseExistingResults

public boolean isReuseExistingResults()

Checks if a new execution of EvaluationThread's can reuse already existing results.

Returns:

true, if is reuse existing results

setReuseExistingResults

public void setReuseExistingResults(boolean reuseExistingResults)

Sets if a new execution of EvaluationThread's can reuse existing results.

Parameters:

reuseExistingResults - the new reuse existing results

getNumberOfThreads

public int getNumberOfThreads()

Gets the number of threads.

Returns:

the number of threads

setNumberOfThreads

public void setNumberOfThreads(int numberOfThreads)

Sets the number of threads.

Parameters:

numberOfThreads - the new number of threads

isRunning

public boolean isRunning()

Checks if the Evaluation is running.

Returns:

true, if is running

setRunning

protected void setRunning(boolean running)

Sets the running.

Parameters:

running - the new running

getEvaluationThreadsRunning

protected java.util.Vector<EvaluationThread> getEvaluationThreadsRunning()

Gets the evaluation threads running.

Returns:

the evaluation threads running

getScheduleController

public ScheduleController getScheduleController()

Returns the ScheduleSontroller that is responsible for the result of the evaluation process.

Returns:

the schedule controller

getEvaluationResults

public ScheduleList getEvaluationResults()

Returns the evaluation results as Vector of TechnicalSystemStateEvaluation.

Returns:

the result Vector with instances of TechnicalSystemStateEvaluation found

addEvaluationResult

public void addEvaluationResult(Schedule schedule)

Adds a result Schedule to the list of results.

Parameters:

schedule - the Schedule to add

removeEvaluationResult

public void removeEvaluationResult(Schedule schedule)

Removes the evaluation result.

Parameters:

schedule - the Schedule to remove

resetEvaluationResults

public void resetEvaluationResults()

Resets the evaluation results.

addSubSchedules

public void addSubSchedules(Schedule resultSchedule,
                            java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,Schedule> subScheduleHash)

Adds/Reminds the sub results for the specified result schedule. (For the handling a TechnicalSystemGroup only!)

Parameters:

resultSchedule - the result schedule

subScheduleHash - the sub schedule hash

getSubSchedules

public java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,Schedule> getSubSchedules(Schedule resultSchedule)

Returns the sub schedules for the specified resultSchedule. (For the handling a TechnicalSystemGroup only!)

Parameters:

resultSchedule - the result schedule

Returns:

the sub schedules

resetEvaluationProcess

public void resetEvaluationProcess()

Reset evaluation process.

resetEvaluationProcess

public void resetEvaluationProcess(boolean completeReset)

Resets the current EvaluationProcess.

Parameters:

completeReset - the completely

startEvaluationByStrategyIDs

public void startEvaluationByStrategyIDs(java.util.Vector<java.lang.String> strategyIdVector)

Starts the evaluation process with the specified vector of strategy ID's.

Parameters:

strategyIdVector - the vector of strategy ID's

startEvaluationByEvaluationClasses

public void startEvaluationByEvaluationClasses(java.util.Vector<EvaluationClass> evaluationClassVector)

Starts the evaluation process with the specified strategy classes.

Parameters:

evaluationClassVector - the vector of EvaluationClass instances

startEvaluationByStrategyClasses

public void startEvaluationByStrategyClasses(java.util.Vector<java.lang.String> strategyClassVector)

Starts the evaluation process with the specified strategy classes.

Parameters:

strategyClassVector - the strategy class vector

startEvaluation

public void startEvaluation()

Starts the evaluation process by using the default strategy and the number of threads that can be configured.

See Also:

setNumberOfThreads(int), getNumberOfThreads()

startEvaluationThread

public void startEvaluationThread()

Starts an EvaluationThread that uses the default evaluation strategy .

startEvaluationThread

public void startEvaluationThread(java.lang.String strategyClassReference)

Starts an EvaluationThread that uses the specified class of the type AbstractEvaluationStrategy. If the class reference is null, the default evaluation strategy will be used.

Parameters:

strategyClassReference - the strategy class reference to be uses in a thread

setEvaluationThreadFinished

public void setEvaluationThreadFinished(EvaluationThread etFinished)

Sets the evaluation thread finished.

Parameters:

etFinished - the new evaluation thread finished

stopEvaluation

public void stopEvaluation()

Stops the evaluation process.

getEvaluationSettings

public EvaluationSettings getEvaluationSettings()

Returns the current EvaluationSettings.

Returns:

the evaluation settings

getEvaluationStateList

public java.util.List<TechnicalSystemStateTime> getEvaluationStateList()

Returns the evaluation state list.

Returns:

the evaluation state list

getStartTime

public long getStartTime()

Returns the evaluation start time.

Returns:

the startTime

getEndTime

public long getEndTime()

Returns the evaluation end time.

Returns:

the endTime

hasConfigurationErrors

public java.lang.String hasConfigurationErrors()

Checks, if the current configuration has errors.

Returns:

a string containing the actual error description

getEvaluationTimeRangeReminder

public EvaluationTimeRangeReminder getEvaluationTimeRangeReminder()

Returns the EvaluationTimeRangeReminder that contains CostFunctionDataSeries's and InputMeasurement's for the current evaluation time range. In order to accelerate the evaluation, it is strongly recommended to use this method for accessing InputMeasurement's and CostFunctionDataSeries's!

Returns:

the evaluation time range reminder

getGraphForStateVariability

public EvaluationGraph getGraphForStateVariability()

Returns the graph for state variability.

Returns:

the graph for state variability

setGraphForStateVariability

public void setGraphForStateVariability(EvaluationGraph newGraphForStateVariability)

Sets the graph for state variability.

Parameters:

newGraphForStateVariability - the new graph for state variability

getGraphForDeltaCosts

public EvaluationGraph getGraphForDeltaCosts()

Returns the graph for delta costs.

Returns:

the graph for delta costs

setGraphForDeltaCosts

public void setGraphForDeltaCosts(EvaluationGraph newGraphForEvaluationByDeltaCosts)

Sets the graph for delta costs.

Parameters:

newGraphForEvaluationByDeltaCosts - the new graph for delta costs

getInitialTechnicalSystemState

public TechnicalSystemState getInitialTechnicalSystemState()

Gets the initial TechnicalSystemState.

Returns:

the initialTechnicalSystemState

setInitialTechnicalSystemState

public void setInitialTechnicalSystemState(TechnicalSystemState newInitialTSS)

Sets the initial technical system state.

getInitialTechnicalSystemStateEvaluation

public TechnicalSystemStateEvaluation getInitialTechnicalSystemStateEvaluation()

Returns the initial TechnicalSystemStateEvaluation derived from the graph for costs over time, where the further evaluation has to start at. This considers also the case that an initial TechnicalSystemState was configured whose state time (see TechnicalSystemState.getStateTime()) is smaller than the duration of the state (see State.getDuration()).

Returns:

the initial TechnicalSystemStateEvaluation, where the further evaluation has to start at.

setInitialTechnicalSystemStateEvaluation

public void setInitialTechnicalSystemStateEvaluation(TechnicalSystemStateEvaluation newInitialTechnicalSystemStateEvaluation)

Sets the initial technical system state evaluation.

Parameters:

newInitialTechnicalSystemStateEvaluation - the new initial technical system state evaluation

resetInitialTechnicalSystemStateEvaluation

public void resetInitialTechnicalSystemStateEvaluation()

Resets the initial TechnicalSystemStateEvaluation that were derived from the graph for costs over time.

getTechnicalSystemStateEvaluationVector

public java.util.Vector<TechnicalSystemStateEvaluation> getTechnicalSystemStateEvaluationVector(TechnicalSystemState tssBluePrint,
                                                                                                long newGlobalTime,
                                                                                                long newStateTime,
                                                                                                java.util.List<java.lang.Long> changeEvents,
                                                                                                TechnicalSystemStateEvaluation startTSSE)

Creates and returns a system state vector that is a vector of TechnicalSystemStateEvaluation over time. This method considers changes of measurements in the specified time range and produces part steps, if required.

Parameters:

tssBluePrint - the blue print for the TechnicalSystemStateEvaluation to produce

newGlobalTime - the new global time

newStateTime - the new state time

changeEvents - the change events for the partitioning of the system states

startTSSE - the start TSSE

Returns:

the vector of TechnicalSystemStateEvaluation

addTechnicalSystemStateEvaluationVectorToGraphForCostsOverTime

public void addTechnicalSystemStateEvaluationVectorToGraphForCostsOverTime(java.util.Vector<TechnicalSystemStateEvaluation> tsseSeriesVector,
                                                                           EvaluationGraph graph,
                                                                           EvaluationGraphNode sourceNode,
                                                                           AbstractEvaluationStrategy evalStrategy)

Adds the subsequent states as specified in the given vector to the graph for costs over time.

Parameters:

tsseSeriesVector - the TechnicalSystemStateEvaluation series vector to add

sourceNode - the source node

evalStrategy - the current evaluation strategy

updateToValidStorageLoadsForStateIdentificationIfNeeded

public boolean updateToValidStorageLoadsForStateIdentificationIfNeeded(TechnicalSystemStateDeltaEvaluation deltaStep)

Updates the storage loads for the state identification, if needed. This will update the StorageLoadEnergy of the new TechnicalSystemStateEvaluation if the EnergyStorageInterface's and the corresponding loads are configured so.

Parameters:

deltaStep - the TechnicalSystemStateDeltaEvaluation to use for the update

Returns:

true, if not necessary or if the storage level was not exceeded

See Also:

TechnicalSystemStateDeltaEvaluation.getTechnicalSystemStateEvaluation(), TechnicalSystemStateEvaluation.getParent(), EnergyStorageInterface.isStateIdentifier(), EnergyStorageInterface.getStateIdentifierPrecision(), TechnicalSystemState.getStorageLoads()

getNextTechnicalSystemStateEvaluation

public TechnicalSystemStateEvaluation getNextTechnicalSystemStateEvaluation(TechnicalSystemStateEvaluation tsseOld,
                                                                            TechnicalSystemStateDeltaEvaluation tssDeltaEvaluation)

Applies, based on the specified old TechnicalSystemStateDeltaEvaluation, the given TechnicalSystemStateDeltaEvaluation and returns the resulting new TechnicalSystemStateEvaluation.
In case that one of the both parameter is null, the method also returns null.

Parameters:

tsseOld - the initial/old TechnicalSystemStateDeltaEvaluation

tssDeltaEvaluation - the TechnicalSystemStateDeltaEvaluation to apply

Returns:

the next/new TechnicalSystemStateEvaluation

getEnergyStorageLoadFromOptionModelCalculation

public EnergyAmount getEnergyStorageLoadFromOptionModelCalculation(EnergyAmount storageLoadOld,
                                                                   DomainInterfaceFlows domainInterfaceFlows,
                                                                   long duration,
                                                                   TechnicalSystemStateEvaluation initialTSSE,
                                                                   TechnicalSystemStateEvaluation newTSSE)

Returns the energy storage load from the OptionModelCalculation, if defined.

Parameters:

storageLoadOld - the storage load old

domainInterfaceFlows - the domain interface flows

duration - the duration

initialTSSE - [contains further optional parameter that might be useful for specific storages and related calculations]
the initial TSSE that represents the system state from which the calculation will be executed. Also contains the old storage load, but provides further information.

newTSSE - [contains further optional parameter that might be useful for specific storages and related calculations]
the new TSSE to which the new storage load will be assigned

Returns:

the energy storage load from option model calculation

getGoodStorageLoadFromOptionModelCalculation

public java.lang.Double getGoodStorageLoadFromOptionModelCalculation(java.lang.Double storageLoadOld,
                                                                     DomainInterfaceFlows domainInterfaceFlows,
                                                                     long duration,
                                                                     TechnicalSystemStateEvaluation initialTSSE,
                                                                     TechnicalSystemStateEvaluation newTSSE)

Returns the energy storage load from the OptionModelCalculation, if defined.

Parameters:

storageLoadOld - the storage load old

domainInterfaceFlows - the domain interface flows

duration - the duration

initialTSSE - [contains further optional parameter that might be useful for specific storages and related calculations]
the initial TSSE that represents the system state from which the calculation will be executed. Also contains the old storage load, but provides further information.

newTSSE - [contains further optional parameter that might be useful for specific storages and related calculations]
the new TSSE to which the new storage load will be assigned

Returns:

the energy storage load from option model calculation