IscFilter

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

Field Values

IscFilter Field Values

Type

Field Name

Description

Integer

FromUID

Gets the unique ID for busbar.

String

BusName

Gets the busbar name.

String

Name

Gets the synchronous machine name.

Integer

Status

Status:

  • 0 = Switched in

  • -1 = Switched out

Integer

FilterType

Filter Type:

  • 1 = Single tuned

  • 2 = Single tuned high pass

  • 3 = Double tuned

  • 4 = C Type

Boolean

Ground

Get or set the grounded status of the filter. True if grounded , False if isolated.

Float

Data1

Get or set the resistance R1 in per unit on the system MVA.

Float

Data2

Get or set the reactance XL1 in per unit on the system MVA.

Float

Data3

Get or set the capacitance XC1 in per unit on the system MVA.

Float

Data4

Get or set the capacitance XC2 in per unit on the system MVA - double tuned and C type only.

Float

Data5

Get or set the reactance XL2 in per unit on the system MVA - double tuned only.

IscFilter Class

class ipsa.IscFilter

Provides access to an IPSA harmonic filter.

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 filter absorbed power in MVA.

Returns:

The filter absorbed power in MVA.

Return type:

float

GetPowerMagnitudekVA() → float

Returns the filter absorbed power in kVA.

Returns:

The filter absorbed power in kVA.

Return type:

float

GetRealPowerMW() → float

Returns the filter absorbed power in MW.

Returns:

The filter absorbed power in MW.

Return type:

float

GetReactivePowerMVAr() → float

Returns the filter absorbed power in MVAr.

Returns:

The filter absorbed power in MVAr.

Return type:

float

GetRealPowerkW() → float

Returns the filter absorbed power in kW.

Returns:

The filter absorbed power in kW.

Return type:

float

GetReactivePowerkVAr() → float

Returns the filter absorbed power in kVAr.

Returns:

The filter absorbed power 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

GetDCLFRealPowerMW() → float

Returns the generator output in MW.

Returns:

The generator output in MW.

Return type:

float

GetDCLFRealPowerkW() → float

Returns the generator output in kW.

Returns:

The generator output in kW.

Return type:

float