TechnicalSystemStateHelper (Energy Option Model

java.lang.Object
- energy.evaluation.TechnicalSystemStateHelper

```
public class TechnicalSystemStateHelper
extends java.lang.Object
```
The Class TechnicalSystemStateHelper provides help functions for one or several instances of TechnicalSystemState.

Constructor Summary

Constructors
Constructor and Description

TechnicalSystemStateHelper()

Constructors
Constructor and Description
`TechnicalSystemStateHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.Comparator<TechnicalSystemStateEvaluation>`	`getComparatorCost()` Returns a comparator for the resulting costs
`static java.util.Comparator<TechnicalSystemState>`	`getComparatorCumulatedCosts(java.lang.String interfaceID)` Returns a comparator for cumulated costs at the specified interface
`static java.util.Comparator<TechnicalSystemState>`	`getComparatorCumulatedEnergy(java.lang.String interfaceID)` Returns a comparator for the cumulated energy amount at the specified interface
`static java.util.Comparator<TechnicalSystemStateEvaluation>`	`getComparatorEnergyLosses()` Returns a comparator for the energy losses
`static java.util.Comparator<TechnicalSystemState>`	`getComparatorEnergyOrGoodFlow(java.lang.String interfaceID)` Returns a comparator for energy flows
`static java.util.Comparator<FixedVariable>`	`getComparatorFixedVariable()` Returns a new comparator for `FixedVariable`'s.
`static java.util.Comparator<TechnicalSystemState>`	`getComparatorGlobalTime()` Returns a new comparator for the global time of `TechnicalSystemState`'s.
`static java.util.Comparator<TechnicalSystemState>`	`getComparatorIOVariable(java.lang.String variableID)` Returns the comparator for I/O-variables with a list of `TechnicalSystemState`'s.
`static java.util.Comparator<TechnicalSystemState>`	`getComparatorState()` Returns a new comparator for the states of `TechnicalSystemState`'s.
`static java.util.Comparator<TechnicalSystemStateEvaluation>`	`getComparatorStateCost()` Returns a comparator for the state costs
`static java.util.Comparator<TechnicalSystemState>`	`getComparatorStorageLoad(java.lang.String interfaceID)` Returns a comparator for storage load
`static java.util.Comparator<AbstractStorageLoad>`	`getComparatorStorageLoads()` Returns the comparator for `StorageLoadEnergy`'s.
`static java.util.Comparator<AbstractUsageOfInterface>`	`getComparatorUsageOfInterfaces()` Returns the comparator for `UsageOfInterfaceEnergy`'s.
`static long`	`getGlobalTimeStart(TechnicalSystemState tss)` Calculate the global time of the start of the state (stateTime==0) from the given tss.
`static TechnicalSystemStateEvaluation`	`getTsseCloneWithoutParent(TechnicalSystemStateEvaluation tsse)` Returns a serial clone of a `TechnicalSystemStateEvaluation`.
`static java.lang.String`	`toString(java.util.List<FixedVariable> fixedVariableList)` This toString method can be used in order to print the IO-List of a `TechnicalSystemState`.
`static java.lang.String`	`toString(java.util.List<FixedVariable> fixedVariableList, java.lang.String separator)` This toString method can be used in order to print the IO-List of a `TechnicalSystemState`.
`static java.lang.String`	`toString(TechnicalSystemState technicalSystemState)` This methods converts a `TechnicalSystemState` into a string for visualisation.
`static java.lang.String`	`toString(TechnicalSystemState technicalSystemState, boolean useNewLineSeparator)` This methods converts a `TechnicalSystemState` into a string for visualisation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TechnicalSystemStateHelper
```
public TechnicalSystemStateHelper()
```
- Method Detail
  - toString
```
public static java.lang.String toString(TechnicalSystemState technicalSystemState)
```
    This methods converts a TechnicalSystemState into a string for visualisation.
    
    Parameters:
    
    technicalSystemState - the TechnicalSystemState
    
    Returns:
    
    the string for the TechnicalSystemState
  - toString
```
public static java.lang.String toString(TechnicalSystemState technicalSystemState,
                                        boolean useNewLineSeparator)
```
    This methods converts a TechnicalSystemState into a string for visualisation.
    
    Parameters:
    
    technicalSystemState - the TechnicalSystemState
    
    useNewLineSeparator - indicates whether to use a line separator or not
    
    Returns:
    
    the string for the TechnicalSystemState
  - toString
```
public static java.lang.String toString(java.util.List<FixedVariable> fixedVariableList)
```
    This toString method can be used in order to print the IO-List of a TechnicalSystemState.
    
    Parameters:
    
    fixedVariableList - the fixed variable list
    
    Returns:
    
    the string of the specified list of fixed variables
  - toString
```
public static java.lang.String toString(java.util.List<FixedVariable> fixedVariableList,
                                        java.lang.String separator)
```
    This toString method can be used in order to print the IO-List of a TechnicalSystemState.
    
    Parameters:
    
    fixedVariableList - the fixed variable list
    
    Returns:
    
    the string of the specified list of fixed variables
  - getComparatorGlobalTime
```
public static java.util.Comparator<TechnicalSystemState> getComparatorGlobalTime()
```
    Returns a new comparator for the global time of TechnicalSystemState's.
    
    Returns:
    
    the comparator for the global time
  - getComparatorState
```
public static java.util.Comparator<TechnicalSystemState> getComparatorState()
```
    Returns a new comparator for the states of TechnicalSystemState's.
    
    Returns:
    
    the comparator for states
  - getComparatorFixedVariable
```
public static java.util.Comparator<FixedVariable> getComparatorFixedVariable()
```
    Returns a new comparator for FixedVariable's.
    
    Returns:
    
    the comparator for FixedVariable's.
  - getComparatorIOVariable
```
public static java.util.Comparator<TechnicalSystemState> getComparatorIOVariable(java.lang.String variableID)
```
    Returns the comparator for I/O-variables with a list of TechnicalSystemState's.
    
    Parameters:
    
    variableID - the variable id
    
    Returns:
    
    the comparator for I/O-variables
  - getComparatorUsageOfInterfaces
```
public static java.util.Comparator<AbstractUsageOfInterface> getComparatorUsageOfInterfaces()
```
    Returns the comparator for UsageOfInterfaceEnergy's.
    
    Returns:
    
    the comparator for UsageOfInterfaceEnergy's.
  - getComparatorEnergyOrGoodFlow
```
public static java.util.Comparator<TechnicalSystemState> getComparatorEnergyOrGoodFlow(java.lang.String interfaceID)
```
    Returns a comparator for energy flows
    
    Parameters:
    
    interfaceID - the interface id
    
    Returns:
    
    a comparator for energy flows
  - getComparatorStorageLoads
```
public static java.util.Comparator<AbstractStorageLoad> getComparatorStorageLoads()
```
    Returns the comparator for StorageLoadEnergy's.
    
    Returns:
    
    the comparator for StorageLoadEnergy's.
  - getComparatorStorageLoad
```
public static java.util.Comparator<TechnicalSystemState> getComparatorStorageLoad(java.lang.String interfaceID)
```
    Returns a comparator for storage load
    
    Parameters:
    
    interfaceID - the interface id
    
    Returns:
    
    a comparator for storage load
  - getComparatorCumulatedEnergy
```
public static java.util.Comparator<TechnicalSystemState> getComparatorCumulatedEnergy(java.lang.String interfaceID)
```
    Returns a comparator for the cumulated energy amount at the specified interface
    
    Parameters:
    
    interfaceID - the interface id
    
    Returns:
    
    a comparator for cumulated energy
  - getComparatorCumulatedCosts
```
public static java.util.Comparator<TechnicalSystemState> getComparatorCumulatedCosts(java.lang.String interfaceID)
```
    Returns a comparator for cumulated costs at the specified interface
    
    Parameters:
    
    interfaceID - the interface id
    
    Returns:
    
    a comparator for cumulated energy
  - getComparatorEnergyLosses
```
public static java.util.Comparator<TechnicalSystemStateEvaluation> getComparatorEnergyLosses()
```
    Returns a comparator for the energy losses
    
    Returns:
    
    a comparator for the energy losses
  - getComparatorStateCost
```
public static java.util.Comparator<TechnicalSystemStateEvaluation> getComparatorStateCost()
```
    Returns a comparator for the state costs
    
    Returns:
    
    a comparator for state costs
  - getComparatorCost
```
public static java.util.Comparator<TechnicalSystemStateEvaluation> getComparatorCost()
```
    Returns a comparator for the resulting costs
    
    Returns:
    
    a comparator for costs
  - getTsseCloneWithoutParent
```
public static TechnicalSystemStateEvaluation getTsseCloneWithoutParent(TechnicalSystemStateEvaluation tsse)
```
    Returns a serial clone of a TechnicalSystemStateEvaluation. The parent (and thus history) will not be included.
    
    Parameters:
    
    tsse - The TechnicalSystemStateEvaluation to be cloned
    
    Returns:
    
    The cloned TechnicalSystemStateEvaluation
  - getGlobalTimeStart
```
public static long getGlobalTimeStart(TechnicalSystemState tss)
```
    Calculate the global time of the start of the state (stateTime==0) from the given tss.
    
    Parameters:
    
    tss - the tss whose state start is to be calculated
    
    Returns:
    
    stateStartGlobalTime the start of the state of the given tss

Class TechnicalSystemStateHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TechnicalSystemStateHelper

Method Detail

toString

toString

toString

toString

getComparatorGlobalTime

getComparatorState

getComparatorFixedVariable

getComparatorIOVariable

getComparatorUsageOfInterfaces

getComparatorEnergyOrGoodFlow

getComparatorStorageLoads

getComparatorStorageLoad

getComparatorCumulatedEnergy

getComparatorCumulatedCosts

getComparatorEnergyLosses

getComparatorStateCost

getComparatorCost

getTsseCloneWithoutParent

getGlobalTimeStart