IscGroup
- class ipsa.IscGroup
The IscGroup class provides access to an IPSA group to set and get group members. Note the extension functions will only work for general groups and may not function for other groups e.g., areas, transformer groups.
- GetName() str
Returns the user defined group name as a string.
- Returns:
The user defined group name.
- Return type:
- SetName(strName: str) None
Sets the name as a string.
- Parameters:
strName (str) – The selected string name.
- GetGroupType() int
Returns the type of the group where:
0 = No group type
1 = Area type group – contains all busbars in an area
2 = Mixed item group
3 = Load scaling group
4 = Load transfer group
5 = Protection device group
8 = Generator scaling group
9 = Region group
10 = Transformer group (master slave operation)
- Returns:
The group type.
- Return type:
- SetMembers(nUIDs: List[int]) None
Overwrites the current list of group members with the given list of component UIDs. This replaces any existing members with the supplied list of UIDs.
- AddMember(nUID: int) None
Appends the component with the given UID to the list of component UIDs if the UID is not present. All existing group member UIDs are unaffected.
- Parameters:
nUID (int) – Component UID.
- RemoveMember(nUID: int) None
Removes the component with the given UID from the list of component UIDs if the UID is present. All other existing group member UIDs are unaffected.
- Parameters:
nUID (int) – Component UID.
- IsMember(nUID: int) bool
Checks whether the component with the given UID is present in the list of component UIDs. The list of group member UIDs will be unaffected.
- CompareGroups(nGroupUID: int, bUseIntersection: bool = False) List[int]
Compares the current group with the group with UID given by nGroupUID. By default, will perform a difference operation returning a list of component UIDs present in the current group but not present in the group with UID given by nGroupUID. If bUseIntersection is True it will return a list of component UIDs present in both lists. Both lists of group member UIDs will be unaffected.
- MergeGroups(nGroupUID: int, bDeleteGroup: bool = False) None
Appends the list of component UIDs from the group with the given UID onto the current group’s UID list. By default the group with the given UID will be unnaffected, unless bDeleteGroup is True, in which case it will be deleted.
- GetLoadScalingReal() float
Returns the per unit scaling factor for the active power load.
- Returns:
The per unit scaling factor for the active power load.
- Return type:
- GetLoadScalingReactive() float
Returns the per unit scaling factor for the reactive power load.
- Returns:
The per unit scaling factor for the reactive power load.
- Return type:
- SetLoadScaling(fMW: float, fMVAr: float) bool
Sets the per unit scaling factors for the active and reactive parts of the load.
- AddDataExtension(strName: str, default: int | float | str) int
Adds an integer data field and returns the new field index. Sets the default value.
Note: The variable of the function is not called default.
You can use either nDefault, dDefault, or strDefault to specify the default value depending on the type of dta extension being added.
- AddListIntDataExtension(strName: str) int
Adds a data field for a list of integers and returns the new field index. Sets the default value to an empty list.
- AddListDblDataExtension(strName: str) int
Adds a data field for a list of doubles and returns the new field index. Sets the default value to an empty list.
- AddListStrDataExtension(strName: str) int
Adds a data field for a list of strings and returns the new field index. Sets the default value to an empty list.
- GetListIntExtensionValue(nFieldIndex: int, nIndex: int) int
Get a single integer value from the list within the given enumerated field.
- GetListDblExtensionValue(nFieldIndex: int, nIndex: int) float
Get a single float value from the list within the given enumerated field.
- GetListStrExtensionValue(nFieldIndex: int, nIndex: int) str
Get a single string value from the list within the given enumerated field.
- GetListIntSize(nFieldIndex: int) int
Gets the size of the list of integers for the given enumerated field.
- GetListDblSize(nFieldIndex: int) int
Gets the size of the list of doubles for the given enumerated field.
- GetListStrSize(nFieldIndex: int) int
Gets the size of the list of strings for the given enumerated field.
- SetListIntExtensionValue(nFieldIndex: int, nIndex: int, nValue: int) bool
Sets the value of a specified element in a list of integers within the given enumerated field.
- SetListDblExtensionValue(nFieldIndex: int, nIndex: int, dValue: float) bool
Sets the value of a specified element in a list of doubles within the given enumerated field.
- SetListStrExtensionValue(nFieldIndex: int, nIndex: int, strValue: str) bool
Sets the value of a specific element in a list of strings within the given enumerated field.
- PushBackListIntExtensionValue(nFieldIndex: int, nValue: int) bool
Adds an item with the given value to the end of a list of integers within the given enumerated field.
- PushBackListDblExtensionValue(nFieldIndex: int, dValue: float) bool
Adds an item with the given value to the end of a list of doubles within the given enumerated field.
- PushBackListStrExtensionValue(nFieldIndex: int, strValue: str) bool
Adds an item with the given value to the end of a list of strings within the given enumerated field.
- GetExtensionFieldIndex(strName: str) int
Returns the field index for the extended data field of a specified name.
- GetExtensionNames() Dict[int, str]
Returns a dictionary of extension field indexes and field names. The dictionary keys are integers representing all the extended data fields. The dictionary values are the field names of the individual extended data fields. Each extended data field is therefore represented by {nIndex:strName}, where integer nIndex is the field index and string strName is the field name.