IscEquivalentBranch

The IscEquivalentBranch class provides access to an IPSA equivalent branch (generated by network reduction), to set and get data values and to retrieve load flow results.

Field Values

IscEquivalentBranch 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.
Integer	Status	Status: 0 = Switched in -1 = Switched out
Float	ResistancePU	Gets and sets the positive sequence resistance in per unit.
Float	ReactancePU	Gets and sets the positive sequence reactance in per unit.
Boolean	HideLabel	True if the branch label (usually the name and any results) should be hidden on the diagram.
String	Comment	Gets and sets the comments.

IscEquivalentBranch Class

class ipsa.IscEquivalentBranch

Provides access to the IPSA equivalent branch.

SetName(strName: str) → bool

Sets the name as a string.

Parameters:

strName (str) – The selected string name.

Returns:

True if successful.

Return type:

bool

GetIValue(nFieldIndex: int) → int

Returns an integer value for the enumerated field.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The integer value.

Return type:

int

GetDValue(nFieldIndex: int) → float

Returns a double value for the enumerated field.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The double value.

Return type:

float

GetSValue(nFieldIndex: int) → str

Returns a string value for the enumerated field.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The string value.

Return type:

str

GetBValue(nFieldIndex: int) → bool

Returns a boolean value for the enumerated field.

Parameters:

nFieldIndex (int) – The field index.

Returns:

The boolean value.

Return type:

bool

SetIValue(nFieldIndex: int, nValue: int) → bool

Sets the value for the enumerated field from an integer.

Parameters:

• nFieldIndex (int) – The field index.

• nValue (int) – The given integer value.

Returns:

True if successful.

Return type:

bool

SetDValue(nFieldIndex: int, dValue: float) → bool

Sets the value for the enumerated field from a double.

Parameters:

• nFieldIndex (int) – The field index.

• dValue (float) – The given double value.

Returns:

True if successful.

Return type:

bool

SetSValue(nFieldIndex: int, strValue: int) → bool

Sets the value for the enumerated field from a string.

Parameters:

• nFieldIndex (int) – The field index.

• strValue (str) – The given string value.

Returns:

True if successful.

Return type:

bool

SetBValue(nFieldIndex: int, bValue: bool) → bool

Sets the value for the enumerated field from boolean.

Parameters:

• nFieldIndex (int) – The field index.

• bValue (bool) – The given boolean value.

Returns:

True if successful.

Return type:

bool

GetSendPowerMagnitudeMVA() → float

Returns the equivalent branch sending end power in MVA.

Returns:

The equivalent branch sending end power in MVA.

Return type:

float

GetSendPowerMagnitudekVA() → float

Returns the equivalent branch sending end power in kVA.

Returns:

The equivalent branch sending end power in kVA.

Return type:

float

GetSendRealPowerMW() → float

Returns the equivalent branch sending end power in MW.

Returns:

The equivalent branch sending end power in MW.

Return type:

float

GetSendReactivePowerMVAr() → float

Returns the equivalent branch sending end power in MVAr.

Returns:

The equivalent branch sending end power in MVAr.

Return type:

float

GetSendRealPowerkW() → float

Returns the equivalent branch sending end power in kW.

Returns:

The equivalent branch sending end power in kW.

Return type:

float

GetSendReactivePowerkVAr() → float

Returns the equivalent branch sending end power in kVAr.

Returns:

The equivalent branch sending end power in kVAr.

Return type:

float

GetReceivePowerMagnitudeMVA() → float

Returns the equivalent branch receiving end power in MVA.

Returns:

The equivalent branch receiving end power in MVA.

Return type:

float

GetReceivePowerMagnitudekVA() → float

Returns the equivalent branch receiving end power in kVA.

Returns:

The equivalent branch receiving end power in kVA.

Return type:

float

GetReceiveRealPowerMW() → float

Returns the equivalent branch receiving end power in MW.

Returns:

The equivalent branch receiving end power in MW.

Return type:

float

GetReceiveReactivePowerMVAr() → float

Returns the equivalent branch receiving end power in MVAr.

Returns:

The equivalent branch receiving end power in MVAr.

Return type:

float

GetReceiveRealPowerkW() → float

Returns the equivalent branch receiving end power in kW.

Returns:

The equivalent branch receiving end power in kW.

Return type:

float

GetReceiveReactivePowerkVAr() → float

Returns the equivalent branch receiving end power in kVAr.

Returns:

The equivalent branch receiving end power in kVAr.

Return type:

float

GetLargestPowerMagnitudeMVA() → float

Returns the highest equivalent branch power in MVA.

Returns:

The highest equivalent branch power in MVA.

Return type:

float

GetLargestPowerMagnitudekVA() → float

Returns the highest equivalent branch power in kVA.

Returns:

The highest equivalent branch power in kVA.

Return type:

float

GetLargestRealPowerMW() → float

Returns the highest equivalent branch power in MW.

Returns:

The highest equivalent branch power in MW.

Return type:

float

GetLargestReactivePowerMVAr() → float

Returns the highest equivalent branch power in MVAr.

Returns:

The highest equivalent branch power in MVAr.

Return type:

float

GetLargestRealPowerkW() → float

Returns the highest equivalent branch power in kW.

Returns:

The highest equivalent branch power in kW.

Return type:

float

GetLargestReactivePowerkVAr() → float

Returns the highest equivalent branch power in kVAr.

Returns:

The highest equivalent branch power in kVAr.

Return type:

float

GetLossesMW() → float

Returns the equivalent branch losses in MW.

Returns:

The equivalent branch losses in MW.

Return type:

float

GetLossesMVAr() → float

Returns the equivalent branch losses in MVAr.

Returns:

The equivalent branch losses in MVAr.

Return type:

float

GetLosseskW() → float

Returns the equivalent branch losses in kW.

Returns:

The equivalent branch losses in kW.

Return type:

float

GetLosseskVAr() → float

Returns the equivalent branch losses in kVAr.

Returns:

The equivalent branch losses in kVAr.

Return type:

float

GetCapacityHeadroomPC() → float

Returns the equivalent branch capacity headroom as a percentage.

Returns:

The equivalent branch capacity headroom as a percentage.

Return type:

float