Package com.powsybl.iidm.network
Interface Branch<I extends Branch<I>>
-
- All Superinterfaces:
Connectable<I>
,Extendable<I>
,Identifiable<I>
- All Known Subinterfaces:
Line
,TieLine
,TwoWindingsTransformer
- All Known Implementing Classes:
LineAdapter
,TieLineAdapter
,TwoWindingsTransformerAdapter
public interface Branch<I extends Branch<I>> extends Connectable<I>
An equipment with two terminals.Characteristics
Attribute Type Unit Required Defaut value Description Id String - yes - Unique identifier of the branch Name String - yes - Human-readable name of the branch R double Ω yes - The series resistance X double Ω yes - The series reactance G1 double S yes - The first side shunt conductance B1 double S yes - The first side shunt susceptance G2 double S yes - The second side shunt conductance B2 double S yes - The second side shunt susceptance - Author:
- Geoffroy Jamgotchian
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Branch.Overload
Represents a current overload on aBranch
.static class
Branch.Side
-
Method Summary
-
Methods inherited from interface com.powsybl.iidm.network.Connectable
getTerminals, remove
-
Methods inherited from interface com.powsybl.commons.extensions.Extendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
-
Methods inherited from interface com.powsybl.iidm.network.Identifiable
addAlias, addAlias, addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getName, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, getType, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, removeProperty, setFictitious, setName, setProperty
-
-
-
-
Method Detail
-
getTerminal1
Terminal getTerminal1()
Get the first terminal.
-
getTerminal2
Terminal getTerminal2()
Get the second terminal.
-
getTerminal
Terminal getTerminal(Branch.Side side)
-
getSide
Branch.Side getSide(Terminal terminal)
-
getOperationalLimits1
default Collection<OperationalLimits> getOperationalLimits1()
-
getCurrentLimits1
Optional<CurrentLimits> getCurrentLimits1()
-
getNullableCurrentLimits1
CurrentLimits getNullableCurrentLimits1()
-
getActivePowerLimits1
Optional<ActivePowerLimits> getActivePowerLimits1()
-
getNullableActivePowerLimits1
ActivePowerLimits getNullableActivePowerLimits1()
-
getApparentPowerLimits1
Optional<ApparentPowerLimits> getApparentPowerLimits1()
-
getNullableApparentPowerLimits1
ApparentPowerLimits getNullableApparentPowerLimits1()
-
newCurrentLimits1
CurrentLimitsAdder newCurrentLimits1()
-
newActivePowerLimits1
ActivePowerLimitsAdder newActivePowerLimits1()
-
newApparentPowerLimits1
ApparentPowerLimitsAdder newApparentPowerLimits1()
-
getOperationalLimits2
default Collection<OperationalLimits> getOperationalLimits2()
-
getCurrentLimits2
Optional<CurrentLimits> getCurrentLimits2()
-
getNullableCurrentLimits2
CurrentLimits getNullableCurrentLimits2()
-
getActivePowerLimits2
Optional<ActivePowerLimits> getActivePowerLimits2()
-
getNullableActivePowerLimits2
ActivePowerLimits getNullableActivePowerLimits2()
-
getApparentPowerLimits2
Optional<ApparentPowerLimits> getApparentPowerLimits2()
-
getNullableApparentPowerLimits2
ApparentPowerLimits getNullableApparentPowerLimits2()
-
newCurrentLimits2
CurrentLimitsAdder newCurrentLimits2()
-
newActivePowerLimits2
ActivePowerLimitsAdder newActivePowerLimits2()
-
newApparentPowerLimits2
ApparentPowerLimitsAdder newApparentPowerLimits2()
-
getCurrentLimits
default Optional<CurrentLimits> getCurrentLimits(Branch.Side side)
-
getActivePowerLimits
default Optional<ActivePowerLimits> getActivePowerLimits(Branch.Side side)
-
getApparentPowerLimits
default Optional<ApparentPowerLimits> getApparentPowerLimits(Branch.Side side)
-
getLimits
default Optional<? extends LoadingLimits> getLimits(LimitType type, Branch.Side side)
-
getNullableCurrentLimits
default CurrentLimits getNullableCurrentLimits(Branch.Side side)
-
getNullableActivePowerLimits
default ActivePowerLimits getNullableActivePowerLimits(Branch.Side side)
-
getNullableApparentPowerLimits
default ApparentPowerLimits getNullableApparentPowerLimits(Branch.Side side)
-
getNullableLimits
default LoadingLimits getNullableLimits(LimitType type, Branch.Side side)
-
isOverloaded
boolean isOverloaded()
Only checks overloading for LimitType.Current and permanent limits
-
isOverloaded
boolean isOverloaded(float limitReduction)
Only checks overloading for LimitType.Current and permanent limits
-
getOverloadDuration
int getOverloadDuration()
-
checkPermanentLimit
@Deprecated(since="4.3.0") default boolean checkPermanentLimit(Branch.Side side, float limitReduction)
Deprecated.Since 4.3.0, usecheckPermanentLimit(Side, float, LimitType)
instead.
-
checkPermanentLimit
default boolean checkPermanentLimit(Branch.Side side, float limitReduction, LimitType type)
-
checkPermanentLimit
@Deprecated(since="4.3.0") default boolean checkPermanentLimit(Branch.Side side)
Deprecated.Since 4.3.0, usecheckPermanentLimit(Side, LimitType)
instead.
-
checkPermanentLimit
default boolean checkPermanentLimit(Branch.Side side, LimitType type)
-
checkPermanentLimit1
@Deprecated(since="4.3.0") default boolean checkPermanentLimit1(float limitReduction)
Deprecated.Since 4.3.0, usecheckPermanentLimit1(float, LimitType)
instead.
-
checkPermanentLimit1
default boolean checkPermanentLimit1(float limitReduction, LimitType type)
-
checkPermanentLimit1
@Deprecated(since="4.3.0") default boolean checkPermanentLimit1()
Deprecated.Since 4.3.0, usecheckPermanentLimit1(LimitType)
instead.
-
checkPermanentLimit1
default boolean checkPermanentLimit1(LimitType type)
-
checkPermanentLimit2
@Deprecated(since="4.3.0") default boolean checkPermanentLimit2(float limitReduction)
Deprecated.Since 4.3.0, usecheckPermanentLimit2(float, LimitType)
instead.
-
checkPermanentLimit2
default boolean checkPermanentLimit2(float limitReduction, LimitType type)
-
checkPermanentLimit2
@Deprecated(since="4.3.0") default boolean checkPermanentLimit2()
Deprecated.Since 4.3.0, usecheckPermanentLimit2(LimitType)
instead.
-
checkPermanentLimit2
default boolean checkPermanentLimit2(LimitType type)
-
checkTemporaryLimits
@Deprecated(since="4.3.0") default Branch.Overload checkTemporaryLimits(Branch.Side side, float limitReduction)
Deprecated.Since 4.3.0, usecheckTemporaryLimits(Side, float, LimitType)
instead.
-
checkTemporaryLimits
default Branch.Overload checkTemporaryLimits(Branch.Side side, float limitReduction, LimitType type)
-
checkTemporaryLimits
@Deprecated(since="4.3.0") default Branch.Overload checkTemporaryLimits(Branch.Side side)
Deprecated.Since 4.3.0, usecheckTemporaryLimits(Side, LimitType)
instead.
-
checkTemporaryLimits
default Branch.Overload checkTemporaryLimits(Branch.Side side, LimitType type)
-
checkTemporaryLimits1
@Deprecated(since="4.3.0") default Branch.Overload checkTemporaryLimits1(float limitReduction)
Deprecated.Since 4.3.0, usecheckTemporaryLimits1(float, LimitType)
instead.
-
checkTemporaryLimits1
default Branch.Overload checkTemporaryLimits1(float limitReduction, LimitType type)
-
checkTemporaryLimits1
@Deprecated(since="4.3.0") default Branch.Overload checkTemporaryLimits1()
Deprecated.Since 4.3.0, usecheckTemporaryLimits1(LimitType)
instead.
-
checkTemporaryLimits1
default Branch.Overload checkTemporaryLimits1(LimitType type)
-
checkTemporaryLimits2
@Deprecated(since="4.3.0") default Branch.Overload checkTemporaryLimits2(float limitReduction)
Deprecated.Since 4.3.0, usecheckTemporaryLimits2(float, LimitType)
instead.
-
checkTemporaryLimits2
default Branch.Overload checkTemporaryLimits2(float limitReduction, LimitType type)
-
checkTemporaryLimits2
@Deprecated(since="4.3.0") default Branch.Overload checkTemporaryLimits2()
Deprecated.Since 4.3.0, usecheckTemporaryLimits2(LimitType)
instead.
-
checkTemporaryLimits2
default Branch.Overload checkTemporaryLimits2(LimitType type)
-
-