IscCircuitBreaker

The IscCircuitBreaker class provides access to an IPSA circuit breaker, to set and get data values. There are no analysis results associated with circuit breakers in this version.

Field Values

IscCircuitBreaker Field Values

Type

Field Name

Description

String

BusName or NearBusName

Gets the busbar name nearest to the circuit breaker.

String

FarBusName

For a circuit breaker on a branch, gets the busbar name at the other end of the branch to the circuit breaker.

String

BranchName

Gets the branch name the circuit breaker is located on.

String

Name

Gets the circuit breaker name.

Integer

Status

Status:

  • 0 = Switched in

  • -1 = Switched out

Boolean

NOP

If True then the circuit breaker is normally open.

Float

MakePeakkA

Sets and gets the peak rating in kA.

Float

BreakRMSkA

Sets and gets the symmetrical break rating in kA.

Float

BreakDCPC

Sets and gets the rated percentage DC component of the device.

Float

BreakTimemS

Sets and gets the time for the break rating in milliseconds.

Integer

BreakerType

Sets and gets the circuit breaker type:

  • 0 = Circuit breaker

  • 1 = Isolator

  • 2 = Disconnector

  • 3 = Recloser (reliability)

  • 4 = Remote control switch (reliability)

  • 5 = Fuse (reliability)

Float

SwitchTimeHr

Sets and gets the switch time in hours, used for reliability analysis.

Float

NomCurrentkA

Sets and gets the nominal current rating in kA

Boolean

FeederCB

True if this breaker is a feeder breaker

String

DbType

Gets the database type.

Boolean

Aggregate

An equivalent for a collection of the same object.

IscCircuitBreaker Class

class ipsa.IscCircuitBreaker

Provides access to an IPSA circuit breaker.

GetBranchUID() → int

Returns the UID of the branch which the breaker is located on.

Returns:

The UID of the branch which the breaker is located on.

Return type:

int

GetBusbarUID() → int

Returns the UID of the busbar that the breaker is connected to. If the breaker is located on the sending end of a branch, then the UID of the sending end busbar is returned.

Returns:

The UID of the busbar that the breaker is connected to.

Return type:

int

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

PopulateByDBEntry(strBreakerDataName: str) → bool

Populates the object data with database information from the first database that was loaded.

Parameters:

strBreakerDataName (str) – The break data name.

Returns:

True if successful.

Return type:

bool