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

String

Name

Gets and sets the name of the protection device.

Integer

Status

Status (Note this is the status of the device itself and currently always should be in. The status of the protection container the device lies within can be found through the auxiliary function):

  • 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

GetProtContainerUID() → int

Get the UID of the protection container that contains this device.

Returns:

The UID of this device’s protection container.

Return type:

int

GetProtContainerName() → str

Get the name of the protection container that contains this device.

Returns:

The name of this device’s protection container.

Return type:

str

GetProtContainerStatus() → int

Get the status of the protection container that contains this device.

Returns:

The status of this device’s protection container.

Return type:

int

GetProtCTUID() → int

Get the UID of the CT associated with this device.

Note if this device is not a relay, there will be no associated CT.

Returns:

The UID of this device’s CT (or 0 if it has none).

Return type:

int

GetProtCTName() → str

Get the name of the CT associated with this device.

Note if this device is not a relay, there will be no associated CT.

Returns:

The name of this device’s CT.

Return type:

str

GetNearBusbarUID() → int

Get the UID of the busbar nearest to the protection device/container.

Returns:

The UID of the busbar nearest to the protection device/container.

Return type:

int

GetNearBusbarName() → str

Get the name of the busbar nearest to the protection device/container.

Returns:

The name of the busbar nearest to the protection device/container.

Return type:

str

GetBranchUID() → int

Get the UID of the branch the protection device/container lies upon.

Returns:

The UID of the branch the protection device/container lies upon.

Return type:

int