GetParametersMultipleElement Function

 

The GetParametersMultipleElement function is used to request the values of specified fields for a set of objects in the load flow case. The function can return values for all devices of a particular type, or can return values for only a list of devices of a particular type based on a filter defined for the loaded case.

 

Function Prototype

GetParametersMultipleElement(ObjectType, ParamList, Filter)

 

Parameter Definitions

ObjectType : String The type of object for which parameters are being retrieved.

ParamList : Variant A variant array storing strings. This array stores a list of PowerWorldâ object field variables, as defined in the section on PowerWorld Object Variables, for the values to retrieve from Simulator.

Filter : String The name of an advanced filter, a device filter, or a single-condition filter. If no filter is desired, simply pass an empty string. An error will be returned if a named filter cannot be found, device cannot be found for a device filter, or a single-condition filter is in the wrong format.

 

Output

When Difference Case Tools and DiffCaseMode = Change, then using the various get parameters calls will only return objects that have input parameters specified that have at least one non-key field that has changed (this was added in Version 23 patch on June 25, 2024.)

The output is a variant array:

Output(0) — error string

Output(1) — set of nested arrays containing the parameter values for the device type requested. The number of arrays of values returned depends on the number of fields in ParamList.

 

Output Structure

The Output structure of GetParametersMultipleElement is shown in the following figure:

 

 

As you can see, to access the first parameter value for the first device, Output[1][0][0] would be the correct array index. For example, the bus number for the first bus would be stored at Output[1][0][0] after calling Output = GetParametersMultipleElement('Bus',fieldarray, ''), and assuming that we have fieldarray = Array('Number', 'Name').