Package com.powsybl.openrao.searchtreerao.commons.optimizationperimeters

Class AbstractOptimizationPerimeter

java.lang.Object

com.powsybl.openrao.searchtreerao.commons.optimizationperimeters.AbstractOptimizationPerimeter

All Implemented Interfaces:

OptimizationPerimeter

Direct Known Subclasses:

AutoOptimizationPerimeter, CurativeOptimizationPerimeter, GlobalOptimizationPerimeter, PreventiveOptimizationPerimeter

public abstract class AbstractOptimizationPerimeter
extends Object
implements OptimizationPerimeter

Author:

Baptiste Seguinot <baptiste.seguinot at rte-france.com>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOptimizationPerimeter(State mainOptimizationState, Set<FlowCnec> flowCnecs, Set<FlowCnec> loopFlowCnecs, Set<NetworkAction> availableNetworkActions, Map<State,Set<RangeAction<?>>> availableRangeActions)

Method Summary

Modifier and Type	Method	Description
Set<FlowCnec>	getFlowCnecs()	Returns the set of FlowCnec which are either optimized or monitored by the perimeter
Set<FlowCnec>	getLoopFlowCnecs()	Returns the set of FlowCnec whose loop-flows are monitored
State	getMainOptimizationState()	The main optimization state is: - the state on which the network actions are optimized - the first state (chronologically speaking) on which range actions are optimized
Set<FlowCnec>	getMonitoredFlowCnecs()	Returns the set of FlowCnec which are monitored by the perimeter
Set<State>	getMonitoredStates()	Returns the set of states which are monitored by the perimeter A 'monitored state' is a state which contains at least one FlowCnec: - which is optimized, or - which is monitored, or - which has loop-flows which are monitored A 'monitored state' does not necessarily have RemedialActions
Set<NetworkAction>	getNetworkActions()	Returns the set of network actions which will be optimized on the main optimization state
Set<FlowCnec>	getOptimizedFlowCnecs()	Returns the set of FlowCnec which are optimized by the perimeter
Set<State>	getRangeActionOptimizationStates()	Returns the set of states on which range actions are optimized.
Set<RangeAction<?>>	getRangeActions()	Returns a set of all the RangeActions that will be optimized on any state
Map<State,Set<RangeAction<?>>>	getRangeActionsPerState()	For each state of getRangeActionOptimizationStates(), returns the set of range actions which will be optimized on this state

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractOptimizationPerimeter

protected AbstractOptimizationPerimeter(State mainOptimizationState,
 Set<FlowCnec> flowCnecs,
 Set<FlowCnec> loopFlowCnecs,
 Set<NetworkAction> availableNetworkActions,
 Map<State,Set<RangeAction<?>>> availableRangeActions)

Method Details

getMainOptimizationState

public State getMainOptimizationState()

Description copied from interface: OptimizationPerimeter

The main optimization state is: - the state on which the network actions are optimized - the first state (chronologically speaking) on which range actions are optimized

Specified by:

getMainOptimizationState in interface OptimizationPerimeter

getRangeActionOptimizationStates

public Set<State> getRangeActionOptimizationStates()

Description copied from interface: OptimizationPerimeter

Returns the set of states on which range actions are optimized. In most cases, getRangeActionOptimizationStates() will only contain getMainOptimizationState() Though, if RangeActions are optimized in preventive and in curative (for instance, in the 2nd prev optimization), getRangeActionOptimizationStates() will gather all the states on which at least one RangeAction can be optimized.

Specified by:

getRangeActionOptimizationStates in interface OptimizationPerimeter

getMonitoredStates

public Set<State> getMonitoredStates()

Description copied from interface: OptimizationPerimeter

Returns the set of states which are monitored by the perimeter A 'monitored state' is a state which contains at least one FlowCnec: - which is optimized, or - which is monitored, or - which has loop-flows which are monitored A 'monitored state' does not necessarily have RemedialActions

Specified by:

getMonitoredStates in interface OptimizationPerimeter

getFlowCnecs

public Set<FlowCnec> getFlowCnecs()

Description copied from interface: OptimizationPerimeter

Returns the set of FlowCnec which are either optimized or monitored by the perimeter

Specified by:

getFlowCnecs in interface OptimizationPerimeter

getOptimizedFlowCnecs

public Set<FlowCnec> getOptimizedFlowCnecs()

Description copied from interface: OptimizationPerimeter

Returns the set of FlowCnec which are optimized by the perimeter

Specified by:

getOptimizedFlowCnecs in interface OptimizationPerimeter

getMonitoredFlowCnecs

public Set<FlowCnec> getMonitoredFlowCnecs()

Description copied from interface: OptimizationPerimeter

Returns the set of FlowCnec which are monitored by the perimeter

Specified by:

getMonitoredFlowCnecs in interface OptimizationPerimeter

getLoopFlowCnecs

public Set<FlowCnec> getLoopFlowCnecs()

Description copied from interface: OptimizationPerimeter

Returns the set of FlowCnec whose loop-flows are monitored

Specified by:

getLoopFlowCnecs in interface OptimizationPerimeter

getNetworkActions

public Set<NetworkAction> getNetworkActions()

Description copied from interface: OptimizationPerimeter

Returns the set of network actions which will be optimized on the main optimization state

Specified by:

getNetworkActions in interface OptimizationPerimeter

getRangeActionsPerState

public Map<State,Set<RangeAction<?>>> getRangeActionsPerState()

Description copied from interface: OptimizationPerimeter

For each state of getRangeActionOptimizationStates(), returns the set of range actions which will be optimized on this state

Specified by:

getRangeActionsPerState in interface OptimizationPerimeter

getRangeActions

public Set<RangeAction<?>> getRangeActions()

Description copied from interface: OptimizationPerimeter

Returns a set of all the RangeActions that will be optimized on any state

Specified by:

getRangeActions in interface OptimizationPerimeter