IscBranch
The IscBranch
class provides access to an IPSA branch, to set and get data values and to retrieve analysis results.
Note that the branch rating sets are defined in the IscNetwork
class.
Field Values
Type |
Field Name |
Description |
---|---|---|
Integer |
FromUID |
Gets the unique component ID for the “From” busbar. |
Integer |
ToUID |
Gets the unique component ID for the “To” busbar. |
String |
FromBusName |
Gets the sending busbar name. |
String |
ToBusName |
Gets the receiving busbar name. |
String |
Name |
Gets the branch name. |
Boolean |
HideLabel |
|
Integer |
Type |
Gets the branch/line type as defined below.
|
Integer |
Status |
Line status as defined below:
|
Float |
ResistancePU |
Positive sequence resistance. |
Float |
MinResistancePU |
Positive sequence minimum resistance. |
Float |
ReactancePU |
Positive sequence reactance. |
Float |
SusceptancePU |
Positive sequence susceptance. |
Float |
ZSResistancePU |
Zero sequence resistance. |
Float |
ZSReactancePU |
Zero sequence reactance. |
Boolean |
ZeroImpedance |
|
Boolean |
ZeroSequence |
|
Float |
SwitchTime1Sec |
Line switching time 1. |
Float |
SwitchTime2Sec |
Line switching time 2. |
Float |
HarmRC0 HarmRC12 HarmRC1 HarmRC2 HarmRC3 |
Harmonic polynomial constants RC0, RC12, RC1, RC2 and RC3 in: \(R_{h} = R[RC0 + RC12.h^{0.5} 0 + RC1.h + RC2.h^2 + RC3.h^3]\) |
Float |
HarmXC0 HarmXC1 HarmXC2 HarmXC3 HarmXCEX HarmXEX |
Harmonic polynomial constants XC0, XC1, XC2, XC3, XCEX and XEX in: \(X{h} = X[XC0 + XC1.h + XC2.h^2 + XC3.h^3] + XCEX.X.h^{XEX}\) |
Float |
FailureRateYr |
Branch failure rate per annum. |
Float |
RepairTimeHr |
Branch repair time in hours. |
String |
DbType1 |
Branch database type. For representing the cable at the From end of the transformer. |
String |
DbType2 |
Second cable database type representing the cable at the To end of the transformer. |
Float |
DbLength1 or LengthKm |
First cable database length. |
Float |
DbLength2 |
Second cable database length (for transformers only). |
Integer |
DbPar1 |
Gets the number of lines of database type 1 in parallel. |
Integer |
DbPar2 |
Gets the number of lines of database type 2 in parallel. |
String |
DbTranType |
Gets the transformer database type (only for transformers). |
Integer |
DbTranPar |
Gets the number of transformers in parallel (database only and only for transformers). |
String |
UdmID |
Gets the UDM ID. |
Integer |
UdmDevEnd |
Gets the device end. |
Integer |
UdmCtrlType |
Gets the UDM type. |
Integer |
UdmCtrlUID |
Gets the UDM control ID. |
String |
PluginID |
Plugin Name, empty string means no plugin is assigned. |
IscBranch Class
- class ipsa.IscBranch
Provides access to the IPSA branch.
- AddSections(nSections: int) None
Add sections to the branch. All branches start with one section.
- Parameters:
nSections (int) – The number of sections.
- GetSections() int
Returns the number of sections in the branch. All branches have at least one section.
- Returns:
The number of sections in the branch.
- Return type:
- GetIValue(nFieldIndex: int) int
- GetIValue(nSection: int, nFieldIndex: int) int
Returns an integer value for the enumerated field.
- GetDValue(nFieldIndex: int) float
- GetDValue(nSection: int, nFieldIndex: int) float
Returns a double value for the enumerated field.
- GetSValue(nFieldIndex: int) str
- GetSValue(nSection: int, nFieldIndex: int) str
Returns a string value for the enumerated field.
- GetBValue(nFieldIndex: int) bool
- GetBValue(nSection: int, nFieldIndex: int) bool
Returns a boolean value for the enumerated field.
- SetIValue(nFieldIndex: int, nValue: int) bool
- SetIValue(nSection: int, nFieldIndex: int, nValue: int) bool
Sets the value for the enumerated field from an integer.
- SetDValue(nFieldIndex: int, dValue: float) bool
- SetDValue(nSection: int, nFieldIndex: int, dValue: float) bool
Sets the value for the enumerated field from a double.
- SetSValue(nFieldIndex: int, strValue: int) bool
- SetSValue(nSection: int, nFieldIndex: int, strValue: int) bool
Sets the value for the enumerated field from a string.
- SetBValue(nFieldIndex: int, bValue: bool) bool
- SetBValue(nSection: int, nFieldIndex: int, bValue: bool) bool
Sets the value for the enumerated field from boolean.
- GetRatingMVA(nRatingIndex: int) float
- GetRatingMVA(nSection: int, nRatingIndex: int) float
Returns the MVA rating associated with the rating set given by the rating index. Set 0 for details of branch rating indices.
- GetRatingSendkA(nRatingIndex: int) float
- GetRatingSendkA(nSection: int, nRatingIndex: int) float
Returns the send end kA rating associated with the rating set given by the rating index. Set 0 for details of branch rating indices.
- GetRatingReceivekA(nRatingIndex: int) float
- GetRatingReceivekA(nSection: int, nRatingIndex: int) float
Returns the receiving end kA rating associated with the rating set given by the rating index. Set 0 for details of branch rating indices.
- SetRatingMVA(nRatingIndex: int, dRatingMVA: float) None
- SetRatingMVA(nSection: int, nRatingIndex: int, dRatingMVA: float) None
Sets the MVA rating to the specified rating MVA for the rating set given by the rating index.
- SetRatingkA(nRatingIndex: int, dRatingkA: float) None
- SetRatingkA(nSection: int, nRatingIndex: int, dRatingkA: float) None
Sets the kA rating to the specified rating kA for the rating set given by the rating index.
- SetRatingSendkA(nRatingIndex: int, dRatingkA: float) None
- SetRatingSendkA(nSection: int, nRatingIndex: int, dRatingkA: float) None
Sets the send end kA rating to the specified rating kA for the rating set given by the rating index.
- SetRatingReceivekA(nRatingIndex: int, dRatingkA: float) None
- SetRatingReceivekA(nSection: int, nRatingIndex: int, dRatingkA: float) None
Sets the receiving end kA rating to the specified rating kA for the rating set given by the rating index.
- PopulateByDBEntry(strLineDataName: str, dLength: float, nParallel: int) bool
Populates the object data with database information from the first database that was loaded.
- GetSendPowerMagnitudeMVA() float
Returns the branch sending end power in MVA.
- Returns:
The branch sending end power in MVA.
- Return type:
- GetSendPowerMagnitudekVA() float
Returns the branch sending end power in kVA.
- Returns:
The branch sending end power in kVA.
- Return type:
- GetSendRealPowerMW() float
Returns the branch sending end power in MW.
- Returns:
The branch sending end power in MW.
- Return type:
- GetSendReactivePowerMVAr() float
Returns the branch sending end power in MVAr.
- Returns:
The branch sending end power in MVAr.
- Return type:
- GetSendRealPowerkW() float
Returns the branch sending end power in kW.
- Returns:
The branch sending end power in kW.
- Return type:
- GetSendReactivePowerkVAr() float
Returns the branch sending end power in kVAr.
- Returns:
The branch sending end power in kVAr.
- Return type:
- GetReceivePowerMagnitudeMVA() float
Returns the branch receiving end power in MVA.
- Returns:
The branch receiving end power in MVA.
- Return type:
- GetReceivePowerMagnitudekVA() float
Returns the branch receiving end power in kVA.
- Returns:
The branch receiving end power in kVA.
- Return type:
- GetReceiveRealPowerMW() float
Returns the branch receiving end power in MW.
- Returns:
The branch receiving end power in MW.
- Return type:
- GetReceiveReactivePowerMVAr() float
Returns the branch receiving end power in MVAr.
- Returns:
The branch receiving end power in MVAr.
- Return type:
- GetReceiveRealPowerkW() float
Returns the branch receiving end power in kW.
- Returns:
The branch receiving end power in kW.
- Return type:
- GetReceiveReactivePowerkVAr() float
Returns the branch receiving end power in kVAr.
- Returns:
The branch receiving end power in kVAr.
- Return type:
- GetLargestPowerMagnitudeMVA() float
- GetLargestPowerMagnitudeMVA(nStudyUID: int) float
Returns the highest branch power in MVA.
- GetLargestPowerMagnitudekVA() float
Returns the highest branch power in kVA.
- Returns:
The highest branch power in kVA.
- Return type:
- GetLargestRealPowerMW() float
Returns the highest branch power in MW.
- Returns:
The highest branch power in MW.
- Return type:
- GetLargestReactivePowerMVAr() float
Returns the highest branch power in MVAr.
- Returns:
The highest branch power in MVAr.
- Return type:
- GetLargestRealPowerkW() float
Returns the highest branch power in kW.
- Returns:
The highest branch power in kW.
- Return type:
- GetLargestReactivePowerkVAr() float
Returns the highest branch power in kVAr.
- Returns:
The highest branch power in kVAr.
- Return type:
- GetLossesMW() float
Returns the branch losses in MW.
- Returns:
The branch losses in MW.
- Return type:
- GetLossesMVAr() float
Returns the branch losses in MVAr.
- Returns:
The branch losses in MVAr.
- Return type:
- GetLosseskW() float
Returns the branch losses in kW.
- Returns:
The branch losses in kW.
- Return type:
- GetLosseskVAr() float
Returns the branch losses in kVAr.
- Returns:
The branch losses in kVAr.
- Return type:
- GetFaultRedComponentMVA() float
Returns the red phase level component in MVA.
- Returns:
The red phase level component in MVA.
- Return type:
- GetFaultYellowComponentMVA() float
Returns the yellow phase fault level component in MVA.
- Returns:
The yellow phase fault level component in MVA.
- Return type:
- GetFaultBlueComponentMVA() float
Returns the blue phase fault level component in MVA.
- Returns:
The blue phase fault level component in MVA.
- Return type:
- GetFaultPositiveComponentMVA() float
Returns the positive sequence fault level component in MVA.
- Returns:
The positive sequence fault level component in MVA.
- Return type:
- GetFaultNegativeComponentMVA() float
Returns the negative sequence fault level component in MVA.
- Returns:
The negative sequence fault level component in MVA.
- Return type:
- GetFaultZeroComponentMVA() float
Returns the zero sequence fault level component in MVA.
- Returns:
The zero sequence fault level component in MVA.
- Return type:
- GetFaultRedComponentkA() float
Returns the red phase component of fault current in kA.
- Returns:
The red phase component of fault current in kA.
- Return type:
- GetFaultYellowComponentkA() float
Returns the yellow phase component of fault current in kA.
- Returns:
The yellow phase component of fault current in kA.
- Return type:
- GetFaultBlueComponentkA() float
Returns the blue phase component of fault current in kA.
- Returns:
The blue phase component of fault current in kA.
- Return type:
- GetFaultPositiveComponentkA() float
Returns the positive sequence component of fault current in kA.
- Returns:
The positive sequence component of fault current in kA.
- Return type:
- GetFaultNegativeComponentkA() float
Returns the negative sequence component of fault current in kA.
- Returns:
The negative sequence component of fault current in kA.
- Return type:
- GetFaultZeroComponentkA() float
Returns the zero sequence component of fault current in kA.
- Returns:
The zero sequence component of fault current in kA.
- Return type:
- GetFaultRedComponentAngleDeg() float
Returns the red phase component of fault angle in degrees.
- Returns:
The red phase component of fault angle in degrees.
- Return type:
- GetFaultYellowComponentAngleDeg() float
Returns the yellow phase component of fault angle in degrees.
- Returns:
The yellow phase component of fault angle in degrees.
- Return type:
- GetFaultBlueComponentAngleDeg() float
Returns the blue phase component of fault angle in degrees.
- Returns:
The blue phase component of fault angle in degrees.
- Return type:
- GetFaultPositiveComponentAngleDeg() float
Returns the positive sequence component of fault angle in degrees.
- Returns:
The positive sequence component of fault angle in degrees.
- Return type:
- GetFaultNegativeComponentAngleDeg() float
Returns the negative sequence component of fault angle in degrees.
- Returns:
The negative sequence component of fault angle in degrees.
- Return type:
- GetFaultZeroComponentAngleDeg() float
Returns the zero sequence component of fault angle in degrees.
- Returns:
The zero sequence component of fault angle in degrees.
- Return type:
- GetCurrentMagnitude(dOrder: float) float
Returns the current magnitude in per unit on the network base for the harmonic order.
- GetResistance(dOrder: float) float
Returns the branch harmonic resistance in per unit on the network base for the harmonic order.
- GetReactance(dOrder: float) float
Returns the branch harmonic reactance in per unit on the network base for the harmonic order.
- GetSusceptance(dOrder: float) float
Returns the branch harmonic susceptance in per unit on the network base for the harmonic order.
- GetProfileMinimumFlowMVA() float
Returns the minimum branch flow in MVA from the profile study results.
- Returns:
The minimum branch flow in MVA from the profile study results.
- Return type:
- GetProfileMinimumFlowkA() float
Returns the minimum branch flow in kA from the profile study results.
- Returns:
The minimum branch flow in kA from the profile study results.
- Return type:
- GetProfileMaximumFlowMVA() float
Returns the maximum branch flow in MVA from the profile study results.
- Returns:
The maximum branch flow in MVA from the profile study results.
- Return type:
- GetProfileMaximumFlowkA() float
Returns the maximum branch flow in kA from the profile study results.
- Returns:
The maximum branch flow in kA from the profile study results.
- Return type:
- GetProfileMedianFlowMVA() float
Returns the median of the branch flow in MVA from the profile study results.
- Returns:
The median of the branch flow in MVA from the profile study results.
- Return type:
- GetProfileMedianFlowkA() float
Returns the median of the branch flow in kA from the profile study results.
- Returns:
The median of the branch flow in kA from the profile study results.
- Return type:
- GetMinimumProfileIndex() int
Returns the category index which identifies the minimum branch flow from the profile study results.
- Returns:
The minimum category index.
- Return type:
- GetMaximumProfileIndex() int
Returns the category index which identifies the maximum branch flow from the profile study results.
- Returns:
The maximum category index.
- Return type:
- GetDCLFSendPowerMagnitudeMVA() float
Returns the branch sending end power in MVA.
- Returns:
The branch sending end power in MVA.
- Return type:
- GetDCLFSendPowerMagnitudekVA() float
Returns the branch sending end power in kVA.
- Returns:
The branch sending end power in kVA.
- Return type:
- GetDCLFSendRealPowerMW() float
Returns the branch sending end power in MW.
- Returns:
The branch sending end power in MW.
- Return type:
- GetDCLFSendRealPowerkW() float
Returns the branch sending end power in kW.
- Returns:
The branch sending end power in kW.
- Return type:
- GetDCLFReceivePowerMagnitudeMVA() float
Returns the branch receiving end power in MVA.
- Returns:
The branch receiving end power in MVA.
- Return type:
- GetDCLFReceivePowerMagnitudekVA() float
Returns the branch receiving end power in kVA.
- Returns:
The branch receiving end power in kVA.
- Return type:
- GetDCLFReceiveRealPowerMW() float
Returns the branch receiving end power in MW.
- Returns:
The branch receiving end power in MW.
- Return type:
- GetDCLFReceiveRealPowerkW() float
Returns the branch receiving end power in kW.
- Returns:
The branch receiving end power in kW.
- Return type:
- GetDCLFLargestPowerMagnitudeMVA() float
Returns the highest branch power in MVA.
- Returns:
The highest branch power in MVA.
- Return type:
- GetDCLFLargestPowerMagnitudekVA() float
Returns the highest branch power in kVA.
- Returns:
The highest branch power in kVA.
- Return type:
- GetDCLFLargestRealPowerMW() float
Returns the highest branch power in MW.
- Returns:
The highest branch power in MW.
- Return type:
- GetDCLFLargestRealPowerkW() float
Returns the highest branch power in kW.
- Returns:
The highest branch power in kW.
- Return type: