IscProtectionDevice

The IscProtectionDevice class provides access to a single protection device, such as a relay, allowing data to be set and cleared.

Field Values

**IscProtectionDevice Field Values**
Type	Field Name	Description
Integer	FromUID	Gets the unique ID of the nearest busbar to the protection device.
String	BusName	Gets of the nearest busbar to the protection device.
String	Name	Gets and sets the name of the protection device.
Integer	Status	Status: 0 = Switched in -1 = Switched out
String	DeviceManufacturer	Gets the name of the manufacturer for the relay assigned to the protection device.
String	DeviceFamily	Gets the name of the relay family for the relay assigned to the protection device.
String	DeviceDBName	Gets the data base name of the relay assigned to the protection device.
String	DeviceVersion	Gets the version text of the relay assigned to the protection device.
String	DeviceComments	Gets the comments for the relay assigned to the protection device.
Float	OCNominalCurrentA	Gets the UID nominal operating current of the relay in Amps.

IscProtectionDevice Class

class ipsa.IscProtectionDevice

Provides access to a single protection device, such as a relay.

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