IscMechSwCapacitor

The IscMechSwCapacitor class provides access to an IPSA mechanical switched capacitor, to set and get data values and to retrieve load flow results.

Field Values

IscMechSwCapacitor Field Values

Type

Field Name

Description

Integer

FromUID

Gets the unique ID of the sending busbar.

String

BusName

Gets the busbar name.

String

Name

Gets the mechanical switched capacitor name.

Integer

Status

Status of mechanical switched capacitor:

  • 0 = Switched in

  • -1 = Switched out

Integer

ControlMode

Sets or returns the control mode of the mechanical switched capacitor:

  • 0 = Local voltage control

  • 1 = Remote busbar voltage control

  • 2 = Reactive power flow control at receive end of branch

  • 3 = Reactive power control at send end of branch

Integer

ControlSteps

Sets or returns the control mode of the mechanical switched capacitor:

  • 0 = Switch based on discrete steps

  • 1 = Continuous control based on min and max limits (see MinContinuousMVAr and MaxContinuousMVAr)

Integer

CapSteps

Sets or returns the number of capacitor steps.

Integer

IndSteps

Sets or returns the number of inductor steps.

Float

CapStepSizeMVAr

Sets or returns the capacitor step size in MVAr.

Float

IndStepSizeMVAr

Sets or returns the inductor step size in MVAr.

Float

TargetVoltagePU

Sets or returns the target voltage in per unit.

Float

BandwidthPC

Sets or returns the bandwidth of acceptable voltage in percentage.

Integer

InitPosition

Sets or returns the initial position of the mechanical switched capacitor. Positive values represent capacitor steps and negative values are inductive steps.

Float

MaxContinuousMVAr

Sets or returns the maximum MVAr output of the MSC when in continuous control mode.

Float

MinContinuousMVAr

Sets or returns the minimum MVAr output of the MSC when in continuous control mode.

Float

ContinuousOutputMVAr

Sets or returns the operating output of the MSC when in continuous control mode.

Integer

ControlActive

Sets or returns the voltage or power factor control status of the MSC:

  • 0 = Voltage or power factor control off

  • 1 = Voltage or power factor control is active

Integer

ControlledUID

Sets or returns the busbar UID for the remote busbar whose voltage is being controlled.

Integer

SendEnd

Sets or returns the branch end that is controlled when in power factor control mode:

  • 0 = Control power factor at receiving end

  • 1 = Control power factor at send end

IscMechSwCapacitor Class

class ipsa.IscMechSwCapacitor

Provides access to an IPSA mechanical switched capacitor.

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

GetFinalPosition() → int

Returns the position of the MSC after a load flow. Positive values represent capacitor steps and negative values are inductive steps. See also ContinuousOutputMVAr for the output in continuous mode.

Returns:

The position of the MSC after a load flow.

Return type:

int