IscBusbar

The IscBusbar class provides access to an IPSA busbar, to set and get data values and to retrieve load flow and fault level results.

Field Values

IscBusbar Field Values

Type

Field Name

Description

String

Name

Gets the busbar name.

Float

NomVoltkV

Nominal bus voltage in kV

Integer

ControlType

Gets the type of busbar, e.g. slack, PV, PQ, etc.

  • 0 = No voltage control at bus

  • 1 = Slack busbar

  • 2 = Real power and voltage control by generator

  • 3 = No longer used

  • 4 = No longer used

  • 5 = Voltage controlled by transformer

  • 6 = No longer used

  • 7 = Multiple types of voltage control, i.e. generator and transformer

  • 8 = Voltage controlled by remote PV generator

  • 9 = Voltage controlled by local switched capacitor

  • 10 = Voltage controlled by remote switched capacitor

Integer

Type

Gets the physical type of busbar e.g. straight joint, mains joint etc.

  • 0 = Unset

  • 1 = Straight joint

  • 2 = Mains joint

  • 3 = Service cable joint

  • 4 = Service termination joint

  • 5 = Overhead termination joint

  • 6 = Ground mounted substation node

Float

VoltPU

Gets the voltage magnitude in per unit.

Float

VoltAngleRad

Gets the voltage angle in radians.

String

Comment

Gets and sets the comments.

Float

FaultMakePeakkA

The rated asymmetric peak make current in kA at half a cycle. These must be accessed through the GetFaultDValue/SetFaultDValue functions.

Float

FaultBreakRMSkA

The rated RMS symmetric break rating in kA at the break time specified. These must be accessed through the GetFaultDValue/SetFaultDValue functions.

Float

FaultBreakTimemS

The time in milliseconds for which the Break ratings are given. These must be accessed through the GetFaultDValue/SetFaultDValue functions.

Float

FaultBreakDCPC

The rated DC break current as a percentage of the rated symmetric break current. These must be accessed through the GetFaultDValue/SetFaultDValue functions.

Float

FaultNomCurrentkA

A value designating the “standard” current at which the busbar operates. These must be accessed through the GetFaultDValue/SetFaultDValue functions.

Integer

ArcBusbarConfiguration

Specific busbar configuration for this bus according to the definitions penned out by IEEE-1584 standard:

  • 0 = Unknown

  • 1 = VCB (vertical closed box)

  • 2 = VCBB (vertical closed bolted box)

  • 3 = HCB (horizontal closed box)

  • 4 = VOA (vertical open air box)

  • 5 = HOA (horizontal open air box)

Float

ArcEnclosureWidthMM

Width of the busbar enclosure for the arcflash in mm.

Float

ArcEnclosureHeightMM

Height of the busbar enclosure for the arcflash in mm.

Float

ArcEnclosureDepthMM

Depth of the busbar enclosure for the arcflash in mm.

Float

ArcConductorGapMM

Air gap between the conductors that the arc flash jumps across in mm.

Float

ArcWorkingDistanceMM

Working distance for the bus container in mm.

Integer

ArcIEEEStandard

The IEEE-1584 standard for conduction arc flash studies. Users can toggle between the two for comparative studies:

  • 0 = 2002

  • 1 = 2018

Integer

ArcEnclosure

A 2002 IEEE-1584 legacy parameter. The type of busbar enclosure:

  • 0 = None or open

  • 1 = Box

Integer

ArcEquipmentType

A 2002 IEEE-1584 legacy parameter. The specific type of busbar:

  • 0 = Not set

  • 1 = Open air

  • 2 = Switchgear

  • 3 = MCC and panels

  • 4 = Cable

Boolean

ArcUngrounded

A 2002 IEEE-1584 legacy parameter. True if the busbar is ungrounded.

IscBusbar Class

class ipsa.IscBusbar

Provides access to an IPSA busbar.

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

GetFaultDValue(nFaultFieldIndex: int) → float

Returns a float value for the circuit breaker field. In IPSA 2.10.2, nFaultFieldIndex should be one of FaultMakePeakkA, FaultBreakRMSkA, FaultBreakDCPC, FaultBreakTimemS or FaultNomCurrentkA. nFaultFieldIndex can also be one of the IscCircuitBreaker field indexes MakePeakkA, BreakRMSkA, BreakDCPC, BreakTimemS or NomCurrentkA. This function is used to get fault (breaker) ratings for a busbar.

Parameters:

nFaultFieldIndex (int) – FaultMakePeakkA, FaultBreakRMSkA, FaultBreakDCPC, FaultBreakTimemS or FaultNomCurrentkA.

Returns:

The float value for the selected field.

Return type:

float

SetFaultDValue(nFaultFieldIndex: int) → bool

Sets the value for the circuit breaker field. In IPSA 2.10.2, nFaultFieldIndex should be one of FaultMakePeakkA, FaultBreakRMSkA, FaultBreakDCPC, FaultBreakTimemS or FaultNomCurrentkA. nFaultFieldIndex can also be one of the IscCircuitBreaker field indexes MakePeakkA, BreakRMSkA, BreakDCPC, BreakTimemS or NomCurrentkA. This function is used to set fault (breaker) ratings for a busbar.

Parameters:

nFaultFieldIndex (int) – FaultMakePeakkA, FaultBreakRMSkA, FaultBreakDCPC, FaultBreakTimemS or FaultNomCurrentkA.

Returns:

True if successful.

Return type:

bool

GetVoltageMagnitudePU(nStudyUid: int) → float
GetVoltageMagnitudePU() → float
GetVoltageMagnitudePU(dOrder: float) → float

Returns the voltage magnitude in per unit.

If a UID is provided this is for the associated automation or contingency study.

Deprecated. If a float dOrder is provided, this is the harmonic voltage magnitude for the given harmonic order. Instead, use GetVoltageMagnitudeHarmPU

Parameters:

  • nStudyUid (int) – The UID of the study.

  • dOrder (float) – The harmonic order.

Returns:

The voltage magnitude, if a UID is provided this returns the voltage magnitude for the associated study. If a dOrder is provided this returns the voltage magnitude for the harmonic order.

Return type:

float

GetVoltageMagnitudekV(nStudyUid: int) → float
GetVoltageMagnitudekV() → float

Returns the voltage magnitude in kV. If a UID is provided this is for the associated automation or contingency study.

Parameters:

nStudyUid (int) – The UID of the study.

Returns:

The voltage magnitude, if a UID is provided this returns the voltage magnitude for the associated study.

Return type:

float

GetVoltageAngleRad() → float
GetVoltageAngleRad(nStudyUid: int) → float

Returns the voltage angle in radians. If a UID is provided this is for the associated automation or contingency study.

Parameters:

nStudyUid (int) – The UID of the study.

Returns:

The voltage angle, if a UID is provided this returns the voltage angle for the associated study.

Return type:

float

GetVoltageAngleDeg() → float
GetVoltageAngleDeg(nStudyUid: int) → float

Returns the voltage angle in degrees. If a UID is provided this is for the associated automation or contingency study.

Parameters:

nStudyUid (int) – The UID of the study.

Returns:

The voltage angle, if a UID is provided this returns the voltage angle for the associated study.

Return type:

float

GetRealMismatchMW() → float

Returns the load flow MW mismatch.

Returns:

The load flow MW mismatch.

Return type:

float

GetReactiveMismatchMVAr() → float

Returns the load flow MVAr mismatch.

Returns:

The load flow MVAr mismatch.

Return type:

float

GetRealGenerationMW() → float

Returns the total MW of generation at a busbar.

Returns:

The total MW of generation at a busbar.

Return type:

float

GetReactiveGenerationMVAr() → float

Returns the total MVAr of generation at a busbar.

Returns:

The total MVAr of generation at a busbar.

Return type:

float

GetRealInductionMW() → float

Returns the total MW of induction machines at a busbar.

Returns:

The total MW of induction machines at a busbar.

Return type:

float

GetReactiveInductionMVAr() → float

Returns the total MVAr of induction machines at a busbar.

Returns:

The total MVAr of induction machines at a busbar.

Return type:

float

GetRealLoadMW() → float

Returns the total MW of static load at a busbar.

Returns:

The total MW of static load at a busbar.

Return type:

float

GetReactiveLoadMVAr() → float

Returns the total MVAr of static load at a busbar.

Returns:

The total MVAr of static load at a busbar.

Return type:

float

GetRedVoltageMagnitudePU() → float

Returns the red phase voltage magnitude in per-unit.

Returns:

The red phase voltage magnitude in per-unit.

Return type:

float

GetRedVoltageMagnitudekV() → float

Returns the red phase voltage magnitude in kV.

Returns:

The red phase voltage magnitude in kV.

Return type:

float

GetRedVoltageAngleDeg() → float

Returns the red phase voltage angle in degrees.

Returns:

The red phase voltage angle in degrees.

Return type:

float

GetYellowVoltageMagnitudePU() → float

Returns the yellow phase voltage magnitude in per-unit.

Returns:

The yellow phase voltage magnitude in per-unit.

Return type:

float

GetYellowVoltageMagnitudekV() → float

Returns the yellow phase voltage magnitude in kV.

Returns:

The yellow phase voltage magnitude in kV.

Return type:

float

GetYellowVoltageAngleDeg() → float

Returns the yellow phase voltage angle in degrees.

Returns:

The yellow phase voltage angle in degrees.

Return type:

float

GetBlueVoltageMagnitudePU() → float

Returns the blue phase voltage magnitude in per-unit.

Returns:

The blue phase voltage magnitude in per-unit.

Return type:

float

GetBlueVoltageMagnitudekV() → float

Returns the blue phase voltage magnitude in kV.

Returns:

The blue phase voltage magnitude in kV.

Return type:

float

GetBlueVoltageAngleDeg() → float

Returns the blue phase voltage angle in degrees.

Returns:

The blue phase voltage angle in degrees.

Return type:

float

GetFaultACComponentMVA() → float

Returns the AC component of fault level in MVA.

Returns:

The AC component of fault level in MVA.

Return type:

float

GetFaultDCComponentMVA() → float

Returns the DC component of fault level in MVA.

Returns:

The DC component of fault level in MVA.

Return type:

float

GetFault2HComponentMVA() → float

Returns the second harmonic component of fault level in MVA.

Returns:

The second harmonic component of fault level in MVA.

Return type:

float

GetFaultDCTheveninX() → float

Returns the inductive/capacitive component of the DC X/R ratio.

Returns:

The inductive/capacitive component of the DC X/R ratio.

Return type:

float

GetFaultDCTheveninR() → float

Returns the resistive component of the DC X/R ratio.

Returns:

The resistive component of the DC X/R ratio.

Return type:

float

GetFaultDCPercentage() → float

Returns the DC component % of fault level.

Returns:

The DC component % of fault level.

Return type:

float

GetFaultRedComponentMVA() → float

Returns the red phase component of fault level in MVA.

Returns:

The red phase component of fault level in MVA.

Return type:

float

GetFaultRedComponentAngleDeg() → float

Returns the red phase component of fault angle in degrees.

Returns:

The red phase component of fault angle in degrees.

Return type:

float

GetFaultYellowComponentMVA() → float

Returns the yellow phase component of fault level in MVA.

Returns:

The yellow phase component of fault level in MVA.

Return type:

float

GetFaultYellowComponentAngleDeg() → float

Returns the yellow phase component of fault angle in degrees.

Returns:

The yellow phase component of fault angle in degrees.

Return type:

float

GetFaultBlueComponentMVA() → float

Returns the blue phase component of fault level in MVA.

Returns:

The blue phase component of fault level in MVA.

Return type:

float

GetFaultBlueComponentAngleDeg() → float

Returns the blue phase component of fault angle in degrees.

Returns:

The blue phase component of fault angle in degrees.

Return type:

float

GetFaultPositiveComponentMVA() → float

Returns the positive sequence component of fault level in MVA.

Returns:

The positive sequence component of fault level in MVA.

Return type:

float

GetFaultPositiveComponentAngleDeg() → float

Returns the positive sequence component of fault angle in degrees.

Returns:

The positive sequence component of fault angle in degrees.

Return type:

float

GetFaultNegativeComponentMVA() → float

Returns the negative sequence component of fault level in MVA.

Returns:

The negative sequence component of fault level in MVA.

Return type:

float

GetFaultNegativeComponentAngleDeg() → float

Returns the negative sequence component of fault angle in degrees.

Returns:

The negative sequence component of fault angle in degrees.

Return type:

float

GetFaultZeroComponentMVA() → float

Returns the zero sequence component of fault level in MVA.

Returns:

The zero sequence component of fault level in MVA.

Return type:

float

GetFaultZeroComponentAngleDeg() → float

Returns the zero sequence component of fault angle in degrees.

Returns:

The zero sequence component of fault angle in degrees.

Return type:

float

GetFaultACComponentkA() → float

Returns the AC component of fault level in kA.

Returns:

The AC component of fault level in kA.

Return type:

float

GetFaultDCComponentkA() → float

Returns the DC component of fault level in kA.

Returns:

The DC component of fault level in kA.

Return type:

float

GetFault2HComponentkA() → float

Returns the second harmonic component of fault level in kA.

Returns:

The second harmonic component of fault level in kA.

Return type:

float

GetFaultRedComponentkA() → float

Returns the red phase component of fault level in kA.

Returns:

The red phase component of fault level in kA.

Return type:

float

GetFaultYellowComponentkA() → float

Returns the yellow phase component of fault level in kA.

Returns:

The yellow phase component of fault level in kA.

Return type:

float

GetFaultBlueComponentkA() → float

Returns the blue phase component of fault level in kA.

Returns:

The blue phase component of fault level in kA.

Return type:

float

GetFaultPositiveComponentkA() → float

Returns the positive sequence component of fault level in kA.

Returns:

The positive sequence component of fault level in kA.

Return type:

float

GetFaultNegativeComponentkA() → float

Returns the negative sequence component of fault level in kA.

Returns:

The negative sequence component of fault level in kA.

Return type:

float

GetFaultZeroComponentkA() → float

Returns the zero sequence component of fault level in kA.

Returns:

The zero sequence component of fault level in kA.

Return type:

float

GetFaultRedVoltagePU() → float

Returns the red phase fault voltage in per unit.

Returns:

The red phase fault voltage in per unit.

Return type:

float

GetFaultRedVoltageAngleDeg() → float

Returns the red phase fault voltage angle in degrees.

Returns:

The red phase fault voltage angle in degrees.

Return type:

float

GetFaultYellowVoltagePU() → float

Returns the yellow phase fault voltage in per unit.

Returns:

The yellow phase fault voltage in per unit.

Return type:

float

GetFaultYellowVoltageAngleDeg() → float

Returns the yellow phase fault voltage angle in degrees.

Returns:

The yellow phase fault voltage angle in degrees.

Return type:

float

GetFaultBlueVoltagePU() → float

Returns the blue phase fault voltage in per unit.

Returns:

The blue phase fault voltage in per unit.

Return type:

float

GetFaultBlueVoltageAngleDeg() → float

Returns the blue phase fault voltage angle in degrees.

Returns:

The blue phase fault voltage angle in degrees.

Return type:

float

GetFaultPositiveVoltagePU() → float

Returns the positive sequence component of fault voltage in per unit.

Returns:

The positive sequence component of fault voltage in per unit.

Return type:

float

GetFaultPositiveVoltageAngleDeg() → float

Returns the positive sequence component of fault voltage angle in degrees.

Returns:

The positive sequence component of fault voltage angle in degrees.

Return type:

float

GetFaultNegativeVoltagePU() → float

Returns the negative sequence component of fault voltage in per unit.

Returns:

The negative sequence component of fault voltage in per unit.

Return type:

float

GetFaultNegativeVoltageAngleDeg() → float

Returns the negative sequence component of fault voltage angle in degrees.

Returns:

The negative sequence component of fault voltage angle in degrees.

Return type:

float

GetFaultZeroVoltagePU() → float

Returns the zero sequence component of fault voltage in per unit.

Returns:

The zero sequence component of fault voltage in per unit.

Return type:

float

GetFaultZeroVoltageAngleDeg() → float

Returns the zero sequence component of fault voltage angle in degrees.

Returns:

The zero sequence component of fault voltage angle in degrees.

Return type:

float

GetFaultIEC909InitialSymRMSMVA() → float

Returns the initial symmetrical RMS fault level in MVA for IEC60909 analysis.

Returns:

The initial symmetrical RMS fault level in MVA for IEC60909 analysis.

Return type:

float

GetFaultIEC909PeakMVA() → float

Returns the peak fault level in MVA for IEC60909 analysis.

Returns:

The peak fault level in MVA for IEC60909 analysis.

Return type:

float

GetFaultIEC909AsymmetricBreakMVA() → float

Returns the asymmetric break fault level in MVA for IEC60909 analysis.

Returns:

The asymmetric break fault level in MVA for IEC60909 analysis.

Return type:

float

GetFaultIEC909SymmetricBreakMVA() → float

Returns the symmetric break fault level in MVA for IEC60909 analysis.

Returns:

The symmetric break fault level in MVA for IEC60909 analysis.

Return type:

float

GetFaultIEC909DCMagnitudeMVA() → float

Returns the DC fault level magnitude in MVA for IEC60909 analysis.

Returns:

The DC fault level magnitude in MVA for IEC60909 analysis.

Return type:

float

GetFaultIEC909SteadyStateMVA() → float

Returns the steady state fault level in MVA for IEC60909 analysis.

Returns:

The steady state fault level in MVA for IEC60909 analysis.

Return type:

float

GetFaultIEC909DCXoverR() → float

Returns the X/R ratio for IEC60909 analysis.

Returns:

The X/R ratio for IEC60909 analysis.

Return type:

float

GetFaultIEC909DCXoverRBreak() → float

Returns the X/R ratio at break time for IEC60909 analysis.

Returns:

The X/R ratio at break time for IEC60909 analysis.

Return type:

float

GetFaultIEC909InitialSymRMSkA() → float

Returns the initial symmetrical RMS fault level in kA for IEC60909 analysis.

Returns:

The initial symmetrical RMS fault level in kA for IEC60909 analysis.

Return type:

float

GetFaultIEC909PeakkA() → float

Returns the peak fault level in kA for IEC60909 analysis.

Returns:

The peak fault level in kA for IEC60909 analysis.

Return type:

float

GetFaultIEC909AsymmetricBreakkA() → float

Returns the asymmetric break fault level in kA for IEC60909 analysis.

Returns:

The asymmetric break fault level in kA for IEC60909 analysis.

Return type:

float

GetFaultIEC909SymmetricBreakkA() → float

Returns the symmetric break fault level in kA for IEC60909 analysis.

Returns:

The symmetric break fault level in kA for IEC60909 analysis.

Return type:

float

GetFaultIEC909DCMagnitudekA() → float

Returns the DC fault level magnitude in kA for IEC60909 analysis.

Returns:

The DC fault level magnitude in kA for IEC60909 analysis.

Return type:

float

GetFaultIEC909SteadyStatekA() → float

Returns the steady state fault level in kA for IEC60909 analysis.

Returns:

The steady state fault level in kA for IEC60909 analysis.

Return type:

float

GetVoltageOrders() → List[float]

Returns a list of all harmonic orders at a busbar. These harmonic orders can then be used to access busbar results at a specific harmonic order.

Returns:

All harmonic orders at a busbar.

Return type:

list(float)

GetVoltageMagnitudeHarmPU(dOrder: float) → float

Returns the harmonic voltage magnitude in per unit for harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The harmonic voltage magnitude in per unit.

Return type:

float

GetVoltageMagnitudePC(dOrder: float) → float

Returns the harmonic voltage magnitude in percent for harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The harmonic voltage magnitude in percent.

Return type:

float

GetVoltageAngle(dOrder: float) → float

Returns the harmonic voltage angle in radians for harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The harmonic voltage angle in radians.

Return type:

float

GetImpedanceOrders() → List[float]

Returns a list of all harmonic impedance orders at a busbar. These harmonic orders can then be used to access busbar results at a specific harmonic order.

Returns:

All harmonic impedance orders at a busbar.

Return type:

list[float]

GetImpedanceMagnitude(dOrder: float) → float

Returns the harmonic impedance magnitude in per unit for harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The harmonic impedance magnitude in per unit.

Return type:

float

GetImpedanceAngle(dOrder: float) → float

Returns the harmonic impedance angle in radians for harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The harmonic impedance angle in radians.

Return type:

float

GetImpedanceReal(dOrder: float) → float

Returns the real part of the harmonic impedance in per unit for harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The real part of the harmonic impedance in per unit.

Return type:

float

GetImpedanceImaginary(dOrder: float) → float

Returns the imaginary part of the harmonic impedance in per unit for harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The imaginary part of the harmonic impedance in per unit.

Return type:

float

GetTotalHarmonicDistortion() → float

Returns the total harmonic distortion at a busbar in percent.

Returns:

The total harmonic distortion at a busbar in percent.

Return type:

float

GetHarmonicDistortion(dOrder: float) → float

Returns the harmonic distortion at a busbar in percent for order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The harmonic distortion at a busbar in percent.

Return type:

float

GetMaximumDistortion() → List[float]

Returns a list of reals for harmonic order with the highest distortion. The distortion is in percent.

Returns:

A list of reals for harmonic order with the highest distortion.

Return type:

list[float]

GetResonances() → List[float]

Returns a list containing all the resonances found at a busbar. Each list gives the lower and upper resonance orders for each resonance found.

Returns:

A list containing all the resonances found at a busbar.

Return type:

list[float]

GetVoltageSum() → float

Returns the arithmetic sum of all harmonic voltages at a busbar in per unit.

Returns:

The arithmetic sum of all harmonic voltages at a busbar in per unit.

Return type:

float

GetAverageInterruptionHours() → float

Returns the average interruption time in hours from the reliability study results.

Returns:

The average interruption time in hours from the reliability study results.

Return type:

float

GetAnnualInterruptionHours() → float

Returns the total annual interruption time in hours from the reliability study results.

Returns:

The total annual interruption time in hours from the reliability study results.

Return type:

float

GetAnnualInterruptionFrequency() → float

Returns the number of interruptions per year from the reliability study results.

Returns:

The number of interruptions per year from the reliability study results.

Return type:

float

GetProfileMinimumVoltagePU() → float

Returns the minimum voltage in per unit from the profile study results.

Returns:

The minimum voltage in per unit from the profile study results.

Return type:

float

GetProfileMaximumVoltagePU() → float

Returns the maximum voltage in per unit from the profile study results.

Returns:

The maximum voltage in per unit from the profile study results.

Return type:

float

GetProfileMedianVoltagePU() → float

Returns the median of the voltage in per unit from the profile study results.

Returns:

The median of the voltage in per unit from the profile study results.

Return type:

float

GetMinimumProfileIndex() → int

Returns the category index which identifies the minimum busbar voltage result from the profile study results.

Returns:

The minimum category index.

Return type:

int

GetMaximumProfileIndex() → int

Returns the category index which identifies the maximum busbar voltage result from the profile study results.

Returns:

The maximum category index.

Return type:

int

GetDCLFVoltageAngleDeg() → float

Returns the voltage angle in degrees.

Returns:

The voltage angle in degrees.

Return type:

float

GetDCLFVoltageAngleRad() → float

Returns the voltage angle in radians.

Returns:

The voltage angle in radians.

Return type:

float

GetDCLFRealGenerationMW() → float

Returns the total MW of generation at a busbar.

Returns:

The total MW of generation at a busbar.

Return type:

float

GetDCLFRealGenerationkW() → float

Returns the total kW of generation at a busbar.

Returns:

The total kW of generation at a busbar.

Return type:

float

GetDCLFRealLoadMW() → float

Returns the total MW of static load at a busbar.

Returns:

The total MW of static load at a busbar.

Return type:

float

GetDCLFRealLoadkW() → float

Returns the total kW of static load at a busbar.

Returns:

The total kW of static load at a busbar.

Return type:

float

GetDCLFTransmissionLossFactor() → float

Returns transmission losses factor for the busbar.

Returns:

Transmission losses factor for the busbar.

Return type:

float

GetArcBusbarConfiguration() → int

Returns the specific busbar configuration for this bus according to the definitions penned out by IEEE-1584 standard:

  • 0 = Unknown

  • 1 = VCB (vertical closed box)

  • 2 = VCBB (vertical closed bolted box)

  • 3 = HCB (horizontal closed box)

  • 4 = VOA (vertical open air box)

  • 5 = HOA (horizontal open air box)

Returns:

The specific busbar configuration.

Return type:

int

GetArcEnclosureHeightMM() → float

Returns the height of the busbar enclosure for the arcflash in mm.

Returns:

The height of the busbar enclosure for the arcflash in mm.

Return type:

float

GetArcEnclosureWidthMM() → float

Returns the width of the busbar enclosure for the arcflash in mm.

Returns:

The width of the busbar enclosure for the arcflash in mm.

Return type:

float

GetArcEnclosureDepthMM() → float

Returns the depth of the busbar enclosure for the arcflash in mm.

Returns:

The depth of the busbar enclosure for the arcflash in mm.

Return type:

float

GetArcConductorGapMM() → float

Returns the air gap between the conductors that the arc flash jumps across in mm.

Returns:

The air gap between the conductors in mm.

Return type:

float

GetArcWorkingDistanceMM() → float

Returns the working distance for the bus container in mm.

Returns:

The working distance for the bus container in mm.

Return type:

float

SetArcBusbarConfiguration(nConfig: int) → bool

Sets the specific busbar configuration for this bus according to the definitions penned out by IEEE-1584 standard:

  • 0 = Unknown

  • 1 = VCB (vertical closed box)

  • 2 = VCBB (vertical closed bolted box)

  • 3 = HCB (horizontal closed box)

  • 4 = VOA (vertical open air box)

  • 5 = HOA (horizontal open air box)

Parameters:

nConfig (int) – The specific busbar configuration.

Returns:

True if successful.

Return type:

bool

SetArcEnclosureHeightMM(dHeight: float) → bool

Sets the height of the busbar enclosure for the arcflash in mm.

Parameters:

dHeight (float) – The height of the busbar enclosure for the arcflash in mm.

Returns:

True if successful.

Return type:

bool

SetArcEnclosureWidthMM(dWidth: float) → bool

Sets the width of the busbar enclosure for the arcflash in mm.

Parameters:

dWidth (float) – The width of the busbar enclosure for the arcflash in mm.

Returns:

True if successful.

Return type:

bool

SetArcEnclosureDepthMM(dDepth: float) → bool

Sets the depth of the busbar enclosure for the arcflash in mm.

Parameters:

dDepth (float) – The depth of the busbar enclosure for the arcflash in mm.

Returns:

True if successful.

Return type:

bool

SetArcConductorGapMM(dConductorGap: float) → bool

Returns the air gap between the conductors that the arc flash jumps across in mm.

Parameters:

dConductorGap (float) – The air gap between the conductors in mm.

Returns:

True if successful.

Return type:

bool

SetArcWorkingDistanceMM(dWorkingDistance: float) → bool

Returns the working distance for the bus container in mm.

Parameters:

dWorkingDistance (float) – The working distance for the bus container in mm.

Returns:

True if successful.

Return type:

bool