IscIntertrip

The IscIntertrip class provides access to an IPSA Intertrip group, to get and set member breakers and values that govern its behaviour.

Field Values

**IscIntertrip Field Values**
Type	Field Name	Description
String	Name	The intertrip name.
Integer	TypeMaster	The master control type: 0 = master breakers can have different switch states 1 = master breakers must all have the same switch state
Integer	TypeSlave	The slave control type: 0 = slave breakers will change state whenever a master breaker changes 1 = slave breakers will take the opposite state to the changed master breaker 2 = slave breakers will take the same state as the changed master breaker 3 = slave breakers will all switch in if any master breaker is switched out
List[Integer]	Masters	The UIDs of the master breakers in the intertrip.
List[Integer]	Slaves	The UIDs of the slave breakers in the intertrip.
Float	SignalTimeS	The time for the operation signal from master to slaves in seconds.

IscIntertrip Class

class ipsa.IscIntertrip

Provides access to an IPSA intertrip object.

GetUID() → str

Gets the unique ID of the intertrip

Returns:: The UID of the intertrip.
Return type:: str

GetName() → str

Gets the python name as a string.

Returns:: The name of the intertrip.
Return type:: str

SetName(strName: str) → bool

Sets the name of the intertrip to the specified name.

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

GetListIValue(nFieldIndex: int) → List[int]

Returns a list of integer values for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The list of values.
Return type:: list[int]

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

SetListIValue(nFieldIndex: int, lIValue: List[int]) → bool

Sets the value for the enumerated field from a list of integers.

Note: Setting the Masters/Slaves will set the list to be the provided list, removing any circuit breakers that are in a different intertrip, or in the current intertrip in the opposite role.

Parameters:

nFieldIndex (int) – The field index.
lIValue (list[int]) – The given list of values.

Returns:

True if successful.

Return type:

bool

GetMembers() → List[int]

Returns a list containing the UIDs of the breakers in the intertrip.

Returns:: The UIDs of the breakers in the intertrip.
Return type:: list(int)

GetMasters() → List[int]

Returns a list containing the UIDs of the master breakers in the intertrip.

Returns:: The UIDs of the masters in the intertrip.
Return type:: list(int)

GetSlaves() → List[int]

Returns a list containing the UIDs of the slave breakers in the intertrip.

Returns:: The UIDs of the slaves in the intertrip.
Return type:: list(int)

AddMaster(nUID: int) → bool

Appends the circuit breaker identified by the nUID to the intertrip as a master. If the circuit breaker already exists in another IscIntertrip object, or as a slave, the intertrip is unchanged.

Parameters:: nUID (int) – The UID of the specified circuit breaker.
Returns:: True if the circuit breaker is added to the intertrip as a master.
Return type:: bool

AddSlave(nUID: int) → bool

Appends the circuit breaker identified by the nUID to the intertrip as a slave. If the circuit breaker already exists in another IscIntertrip object, or as a master, the intertrip is unchanged.

Parameters:: nUID (int) – The UID of the specified circuit breaker.
Returns:: True if the circuit breaker is added to the intertrip as a slave.
Return type:: bool

SwitchMasterSlave(nUID: int) → bool

If nUID identifies a master within the intertrip, converts it to a slave. Otherwise, if it identifies a slave, converts it to a master.

Parameters:: nUID (int) – The UID of the specified circuit breaker.
Returns:: True if the role of the circuit breaker is successfully switched.
Return type:: bool

RemoveMember(nUID: int)

Removes the circuit breaker identified by nUID from the intertrip.

Parameters:: nUID (int) – The UID of the specified circuit breaker.

IsMember(nUID: int) → bool

Checks if the breaker identified by the UID is in the intertrip.

Parameters:: nUID (int) – The UID of the specified circuit breaker.
Returns:: True if circuit breaker is a member of the intertrip.
Return type:: bool

IsMaster(nUID: int) → bool

Checks if the breaker identified by the UID is a master in the intertrip.

Parameters:: nUID (int) – The UID of the specified circuit breaker.
Returns:: True if circuit breaker is a master in the intertrip.
Return type:: bool

IsSlave(nUID: int) → bool

Checks if the breaker identified by the UID is a slave in the intertrip.

Parameters:: nUID (int) – The UID of the specified circuit breaker.
Returns:: True if circuit breaker is a slave in the intertrip.
Return type:: bool

ClearMembers(): Removes all the member circuit breakers from the intertrip.

ClearMasters(): Removes all the master circuit breakers from the intertrip.

ClearSlaves(): Removes all the slave circuit breakers from the intertrip.