IscNetworkCapacity

The IscNetworkCapacity class provides access to the IPSA Network Capacity settings, to set and get data values and to retrieve the Network Capacity results

Field Values

IscNetworkCapacity Field Values

Type	Field Name	Description
Float	PowerFactor	The power factor of capacity type for busbar.
Float	MaximumCapacityMVA	The maximum capacity value in MVA that will be used in the analysis.
Float	MinimumCapStepMVA	The minimum step size before a given busbar iteration terminates.
Integer	RealStudyType	The type of analysis done for active power: 0 = Export 1 = Import 2 = Both
Integer	ReactiveStudyType	The type of analysis done for reactive power: 0 = Export 1 = Import
Float	LowCapacityLimitPC	User definition of the lower capacity divider as a percentage.
Float	HighCapacityLimitPC	User definition of the higher capacity divider as a percentage.
List[Integer]	SelectBusbarUIDs	List of busbar UIDs that are selected for the network capacity. If empty all will be selected.
Boolean	DisplayCapacityPointInfo	Boolean option to output the flat start and capacity point information during the simulation.
Boolean	DisplayBusbarTestInfo	Boolean option to show the busbar constraint information for each test through the simulation.
Boolean	DisplayLineTestInfo	Boolean option to show the branch constraint information for each test through the simulation.
Boolean	UsePercentiles	Boolean option on whether to use and render the percentiles.
Boolean	FlatStartIncremental	Boolean option on whether to run a flat start before every incremental load flow (per busbar and per load value tested in the tool).

IscNetworkCapacity Class

class ipsa.IscNetworkCapacity

Class providing access to the Network Capacity functionality.

GetIValue(nFieldIndex: int) → int

Returns an integer value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The integer value for the field.

Return type:

int

GetDValue(nFieldIndex: int) → float

Returns a float value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The float value for the field.

Return type:

float

GetSValue(nFieldIndex: int) → str

Returns a string value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The string value for the field.

Return type:

str

GetBValue(nFieldIndex: int) → bool

Returns a boolean value for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The boolean value for the field.

Return type:

bool

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 integer value for the enumerated field.

Parameters:

• nFieldIndex (int) – The given enumerated field.

• nValue (int) – The integer value that will be set.

Returns:

True if successful.

Return type:

bool

SetDValue(nFieldIndex: int, dValue: float) → bool

Sets the float value for the enumerated field.

Parameters:

• nFieldIndex (int) – The given enumerated field.

• dValue (float) – The float value that will be set.

Returns:

True if successful.

Return type:

bool

SetSValue(nFieldIndex: int, strValue: str) → bool

Sets the string value for the enumerated field.

Parameters:

• nFieldIndex (int) – The given enumerated field.

• strValue (str) – The string value that will be set.

Returns:

True if successful.

Return type:

bool

SetBValue(nFieldIndex: int, bValue: bool) → bool

Sets the boolean value for the enumerated field.

Parameters:

• nFieldIndex (int) – The given enumerated field.

• bValue (bool) – The boolean value that will be set.

Returns:

True if successful.

Return type:

bool

GetFieldType(nFieldIndex: int) → str

Returns the field type as a string for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The field type.

Return type:

str

GetFieldName(nFieldIndex: int) → str

Returns the field name as a string for the enumerated field.

Parameters:

nFieldIndex (int) – The given enumerated field.

Returns:

The field name.

Return type:

str

SetSelectedBusbars(lBusbarNames: List[str]) → bool

Sets the selected busbars for the Network Capacity analysis from a list of Busbar names.

Parameters:

lBusbarNames (list[str]) – List of names of busbars to be selected.

Returns:

True if successful.

Return type:

bool

SetSelectedBusbarUIDs(lBusbarUIDs: List[int]) → bool

Sets the selected busbars for the Network Capacity analysis from a list of Busbar UIDs.

Parameters:

lBusbarNames (list[int]) – List of UIDs of busbars to be selected.

Returns:

True if successful.

Return type:

bool

GetAvailableCapacityMVAs() → List[float]

Returns the list of the busbar available capacity calculated from the Network Capacity in MVA.

Returns:

List of the busbar available capacity in MVA.

Return type:

list[float]

GetActiveStudyTypes() → List[str]

Returns the study types of the active power part of the calculation.

Returns:

List of the study types of the active power part.

Return type:

list[str]

GetReactiveStudyTypes() → List[str]

Returns the study types of the reactive power part of the calculation.

Returns:

List of the study types of the reactive power part.

Return type:

list[str]

GetNetCapResults() → List[str]

Returns whether there is a pass or fail on each busbar (fail if there is a problem or violation).

Returns:

List of whether each busbar passes or fails.

Return type:

list[str]

GetLimitTypeResults() → List[str]

Returns a list of the violations if there is a fail.

Returns:

List of violations if there is a fail.

Return type:

list[str]

GetLimitCompTypes() → List[str]

Returns a list of the type of component that caused the fail.

Returns:

List of the type of component causing the fail.

Return type:

list[str]

GetLimitCompUIDs() → List[int]

Returns the list of component UIDs that caused the violations.

Returns:

List of component UIDs that caused the violations.

Return type:

list[int]

GetLimitCompNames() → List[int]

Returns the list of names of the components that caused the violations.

Returns:

List of component names that caused the violations.

Return type:

list[int]

GetResultsBusbarNames() → List[str]

Returns the list of the busbars included in the calculation.

Returns:

List of busbars included in the calculation.

Return type:

list[str]

GetLimitPercentiles() → List[str]

Returns which percentile the available capacity MVA fell into for each busbar.

Returns:

List of which percentile the available capacity was within for each busbar.

Return type:

list[str]