IscNetworkData

The IscNetworkData class provides access to the IPSA network data such as the system base MVA, to set and get data values.

Field Values

IscNetworkData Field Values

Type

Field Name

Description

String

Title

Gets or sets the network title.

String

Author

Gets or sets the network author.

String

CreationTime

Gets the date and time when the network was first created.

String

Comment

Gets the comment entered for the network data.

Float

Base

Gets or sets the system base MVA for the network.

Boolean

BaseinKVA

True if the Base is in KVA otherwise the base is in MVA.

Float

Frequency

Gets or sets the system base frequency in hertz for the network.

IscNetworkData Class

class ipsa.IscNetworkData

Provides access to the IPSA network data.

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

GetBranchRatingName(nIndex: int) str

Returns the name representing the rating set identified by an index.

Parameters:

nIndex (int) – The specified index.

Returns:

The rating set name, or empty set if no rating set with that index exists in the network.

Return type:

str