OutputTypeAdapter (PLANitAllJavaOnly 0.4.0 API)

All Known Subinterfaces:

MacroscopicLinkOutputTypeAdapter, OdOutputTypeAdapter, PathOutputTypeAdapter, UntypedLinkOutputTypeAdapter<T>

All Known Implementing Classes:

MacroscopicLinkOutputTypeAdapterImpl, OdOutputTypeAdapterImpl, OutputTypeAdapterImpl, PathOutputTypeAdapterImpl, PhysicalLinkOutputTypeAdapterImpl, StaticLtmLinkOutputTypeAdapter, TraditionalStaticAssignmentLinkOutputTypeAdapter, TraditionalStaticAssignmentOdOutputTypeAdapter, TraditionalStaticPathOutputTypeAdapter, UntypedLinkOutputTypeAdapterImpl
```
public interface OutputTypeAdapter
```
Top-level interface for all output type adapters

Author:

gman6028

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Optional<Integer>`	`getIterationIndexForSubOutputType(SubOutputTypeEnum subOutputTypeEnum)`	Determine the iteration index that is relevant for the data related to the provided output type enum Generally, this equates to the actual current iteration index, but if the data for example is trailing an iteration then this will collect the correct iteration index for this data as opposed to the iteration index of the simulation itself.
`OutputType`	`getOutputType()`	Return the output type corresponding to this output adapter

- Method Detail
  - getOutputType
```
OutputType getOutputType()
```
    Return the output type corresponding to this output adapter
    
    Returns:
    
    the output type corresponding to this output adapter
  - getIterationIndexForSubOutputType
```
Optional<Integer> getIterationIndexForSubOutputType(SubOutputTypeEnum subOutputTypeEnum)
                                             throws PlanItException
```
    Determine the iteration index that is relevant for the data related to the provided output type enum Generally, this equates to the actual current iteration index, but if the data for example is trailing an iteration then this will collect the correct iteration index for this data as opposed to the iteration index of the simulation itself. Hence, it is always safer to use this method when persisting data
    
    Parameters:
    
    subOutputTypeEnum - , allowed to be null, in that case it is assumed there does not exist a suboutputtype for this output type
    
    Returns:
    
    iterationIndexForData
    
    Throws:
    
    PlanItException - thrown if exception