public class LimitViolation extends AbstractExtendable<LimitViolation>
Constructor and Description |
---|
LimitViolation(String subjectId,
LimitViolationType limitType,
double limit,
float limitReduction,
double value)
Create a new LimitViolation, for types other than current limits.
|
LimitViolation(String subjectId,
LimitViolationType limitType,
String limitName,
int acceptableDuration,
double limit,
float limitReduction,
double value,
Branch.Side side)
Create a new LimitViolation.
|
LimitViolation(String subjectId,
String subjectName,
LimitViolationType limitType,
double limit,
float 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,
float limitReduction,
double value,
Branch.Side side)
Create a new LimitViolation.
|
Modifier and Type | Method and Description |
---|---|
int |
getAcceptableDuration()
The acceptable duration, in seconds, associated to the current violation value.
|
double |
getLimit()
The value of the limit which has been violated.
|
String |
getLimitName()
The name of the limit which has been violated.
|
float |
getLimitReduction()
The limit reduction factor used for violation detection.
|
LimitViolationType |
getLimitType()
The type of limit which has been violated.
|
Branch.Side |
getSide()
The side of the equipment where the violation occurred.
|
String |
getSubjectId()
The identifier of the network equipment on which the violation occurred.
|
String |
getSubjectName()
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.
|
String |
toString() |
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
newExtension
public LimitViolation(String subjectId, @Nullable String subjectName, LimitViolationType limitType, @Nullable String limitName, int acceptableDuration, double limit, float limitReduction, double value, @Nullable Branch.Side side)
According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
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 be null
for non-branch equipments.public LimitViolation(String subjectId, LimitViolationType limitType, String limitName, int acceptableDuration, double limit, float limitReduction, double value, Branch.Side side)
According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
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 be null
for non-branch equipments.public LimitViolation(String subjectId, String subjectName, LimitViolationType limitType, double limit, float limitReduction, double value)
According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
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.public LimitViolation(String subjectId, LimitViolationType limitType, double limit, float limitReduction, double value)
According to the violation type, all parameters may not be mandatory. See constructor overloads for particular types.
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.public String getSubjectId()
@Nullable public String getSubjectName()
null
.public LimitViolationType getLimitType()
public double getLimit()
@Nullable public String getLimitName()
null
.null
.public int getAcceptableDuration()
public float getLimitReduction()
0.95f
public double getValue()
@Nullable public Branch.Side getSide()
null
for equipments
other than branches.null
for equipments
other than branches.Copyright © 2020. All rights reserved.