4.1  PowerScript Functions

This section lists all the PowerScript functions in alphabetical order of the function name.  The following is an alphabetical list:

 

AppExit               Exit OneLiner/Power Flow application.

BusPicker             Bus selection dialog box.

BoundaryEquivalent Creates a network equivalent.

ComputeRelayTime     Compute operating time of a protective device.

DoArcFlash            Run arc-flash calculation.

DoBreakerRating      Run breaker rating study.

DoFault               Simulates one or more faults.

DoSteppedEvent       Do stepped-event simulation.

DoVS                  Voltage sag analysis.

DoVSEx                Voltage sag analysis with fault duration computed using stepped-event analysis.

DoPF                  Simulate a power flow.

ErrorString          Returns text description of the last script function error.

ExportNetwork        Export network to ASPEN text data file.

ExportNetworkPSSE    Export network to PSS/E RAW and SEQ text data files.

EquipmentType        Gets the equipment type given a handle.

FaultDescription    Returns the fault description in a string.

FaultSelector       Fault selection dialog box.

FileOpenDialog      Open File dialog box.

FileSaveDialog      Save file dialog box.

FindBusByName        Returns the handle of the bus having a given name and nominal kV.

FindEquipmentByTag Returns the handle of the object having a given tag in its tag string .

FolderSelectDialog Folder selection dialog box.

FullBusName          Composes a string with bus number, bus name and nominal kV given a handle.

FullRelayName        Composes a string with relay type, name and branch location.

GetBusEquipment      Returns the handle of the next piece of equipment of a given type at a bus.

GetData               Puts a datum of interest into a program variable.

GetEquipment         Returns the handle of the next piece of network equipment of the given type.

GetFlow               Gets the power flow for a load, generator, shunt or branch in load flow simulation.

GetObjMemo            Gets the memo string of an object.

GetObjTags            Gets the tags string of an object.

GetOlrFileName       Print full path name of current OLR file.

GetPFCurrent         Gets the current flow for a load, generator, shunt or branch in load flow simulation.

GetPFVoltage         Gets the voltage at a bus or at the end buses of a branch in load flow simulation.

GetProgramVersion    Print string with program version and build information.

GetPSCVoltage        Gets the pre-fault voltage at a bus or at the end buses of a branch.

GetRelay              Returns the handle of the next protective device in a relay group.

GetRelayTime         Gets the operating time of a relay in a fault.

GetSCCurrent         Gets the current flow for a load, generator, shunt or branch in a fault.

GetSCVoltage         Gets the post fault voltage at a bus or at the end buses of a branch.

GetSteppedEvent      Gets detailed result of a step in stepped-event simulation.

GetVSVoltage         Gets the voltage sag analysis result.

LoadDataFile         Open a binary or text data file.

Locate1LObj          Locate an object on the 1-line diagram.

MakeOutageList       Make branch outage list for fault simulation.

NextBusByName        Returns the handle of the next bus in the bus list that is sorted by name.

NextBusByNumber      Returns the handle of the next bus in the bus list that is sorted by number.

PickFault           Selects one of the available fault results.

PostData              Validates all the updated parameters of an equipment and updates the database.

ProgressDialog       Progress dialog box.

PrintTTY              Puts a message on the TTY window.

PrintObj1LPF         Return a text description of network database object

ReadChangeFile      Read a change file

SaveDataFile         Save network data to file.

SetData               Changes the value of a parameter in a temporary object.

SetObjMemo            Changes the memo of a object.

SetObjTags            Changes the tags of a object.

ShowFault           Selects one of the available fault results and show it on the one-line diagram.