IscMGSet

The IscMGSet class provides access to an IPSA motor-generator set, to set and get data values and to retrieve load flow results.

Field Values

IscMGSet Field Values

Type	Field Name	Description
Integer	FromUID	Gets the unique component ID for the sending busbar.
Integer	ToUID	Gets the unique component ID for the receiving busbar.
String	FromBusName	Gets the sending busbar name.
String	ToBusName	Gets the receiving busbar name.
String	Name	Gets the MG set name.
Integer	Status	Status of MG set: 0 = Switched in -1 = Switched out

IscMGSet Class

class ipsa.IscMGSet

Provides access to an IPSA motor-generator set.

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

GetACRealPowerMW() → float

Returns the AC real power output of the motor-generator set in MW.

Returns:

The AC real power output of the motor-generator set in MW.

Return type:

float

GetACRealPowerkW() → float

Returns the AC real power output of the motor-generator set in kW.

Returns:

The AC real power output of the motor-generator set in kW.

Return type:

float

GetACReactivePowerMVAr() → float

Returns the AC reactive power output of the motor-generator set in MVAr.

Returns:

The AC reactive power output of the motor-generator set in MVAr.

Return type:

float

GetACReactivePowerkVAr() → float

Returns the AC reactive power output of the motor-generator set in kVAr.

Returns:

The AC reactive power output of the motor-generator set in kVAr.

Return type:

float

GetACTotalPowerMVA() → float

Returns the total AC output power of the motor-generator set in MVA.

Returns:

The total AC output power of the motor-generator set in MVA.

Return type:

float

GetACTotalPowerkVA() → float

Returns the total AC output power of the motor-generator set in kVA.

Returns:

The total AC output power of the motor-generator set in kVA.

Return type:

float

GetACCurrentkA() → float

Returns the AC current of the motor-generator set in kA.

Returns:

The AC current of the motor-generator set in kA.

Return type:

float

GetDCRealPowerMW() → float

Returns the DC real power output of the motor-generator set in MW.

Returns:

The DC real power output of the motor-generator set in MW.

Return type:

float

GetDCRealPowerkW() → float

Returns the DC real power output of the motor-generator set in kW.

Returns:

The DC real power output of the motor-generator set in kW.

Return type:

float

GetDCTotalPowerMVA() → float

Returns the total DC output power of the motor-generator set in MVA.

Returns:

The total DC output power of the motor-generator set in MVA.

Return type:

float

GetDCTotalPowerkVA() → float

Returns the total DC output power of the motor-generator set in kVA.

Returns:

The total DC output power of the motor-generator set in kVA.

Return type:

float

GetDCCurrentkA() → float

Returns the DC current of the motor-generator set in kA.

Returns:

The DC current of the motor-generator set in kA.

Return type:

float