Internal types

abstract type TimeStructurePeriod{T} <: TimeStructure{T}

Abstract type representing different time structures that consists of one or more time periods. It is used for TimeStructures that can also act as index for periods, e.g., AbstractStrategicPeriod.

The type 'T' gives the data type used for the duration of the time periods.

abstract type TimeStructInnerIter{T<:Duration}

Abstract type representing different iterators for individual time structures. The difference to TimeStructure is that iterating through a TimeStructInnerIter will not provide a TimePeriod, but a TimeStructure.

abstract type TimeStructOuterIter{T<:Duration}

Abstract type representing different iterators for individual time structures. The difference to TimeStructure is that iterating through a TimeStructOuterIter will not provide a TimePeriod, but a TimeStructure.

abstract type AbstractTreeNode{S,T} <: AbstractStrategicPeriod{S,T}

Abstract base type for all tree nodes within a TwoLevelTree type.

struct StratNode{S, T, OP<:TimeStructure{T}} <: AbstractTreeNode{S,T}

A structure representing a single strategic node of a TwoLevelTree. It is created through iterating through StratTreeNodes.

It is equivalent to a StrategicPeriod of a TwoLevel time structure when utilizing a TwoLevelTree.

struct StrategicScenario

Description of an individual strategic scenario. It includes all strategic nodes corresponding to a scenario, including the probability. It can be utilized within a decomposition algorithm.

abstract type AbstractTreeStructure{T} <: TimeStructOuterIter{T}

Abstract base type for all tree timestructures within a TwoLevelTree type.

struct StratTreeNodes{S,T,OP<:TimeStructure{T}} <: AbstractStratPers{T}

Type for iterating through the individual strategic nodes of a TwoLevelTree. It is automatically created through the function strat_periods, and hence, strategic_periods.

Iterating through StratTreeNodes using the WithPrev iterator changes the behaviour, although the meaning remains unchanged.

struct StrategicScenarios

Type for iteration through the individual strategic scenarios represented as StrategicScenario.

abstract type AbstractStrategicPeriod{S,T} <: TimeStructurePeriod{T}

Abstract type used for time structures that represent a strategic period. These periods are obtained when iterating through the strategic periods of a time structure declared by the function strat_periods.

struct SingleStrategicPeriodWrapper{T,SP<:TimeStructure{T}} <: AbstractStrategicPeriod{T,T}

A type representing a single strategic period supporting iteration over its time periods. It is created when iterating through SingleStrategicPeriodWrapper.

struct StrategicPeriod{S,T,OP<:TimeStructure{T}} <: AbstractStrategicPeriod{S,T}

A type representing a single strategic period supporting iteration over its time periods. It is created when iterating through StratPers.

abstract type AbstractStratPers{S,T} <: TimeStructInnerIter

Abstract type used for time structures that represent a collection of strategic periods, obtained through calling the function strat_periods.

struct SingleStrategicPeriodWrapper{T,SP<:TimeStructure{T}} <: AbstractStratPers{T}

Type for iterating through the individual strategic periods of a time structure without TwoLevel. It is automatically created through the function strat_periods.

struct StratPers{S,T,OP} <: AbstractStratPers{T}

Type for iterating through the individual strategic periods of a TwoLevel time structure. It is automatically created through the function strat_periods.

abstract type AbstractRepresentativePeriod{T} <: TimeStructurePeriod{T}

Abstract type used for time structures that represent a representative period. These periods are obtained when iterating through the representative periods of a time structure declared by the function repr_periods.

struct SingleReprPeriod{T,OP<:TimeStructure{T}} <: AbstractRepresentativePeriod{T}

A type representing a single representative period supporting iteration over its time periods. It is created when iterating through SingleReprPeriodWrapper.

struct RepresentativePeriod{T,OP<:TimeStructure{T}} <: AbstractRepresentativePeriod{T}

A type representing a single representative period supporting iteration over its time periods. It is created when iterating through ReprPers.

struct StratReprPeriod{T,OP<:TimeStructure{T}} <: AbstractRepresentativePeriod{T}

A type representing a single representative period supporting iteration over its time periods. It is created when iterating through StratReprPers.

struct StratNodeReprPeriod{T,OP<:TimeStructure{T}} <: AbstractRepresentativePeriod{T}

A structure representing a single representative period of a StratNode of a TwoLevelTree. It is created through iterating through StratNodeReprPers.

It is equivalent to a StratReprPeriod of a TwoLevel time structure when utilizing a TwoLevelTree.

struct SingleReprPeriodWrapper{T,OP<:TimeStructure{T}} <: TimeStructInnerIter{T}

Type for iterating through the individual representative periods of a time structure without RepresentativePeriods. It is automatically created through the function repr_periods.

struct ReprPers{S,T,OP} <: TimeStructInnerIter{T}

Type for iterating through the individual representative periods of a RepresentativePeriods time structure. It is automatically created through the function repr_periods.

struct StratReprPers{T,OP<:TimeStructInnerIter{T}} <: TimeStructOuterIter{T}

Type for iterating through the individual representative periods of a StrategicPeriod time structure. It is automatically created through the function repr_periods.

struct StratNodeReprPers{T,OP<:TimeStructInnerIter{T}} <: AbstractTreeStructure{T}

Type for iterating through the individual presentative periods of a StratNode. It is automatically created through the function repr_periods.

abstract type AbstractOperationalScenario{T} <: TimeStructurePeriod{T}

Abstract type used for time structures that represent an operational scenario. These periods are obtained when iterating through the operational scenarios of a time structure declared by the function opscenarios.

struct SingleScenario{T,SC<:TimeStructure{T}} <: AbstractRepresentativePeriod{T}

A type representing a single operational scenario supporting iteration over its time periods. It is created when iterating through SingleScenarioWrapper.

struct OperationalScenario{T,OP<:TimeStructure{T}} <: AbstractOperationalScenario{T}

A type representing a single operational scenario supporting iteration over its time periods. It is created when iterating through OpScens.

struct ReprOpScenario{T,OP<:TimeStructure{T}} <: AbstractOperationalScenario{T}

A type representing a single operational scenarios supporting iteration over its time periods. It is created when iterating through RepOpScens.

struct StratOpScenario{T,OP<:TimeStructure{T}} <: AbstractOperationalScenario{T}

A type representing a single operational scenario supporting iteration over its time periods. It is created when iterating through StratOpScens.

struct StratReprOpScenario{T, OP<:TimeStructure{T}} <: AbstractRepresentativePeriod{T}

A type representing a single representative period supporting iteration over its time periods. It is created when iterating through StratReprPers.

struct StratNodeOpScenario{T,OP<:TimeStructure{T}}  <: AbstractOperationalScenario{T}

A structure representing a single operational scenario for a strategic node supporting iteration over its time periods. It is created through iterating through StratNodeOpScens.

It is equivalent to a StratOpScenario of a TwoLevel time structure when utilizing a TwoLevelTree.

struct StratNodeReprOpScenario{T} <: AbstractOperationalScenario{T}

A structure representing a single operational scenario for a representative period in A TwoLevelTree structure supporting iteration over its time periods.

struct SingleScenarioWrapper{T,OP<:TimeStructure{T}} <: TimeStructInnerIter{T}

Type for iterating through the individual operational scenarios of a time structure without OperationalScenarios. It is automatically created through the function opscenarios.

struct OpScens{T,OP} <: TimeStructInnerIter{T}

Type for iterating through the individual operational scenarios of a OperationalScenarios time structure. It is automatically created through the function opscenarios.

struct RepOpScens{T,OP<:TimeStructInnerIter{T}} <: TimeStructOuterIter{T}

Type for iterating through the individual operational scenarios of a RepresentativePeriod time structure. It is automatically created through the function opscenarios.

struct StratOpScens{T,OP<:TimeStructInnerIter{T}} <: TimeStructOuterIter{T}

Type for iterating through the individual operational scenarios of a StrategicPeriod time structure. It is automatically created through the function opscenarios.

struct StratReprOpScens{T,OP<:TimeStructInnerIter{T}} <: TimeStructOuterIter{T}

Type for iterating through the individual operational scenarios of a StrategicPeriod time structure with RepresentativePeriods. It is automatically created through the function opscenarios.

struct StratNodeOpScens{T,OP<:TimeStructInnerIter{T}} <: AbstractTreeStructure{T}

Type for iterating through the individual operational scenarios of a StratNode. It is automatically created through the function opscenarios.

struct StratNodeReprOpScens{T,OP<:TimeStructInnerIter{T}} <: AbstractTreeStructure{T}

Type for iterating through the individual operational scenarios of a StratNodeReprPeriod. It is automatically created through the function opscenarios.

abstract type TimePeriod

Abstract type used for a uniform interface for iterating through time structures and indexing of time profiles.

struct SimplePeriod{T<:Number} <: TimePeriod

Time period for a single operational period. It is created through iterating through a SimpleTimes time structure.

struct CalendarPeriod{T} <: TimePeriod

Time period for a single operational period. It is created through iterating through a CalendarTimes time structure with duration measured in hours (by default).

struct ScenarioPeriod{P} <: TimePeriod where {P<:TimePeriod}

Time period for a single operational period. It is created through iterating through a OperationalScenarios time structure. It is as well created as period within OperationalPeriod when the time structure includes OperationalScenarios.

struct ReprPeriod{P} <: TimePeriod where {P<:TimePeriod}

Time period for a single operational period. It is created through iterating through a RepresentativePeriods time structure. It is as well created as period within OperationalPeriod when the time structure includes RepresentativePeriods.

struct OperationalPeriod{P} <: TimePeriod where {P<:TimePeriod}

Time period for a single operational period. It is created through iterating through a TwoLevel time structure.

struct TreePeriod{P} <: TimePeriod where {P<:TimePeriod}

Time period for iteration of a TwoLevelTree time structure. This period has in addition to an operational period also the two fields branch and prob_branch corresponding to the respective branch and probability of the branch