IscLoad

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

Field Values

IscLoad Field Values

Type

Field Name

Description

Integer

FromUID

Gets the unique ID for busbar.

String

BusName

Gets the busbar name.

String

Name

Gets the load name.

Integer

Status

Status:

  • 0 = Switched in

  • 1 = Switched out

Float

RealMW

Gets and sets the real power output in MW.

Float

ReactiveMVAr

Gets and sets the reactive power output in MVAr.

Integer

ProfileUID

Sets and gets the load profile UID for the load.

Integer

Customers

Sets and gets the number of customers that this load represents. Used for reliability analysis.

Integer

CustomerType

Sets and gets the customer type that this load represents.

Boolean

IsEquivalent

If True then the load is an equivalent load.

Integer

LoadPlanningStage

The stage the load is currently at:

  • 0 = Proposed

  • 1 = Accepted

  • 2 = Completed

  • 3 = Energised (default, in service)

Float

RatedPowerMW

Gets and sets the real power rating value for the load in MW.

Float

RatedPowerMVA

Gets and sets the apparent power rating value for the load in MVA.

Boolean

EquivalentMotorFault

Gets and sets boolean on whether this load has a motor fault contribution.

Integer

FaultPowerMode

Gets and sets whether the power used is:

  • 0 = Rated Power (MVA)

  • 1 = Actual Power (MVA)

Float

FaultScaling

Gets and sets the scale factor for rescaling the chosen power to divide through the equivalent impedance parameters.

Integer

EquivalentMotorModel

Gets and sets the motor model:

  • 0 = Inner/Outer

  • 1 = Running/Standstill

Float

EquivalentStatorRPU

Gets and sets the motor equivalent stator resistance in PU.

Float

EquivalentStatorXPU

Gets and sets the motor equivalent stator reactance in PU.

Float

EquivalentMagXPU

Gets and sets the motor equivalent magnetising reactance in PU.

Float

EquivInnerRPU

Gets and sets the motor equivalent inner resistance in PU.

Float

EquivInnerXPU

Gets and sets the motor equivalent inner reactance in PU.

Float

EquivOuterRPU

Gets and sets the motor equivalent outer resistance in PU.

Float

EquivOuterXPU

Gets and sets the motor equivalent outer reactance in PU.

Boolean

EquivUseManual

Gets and sets whether to give the equivalent parameters with a manual override.

Float

ActualPowerMVA

Gets the load flow result power that arises from the load flow and scaling and profile selection.

String

Comment

Gets and sets the comments.

Boolean

Aggregate

An equivalent for a collection of the same object.

IscLoad Class

class ipsa.IscLoad

Provides access to an IPSA load.

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

GetPowerMagnitudeMVA() → float

Returns the load in MVA.

Returns:

The load in MVA.

Return type:

float

GetPowerMagnitudekVA() → float

Returns the load in kVA.

Returns:

The load in kVA.

Return type:

float

GetRealPowerMW() → float

Returns the load in MW.

Returns:

The load in MW.

Return type:

float

GetReactivePowerMVAr() → float

Returns the load in MVAr.

Returns:

The load in MVAr.

Return type:

float

GetRealPowerkW() → float

Returns the load in kW.

Returns:

The load in kW.

Return type:

float

GetReactivePowerkVAr() → float

Returns the load in kVAr.

Returns:

The load in kVAr.

Return type:

float

GetCurrentMagnitude(dOrder: float) → float

Returns the current magnitude in per unit on the network base for the harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The current magnitude in per unit.

Return type:

float

GetCurrentAngle(dOrder: float) → float

Returns the current angle in radians for the harmonic order.

Parameters:

dOrder (float) – The harmonic order.

Returns:

The current angle in radians.

Return type:

float

GetDCLFPowerMagnitudeMVA() → float

Returns the load in MVA.

Returns:

The load in MVA.

Return type:

float

GetDCLFPowerMagnitudekVA() → float

Returns the load in kVA.

Returns:

The load in kVA.

Return type:

float

GetDCLFRealPowerMW() → float

Returns the load in MW.

Returns:

The load in MW.

Return type:

float

GetDCLFRealPowerkW() → float

Returns the load in kW.

Returns:

The load in kW.

Return type:

float