Class LimitViolation
- All Implemented Interfaces:
Extendable<LimitViolation>
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
-
Constructor Summary
ConstructorDescriptionLimitViolation
(String subjectId, LimitViolationType limitType, double limit, double limitReduction, double value) Create a new LimitViolation, for voltage angle limit.LimitViolation
(String subjectId, LimitViolationType limitType, String limitName, int acceptableDuration, double limit, double limitReduction, double value) Create a new LimitViolation without side.LimitViolation
(String subjectId, LimitViolationType limitType, String limitName, int acceptableDuration, double limit, double limitReduction, double value, TwoSides side) Create a new LimitViolation.LimitViolation
(String subjectId, String subjectName, LimitViolationType limitType, double limit, double limitReduction, double value) Create a new LimitViolation, for types other than current limits.LimitViolation
(String subjectId, String subjectName, LimitViolationType limitType, String limitName, int acceptableDuration, double limit, double limitReduction, double value) Create a new LimitViolation without side.LimitViolation
(String subjectId, String subjectName, LimitViolationType limitType, String limitName, int acceptableDuration, double limit, double limitReduction, double value, ThreeSides side) Create a new LimitViolation.LimitViolation
(String subjectId, String subjectName, LimitViolationType limitType, String limitName, int acceptableDuration, double limit, double limitReduction, double value, TwoSides side) Create a new LimitViolation. -
Method Summary
Modifier and TypeMethodDescriptionint
The acceptable duration, in seconds, associated to the current violation value.double
getLimit()
The value of the limit which has been violated.The name of the limit which has been violated.double
The limit reduction factor used for violation detection.The type of limit which has been violated.getSide()
The side of the equipment where the violation occurred.The side of the equipment with two sides (like branch) where the violation occurred.The identifier of the network equipment on which the violation occurred.The name of the network equipment on which the violation occurred.double
getValue()
The actual value of the physical value which triggered the detection of a violation.toString()
Methods inherited from class com.powsybl.commons.extensions.AbstractExtendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension, removeExtension
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.powsybl.commons.extensions.Extendable
newExtension
-
Constructor Details
-
LimitViolation
public LimitViolation(String subjectId, @Nullable String subjectName, LimitViolationType limitType, @Nullable String limitName, int acceptableDuration, double limit, double limitReduction, double value, @Nullable ThreeSides side) Create a new LimitViolation.According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
- Parameters:
subjectId
- The identifier of the network equipment on which the violation occurred.subjectName
- An optional name of the network equipment on which the violation occurred.limitType
- The type of limit which has been violated.limitName
- An optional name for the limit which has been violated.acceptableDuration
- The acceptable duration, in seconds, associated to the current violation value. Only relevant for current limits.limit
- The value of the limit which has been violated.limitReduction
- The limit reduction factor used for violation detection.value
- The actual value of the physical value which triggered the detection of a violation.side
- The side of the equipment where the violation occurred. May benull
for non-branch, non-three windings transformer equipments.
-
LimitViolation
public LimitViolation(String subjectId, @Nullable String subjectName, LimitViolationType limitType, @Nullable String limitName, int acceptableDuration, double limit, double limitReduction, double value) Create a new LimitViolation without side.According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
- Parameters:
subjectId
- The identifier of the network equipment on which the violation occurred.subjectName
- An optional name of the network equipment on which the violation occurred.limitType
- The type of limit which has been violated.limitName
- An optional name for the limit which has been violated.acceptableDuration
- The acceptable duration, in seconds, associated to the current violation value. Only relevant for current limits.limit
- The value of the limit which has been violated.limitReduction
- The limit reduction factor used for violation detection.value
- The actual value of the physical value which triggered the detection of a violation.
-
LimitViolation
public LimitViolation(String subjectId, @Nullable String subjectName, LimitViolationType limitType, @Nullable String limitName, int acceptableDuration, double limit, double limitReduction, double value, TwoSides side) Create a new LimitViolation.According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
- Parameters:
subjectId
- The identifier of the network equipment on which the violation occurred.subjectName
- An optional name of the network equipment on which the violation occurred.limitType
- The type of limit which has been violated.limitName
- An optional name for the limit which has been violated.acceptableDuration
- The acceptable duration, in seconds, associated to the current violation value. Only relevant for current limits.limit
- The value of the limit which has been violated.limitReduction
- The limit reduction factor used for violation detection.value
- The actual value of the physical value which triggered the detection of a violation.side
- The side of the equipment where the violation occurred. May benull
for non-branch, non-three windings transformer equipments.
-
LimitViolation
public LimitViolation(String subjectId, LimitViolationType limitType, String limitName, int acceptableDuration, double limit, double limitReduction, double value, TwoSides side) Create a new LimitViolation.According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
- Parameters:
subjectId
- The identifier of the network equipment on which the violation occurred.limitType
- The type of limit which has been violated.limitName
- An optional name for the limit which has been violated.acceptableDuration
- The acceptable duration, in seconds, associated to the current violation value. Only relevant for current limits.limit
- The value of the limit which has been violated.limitReduction
- The limit reduction factor used for violation detection.value
- The actual value of the physical value which triggered the detection of a violation.side
- The side of the equipment where the violation occurred. May benull
for non-branch, non-three windings transformer equipments.
-
LimitViolation
public LimitViolation(String subjectId, LimitViolationType limitType, String limitName, int acceptableDuration, double limit, double limitReduction, double value) Create a new LimitViolation without side.According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
- Parameters:
subjectId
- The identifier of the network equipment on which the violation occurred.limitType
- The type of limit which has been violated.limitName
- An optional name for the limit which has been violated.acceptableDuration
- The acceptable duration, in seconds, associated to the current violation value. Only relevant for current limits.limit
- The value of the limit which has been violated.limitReduction
- The limit reduction factor used for violation detection.value
- The actual value of the physical value which triggered the detection of a violation.
-
LimitViolation
public LimitViolation(String subjectId, String subjectName, LimitViolationType limitType, double limit, double limitReduction, double value) Create a new LimitViolation, for types other than current limits.According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
- Parameters:
subjectId
- The identifier of the network equipment on which the violation occurred.subjectName
- An optional name of the network equipment on which the violation occurred.limitType
- The type of limit which has been violated.limit
- The value of the limit which has been violated.limitReduction
- The limit reduction factor used for violation detection.value
- The actual value of the physical value which triggered the detection of a violation.
-
LimitViolation
public LimitViolation(String subjectId, LimitViolationType limitType, double limit, double limitReduction, double value) Create a new LimitViolation, for voltage angle limit.According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
- Parameters:
subjectId
- The identifier of the network equipment on which the violation occurred.limitType
- The type of limit which has been violated.limit
- The value of the limit which has been violated.limitReduction
- The limit reduction factor used for violation detection.value
- The actual value of the physical value which triggered the detection of a violation.
-
-
Method Details
-
getSubjectId
The identifier of the network equipment on which the violation occurred.- Returns:
- the identifier of the network equipment on which the violation occurred.
-
getSubjectName
The name of the network equipment on which the violation occurred. May benull
.- Returns:
- the name of the network equipment on which the violation occurred.
-
getLimitType
The type of limit which has been violated.- Returns:
- the type of limit which has been violated.
-
getLimit
public double getLimit()The value of the limit which has been violated.- Returns:
- the value of the limit which has been violated.
-
getLimitName
The name of the limit which has been violated. May benull
.- Returns:
- the value of the limit which has been violated. May be
null
.
-
getAcceptableDuration
public int getAcceptableDuration()The acceptable duration, in seconds, associated to the current violation value. Only relevant for current limits.- Returns:
- the acceptable duration, in seconds, associated to the current violation value.
-
getLimitReduction
public double getLimitReduction()The limit reduction factor used for violation detection. For example when monitoring values above 95% of a given limit, this will return0.95
- Returns:
- the limit reduction factor used for violation detection.
-
getValue
public double getValue()The actual value of the physical value which triggered the detection of a violation.- Returns:
- the actual value of the physical value which triggered the detection of a violation.
-
getSideAsTwoSides
The side of the equipment with two sides (like branch) where the violation occurred.- Returns:
- the side of the equipment with two sides (like branch) where the violation occurred.
-
getSide
The side of the equipment where the violation occurred. Will benull
for equipments other than branches and three windings transformers.- Returns:
- the side of the equipment where the violation occurred. Will be
null
for equipments other than branches and three windings transformers.
-
toString
-