energygroup.evaluation

Class AbstractGroupEvaluationStrategy

java.lang.Object

energy.evaluation.AbstractEvaluationStrategy

energygroup.evaluation.AbstractGroupEvaluationStrategy

Direct Known Subclasses:

AbstractGroupEvaluationStrategyRT, FallBackGroupStrategy, MyGroupEvaluationStrategy, SmartHouseStrategy, VppMicroCHP

public abstract class AbstractGroupEvaluationStrategy
extends AbstractEvaluationStrategy

The Class AbstractGroupEvaluationStrategy represents the super class for all group evaluation strategies that are to be applied for specific TechnicalSystemGroup's. Consequently, it has to be extend in order to create a customised evaluation strategy.

Field Summary

Fields inherited from class energy.evaluation.AbstractEvaluationStrategy

evaluationStart, optionModelController

Constructor Summary

Constructors

Constructor and Description
AbstractGroupEvaluationStrategy(OptionModelController optionModelController) Instantiates a new abstract group evaluation strategy.

Method Summary

Modifier and Type	Method and Description
Schedule	addStateToResults(TechnicalSystemStateEvaluation tsStateEval) Adds the specified, final TechnicalSystemStateEvaluation state to the result list of the EvaluationProcess and returns the created Schedule.
abstract FlowsMeasuredGroupMember	doNetworkCalculation(javax.swing.tree.DefaultMutableTreeNode currentParentNode, java.util.List<TechnicalInterface> outerInterfaces, FlowsMeasuredGroup fmGroup) Will be invoked, if a network calculation is required.
void	executeEvaluation() Executes the customized evaluation process by calling the abstract method AbstractEvaluationStrategy.runEvaluation().
protected boolean	executeSubEvaluationStrategies() Executes all sub evaluation strategies and returns if they are finished.
protected EvaluationGraph	getGraphForDeltaCosts() Returns the graph for delta costs.
GroupCalculation	getGroupCalculation() Returns the current, local GroupCalculation that belongs to the current group evaluation strategy.
protected GroupController	getGroupController() Returns the GroupController that manages the current TechnicalSystemGroup.
java.lang.Object	getOutNodeState(CalculationStepNode<?> calculationStepNode, TechnicalSystemStateEvaluation tsse, java.util.Vector<?> nextCalcStepNodes) Has to return the out node state after calculations were executed and decisions were made.
java.lang.Object	getOutNodeState(CalculationStepNode<?> calculationStepNode, java.util.Vector<?> nextCalcStepNodes) Returns the out node state for a single CalculationStepNode within a sequential network calculation (DO NOT OVERWRITE!).
abstract AbstractSequentialNetworkCalculation<?>	getSequentialNetworkCalculation() Can be used in order to define an individual sequential network calculation by an extended AbstractSequentialNetworkCalculation and thus a AbstractGroupTreeAction.GroupTreeTraversal within an extended AbstractGroupTreeAction.
boolean	isUsingSubStrategies() Checks if the current evaluation strategy is using sub strategies.
abstract Schedule	meetDecisionForScheduleList(javax.swing.tree.DefaultMutableTreeNode currentNode, GroupTreeNodeObject gtno, ScheduleList scheduleList) Meet decision for group member that is a ScheduleList.
abstract TechnicalSystemStateDeltaEvaluation	meetDecisionForTechnicalSystem(javax.swing.tree.DefaultMutableTreeNode currentNode, GroupTreeNodeObject gtno, java.util.Vector<TechnicalSystemStateDeltaEvaluation> deltaSteps) Meet decision for a group member that is a TechnicalSystem.
protected void	setGraphForDeltaCosts(EvaluationGraph newGraphForEvaluationByDeltaCosts) Sets the graph for delta costs.
protected void	setUsingSubStrategies(boolean usingSubStrategies) Sets that sub strategies are used for the current evaluation strategy.

Methods inherited from class energy.evaluation.AbstractEvaluationStrategy

addStateToResults, calculateAndSetStateCosts, convertToTechnicalSystemStateEvaluation, copyEnergyAmount, copyEnergyFlowInWatt, copyStorageLoad, copyTechnicalSystemState, copyTechnicalSystemState, getAllDeltaEvaluationsStartingFromTechnicalSystemState, getAllDeltaEvaluationsStartingFromTechnicalSystemState, getAllDeltaEvaluationsStartingFromTechnicalSystemState, getAllPossibleSubsequentStatesByDefinition, getAllPossibleSubsequentStatesByDefinition, getCostFunctionHistory, getCostModel, getCustomToolBarElements, getDefaultSIPrefix, getDefaultTimeUnit, getEndTime, getEvaluationProcess, getEvaluationResults, getEvaluationSettings, getEvaluationThread, getEvaluationTimeRangeReminder, getFirstTechnicalSystemStateEvaluationWithEqualState, getGraphForStateVariability, getInitialTechnicalSystemStateEvaluation, getNextTechnicalSystemStateEvaluation, getNodeStateResolver, getOptionModelCalculation, getStartTime, getStateDurationFromTechnicalSystemState, getTechnicalInterfaceConfiguration, hasStateCostFunction, isAvailableOptionModelCalculation, isConstantStateSinceGlobalTime, isEnabledPrintToConsole, isRealTimeStrategyOrPartOfRealTimeStrategy, isStopEvaluation, print, printlnGlobalTime, printlnGlobalTime, recursivelyCreateEvaluationGraphForCostsOverTime, recursivelyCreateEvaluationGraphForCostsOverTime, resetInitialTechnicalSystemStateEvaluation, resetScheduleAndCalculationsStartingFrom, runEvaluation, setEnablePrintToConsole, setEvaluationThread, setGraphForStateVariability, setInitialTechnicalSystemStateEvaluation, stopEvaluation

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGroupEvaluationStrategy

public AbstractGroupEvaluationStrategy(OptionModelController optionModelController)

Instantiates a new abstract group evaluation strategy.

Parameters:

optionModelController - the option model controller

Method Detail

getGroupController

protected GroupController getGroupController()

Returns the GroupController that manages the current TechnicalSystemGroup.

Returns:

the group controller

getGroupCalculation

public GroupCalculation getGroupCalculation()

Returns the current, local GroupCalculation that belongs to the current group evaluation strategy.

Returns:

the group calculation

executeEvaluation

public void executeEvaluation()

Description copied from class: AbstractEvaluationStrategy

Executes the customized evaluation process by calling the abstract method AbstractEvaluationStrategy.runEvaluation(). This method contains also a try catch block in order to prevent faulty configurations and blocking of further executions and functions.

Overrides:

executeEvaluation in class AbstractEvaluationStrategy

getSequentialNetworkCalculation

public abstract AbstractSequentialNetworkCalculation<?> getSequentialNetworkCalculation()

Can be used in order to define an individual sequential network calculation by an extended AbstractSequentialNetworkCalculation and thus a AbstractGroupTreeAction.GroupTreeTraversal within an extended AbstractGroupTreeAction.
If no sequential network calculation is required, just return null here!

Returns:

the sequential network calculation to use or null

See Also:

AbstractSequentialNetworkCalculation

getOutNodeState

public final java.lang.Object getOutNodeState(CalculationStepNode<?> calculationStepNode,
                                              java.util.Vector<?> nextCalcStepNodes)

Returns the out node state for a single CalculationStepNode within a sequential network calculation (DO NOT OVERWRITE!).

Parameters:

calculationStepNode - the calculation step node

nextCalcStepNodes - the vector of next calculation step nodes

Returns:

the out node state

getOutNodeState

public java.lang.Object getOutNodeState(CalculationStepNode<?> calculationStepNode,
                                        TechnicalSystemStateEvaluation tsse,
                                        java.util.Vector<?> nextCalcStepNodes)

Has to return the out node state after calculations were executed and decisions were made. Override THIS method in order to define the required out-node states for a sequential network calculation!

Parameters:

calculationStepNode - the calculation step node

tsse - the TechnicalSystemStateEvaluation that represents the current system state

nextCalcStepNodes - the next calculation step nodes

Returns:

the out node state

doNetworkCalculation

public abstract FlowsMeasuredGroupMember doNetworkCalculation(javax.swing.tree.DefaultMutableTreeNode currentParentNode,
                                                              java.util.List<TechnicalInterface> outerInterfaces,
                                                              FlowsMeasuredGroup fmGroup)

Will be invoked, if a network calculation is required.

Parameters:

currentParentNode - the current parent node of the GroupTreeModel

outerInterfaces - the outer interfaces

fmGroup - the current FlowsMeasuredGroup

Returns:

the FlowsMeasuredGroup for each TechnicalInterface summarised in one instance of FlowsMeasuredGroupMember

meetDecisionForTechnicalSystem

public abstract TechnicalSystemStateDeltaEvaluation meetDecisionForTechnicalSystem(javax.swing.tree.DefaultMutableTreeNode currentNode,
                                                                                   GroupTreeNodeObject gtno,
                                                                                   java.util.Vector<TechnicalSystemStateDeltaEvaluation> deltaSteps)

Meet decision for a group member that is a TechnicalSystem.

Parameters:

currentNode - the current node of the GroupTreeModel

gtno - the GroupTreeNodeObject of the current node

deltaSteps - the delta steps

Returns:

the TechnicalSystemStateDeltaEvaluation technical system state delta evaluation

meetDecisionForScheduleList

public abstract Schedule meetDecisionForScheduleList(javax.swing.tree.DefaultMutableTreeNode currentNode,
                                                     GroupTreeNodeObject gtno,
                                                     ScheduleList scheduleList)

Meet decision for group member that is a ScheduleList.

Parameters:

currentNode - the current node of the GroupTreeModel

gtno - the GroupTreeNodeObject of the current node

scheduleList - the ScheduleList from which one Schedule has to be selected

Returns:

the Schedule to use

addStateToResults

public Schedule addStateToResults(TechnicalSystemStateEvaluation tsStateEval)

Description copied from class: AbstractEvaluationStrategy

Adds the specified, final TechnicalSystemStateEvaluation state to the result list of the EvaluationProcess and returns the created Schedule.

Overrides:

addStateToResults in class AbstractEvaluationStrategy

Parameters:

tsStateEval - the TechnicalSystemStateEvaluation

Returns:

the Schedule

See Also:

EvaluationProcess.addEvaluationResult(Schedule)

getGraphForDeltaCosts

protected EvaluationGraph getGraphForDeltaCosts()

Description copied from class: AbstractEvaluationStrategy

Returns the graph for delta costs.

Overrides:

getGraphForDeltaCosts in class AbstractEvaluationStrategy

Returns:

the graph for delta costs

setGraphForDeltaCosts

protected void setGraphForDeltaCosts(EvaluationGraph newGraphForEvaluationByDeltaCosts)

Description copied from class: AbstractEvaluationStrategy

Sets the graph for delta costs.

Overrides:

setGraphForDeltaCosts in class AbstractEvaluationStrategy

Parameters:

newGraphForEvaluationByDeltaCosts - the new graph for delta costs

executeSubEvaluationStrategies

protected boolean executeSubEvaluationStrategies()

Executes all sub evaluation strategies and returns if they are finished. Additionally, the local flag that indicates if the individual strategies of the sub systems are used, will be set to true .

Returns:

true, if the execution was successful

See Also:

isUsingSubStrategies()

isUsingSubStrategies

public boolean isUsingSubStrategies()

Checks if the current evaluation strategy is using sub strategies.

Returns:

true, if is using sub strategies

setUsingSubStrategies

protected void setUsingSubStrategies(boolean usingSubStrategies)

Sets that sub strategies are used for the current evaluation strategy.

Parameters:

usingSubStrategies - the new using sub strategies