energy.evaluation

Class TechnicalSystemStateDeltaHelper

java.lang.Object

energy.evaluation.TechnicalSystemStateDeltaHelper

public class TechnicalSystemStateDeltaHelper
extends java.lang.Object

The Class TechnicalSystemStateDeltaHelper provides help functions for one or several instances of TechnicalSystemStateDeltaEvaluation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TechnicalSystemStateDeltaHelper.DeltaSelectionBy The enumeration DeltaSelectionBy.

Constructor Summary

Constructors

Constructor and Description
TechnicalSystemStateDeltaHelper()

Method Summary

Modifier and Type	Method and Description
static java.util.Vector<TechnicalSystemStateDeltaEvaluation>	filterTechnicalSystemStateDeltaEvaluation(java.util.Vector<TechnicalSystemStateDeltaEvaluation> deltaSteps, TechnicalSystemStateDeltaHelper.DeltaSelectionBy selectionType, java.lang.String variableOrInterfaceID, java.lang.Object targetValue) Filters the specified list of technical system state delta evaluation according to the settings.
static java.util.Vector<TechnicalSystemStateDeltaEvaluation>	filterTechnicalSystemStateDeltaEvaluation(java.util.Vector<TechnicalSystemStateDeltaEvaluation> deltaSteps, TechnicalSystemStateDeltaHelper.DeltaSelectionBy selectionType, java.lang.String variableOrInterfaceID, java.lang.Object targetValue, double tolerance) Filters the specified list of technical system state delta evaluation according to the settings.
static TechnicalSystemStateDeltaEvaluation	findClosestTechnicalSystemStateDeltaEvaluation(java.util.Collection<TechnicalSystemStateDeltaEvaluation> tssDeltaCollection, TechnicalSystemStateDeltaHelper.DeltaSelectionBy selectionType, java.lang.String variableOrInterfaceID, java.lang.Object targetValue) From a list of TechnicalSystemStateDeltaEvaluations, find the one for which the value of a specified IO variable is closest to a target value.
static java.util.Comparator<TechnicalSystemStateDeltaEvaluation>	getComparatorCosts() Returns a new comparator for the costs of TechnicalSystemStateDeltaEvaluation's.
static java.util.Comparator<TechnicalSystemStateDeltaEvaluation>	getComparatorEnergyAmount() Returns a new comparator for the overall energy amount of TechnicalSystemStateDeltaEvaluation's.
static java.util.Comparator<TechnicalSystemStateDeltaEvaluation>	getComparatorEnergyLosses() Returns a new comparator for the energy losses of TechnicalSystemStateDeltaEvaluation's.
static java.util.Comparator<TechnicalSystemStateDeltaEvaluation>	getComparatorInterfaceCosts(java.lang.String interfaceID) Returns a new comparator for the costs at the specified EnergyInterface of TechnicalSystemStateDeltaEvaluation's.
static java.util.Comparator<TechnicalSystemStateDeltaEvaluation>	getComparatorInterfaceEnergyAmount(java.lang.String interfaceID) Returns a new comparator for the energy amount at the specified EnergyInterface of TechnicalSystemStateDeltaEvaluation's.
static java.util.Comparator<TechnicalSystemStateDeltaEvaluation>	getComparatorInterfaceEnergyFlow(java.lang.String interfaceID) Returns a new comparator for the energy flow at the specified EnergyInterface of TechnicalSystemStateDeltaEvaluation's.
static java.util.Comparator<TechnicalSystemStateDeltaEvaluation>	getComparatorIoValue(java.lang.String variableID) This comparator compares two TechnicalSystemStateDeltaEvaluations by the value of a specified IO variable in the resulting TechnicalSystemStateEvaluations.
static java.util.Comparator<TechnicalSystemStateDeltaEvaluation>	getComparatorStateCosts() Returns a new comparator for the state costs of TechnicalSystemStateDeltaEvaluation's.

Methods inherited from class java.lang.Object

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

Constructor Detail

TechnicalSystemStateDeltaHelper

public TechnicalSystemStateDeltaHelper()

Method Detail

getComparatorEnergyAmount

public static java.util.Comparator<TechnicalSystemStateDeltaEvaluation> getComparatorEnergyAmount()

Returns a new comparator for the overall energy amount of TechnicalSystemStateDeltaEvaluation's.

Returns:

the comparator

See Also:

TechnicalSystemStateDeltaEvaluation.getDeltaAmountAndCosts(), TechnicalSystemStateDeltaEvaluation.AmountsAndCosts.getEnergyAmount()

getComparatorCosts

public static java.util.Comparator<TechnicalSystemStateDeltaEvaluation> getComparatorCosts()

Returns a new comparator for the costs of TechnicalSystemStateDeltaEvaluation's.

Returns:

the comparator

See Also:

TechnicalSystemStateDeltaEvaluation.getDeltaAmountAndCosts(), TechnicalSystemStateDeltaEvaluation.AmountsAndCosts.getCosts()

getComparatorEnergyLosses

public static java.util.Comparator<TechnicalSystemStateDeltaEvaluation> getComparatorEnergyLosses()

Returns a new comparator for the energy losses of TechnicalSystemStateDeltaEvaluation's.

Returns:

the comparator

See Also:

TechnicalSystemStateDeltaEvaluation.getEnergyLosses()

getComparatorStateCosts

public static java.util.Comparator<TechnicalSystemStateDeltaEvaluation> getComparatorStateCosts()

Returns a new comparator for the state costs of TechnicalSystemStateDeltaEvaluation's.

Returns:

the comparator

See Also:

TechnicalSystemStateDeltaEvaluation.getStateCosts()

getComparatorInterfaceEnergyFlow

public static java.util.Comparator<TechnicalSystemStateDeltaEvaluation> getComparatorInterfaceEnergyFlow(java.lang.String interfaceID)

Returns a new comparator for the energy flow at the specified EnergyInterface of TechnicalSystemStateDeltaEvaluation's.

Parameters:

interfaceID - the interface id

Returns:

the comparator

See Also:

TechnicalSystemStateDeltaEvaluation.getTechnicalInterfaceDeltas(), TechnicalSystemStateDeltaEvaluation.TechnicalInterfaceCondition.getEnergyFlowInWatt()

getComparatorInterfaceEnergyAmount

public static java.util.Comparator<TechnicalSystemStateDeltaEvaluation> getComparatorInterfaceEnergyAmount(java.lang.String interfaceID)

Returns a new comparator for the energy amount at the specified EnergyInterface of TechnicalSystemStateDeltaEvaluation's.

Parameters:

interfaceID - the interface id

Returns:

the comparator

See Also:

TechnicalSystemStateDeltaEvaluation.getTechnicalInterfaceDeltas(), TechnicalSystemStateDeltaEvaluation.TechnicalInterfaceCondition.getDeltaAmountAndCosts(), TechnicalSystemStateDeltaEvaluation.AmountsAndCosts.getEnergyAmount()

getComparatorInterfaceCosts

public static java.util.Comparator<TechnicalSystemStateDeltaEvaluation> getComparatorInterfaceCosts(java.lang.String interfaceID)

Returns a new comparator for the costs at the specified EnergyInterface of TechnicalSystemStateDeltaEvaluation's.

Parameters:

interfaceID - the interface id

Returns:

the comparator

See Also:

TechnicalSystemStateDeltaEvaluation.getTechnicalInterfaceDeltas(), TechnicalSystemStateDeltaEvaluation.TechnicalInterfaceCondition.getDeltaAmountAndCosts(), TechnicalSystemStateDeltaEvaluation.AmountsAndCosts.getCosts()

getComparatorIoValue

public static java.util.Comparator<TechnicalSystemStateDeltaEvaluation> getComparatorIoValue(java.lang.String variableID)

This comparator compares two TechnicalSystemStateDeltaEvaluations by the value of a specified IO variable in the resulting TechnicalSystemStateEvaluations.

Parameters:

variableID - The ID of the variable to be compared

Returns:

the comparator

filterTechnicalSystemStateDeltaEvaluation

public static java.util.Vector<TechnicalSystemStateDeltaEvaluation> filterTechnicalSystemStateDeltaEvaluation(java.util.Vector<TechnicalSystemStateDeltaEvaluation> deltaSteps,
                                                                                                              TechnicalSystemStateDeltaHelper.DeltaSelectionBy selectionType,
                                                                                                              java.lang.String variableOrInterfaceID,
                                                                                                              java.lang.Object targetValue)

Filters the specified list of technical system state delta evaluation according to the settings.

Parameters:

deltaSteps - the vector of delta steps to select from

selectionType - the selection type (@see TechnicalSystemStateDeltaHelper.DeltaSelectionBy)

variableOrInterfaceID - the variable or interface ID

targetValue - the target value (may be a boolean, an integer or a double)

Returns:

the vector of TechnicalSystemStateDeltaEvaluation that match the specified conditions

filterTechnicalSystemStateDeltaEvaluation

public static java.util.Vector<TechnicalSystemStateDeltaEvaluation> filterTechnicalSystemStateDeltaEvaluation(java.util.Vector<TechnicalSystemStateDeltaEvaluation> deltaSteps,
                                                                                                              TechnicalSystemStateDeltaHelper.DeltaSelectionBy selectionType,
                                                                                                              java.lang.String variableOrInterfaceID,
                                                                                                              java.lang.Object targetValue,
                                                                                                              double tolerance)

Filters the specified list of technical system state delta evaluation according to the settings. For numeric target values, a tolerance can be specified.

Parameters:

deltaSteps - the vector of delta steps to select from

selectionType - the selection type (@see TechnicalSystemStateDeltaHelper.DeltaSelectionBy)

variableOrInterfaceID - the variable or interface ID

targetValue - the target value (may be a boolean, an integer or a double)

tolerance - the tolerance for the target value (not applicable for boolean)

Returns:

the vector of TechnicalSystemStateDeltaEvaluation that match the specified conditions

findClosestTechnicalSystemStateDeltaEvaluation

public static TechnicalSystemStateDeltaEvaluation findClosestTechnicalSystemStateDeltaEvaluation(java.util.Collection<TechnicalSystemStateDeltaEvaluation> tssDeltaCollection,
                                                                                                 TechnicalSystemStateDeltaHelper.DeltaSelectionBy selectionType,
                                                                                                 java.lang.String variableOrInterfaceID,
                                                                                                 java.lang.Object targetValue)

From a list of TechnicalSystemStateDeltaEvaluations, find the one for which the value of a specified IO variable is closest to a target value.

Parameters:

tssDeltaCollection - The list of TechnicalSystemStateDeltaEvaluations

selectionType - the selection type

variableOrInterfaceID - the variable or interface ID

targetValue - the target value

Returns:

The closest TechnicalSystemStateDeltaEvaluation