Class RaoResultWithAngleMonitoring
java.lang.Object
com.powsybl.openrao.data.raoresultapi.RaoResultClone
com.powsybl.openrao.monitoring.anglemonitoring.RaoResultWithAngleMonitoring
- All Implemented Interfaces:
RaoResult
class that enhances rao result with angle monitoring results
- Author:
- Mohamed Ben Rejeb <mohamed.ben-rejeb at rte-france.com>
-
Field Summary
Fields inherited from interface com.powsybl.openrao.data.raoresultapi.RaoResult
INITIAL_INSTANT_ID
-
Constructor Summary
ConstructorDescriptionRaoResultWithAngleMonitoring
(RaoResult raoResult, AngleMonitoringResult angleMonitoringResult) -
Method Summary
Modifier and TypeMethodDescriptionIt gathers theNetworkAction
that are activated during the specifiedState
.double
Get the overall sensitivity computation status of the RAOdouble
boolean
isActivatedDuringState
(State state, NetworkAction networkAction) It states if theNetworkAction
is activated on a specificState
.boolean
isActivatedDuringState
(State state, RemedialAction<?> remedialAction) It states if theRemedialAction
is activated on a specificState
.boolean
isSecure()
Indicates whether all the CNECs are secure at last instant (i.e.boolean
isSecure
(PhysicalParameter... u) Indicates whether all the CNECs of a given type are secure at last instant (i.e.boolean
isSecure
(Instant instant, PhysicalParameter... u) Indicates whether the all the CNECs of a given type at a given instant are secure.Methods inherited from class com.powsybl.openrao.data.raoresultapi.RaoResultClone
getActivatedRangeActionsDuringState, getCommercialFlow, getComputationStatus, getCost, getFlow, getFunctionalCost, getLoopFlow, getMargin, getOptimizationStepsExecuted, getOptimizedSetPointOnState, getOptimizedSetPointsOnState, getOptimizedTapOnState, getOptimizedTapsOnState, getPreOptimizationSetPointOnState, getPreOptimizationTapOnState, getPtdfZonalSum, getRelativeMargin, getVirtualCost, getVirtualCost, getVirtualCostNames, isActivatedDuringState, setOptimizationStepsExecuted, wasActivatedBeforeState
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.powsybl.openrao.data.raoresultapi.RaoResult
getMargin, getVoltage, isActivated
-
Constructor Details
-
RaoResultWithAngleMonitoring
public RaoResultWithAngleMonitoring(RaoResult raoResult, AngleMonitoringResult angleMonitoringResult)
-
-
Method Details
-
getComputationStatus
Description copied from interface:RaoResult
Get the overall sensitivity computation status of the RAO- Specified by:
getComputationStatus
in interfaceRaoResult
- Overrides:
getComputationStatus
in classRaoResultClone
-
getAngle
Description copied from interface:RaoResult
- Parameters:
optimizationInstant
- : The optimized instant to be studied (set to null to access initial results)angleCnec
- : The angle cnec to be studied.unit
- : The unit in which the flow is queried. Only accepted value for now is DEGREE.- Returns:
- The angle on the cnec at the optimization state in the given unit.
-
getMargin
Description copied from interface:RaoResult
It gives the margin on anAngleCnec
at a givenInstant
and in a givenUnit
. It is basically the difference between the angle and the most constraining threshold in the angle direction of the given branch. If it is negative the cnec is under constraint.- Parameters:
optimizationInstant
- : The optimized instant to be studied (set to null to access initial results)angleCnec
- : The angle cnec to be studied.unit
- : The unit in which the margin is queried. Only accepted for now is DEGREE.- Returns:
- The margin on the angle cnec at the optimization state in the given unit.
-
getActivatedNetworkActionsDuringState
Description copied from interface:RaoResult
It gathers theNetworkAction
that are activated during the specifiedState
.- Specified by:
getActivatedNetworkActionsDuringState
in interfaceRaoResult
- Overrides:
getActivatedNetworkActionsDuringState
in classRaoResultClone
- Parameters:
state
- : The state of the state tree to be studied.- Returns:
- The set of activated network action during the specified state.
-
isActivatedDuringState
Description copied from interface:RaoResult
It states if theRemedialAction
is activated on a specificState
.- Specified by:
isActivatedDuringState
in interfaceRaoResult
- Overrides:
isActivatedDuringState
in classRaoResultClone
- Parameters:
state
- : The state of the state tree to be studied.remedialAction
- : The remedial action to be studied.- Returns:
- True if the remedial action is chosen by the optimizer during the specified state.
-
isActivatedDuringState
Description copied from interface:RaoResult
It states if theNetworkAction
is activated on a specificState
.- Specified by:
isActivatedDuringState
in interfaceRaoResult
- Overrides:
isActivatedDuringState
in classRaoResultClone
- Parameters:
state
- : The state of the state tree to be studied.networkAction
- : The network action to be studied.- Returns:
- True if the network action is chosen by the optimizer during the specified state.
-
isSecure
Description copied from interface:RaoResult
Indicates whether the all the CNECs of a given type at a given instant are secure.- Specified by:
isSecure
in interfaceRaoResult
- Overrides:
isSecure
in classRaoResultClone
- Parameters:
instant
- : The instant to assessu
- : The types of CNECs to check (FLOW -> FlowCNECs, ANGLE -> AngleCNECs, VOLTAGE -> VoltageCNECs). 1 to 3 arguments can be provided.- Returns:
- whether all the CNECs of the given type(s) are secure at the optimized instant.
-
isSecure
Description copied from interface:RaoResult
Indicates whether all the CNECs of a given type are secure at last instant (i.e. after RAO)..- Specified by:
isSecure
in interfaceRaoResult
- Overrides:
isSecure
in classRaoResultClone
- Parameters:
u
- : The types of CNECs to check (FLOW -> FlowCNECs, ANGLE -> AngleCNECs, VOLTAGE -> VoltageCNECs). 1 to 3 arguments can be provided.- Returns:
- whether all the CNECs of the given type(s) are secure at last instant (i.e. after RAO)..
-
isSecure
public boolean isSecure()Description copied from interface:RaoResult
Indicates whether all the CNECs are secure at last instant (i.e. after RAO)..- Specified by:
isSecure
in interfaceRaoResult
- Overrides:
isSecure
in classRaoResultClone
- Returns:
- whether all the CNECs are secure at last instant (i.e. after RAO)..
-