ASPEN

PowerScript V10

Reference Manual

Advanced Systems for Power Engineering, Inc.

NOTICE

ASPEN PowerScript is a proprietary computer program of Advanced Systems for Power Engineering, Inc. (ASPEN).

The information in this document is subject to change without notice. Advanced Systems for Power Engineering, Inc.
assumes no responsibility for any errors that may appear in this document.

Copyright 1988-2005 Advanced Systems for Power Engineering, Inc. All rights reserved.

HOW TO ORDER MORE MANUALS

This User's Manual may be duplicated by the Licensee for its own use. You can order a new copy by writing to the
address below. Please refer to document OL-PS-2005.

HOW TO REACH ASPEN

Mailing address: ASPEN

34 N. San Mateo Drive
San Mateo, CA 94401
U.S.A.

Telephone: (650)347-3997
Fax: (650)347-0233
eMail: [email protected]
Web Site: www.aspeninc.com

Our office hours are from 8:30 a.m. to 5:30 p.m. Pacific time (GMT-8 in the winter, GMT-7 in the summer), Monday
through Friday.

_________________________________________________________________________________
ASPEN OneLiner, ASPEN PowerScript, ASPEN Power Flow, ASPEN Overcurrent Relay Editor, ASPEN
Distance Relay Editor, ASPEN DistriView, ASPEN Batch Short Circuit Module, ASPEN Breaker Rating
Module and ASPEN Relay Database are trademarks of Advanced Systems for Power Engineering, Inc.

PSS/E and PSS/U are trademarks of Power Technologies, Inc.

IBM is a registered trademark of International Business Machines Incorporated.
Microsoft is a registered trademark of Microsoft Corp. Windows is a trademark of Microsoft Corp.
Contents
SECTION 1 INTRODUCTION ............................................................................................................................................. 3
1.1 SCRIPTING LANGUAGE ..........................................................................................................................................................3
1.2 LANGUAGE SPECIFICATION .................................................................................................................................................4
SECTION 2 TUTORIAL ........................................................................................................................................................ 5
2.1 INTRODUCTION......................................................................................................................................................................5
2.2 EDITING A SCRIPT FILE........................................................................................................................................................5
2.3 DEBUGGING A SCRIPT ...........................................................................................................................................................7
2.4 EDITING DIALOG BOXES.......................................................................................................................................................9
2.5 RUNNING SCRIPTS AS PROGRAM COMMANDS ................................................................................................................13
2.6 SAMPLE SCRIPTS.................................................................................................................................................................14
SECTION 3 OVERVIEW .....................................................................................................................................................15
3.1 OBJECT HANDLES................................................................................................................................................................15
3.2 EQUIPMENT TYPE CODE....................................................................................................................................................16
3.3 NETWORK DATA A CCESS ..................................................................................................................................................16
3.4 SHORT CIRCUIT SOLUTION ...............................................................................................................................................22
3.5 POWER FLOW SOLUTION...................................................................................................................................................23
3.6 RESERVED NAMES AND KEYWORDS .................................................................................................................................23
SECTION 4 FUNCTION REFERENCE..............................................................................................................................25
4.1 POWERSCRIPT FUNCTIONS................................................................................................................................................25
Function BusPicker .............................................................................................................................................................26
Function DoFault.................................................................................................................................................................27
Function DoPF .....................................................................................................................................................................29
Function EquipmentType....................................................................................................................................................31
Function GetBusEquipment ...............................................................................................................................................32
Function GetData.................................................................................................................................................................33
Function GetEquipment......................................................................................................................................................34
Function GetFlow ................................................................................................................................................................35
Function GetPFCurrent......................................................................................................................................................36
Function GetPFVoltage......................................................................................................................................................37
Function GetPSCVoltage ...................................................................................................................................................38
Function GetRelay ...............................................................................................................................................................39
Function GetRelayTime.......................................................................................................................................................40
Function GetSCCurrent......................................................................................................................................................41
Function GetSCVoltage ......................................................................................................................................................43
Function ErrorString...........................................................................................................................................................45
Function FaultSelector.......................................................................................................................................................46
Function FindBusByName..................................................................................................................................................47
Function FullBusName .......................................................................................................................................................48
Function NextBusByName ..................................................................................................................................................49
Function NextBusByNumber..............................................................................................................................................50
Function PickFault..............................................................................................................................................................51

ASPEN PowerScript V10 Contents i

 Function PostData ...............................................................................................................................................................52
Function PrintTTY................................................................................................................................................................53
Function ReadChangeFile .................................................................................................................................................54
Function SetData .................................................................................................................................................................55
Function ShowFault ............................................................................................................................................................56
INDEX..............................................................................................................................................................................................57

ii Contents ASPEN PowerScript V10

SECTION 1 INTRODUCTION

1.1 Scripting Language

ASPEN PowerScript is a scripting tool embedded in ASPEN OneLiner and ASPEN Power Flow Program to
enable users to drive the programs with instructions written in BASIC. You can use PowerScript to examine
and modify all the system and network parameters and utilize OneLiner and Power Flow as solution engines.
PowerScript has many applications. In the simplest form, a script can be just a few lines of instructions designed
to automate a frequently performed task. For instance you can write a script in OneLiner to find the highest fault
current at a bus with the adjacent branches outaged one at a time. Simple scripts of this type are commonly
referred to as macros.
With a slightly more complicated script, you can use PowerScript to create customized reports of network
parameters and solution variables. As an example, you can create your own report in Power Flow to list all the PV
buses whose output is pegged at the maximum or minimum value.
A script can be a full-fledged computer program with its own decision-making capabilities and computational
logic. A OneLiner user, for example, can write a script to locate a fault by simulating a number of faults along a
line and compare the voltage and current solutions to the values recorded to find the best match. A Power Flow
user can write a script to perform outage studies.
PowerScript has a wide range of input/output capabilities. A script can open disk files for reading in or writing
out any kind of text or binary data. It can also interact with the user through dialog boxes and keyboard handling
routines. PowerScript comes with a built-in dialog box editor that makes designing dialog boxes a snap. The
editor has all standard dialog-box controls such as Edit, List, and Combo boxes, and Check and Radio buttons.
PowerScript supports OLE Automation, a widely used standard for connecting computer software made by
different vendors. This means a script can utilize and manipulate programs, such as MS Word and Excel, which
are written as OLE containers. In a sample power-flow script that finds the maximum MW transfer between two
areas, the script sends the solution to Excel and directs it to plot the classical voltage-versus-MW curve. The
possibility of what you can do with PowerScript is limitless.
A text editor is built into OneLiner and Power Flow to enable you to modify scripts. The build-in script editor has
many advanced features including syntax highlighting. A symbolic debugger for PowerScript is also built-in. In
the debug mode, you can stop the script at any point and examine all the program variables.
Many example scripts are included with OneLiner and Power Flow. Some of these scripts are useful applications
of their own right. We encourage you to take a close look at these scripts.

ASPEN PowerScript V10 SECTION 1 INTRODUCTION 3

1.2 Language Specification
ASPEN PowerScript fully supports the BASIC programming language syntax, as well as the standard intrinsic
functions in BASIC. Comprehensive BASIC language reference is available in on-line help file BASIC Language
Reference.
PowerScript comes with a collection of subroutines that lets you:
Examine and modify network data and relay data in ASPEN OneLiner and Power Flow.
Perform short circuit and power flow solutions.
Access the value of solution variables.
These functions are described in Section 3 and Section 4.
If you are new to PowerScript, we suggest you follow the tutorial in Section 2.

4 SECTION 1 INTRODUCTION ASPEN PowerScript V10

SECTION 2 TUTORIAL

2.1 Introduction
In this section you will learn how to edit a script, run it and debug it. You will also see how to turn the script into
a function that you can call directly from the menu bar of OneLiner or Power Flow.
We will use OneLiner as the executable program in this tutorial. The same steps can be used in the Power Flow
Program.
The example script is a very simple per-unit calculator. The script will use the system MVA of the currently open
network as the base MVA. It will also set the base kV to the nominal kV of the currently selected object on the
one-line diagram. The kV base is set to zero if nothing is selected.

2.2 Editing a Script File

A BASIC script file is a text file that you can edit with any word processor or text edit. OneLiner and Power Flow
both have built-in editors that are designed for editing script. We encourage you to use the built-in editors.
Please follow these directions to open a script file called perunit1.bas.
A 29-bus system is used in most of this tutorial. You will now open its binary data file.
1. Open the file EXAMPLE30.OLR (EXAMPLE09.OLR for Academic Suite users,
and ASPEN9.OLR for Power Flow users.)
Note: It is not necessary to have a network open in order to edit a script file, but
in practice, most PowerScript commands require an open data file to run.
2. Select the Tool | Scripting | Edit / Create Script command

Note: You can click on the button on the toolbar.

A blank Script Editor window will appear
3. Open the file perunit1.pas in the script editor as follows.
Select the File | Open. Click once on the file name 'perunit1.bas' in the
list box. The name will appear in the File Name edit box. Click on the
"Open" button.
The file will be loaded into the Script Editor

ASPEN PowerScript V10 SECTION 2 TUTORIAL 5

 4. Perform a test run.
Select the Run | Start command. The per unit calculator main dialog box
will appear. The Base MVA edit box will show the current system MVA
base of 100.

Enter data: Base kV = 132; Ohm = 5;

Click on the Ohm -> PU button. The corresponding per unit value of
0.028696 will be displayed in the edit box labeled p.u
5. Click on Done to close the PU calculator and return to the script editor screen.

6 SECTION 2 TUTORIAL ASPEN PowerScript V10

2.3 Debugging a Script
A nontrivial program has at least one bug by definition. We purposely introduced one in the example file to give
you a chance to fix it.
In this part of the tutorial, we assume you have just completed step 3 in section 2.2.
1. Select Run | Start command.
The Per Unit calculator main dialog will appear.
2. Without entering any data, click on Ohm->PU button
A division-by-zero message box will appear

Click on Debug button. The script editor will re-appear in which the line of
code where the error occurred is being highlighted in yellow (the last line,
at the very bottom).

ASPEN PowerScript V10 SECTION 2 TUTORIAL 7

 3. Select Run | End to stop the execution of the script.
4. Select the Debug | Toggle Break Point command to set a break point at the error
line.
A solid purple dot will appear near the beginning of the line, and the text
on the line will be highlighted in purple. This indicates that a break point
has been inserted on the line.
5. Select Run | Start.
Leave Base kV edit box blank. Click on Ohm -> PU button. The script
editor will re-appear showing that the program has stopped at the break
point position.
Move the mouse pointer over the BaseZ variable on this line. A small
window will appear near the mouse pointer showing current value of this
variable, which is zero:

Its clear that the divide by zero error was caused by BazeZ=0 which in
turn is caused by the zero value of BaseKV. We will now add some logic
to the script program to prevent this from happening.
6. Select Run | End to stop the program.

8 SECTION 2 TUTORIAL ASPEN PowerScript V10

 7. Replace the Do Loop code around the break point by the code shown below:
Do
button = Dialog( dlg )
If button = 3 Then Exit Do ' Done
If dlg.BaseKV <= 0 Then
Print "Base kV not positive"
ElseIf dlg.baseMVA <= 0 Then
Print "Base MVA not positive"
Else
BaseZ = dlg.BaseKV * dlg.BaseKV / dlg.BaseMVA
If button = 1 Then
dlg.PU = dlg.Ohm / BaseZ
Else
dlg.Ohm = dlg.PU * BaseZ
End If
End If
Loop

8. Select Run | Start to run the new code. Click on Ohm -> PU with blank Base
kV edit box.
A message will appear with a warning:

Click on OK. The main program dialog will re-appear, ready to accept new
input.
9. Click on Done to close the Per Unit calculator program.

2.4 Editing Dialog Boxes

OneLiner and Power Flow have a dialog-box editor program that lets you create and edit dialog boxes. The
editing is done in a graphical setting. You can drag and drop edit boxes, list boxes, combo boxes and other
standard dialog-box objects from the toolbar onto your dialog box.
In this part of tutorial we assume that you have just completed step 9 in section 2.3.
1. Select the text with dialog-box specification, which is surrounded by Begin
Dialog and End Dialog keywords.
2. Select command Edit | Copy to transfer the text to Window clipboard.

ASPEN PowerScript V10 SECTION 2 TUTORIAL 9

 3. Open ASPEN V10 program group on the desktop.

Run the dialog designer program by double clicking on its icon. The
dialog editor screen will appear.

10 SECTION 2 TUTORIAL ASPEN PowerScript V10

 4. In the Editor, select File | Load Dialog From Clipboard. The per unit calculator
program main dialog will appear.

5. Click on the Add Text Label button on the Dialog Editor Tool bar. The cursor
pointer will become a cross.
Click once to the right of the BaseMVA edit box.
Select Window | Properties Window command. This will bring up
Properties for Text Label window.
Enter label (must be > 0)
Go back to the Design window. Adjust size and position of various dialog
box components to tidy up the dialog box.
Repeat the process above to create another identical label next to BaseKV
edit box.

ASPEN PowerScript V10 SECTION 2 TUTORIAL 11

 6. When you are satisfied with the new appearance of the dialog box design Select
command File | Put Dialog on Clipboard. The dialog editor data will be copied to
the Windows clipboard.
7. Switch back to the Script Editor window without closing the dialog editor.
Note: Never attempt to close the Dialog editor by selecting File | Close
command or by clicking on the Dialog editor window close button.
Select Edit | Paste to replace the old dialog data in the script program with
the newly modified one.
8. Select File | Save to save the new code.
9. Run the script to check the new code.
10. Switch to the Dialog Editor to make any changes to the dialog and repeat step 5-
8.
11. Select Edit | Dialog Editor to close the dialog editor.

12 SECTION 2 TUTORIAL ASPEN PowerScript V10

2.5 Running Scripts as Program Commands
Once you have created a script, you can execute it directly from the main program window of OneLiner or Power
Flow, via the Tools | Scripting | Run Script command. You can also assign a script file to each of the five
customizable menu commands under Tools | User-Defined Commands. This part of the tutorial will introduce you
to these features.
1. Run the script from the Scripting | Run Script command.
Select command Tools | Scripting | Run Script. A file open dialog box will
appear.

Note: You can also use toolbar button or keyboard short-cut Ctrl-R
Select file name perunit1.bas from the list box and click on Open. The
main dialog of per unit program will appear.
Click on Done when you finish using the per unit calculator.
2. Customize user-defined commands.
Select command Tools | User-defined Commands | Setup. A dialog box will
appear.

Enter Menu label and full path name to per-unit calculator script file as
shown in the picture.
Click on OK when done. The Per Unit Calculator command will now be
available in the program menu.

ASPEN PowerScript V10 SECTION 2 TUTORIAL 13

 3. Select Toots | User-Defined Commands | Per Unit Calculator. The script will start
running and main dialog of per unit program will appear.

2.6 Sample Scripts

The per-unit calculator script shown in the previous section is just a simple example designed to show you how
to get started with the scripting feature. To explore further, you may want to examine other sample scripts that are
shipped with OneLiner and Power Flow Program.
You can find these sample scripts in the c:\ASPEN05\Script directory for OneLiner and c:\ASPENPF05\Script
directory for Power Flow. Within each of these directories is a file README.TXT that contains the most current
list of script samples and a brief description of what they do.
You can also find script programs submitted by ASPEN users in the Exchange page on ASPENs web site
(http://www.aspeninc.com/exchange). We urge you to submit scripts that you want to share with other ASPEN
users.

14 SECTION 2 TUTORIAL ASPEN PowerScript V10

SECTION 3 OVERVIEW

3.1 Object Handles

PowerScript identifies each network object by a unique number, called a handle. You must use one of the
following functions to obtain a handle before you can read or update the objects parameters.

GetEquipment returns the handle of the next piece of network equipment of the given type.
GetRelay returns the handle of the next protective device in a relay group.
GetBusEquipment returns the handle of the next piece of equipment of a given type at a bus.
FindBusByName returns the handle of the bus having a given name and nominal kV.
NextBusByName returns the handle of the next bus in sorted bus list.
NextBusByNumber returns the handle of the next bus in sorted bus list.
GetData returns handle as part of an object data, e.g., the end buses of a line.
A detailed description of these functions is given in Section 4.
The handle is an identification tag. When you provide the object handle as an input to a PowerScript function,
the function will know which object you are referring to.
In addition to handles returned by the functions listed above, there are several pre-defined handles that give
PowerScript access to general system data:
Table 3.1. List of predefined PowerScript handles

Data Code
System data HND_SYS
Power flow case solution HND_PF
Short circuit case solution HND_SC

ASPEN PowerScript V10 SECTION 3 OVERVIEW 15

3.2 Equipment Type Code
The functions GetEquipment, GetRelay, GetBusEquipment, plus several other PowerScript functions require you
to enter an equipment type code to identify the object type of interest. The complete type code list is in the table
3.2.
Table 3.2. List of PowerScript equipment type codes

Equipment type Code

Bus TC_BUS
Load TC_LOAD
Load unit TC_LOADUNIT
Shunt TC_SHUNT
Shunt unit TC_SHUNTUNIT
Generator TC_GEN
Generator unit TC_GENUNIT
Switched shunt TC_SVD
Branch connection TC_BRANCH
Transmission Line TC_LINE
2-winding transformer TC_XFMR
3-winding transformer TC_XFMR3
Phase shifter TC_PS
Switch TC_SWITCH
Series capacitor TC_SCAP
System parameter TC_SYS
Relay group TC_RLYGROUP
Overcurrent ground relay TC_RLYOCG
Overcurrent phase relay TC_RLYOCP
DS ground relay TC_RLYDSG
DS phase relay TC_RLYDSP
Fuse TC_FUSE
Power flow case TC_PF
Short circuit case TC_SC

3.3 Network Data Access

The PowerScript function GetData copies network and system data from a OneLiner or Power Flow case to
PowerScript program variables. The datum to be read is uniquely identified by an object handle and a parameter
code. The list of supported parameter codes is given in table below.
Table 3.3. List of PowerScript Equipment Parameter Code

Parameter Data type Write Parameter Code

Access
Branch near bus handle long NO BR_nBus1Hnd
Branch far bus handle long NO BR_nBus2Hnd
Branch tertiary bus handle long NO BR_nBus3Hnd
Branch equipment handle long NO BR_nHandle

16 SECTION 3 OVERVIEW ASPEN PowerScript V10

 Branch in-service flag: 1- active; 2- out-of-service long NO BR_nInService
Branch near bus relay groun handle long NO BR_nRlyGrp1Hnd
Branch far bus relay group handle long NO BR_nRlyGrp2Hnd
Branch tertiary bus relay group handle long NO BR_nRlyGrp3Hnd
Branch type long NO BR_nType
Bus nominal kV double NO BUS_dKVnorminal
Bus area long NO BUS_nArea
Bus number long NO BUS_nNumber
Tap bus flag: 1- yes; 0 no long NO BUS_nTapBus
Bus zone long NO BUS_nZone
Bus location string YES BUS_sLocation
Bus name string YES BUS_sName
DS ground relay CT ratio double NO DG_dCT
Zero sequence compensation factor K - angle double NO DG_dKang
Zero sequence compensation factor K - magnitude double NO DG_dKmag
DS ground relay VT ratio double NO DG_dVT
DS ground relay in-service flag: 1- active; 2- out-of- long NO DG_nInService
service
DS ground relay group handle long NO DG_nRlyGrHnd
DS ground relay ID string NO DG_sID
DS ground relay type string YES DG_sType
DS phase relay CT ratio double NO DP_dCT
DS phase relay VT ratio double NO DP_dVT
DS phase relay in-service flag: 1- active; 2- out-of- long NO DP_nInService
service
DS phase relay group handle long NO DP_nRlyGrHnd
DS phase relay ID string YES DP_sID
DS phase relay type string NO DP_sType
Fuse in-service flag: 1- active; 2- out-of-service long NO FS_nInService
Fuse relay group handle long NO FS_nRlyGrHnd
Fuse ID string YES FS_sID
Fuse type string NO FS_sType
Fault MVA double NO FT_dMVA
Thevenin equivalent negative sequence resistance double NO FT_dRNt
Thevenin equivalent positive sequence resistance double NO FT_dRPt
Thevenin equivalent zero sequence resistance double NO FT_dRZt
Thevenin equivalent negative sequence reactance double NO FT_dXNt
Thevenin equivalent positive sequence reactance double NO FT_dXPt
X/R ratio at fault point double NO FT_dXR
Thevenin equivalent zero sequence reactance double NO FT_dXZt
Generator reference angle double NO GE_dRefAngle
Generator scheduled P double NO GE_dScheduledP
Generator scheduled Q double NO GE_dScheduledQ
Generator scheduled V double NO GE_dScheduledV
Generator in-service flag: long NO GE_nActive
1- active; 2- out-of-service
Handle of generators controlled bus long NO GE_nCtrlBusHnd
Generator regulation flag: 1- PQ; 0- PV long NO GE_nFixedPQ
Generator unit rating double YES GU_dMVArating
Generator unit max MW double YES GU_dPmax

ASPEN PowerScript V10 SECTION 3 OVERVIEW 17

 Generator unit min MW double YES GU_dPmin
Generator unit max MVAR double YES GU_dQmax
Generator unit min MVAR double YES GU_dQmin
Generator unit grounding resistance double YES GU_dRz
Generator unit grounding reactance double YES GU_dXz
Generator unit online flag long YES GU_nOnline
Generator unit ID string NO GU_sID
Generator unit resistances: subtransient, synchronous, array(5) of double YES GU_vdR
transient, negative sequence, zero sequence
Generator unit reactances: subtransient, synchronous, array(5) of double YES GU_vdX
transient, negative sequence, zero sequence
Total load MW double NO LD_dPload
Total load MVAR double NO LD_dQload
Load in-service flag: 1- active; 2- out-of-service long NO LD_nActive
Line B1 double YES LN_dB1
Line B10 double YES LN_dB10
Line B2 double YES LN_dB2
Line B20 double YES LN_dB20
Line G1 double YES LN_dG1
Line G10 double YES LN_dG10
Line G2 double YES LN_dG2
Line G20 double YES LN_dG20
Line length double YES LN_dLength
Line R double YES LN_dR
Line Ro double YES LN_dR0
Line X double YES LN_dX
Line Xo double YES LN_dX0
Line bus 1 handle long NO LN_nBus1Hnd
Line bus 2 handle long NO LN_nBus2Hnd
Line in-service flag: 1- active; 2- out-of-service long YES LN_nInService
Line bus 1 relay group handle long NO LN_nRlyGr1Hnd
Line bus 2 relay group handle long NO LN_nRlyGr2Hnd
Line circuit ID string YES LN_sID
Line length unit string YES LN_sLengthUnit
Line name string YES LN_sName
Line table type string YES LN_sType
Line ratings array(4) of double YES LN_vdRating
Load unit online flag long YES LU_nOnline
Load unit ID string NO LU_sID
Load unit MVARs: const. P, const. I, const Z array(3) of double YES LU_vdMVAR
Load unit MWs: const. P, const. I, const Z array(3) of double YES LU_vdMW
OC ground relay CT ratio double YES OG_dCT
OC ground relay tap Ampere double YES OG_dTap
OC ground relay time dial double YES OG_dTDial
OC ground relay in-service flag: 1- active; 2- out-of- long NO OG_nInService
service
OC ground relay group handle long NO OG_nRlyGrHnd
OC ground relay ID string YES OG_sID
OC ground relay type string NO OG_sType
OC phase relay CT ratio double YES OP_dCT

18 SECTION 3 OVERVIEW ASPEN PowerScript V10

 OC phase relay tap Ampere double YES OP_dTap
OC phase relay time dial double YES OP_dTDial
OC phase relay in-service flag: 1- active; 2- out-of- long NO OP_nInService
service
OC phase relay group handle long NO OP_nRlyGrHnd
OC phase relay ID string YES OP_sID
OC phase relay type string NO OP_sType
Phase shifter shift angle double YES PS_dAngle
Phase shifter shift angle max double YES PS_dAngleMax
Phase shifter shift angle min double YES PS_dAngleMin
Phase shifter B double YES PS_dB
Phase shifter Bo double YES PS_dB0
Phase shifter B2 double YES PS_dB2
Phase shifter MW max double YES PS_dMWmax
Phase shifter MW min double YES PS_dMWmin
Phase shifter R double YES PS_dR
Phase shifter Ro double YES PS_dR0
Phase shifter R2 double YES PS_dR2
Phase shifter X double YES PS_dX
Phase shifter Xo double YES PS_dX0
Phase shifter X2 double YES PS_dX2
Phase shifter primary bus handle long NO PS_nBus1Hnd
Phase shifter secondary bus handle long NO PS_nBus2Hnd
Phase shifter control mode long NO PS_nControlMode
Phase shifter in-service flag: 1- active; 2- out-of-service long YES PS_nInService
Phase shifter primary bus relay group handle long NO PS_nRlyGr1Hnd
Phase shifter secondary bus relay group handle long NO PS_nRlyGr2Hnd
Phase shifter circuit ID string NO PS_sID
Phase shifter name string NO PS_sName
Relay group back up group handle long NO RG_nBackupHnd
Relay group branch handle long NO RG_nBranchHnd
Relay group in-service flag: 1- active; 2- out-of-service long NO RG_nInService
Relay group primary group handle long NO RG_nPrimaryHnd
Relay group annotation string NO RG_sNote
Series capacitor protective level current double YES SC_dIpr
Series capacitor R double YES SC_dR
Series capacitor Ro double YES SC_dR0
Series capacitor X double YES SC_dX
Series capacitor Xo double YES SC_dX0
Series capacitor bus 1 handle long NO SC_nBus1Hnd
Series capacitor bus 2 handle long NO SC_nBus2Hnd
Series capacitor in-service flag: 1- active; 2- out-of- long NO SC_nInService
service; 3- bypassed
Series capacitor circuit ID string NO SC_sID
Series capacitor name string NO SC_sName
Shunt unit succeptance (positive sequence) double YES SU_dB
Shunt unit succeptance (zero sequence) double YES SU_dB0
Shunt unit conductance (positive sequence) double YES SU_dG
Shunt unit conductance (zero sequence) double YES SU_dG0
Shunt unit 3-winding transformer flag long NO SU_n3WX

ASPEN PowerScript V10 SECTION 3 OVERVIEW 19

 Shunt unit online flage long YES SU_nOnline
Shunt unit ID string NO SU_sID
SVD admitance in use double NO SV_dB
SVD max V double NO SV_dVmax
SVD min V double NO SV_dVmin
SVD in-service flag: 1- active; 2- out-of-service long NO SV_nActive
Handle of SVD controled bus long NO SV_nCtrlBusHnd
SVD control mode long NO SV_nCtrlMode
SVD increment B0 array(8) of double NO SV_vdB0inc
SVD increment B array(8) of double NO SV_vdBinc
SVD number of step Array(8) of double NO SV_vnNoStep
Switch current rating Double YES SW_dRating
Switch bus 1 handle long NO SW_nBus1Hnd
Switch bus 2 handle long NO SW_nBus2Hnd
Switch in-service flag: 1- active; 2- out-of-service long YES SW_nInService
Switch position flag: 1- close; 0- open long YES SW_nStatus
Switch name string YES SW_sName
System MVA base double NO SY_dBaseMVA
System number of buses long NO SY_nNObus
System number of generators long NO SY_nNOgen
System number of transmision lines long NO SY_nNOline
System number of loads long NO SY_nNOload
System number of phase shifter long NO SY_nNOps
System number of series capacitors long NO SY_nNOseriescap
System number of shunts long NO SY_nNOshunt
System number of 2-winding transformers long NO SY_nNOxfmr
System number of 3-winding transformers long NO SY_nNOxfmr3
System data: comment string NO SY_sFComment
3-winding transformer B double YES X3_dB
3-winding transformer B0 double YES X3_dB0
3-winding transformer primary side tap kV double NO X3_dPriTap
3-winding transformer R0ps double YES X3_dR0ps
3-winding transformer R0pt double YES X3_dR0pt
3-winding transformer R0st double YES X3_dR0st
3-winding transformer RG1 double YES X3_dRG1
3-winding transformer RG2 double YES X3_dRG2
3-winding transformer RG3 double YES X3_dRG3
3-winding transformer RGn double YES X3_dRGN
3-winding transformer Rps double YES X3_dRps
3-winding transformer Rpt double YES X3_dRpt
3-winding transformer Rst double YES X3_dRst
3-winding transformer secondary side tap kV double NO X3_dSecTap
3-winding transformer tertiary side tap kV double NO X3_dTerTap
3-winding transformer X0ps double YES X3_dX0ps
3-winding transformer X0pt double YES X3_dX0pt
3-winding transformer X0st double YES X3_dX0st
3-winding transformer XG1 double YES X3_dXG1
3-winding transformer XG2 double YES X3_dXG2
3-winding transformer XG3 double YES X3_dXG3
3-winding transformer XGn double YES X3_dXGN

20 SECTION 3 OVERVIEW ASPEN PowerScript V10

 3-winding transformer Xps double YES X3_dXps
3-winding transformer Xpt double YES X3_dXpt
3-winding transformer Xst double YES X3_dXst
3-winding transformer auto transformer flag long NO X3_nAuto
3-winding transformer primary bus handle long NO X3_nBus1Hnd
3-winding transformer secondary bus handle long NO X3_nBus2Hnd
3-winding transformer tertiary bus handle long NO X3_nBus3Hnd
3-winding transformer fictitious bus number long NO X3_nFictBusNo
3-winding transformer in-service flag: long YES X3_nInService
1- active; 2- out-of-service
3-winding transformer primary side relay group handle long NO X3_nRlyGr1Hnd
3-winding transformer secondary side relay group long NO X3_nRlyGr2Hnd
handle
3-winding transformer tertiary side relay group handle long NO X3_nRlyGr3Hnd
3-winding transformer primary winding config string NO X3_sCfgP
3-winding transformer secondary winding config string NO X3_sCfgS
3-winding transformer secondary winding config in test string NO X3_sCfgST
3-winding transformer tertiary winding config string NO X3_sCfgT
3-winding transformer tertiary winding config in test string NO X3_sCfgTT
3-winding transformer circuit ID string NO X3_sID
3-winding transformer name string NO X3_sName
2-winding transformer B double YES XR_dB
2-winding transformer Bo double YES XR_dB0
2-winding transformer B1 double YES XR_dB1
2-winding transformer B10 double YES XR_dB10
2-winding transformer B2 double YES XR_dB2
2-winding transformer B20 double YES XR_dB20
2-winding transformer G1 double YES XR_dG1
2-winding transformer G10 double YES XR_dG10
2-winding transformer G2 double YES XR_dG2
2-winding transformer G20 double YES XR_dG20
2-winding transformer LTC step size double NO XR_dLTCstep
2-winding transformer LTC max tap double NO XR_dMaxTap
2-winding transformer LTC min controlled quantity double NO XR_dMaxVW
limit
2-winding transformer LTC min tap double NO XR_dMinTap
2-winding transformer LTC max controlled quantity double NO XR_dMinVW
limit
2-winding transformer MVA rating double YES XR_dMVA
2-winding transformer primary side tap kV double NO XR_dPriTap
2-winding transformer R double YES XR_dR
2-winding transformer Ro double YES XR_dR0
2-winding transformer Rg1 double YES XR_dRG1
2-winding transformer Rg2 double YES XR_dRG2
2-winding transformer Rgn double YES XR_dRGN
2-winding transformer secodary side tap kV double NO XR_dSecTap
2-winding transformer X double YES XR_dX
2-winding transformer Xo double YES XR_dX0
2-winding transformer Xg1 double YES XR_dXG1
2-winding transformer Xg2 double YES XR_dXG2
2-winding transformer Xgn double YES XR_dXGN

ASPEN PowerScript V10 SECTION 3 OVERVIEW 21

 2-winding transformer auto transformer flag long NO XR_nAuto
2-winding transformer primary bus handle long NO XR_nBus1Hnd
2-winding transformer secondary bus handle long NO XR_nBus2Hnd
2-winding transformer in-service flag: long YES XR_nInService
1- active; 2- out-of-service
2-winding transformer LTC control bus handle long NO XR_nLTCCtrlBusH
nd
2-winding transformer LTC side: 1; 2; 0 long NO XR_nLTCside
2-winding transformer LTC type: long NO XR_nLTCtype
1- control voltage; 2- control MVAR
2-winding transformer metered bus handle long NO XR_nMetered
2-winding transformer primary bus relay group handle long NO XR_nRlyGr1Hnd
2-winding transformer secondary bus relay group long NO XR_nRlyGr2Hnd
handle
2-winding transformer P winding config string NO XR_sCfgP
2-winding transformer S winding config string NO XR_sCfgS
2-winding transformer circuit ID string NO XR_sID
2-winding transformer name string NO XR_sName

Parameters listed in table 3.3 with write access can be modified from PowerScript. There are two functions that
help you modify the parameters of an object: PutData and PostData.
Suppose you want to change three parameters of an object. In your program you must call the function
PutData separately for each of the parameters you are changing. PowerScript automatically creates a
temporary object in memory with the updated parameters.
Once you are done modifying the parameters, you must call the function PostData once to validate the object
data and if the data is valid, copy the temporary object to the OneLiner or Power Flow case.

3.4 Short Circuit Solution

You can call the function DoFault to simulate short circuits. The options available in this function are the same as
those in the Fault | Specify Classical Fault command in OneLiner.
After a fault simulation, you can copy the voltage and current results into PowerScript program variables for
reports or for further processing.
Because a single fault simulation command in OneLiner can initiate simulation of multiple faults of different fault
types and branch outages, you must call the function ShowFault or PickFault to specify the fault of interest.
You can use the functions GetSCVoltage and GetSCCurrent to retrieve post-fault voltage and current at
the terminals of a network object. You can get the total fault current by calling GetSCCurrent with the pre-
defined handle of short circuit solution, HND_SC.
PowerScript function GetRelayTime is used to retrieve operating time of a given relay.

DoFault Simulates one or more faults.

FaultDescription Returns the fault description in a string.
GetRelayTime Gets the operating time of a relay.

22 SECTION 3 OVERVIEW ASPEN PowerScript V10

 GetSCCurrent Gets the current flow for a load, generator, shunt or branch.
GetSCVoltage Gets the voltage at a bus or at the end buses of a branch.
PickFault Selects one of the fault results.
ShowFault Selects one of the fault results and show it on one-line diagram.

3.5 Power Flow Solution

You can use the function DoPF to simulate a power flow case. The options available in this function are the same
as those in the Solve | Power Flow command in Power Flow. After a simulation in the Power Flow Program, you
can copy the voltage and current results into PowerScript program variables for generating report and for further
processing.
The functions GetPFVoltage and GetPFCurrent retrieves solution voltage and current at terminals of the
given network device. The function GetFlow calculates the power flow.

DoPF Simulates a power flow.

GetFlow Gets the MW+jMVAR flow for a load, generator, shunt or branch.
GetPFCurrent Gets the current flow for a load, generator, shunt or branch.
GetPFVoltage Gets the voltage at a bus or at the end buses of a branch.

3.6 Reserved names and keywords

PowerScript programmers must avoid using following names in their programs:
- BASIC language reserved keywords. (see Basic Language Reference Help for full listing)
- PowerScript predefined handles in table 3.1
- PowerScript equipment type codes in table 3.2
- PowerScript parameter codes in table 3.3.
- Other names in the format ???_* where ? represents at most one character and * represent at least one
character.

ASPEN PowerScript V10 SECTION 3 OVERVIEW 23

SECTION 4 FUNCTION REFERENCE

4.1 PowerScript Functions

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

BusPicker Bus selection dialog box.

DoFault Simulates one or more faults.
DoPF Simulate a power flow.
EquipmentType Gets the equipment type given a handle.
ErrorString Gets the error message in a string.
FaultDescription Returns the fault description in a string.
FaultSelector Fault selection dialog box.
FindBusByName Returns the handle of the bus having a given name and nominal kV.
FullBusName Composes a string with bus number, bus name and nominal kV given a handle.
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.
GetPFCurrent Gets the current flow for a load, generator, shunt or branch.
GetPFVoltage Gets the voltage at a bus or at the end buses of a branch.
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.
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.
PrintTTY Puts a message on the TTY window.
ReadChangeFile Read a change file
SetData Changes the value of a parameter in a temporary object.
ShowFault Selects one of the available fault results and show it on the one-line diagram.

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 25

Function BusPicker

Function Function BusPicker( ByRef sWindowText$, ByRef vnBusHnd1() as Long, _

ByRef vnBusHnd2() as Long ) As Long

Purpose: Display bus selection dialog.

Works in: OneLiner / Power Flow.

Parameters:
sWindowText [in] Dialog title.
vnBusHnd1 [in] Array of handle number of buses that are already selected when the dialog opens. The list
must be terminated with zero.
vnBusHnd2 [out] Array of handle number of buses that user selected. The list must is terminated with
zero.
Return value:
1 User clicked OK
0 User clicked Cancel
Remarks: Dimension of the two arrays must be adequate to store all buses in the network.
Example:
sWindowText$ = "My Bus Picker"
nPicked& = BusPicker( sWindowText$, vnBusHnd1, vnBusHnd2 ) strTemp$ = ""
For ii& = 1 to nPicked
nBsHnd& = vnBusHnd2(ii)
strName$ = FullBusName( nBsHnd& )
strTemp$ = strTemp$ + strName$ + Chr(10) + Chr(13)
Next

26 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function DoFault

Function DoFault( ByVal nDevHnd&, ByRef vnFltConn() As Long, _

ByRef vdFltOpt() as Double, ByRef vnOutageOpt() as Long, _
ByRef vnOutageLst() as Long, _
ByVal dFltR#, ByVal dFltX#, ByVal nClearPrev& ) As Long

Purpose: Simulate one or more faults.

Works in: OneLiner only.

Parameters:
nDevHnd [in] handle of a bus or a relay group.
vnFltConn [in] fault connection flags. 1 set; 0 - reset
vnFltConn(1) 3PH
vnFltConn(2) 2LG
vnFltConn(3) 1LG
vnFltConn(4) LL
vdFltOpt [in] fault options flags. 1 set; 0 - reset
vdFltOpt(1) - Close-in
vdFltOpt(2) - Close-in w/ outage
vdFltOpt(3) - Close-in with end opened
vdFltOpt(4) - Close-in with end opened w/ outage
vdFltOpt(5) - Remote bus
vdFltOpt(6) - Remote bus w/ outage
vdFltOpt(7) - Line end
vdFltOpt(8) - Line end w/ outage
vdFltOpt(9) - Intermediate %
vdFltOpt(10) - Intermediate % w/ outage
vdFltOpt(11) - Intermediate % with end opened
vdFltOpt(12) - Intermediate % with end opened w/ outage
vdFltOpt(13) - Auto seq. Intermediate % from
vdFltOpt(14) - Auto seq. Intermediate % to
vnOutageLst [in] list of handles of branches to be outaged; 0 terminated
vnOutageOpt [in] branch outage option flags. 1 set; 0 - reset
vnOutageOpt(1) - one at a time
vnOutageOpt(2) - two at a time
vnOutageOpt(3) - all at once
dFltR [in] fault resistance, in Ohm
dFltX [in] fault reactance, in Ohm
nClearPrev [in] clear previous result flag. 1 set; 0 - reset

Return value:
1 success
0 failure
Remarks: To simulate a single intermediate fault without auto-sequencing, set both vdFltOpt(13)and
vdFltOpt(14) to zero

Example:

' Simulate the faults

If DoFault( nBusHnd, vnFltConn, vdFltOpt, vnOutageOpt, vnOutageLst, dFltR, _
dFltX, nClearPrev ) = 0 Then GoTo HasError

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 27

' Print output
sBusName1 = FullBusName( nBusHnd )
Print #1, "Fault simulation at Bus: ", sBusName1
Print #1, ""
Print #1, " Phase A Phase B Phase C"
Print #1, ""

' Start from the first fault

If PickFault( 1 ) = 0 Then GoTo HasError
Do
If GetSCCurrent( HND_SC, vdVal1, vdVal2, 4 ) = 0 Then GoTo HasError
Print #1, FaultDescription(); Chr(10); _
" "; _
Format( vdVal1(1), "####0.0"); "@"; Format( vdVal2(1), "#0.0"), Space(5), _
Format( vdVal1(2), "####0.0"); "@"; Format( vdVal2(2), "#0.0"), Space(5), _
Format( vdVal1(3), "####0.0"); "@"; Format( vdVal2(3), "#0.0")
Loop While PickFault( SF_NEXT ) > 0
Print "Simulation complete. Report is in " & fileName
Stop
HasError:
Print "Error: ", ErrorString( )
Stop

28 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function DoPF

Function DoPF( ByVal nSlkBusHnd&, ByRef vdPFSettings() as double, _

ByRef vnPFOpt() as double, ByVal nMethod As Long ) As Long

Purpose: Perform a power flow study.

Works in: Power Flow only.

Parameters:
nSlkBusHnd [in] Handle of the system slack bus.
vdPFSettings [in] Power Flow settings
vdPFCriteria(1) Maximum number of iterations
vdPFCriteria(2) MW tolerance
vdPFCriteria(3) MVAR tolerance
vdPFCriteria(4) MW adjustment threshold
vdPFCriteria(5) MVAR adjustment threshold
vnPFOpt [in] Power Flow options 1 set; 0 reset;
vnPFOpt(1) Start from last solution
vnPFOpt(2) Enforce generator VAR limit
vnPFOpt(3) Enforce transformer tap
vnPFOpt(4) Enforce area interchange
vnPFOpt(5) Enable generator remote voltage control
vnPFOpt(6) Enable switched shunt simulation
vnPFOpt(7) Enable phase shifter simulation
vnPFOpt(8) Reset LTC taps
vnPFOpt(9) Enable solution monitor
nMethod [in] Power flow solution method
0 Newton-Raphson
1 Fast decoupled
Return value:
1 success
0 failure
Remarks:
Example:

Dim vnPFOption(10) As Long

Dim vdPFCriteria(5) As Double

' Various PF settings

vdPFCriteria(1) = 20 ' Max iterations
vdPFCriteria(2) = 1 ' MW tolerance
vdPFCriteria(3) = 1 ' MVAR tolerance
vdPFCriteria(4) = 10 ' MW adj. threshold
vdPFCriteria(5) = 10 ' MVAR adj. threshold
' Set PF options
vnPFOption(1) = 1 ' Use previous result
vnPFOption(2) = 0 ' Ignore Gen var limit
vnPFOption(3) = 1 ' Enforce Xfmr tap
vnPFOption(4) = 0 ' Ignore Area interchange
vnPFOption(5) = 0 ' Ignore Gen remove V control
vnPFOption(6) = 0 ' Ignore SVD
vnPFOption(7) = 1 ' Phase shifter
vnPFOption(8) = 0 ' Reset LTC
vnPFOption(9) = 0 ' Disable solution monitor

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 29

 ' PF method
nMethod = 1 ' Newton-Raphson

' Do the power flow

If DoPF( nSlackBus, vdPFCriteria, vnPFOption, nMethod ) = 0 Then GoTo HasError

30 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function EquipmentType

Function EquipmentType( ByVal nHandle& ) As Long

Purpose: Gets object type associated with a given handle.

Works in: OneLiner and Power Flow.

Parameters:
nHandle [in] data object handle

Return value:
>0 equipment type code
0 failure
Remarks: The input requires a valid equipment handle.
Example:

If EquipmentType( nBusHnd ) <> TC_BUS Then

Print "Must select a bus"
Stop
End If

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 31

Function GetBusEquipment
Function GetBusEquipment( ByVal nBusHnd&, ByVal nType&, _
ByRef nHandle& ) As Long

Purpose: Retrieves the handle of the next equipment of a given type that is attached to a bus.

Works in: OneLiner and Power Flow.

Parameters:
nBusHnd [in] Bus handle
nType [in] Equipment type. See remark below.
nHandle [in/out] Equipment handle. Set to zero for the first item. Otherwise, leave it at the value of
the previous item.
Return value:
1 success
-1 already at the end of the list
0 failure
Remarks: Set nHandle to zero to get the first equipment handle. You must get the bus handle prior to calling this
function. The equipment type can be one of the following:
TC_GEN: to get the handle for the generator. There can be at most one at a bus.
TC_LOAD: to get the handle for the load. There can be at most one at a bus.
TC_SHUNT: to get the handle for the shunt. There can be at most one at a bus.
TC_SVD: to get the handle for the switched shunt. There can be at most one at a bus.
TC_GENUNIT: to get the handle for the next generating unit.
TC_LOADUNIT: to get the handle for the next load unit.
TC_SHUNTUNIT: to get the handle for the next shunt unit.
TC_BRANCH: to get the handle for the next branch.

Example:

Put all bus branches in outage list for fault simulation

For ii = 1 To 20 ' max 20 outage
If GetBusEquipment( nBusHnd, TC_BRANCH, nBrHnd ) > 0 Then
vnOutageLst(ii) = nBrHnd
Else
Exit For
End If
Next
vnOutageLst(ii) = 0 ' Must always close the list

32 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function GetData

Function GetData( ByVal deviceHnd&, ByVal paramID&, ByRef outputVal ) as Long

Purpose: Reads a network or system parameter into a program variable.

Works in: OneLiner and Power Flow.

Parameters:
deviceHnd [in] data object handle
paramID [in] parameter ID code
outputVal [out] output variable.

Return value:
1 success
0 failure
Remarks: To read a parameter of a network object, you must first obtain the handle prior to calling this function. To
read a system parameter, you can use the pre-defined handle HND_SYS. Data type of outputVal must
agree with that of the parameter being read. The parameter ID code and data type are available in table
3.3.
Example:

If GetData( HND_SYS, SY_dBaseMVA, dVal1 ) = 0 Then GoTo HasError

Print "BASE MVA = ", Format(dVal1,"##0.0")

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 33

Function GetEquipment

Function GetEquipment( ByVal nType&, ByRef Handle ) As Long

Purpose: Retrieves handle of the next equipment of given type in the system. If nType is set to TC_PICK, this
function will return the handle of the selected equipment on the one-line diagram. If nType is set to the
equipment code for generators, shunts, loads, generating units, shunt units, load units, lines, series
capacitors, transformers, phase shifters, switch and relay groups, this function will return the handle of
all the objects, one by one, in the order they are stored in the OneLiner or Power Flow case.

Works in: OneLiner and Power Flow.

Parameters:
nType [in] equipment type (table 3.2)
nHandle [in/out] equipment handle.

Return value:
1 success
-1 already at the end of the list
0 failure
Remarks: Set nHandle to zero to get the first equipment handle. Set nType to TC_PICK if you want to see which
network element was highlighted on the one-line diagram by the user. (If the user has highlight more
than one piece of equipment, only the handle of the first selection is returned.)
Example:

If GetEquipment( TC_PICKED, nBusHnd ) = 0 Then

Print "Must select a bus"
Stop
End If

34 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function GetFlow
Function GetFlow( ByVal hHandle&, ByRef vdOut1() as double, _
ByRef vdOut2() as double ) As Long

Purpose: Retrieve power flow for a generator, load, shunt, switched shunt, generating unit, load unit, shunt unit,
transmission line, transformer, or phase shifter.

Works in: Power Flow only.

Parameters:
nHandle [in] data object handle
vdOut1 [out] Real power in MW into equipment terminal(s)
vdOut2 [out] Reactive power in MVAR into equipment terminal(s)

Return value:
1 success
0 failure
Remarks: The size of arrays vdOut1 and vdOut2 must be at least equal to the number of buses connected to the
equipment: 1 for generator, load, shunt, switched shunt, generating unit, load unit, shunt unit; 2 for Line,
2-winding transformer, phase shifter; switch, switch, 3 for 3-winding transformer. For equipment that has
more than one connected bus, the flow results are stored in the following order:
- vdOut1(1), vnOut2(1): flow from equipments Bus1
- vdOut1(2), vnOut2(2): flow from equipments Bus2
- vdOut1(3), vnOut2(3): flow from equipments Bus3

Example:

Dim Parray(3) As Double, Qarray(9) As Double

Get end bus names
If GetData( LineHnd, LN_nBus1Hnd, BusHnd ) = 0 Then GoTo HasError
Bus1ID = FullBusName( BusHnd )
If GetData(LineHnd, LN_nBus2Hnd, BusHnd ) = 0 Then GoTo HasError
Bus2ID = FullBusName( BusHnd )
Get current
If GetFlow( LineHnd, Parray, Qarray, 4 ) = 0 Then GoTo HasError
Show them
Print _
"Power on line: "; sVal2$ & "-"; sVal3$ & " ID= "; sVal1$; ": "; Chr(10); _
"P1 = "; Format( Parray(1), "#0.0"); " Q1= "; Format( Qarray(1), "#0.0"); _
"; P2 = "; Format( Parray(2), "#0.0"); " Q2 = "; Format( Qarray(2), "#0.0")

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 35

Function GetPFCurrent
Function GetPFCurrent( ByVal hHandle&, ByRef vdOut1() as double, _
ByRef vdOut2() as double ) As Long

Purpose: Retrieve current for a generator, load, shunt, switched shunt, generating unit, load unit, shunt unit,
transmission line, transformer, switch, or phase shifter.

Works in: Power Flow only.

Parameters:
nHandle [in] data object handle
vdOut1 [out] current result magnitude into equipment terminals
vdOut2 [out] current result angle in degree, into equipment terminals
nStyle [in] current result style
=0: output current in Amperes
=1: output current in per-unit
Return value:
1 success
0 failure
Remarks: The size of arrays vdOut1 and vdOut2 must be at least equal to the number of buses connected to the
equipment: 1 for generator, load, shunt, switched shunt, generating unit, load unit, shunt unit; 2 for Line,
2-winding transformer, phase shifter, switch; 3 for 3-winding transformer. For equipment that has more
than one connected b us, the current results are stored in the following order:
- vdOut1(1), vnOut2(1): current from equipments Bus1
- vdOut1(2), vnOut2(2): current from equipments Bus2
- vdOut1(3), vnOut2(3): current from equipments Bus3

Example:

Dim MagArray(3) As Double, AngArray(3) As Double

Get end bus names
If GetData( LineHnd, LN_nBus1Hnd, BusHnd ) = 0 Then GoTo HasError
Bus1ID = FullBusName( BusHnd )
If GetData(LineHnd, LN_nBus2Hnd, BusHnd ) = 0 Then GoTo HasError
Bus2ID = FullBusName( BusHnd )
Get current
If GetPFCurrent( LineHnd, MagArray, AngArray, 0 ) = 0 Then GoTo HasError
Show them
Print _
"Current on line: "; Bus1ID & "-"; Bus2ID & " ID= "; LineID$; ": "; Chr(10); _
"I1 = "; Format( MagArray(1), "#0.0"); "@"; Format( AngArray(1), "#0.0"); Chr(10)
_
"I2 = "; Format( MagArray(2), "#0.0"); "@"; Format( AngArray(2), "#0.0")

36 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function GetPFVoltage
Function GetPFVoltage( ByVal hHandle&, ByRef vdOut1() as double, _
ByRef vdOut2() as double, ByVal nStyle& ) As Long

Purpose: Retrieve voltage of a bus, or of connected buses of a line, transformer, switch or phase shifter.

Works in: Power Flow only.

Parameters:
nHandle [in] data object handle
vdOut1 [out] voltage magnitude
vdOut2 [out] voltage angle in degree
nStyle [in] result style
=1: output voltage in kV
=2: output voltage in per-unit
Return value:
1 success
0 failure
Remarks: The size of arrays vdOut1 and vdOut2 must be at least equal to the number of buses connected to the
equipment: 1 for Bus; 2 for Line, 2-winding transformer, phase shifter, switch; 3 for 3-winding
transformer. For equipment that is connected to more than one bus, the voltage result is stored in the
following order:
- vdOut1(1), vnOut2(1): Voltage at equipments Bus1
- vdOut1(2), vnOut2(2): Voltage at equipments Bus2
- vdOut1(3), vnOut2(3): Voltage at equipments Bus3

Example:

Dim MagArray(3) As Double, AngArray(3) As Double

Get end bus names
If GetData( LineHnd, LN_nBus1Hnd, BusHnd ) = 0 Then GoTo HasError
Bus1ID = FullBusName( BusHnd )
If GetData(LineHnd, LN_nBus2Hnd, BusHnd ) = 0 Then GoTo HasError
Bus2ID = FullBusName( BusHnd )
Get current
If GetPFVoltage( nDevHnd&, vdVal1, vdVal2, 2 ) = 0 Then GoTo HasError
' Show it
Print "Voltage on line: "; sVal2$ & "-"; sVal3$ & " ID= "; sVal1$; ": "; Chr(10); _
"V1 = "; Format( MagArray(1), "#0.00"); "@"; Format( AngArray(1), "#0.0"); _
"; V2 = "; Format( MagArray(2), "#0.00"); "@"; Format(AngArray 2), "#0.0")

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 37

Function GetPSCVoltage
Function GetPSCVoltage( ByVal hHandle&, ByRef vdOut1() as double, _
ByRef vdOut2() as double, ByVal nStyle& ) As Long

Purpose: Retrieve pre-fault voltage of a bus, or of connected buses of a line, transformer, switch or phase shifter.

Works in: OneLiner only.

Parameters:
nHandle [in] data object handle
vdOut1 [out] voltage magnitude
vdOut2 [out] voltage angle in degree
nStyle [in] result style
=1: output voltage in kV
=2: output voltage in per-unit
Return value:
1 success
0 failure
Remarks: The size of arrays vdOut1 and vdOut2 must be at least equal to the number of buses connected to the
equipment: 1 for Bus; 2 for Line, 2-winding transformer, phase shifter, switch; 3 for 3-winding
transformer. For equipment that is connected to more than one bus, the voltage result is stored in the
following order:
- vdOut1(1), vnOut2(1): Voltage at equipments Bus1
- vdOut1(2), vnOut2(2): Voltage at equipments Bus2
- vdOut1(3), vnOut2(3): Voltage at equipments Bus3

Example:

Dim MagArray(3) As Double, AngArray(3) As Double

Get end bus names
If GetData( LineHnd, LN_nBus1Hnd, BusHnd ) = 0 Then GoTo HasError
Bus1ID = FullBusName( BusHnd )
If GetData(LineHnd, LN_nBus2Hnd, BusHnd ) = 0 Then GoTo HasError
Bus2ID = FullBusName( BusHnd )
' Show the fault
If PickFault( 1 ) Then GoTo HasError
Get pre-fault
If GetPSCVoltage( nDevHnd&, vdVal1, vdVal2, 2 ) = 0 Then GoTo HasError
' Show it
Print "Pre-fault voltage on line: "; sVal2$ & "-"; sVal3$ & " ID= "; sVal1$; ": ";
Chr(10); _
"V1 = "; Format( MagArray(1), "#0.00"); "@"; Format( AngArray(1), "#0.0"); _
"; V2 = "; Format( MagArray(2), "#0.00"); "@"; Format(AngArray 2), "#0.0")

38 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function GetRelay

Function GetRelay( ByVal nRlyGrp&, ByRef nRlyHandle& ) As Long

Purpose: Get handle of the next relay or fuse in a relay group.

Works in: OneLiner only.

Parameters:
nRlyGrp [in] relay group handle.
nRlyHandle [int/out] relay handle.
Return value:
1 success
-1 already at last relay
0 failure
Remarks: Set nRlyHandle to zero to get the handle to the first relay in the database.
Example:

' Pick the first fault

If PickFault( 1 ) Then GoTo HasError

' Loop through all relays in the database and find their operating times
nRelayCount& = 0
nRelayHnd& = 0
While GetRelay( nPickedHnd, nRelayHnd& ) > 0
nRelayCount = nRelayCount + 1
nType = EquipmentType( nRelayHnd )
If nType = TC_RLYOCG Then nParamID& = OG_sID
If nType = TC_RLYOCP Then nParamID& = OP_sID
If nType = TC_RLYDSG Then nParamID& = DG_sID
If nType = TC_RLYDSP Then nParamID& = DP_sID
If nType = TC_FUSE Then nParamID& = FS_sID
If GetData( nRelayHnd, nParamID, sID$ ) = 0 Then GoTo HasError
If GetRelayTime( nRelayHnd, 1.0, dTime# ) = 0 Then GoTo HasError
Print "Relay " & sID & ": "; Format( dTime, "#0.#0s" )
Wend
Print "Relays in this group = "; nRelayCount
Stop
' Error handling
HasError:
Print "Error: ", ErrorString( )
Stop

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 39

Function GetRelayTime

Function GetRelayTime( ByVal nHandle&, ByVal dFactor#, ByRef dTime$ ) As Long

Purpose: Computes operating time for a fuse, an overcurrent relay (phase or ground), or a distance relay (phase or
ground).

Works in: OneLiner only.

Parameters:
nHandle [in] relay handle
dFactor [in] relay current multiplying factor
dTime [out] relay operating time in seconds

Return value:
1 success
0 failure
Remarks: All calls to this function must be preceded by a call to ShowFault or PickFault function.

Relay current multiplying factor will be applied to relay current result from simulation before time
calculation.
Example:

' Show the fault

If ShowFault( 1, 3, 7, 0, vnShowRelay ) = 0 Then GoTo HasError

' Loop through all relays and find their operating times
nRelayCount& = 0
nRelayHnd& = 0
While GetRelay( nPickedHnd, nRelayHnd& ) > 0
nRelayCount = nRelayCount + 1
nType = EquipmentType( nRelayHnd )
If nType = TC_RLYOCG Then nParamID& = OG_sID
If nType = TC_RLYOCP Then nParamID& = OP_sID
If nType = TC_RLYDSG Then nParamID& = DG_sID
If nType = TC_RLYDSP Then nParamID& = DP_sID
If nType = TC_FUSE Then nParamID& = FS_sID
If GetData( nRelayHnd, nParamID, sID$ ) = 0 Then GoTo HasError
If GetRelayTime( nRelayHnd, 1.0, dTime# ) = 0 Then GoTo HasError
Print "Relay " & sID & ": "; Format( dTime, "#0.#0s" )
Wend
Print "Relays in this group = "; nRelayCount
Stop
' Error handling
HasError:
Print "Error: ", ErrorString( )
Stop

40 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function GetSCCurrent
Function GetSCCurrent( ByVal hHandle&, ByRef vdOut1() as double, _
ByRef vdOut2() as double, ByVal nStyle& ) As Long

Purpose: Retrieve post fault current for a generator, load, shunt, switched shunt, generating unit, load unit, shunt
unit, transmission line, transformer, switch or phase shifter. You can get the total fault current by calling
this function with the pre-defined handle of short circuit solution, HND_SC.

Works in: OneLiner only.

Parameters:
nHandle [in] data object handle
vdOut1 [out] current result, real part or magnitude, into equipment terminals
vdOut2 [out] current result, imaginary part or angle in degree, into equipment terminals
nStyle [in] current result style
=1: output 012 sequence current in rectangular form
=2: output 012 sequence current in polar form
=3: output ABC phase current in rectangular form
=4: output ABC phase current in polar form
Return value:
1 success
0 failure
Remarks: Size of arrays vdOut1 and vdOut2 must be sufficient to store all current results according to the
following table:
Output Arrays Generator, load, shunt Line, transformer, phase shifter
vdOut1(1) vdOut2(1) Current Phase A, B, C or Current Phase: A, B, C or
vdOut1(2) vdOut2(2) Sequence: zero, pos., neg Seq.: 0, +, - from Bus 1
vdOut1(3) vdOut2(3)

vdOut1(4) vdOut2(4) Not used Transformer only: Neutral

current of winding on Bus 1

vdOut1(5) vdOut2(5) Not used Current Phase: A, B, C or

vdOut1(6) vdOut2(6) Seq.: 0, +, - from Bus 2
vdOut1(7) vdOut2(7)

vdOut1(8) vdOut2(8) Not used Transformer only: Neutral

current of winding on Bus 2

vdOut1(9) vdOut2(5) Not used 3-W Transformer only: Current

vdOut1(10) vdOut2(10) Phase: A, B, C or Seq. 0, +, -
vdOut1(11) vdOut2(11) from Bus 3

vdOut1(12) vdOut2(12) Not used 3-W Transformer only: Delta

circulating current on Bus 3

Example:

Dim MagArray(12) As Double, AngArray(12) As Double

Get end bus names
If GetData( LineHnd, LN_nBus1Hnd, BusHnd ) = 0 Then GoTo HasError

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 41

 Bus1ID = FullBusName( BusHnd )
If GetData(LineHnd, LN_nBus2Hnd, BusHnd ) = 0 Then GoTo HasError
Bus2ID = FullBusName( BusHnd )
Must always show fault before retrieving result
If ShowFault( 1, 0, -999, 0, vnShowRelay ) = 0 Then GoTo HasError
Get post fault current
If GetSCCurrent( LineHnd, MagArray, AngArray2, 4 ) = 0 Then GoTo HasError
Show them
Print _
"Current on line: "; Bus1ID & "-"; Bus2ID & " ID= "; LineID$; ": "; Chr(10); _
"I1a = "; Format( MagArray(1), "#0.0"); "@"; Format( AngArray(1), "#0.0"); _
"; I1b = "; Format( MagArray(2), "#0.0"); "@"; Format( AngArray(2), "#0.0"); _
"; I1c = "; Format( MagArray(3), "#0.0"); "@"; Format( AngArray(3), "#0.0"); _
"; I1g = "; Format( MagArray(4), "#0.0"); "@"; Format( AngArray(4), "#0.0");
Chr(10); _
"I2a = "; Format( MagArray(5), "#0.0"); "@"; Format( AngArray(5), "#0.0"); _
"; I2b = "; Format( MagArray(6), "#0.0"); "@"; Format( AngArray(6), "#0.0"); _
"; I2c = "; Format( MagArray(7), "#0.0"); "@"; Format( AngArray(7), "#0.0"); _
"; I2g = "; Format( MagArray(8), "#0.0"); "@"; Format( AngArray(8), "#0.0")

42 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function GetSCVoltage

Function GetSCVoltage( ByVal nHandle&, ByRef vdOut1() as double, _

ByRef vdOut2() as double, ByVal nStyle& ) As Long

Purpose: Retrieves post-fault voltage of a bus, or of connected buses of a line, transformer, switch or phase
shifter.

Works in: OneLiner only.

Parameters:
nHandle [in] data object handle
vdOut1 [out] voltage result, real part or magnitude, at equipment terminals
vdOut2 [out] voltage result, imaginary part or angle in degree, at equipment terminals
nStyle [in] voltage result style
=1: output 012 sequence voltage in rectangular form
=2: output 012 sequence voltage in polar form
=2: output ABC phase voltage in rectangular form
=4: output ABC phase voltage in polar form
Return value:
1 success
0 failure
Remarks: The size of arrays vdOut1 and vdOut2 must be at least equal to 3 times the number of buses connected
to the equipment: 1 for a Bus; 2 for a Line, 2-winding transformer, phase shifter, switch; 3 for a 3-winding
transformer. For equipment that is connected to more than one bus, voltage result is stored in the arrays
in group of 3 phases ABC (or 3 sequences Zero, Positive, Negative) in the following order:
- vdOut1(13), vnOut2(13): Voltage at equipments Bus1
- vdOut1(46), vnOut2(46): Voltage at equipments Bus2
- vdOut1(79), vnOut2(79): Voltage at equipments Bus3

Example:

If GetEquipment( TC_PICKED, nDevHnd ) = 0 Then

Print "Must select a line"
Stop
End If
If EquipmentType( nDevHnd ) <> TC_LINE Then
Print "Must select a line"
Stop
End If
' Get lines end buses
If GetData( nDevHnd&, LN_sID, sVal1$ ) = 0 Then GoTo HasError
If GetData( nDevHnd&, LN_nBus1Hnd, nBusHnd& ) = 0 Then GoTo HasError
sVal2$ = FullBusName( nBusHnd& )
If GetData( nDevHnd&, LN_nBus2Hnd, nBusHnd& ) = 0 Then GoTo HasError
sVal3$ = FullBusName( nBusHnd& )
' Show the fault
If PickFault( 1 ) Then GoTo HasError
'Get voltagge at the end bus
If GetSCVoltage( nDevHnd&, vdVal1, vdVal2, 4 ) = 0 Then GoTo HasError
' Show it
Print "Voltage on line: "; sVal2$ & "-"; sVal3$ & " ID= "; sVal1$; ": "; Chr(10); _
"V1a = "; Format( vdVal1(1), "#0.0"); "@"; Format( vdVal2(1), "#0.0"); _
"; V1b = "; Format( vdVal1(2), "#0.0"); "@"; Format( vdVal2(2), "#0.0"); _

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 43

 "; V1c = "; Format( vdVal1(3), "#0.0"); "@"; Format( vdVal2(3), "#0.0");
Chr(10); _
"V2a = "; Format( vdVal1(4), "#0.0"); "@"; Format( vdVal2(4), "#0.0"); _
"; V2b = "; Format( vdVal1(5), "#0.0"); "@"; Format( vdVal2(5), "#0.0"); _
"; V2c = "; Format( vdVal1(6), "#0.0"); "@"; Format( vdVal2(6), "#0.0")

44 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function ErrorString

Function ErrorString( ) As String

Purpose: Retrieves the description of the last error. The result is a string.

Works in: OneLiner and Power Flow.

Parameters: none.
Return value:
1 success
0 failure
Remarks:
Example:

HasError:
Print "Error: ", ErrorString( )
Stop

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 45

Function FaultSelector

Function FaultSelector( ByRef vnFltIndex() as Long, _

ByVal sTitle$, ByVal sPrompt$ ) As Long

Purpose: Display fault selection dialog.

Works in: OneLiner only.

Parameters:
sTitle [in] Dialog title.
sPrompt [in] Dialog prompt.
vnFltIndex [out] List of fault index numbers that the user selected
Return value:
Number of fault indices selected.
Remarks:
Array vnFltIndex dimension must be adequate to store user selection.
Example:

nCount = FaultSelector( nFltIdx, "My Fault Selector", "Please Select One Fault" )

46 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function FindBusByName

Function FindBusByName( ByVal sName$, ByVal dNomKV#, ByRef nHandle& ) As Long

Purpose: Searches for the bus that has a certain name and nominal kV.

Works in: OneLiner and Power Flow.

Parameters:
sName [in] bus name
dNomKV [in] bus nominal kV
nHandle [out] bus handle
Return value:
1 success
0 failure
Remarks:
Example:

If 0 = FindBusByName( "Reusens", 132, hDev ) Then GoTo HasError

Print "Bus handle found: ", hDev

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 47

Function FullBusName

Function FullBusName( ByVal nBusHnd& ) As String

Purpose: Return a string composed of name and kV of the given bus.

Works in: OneLiner and Power Flow.

Parameters:
nBusHnd [in] bus handle
Return value:
Full bus name if success.
Empty string otherwise.
Remarks:
Example:

' Print bus info

If GetData( nBusHnd&, BUS_sName, sVal1$ ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_dKVnorminal, dVal1# ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nNumber, nVal1& ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nArea, nVal2& ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nZone, nVal3& ) = 0 Then GoTo HasError
Print "BUS "; FullBusName( nBusHnd& );" AREA=";nVal2&;" ZONE="; nVal3&

48 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function NextBusByName
Function NextBusByName( ByRef nBusHandle& ) As Long

Purpose: Get handle of next bus in a bus list which has been sorted by bus name and nominal kV.

Works in: OneLiner and Power Flow.

Parameters:
nBusHandle [in/out] bus handle
Return value:
1 success
-1 already at last bus
0 failure
Remarks: To get the first bus in the list, call this function with nBusHandle = 0
Example:

Print bus list shorted by name and kV

nBusHnd& = 0
While NextBusByName( nBusHnd& ) > 0
' Print bus info
If GetData( nBusHnd&, BUS_sName, sVal1$ ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_dKVnorminal, dVal1# ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nNumber, nVal1& ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nArea, nVal2& ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nZone, nVal3& ) = 0 Then GoTo HasError
Print #1, "BUS "; FullBusName( nBusHnd& );" AREA=";nVal2&;" ZONE="; nVal3&
Wend

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 49

Function NextBusByNumber

Function NextBusByNumber( ByRef hHandle ) As Long

Purpose: Gets the handle of next bus in a bus list which has been sorted by bus number.

Works in: OneLiner and Power Flow.

Parameters:
nBusHandle [in/out] bus handle
Return value:
1 success
-1 already at last bus
0 failure
Remarks: To get the first bus in the list, call this function with nBusHandle = 0
Example:

Print bus list shorted by bus number

nBusHnd& = 0
While NextBusByNumber ( nBusHnd& ) > 0
' Print bus info
If GetData( nBusHnd&, BUS_sName, sVal1$ ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_dKVnorminal, dVal1# ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nNumber, nVal1& ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nArea, nVal2& ) = 0 Then GoTo HasError
If GetData( nBusHnd&, BUS_nZone, nVal3& ) = 0 Then GoTo HasError
Print #1, "BUS "; FullBusName( nBusHnd& );" AREA=";nVal2&;" ZONE="; nVal3&
Wend

50 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function PickFault

Function PickFault( ByVal nFltIndex& ) As Long

Purpose: Move output pointer to a specific short circuit simulation case. PickFault() is a simplified version of
ShowFault(). Use ShowFault() instead if you wish to control precisely what will be shown on the one-line
diagram.

Works in: OneLiner only.

Parameters:
nFltIndex [in] fault number or
SF_NEXT : next fault
SF_PREV : previous fault
SF_LAST : last available fault

Return value:
1 success
0 failure
Remarks: This function must be called before any post fault voltage and current result can be retrieved. All
subsequent calls to GetSCVoltage and GetSCCurrent functions will return result from the picked short
circuit simulation.
Example:

' Must always pick a fault before getting V and I results

If PickFault( 1 ) = 0 Then GoTo HasError
Do
If GetSCCurrent( HND_SC, vdVal1, vdVal2, 4 ) = 0 Then GoTo HasError
Print #1, FaultDescription(); Chr(10); _
" "; _
Format( vdVal1(1), "####0.0"); "@"; Format( vdVal2(1), "#0.0"), Space(5), _
Format( vdVal1(2), "####0.0"); "@"; Format( vdVal2(2), "#0.0"), Space(5), _
Format( vdVal1(3), "####0.0"); "@"; Format( vdVal2(3), "#0.0")
Loop While ShowFault( SF_NEXT, 0, -999, 0, vnShowRelay ) > 0

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 51

Function PostData

Function PostData( ByVal deviceHnd& ) As Long

Purpose: Perform data validation and update data for the given equipment in the network database.

Works in: OneLiner and Power Flow.

Parameters:
deviceHnd [in] data object handle
Return value:
1 success
0 failure
Remarks: Changes to the equipment data made through SetData function will not be committed to the program
network database until after this function has been executed with success.
Example:

If SetData( nSCapHnd, SC_dX, dXc ) = 0 Then GoTo HasError

If SetData( nSCapHnd, SC_dX0, dXc ) = 0 Then GoTo HasError
If SetData( nSCapHnd, SC_dR, dRc ) = 0 Then GoTo HasError
If SetData( nSCapHnd, SC_dR0, dRc ) = 0 Then GoTo HasError
If PostData( nSCapHnd ) = 0 Then GoTo HasError 'Save the whole thing

52 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function PrintTTY

Function PrintTTY ( ByVal stringVal& ) As Long

Purpose: Output string to the TTY window of OneLiner or Power Flow.

Works in: OneLiner and Power Flow.

Parameters:
stringVal [in] String to be displayed.

Return value:
1 success
0 failure
Remarks:
Example:

stringVal$ = ANSI X/R = & AnsiXR

If PrintTTY(stringVal ) = 0 Then GoTo HasError

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 53

Function ReadChangeFile

Function ReadChangeFile( ByRef sFileName$, ByVal nFlag& ) As Long

Purpose: Read a change file.

Works in: OneLiner and Power Flow.

Parameters:
sFileName [in] Path name of the change file.
nFlag [in] Silent mode: 1- true; 0- false.

Return value:
1 success
0 failure
Remarks: Set nFlag to True to accept all changes in the change file without having to confirm each one separately.
Example:

If ReadChangeFile( changea_b.chf, 1 ) = 0 Then GoTo HasError

54 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

Function SetData

Function SetData( ByVal deviceHnd&, ByVal paramID&, ByVal newValue ) as Long

Purpose: Reads the value of a network datum into a program variable.

Works in: OneLiner and Power Flow.

Parameters:
deviceHnd [in] data object handle
paramID [in] parameter ID code (must be labeled with write attribute in table 3.3)
newValue [in] new value.

Return value:
1 success
0 failure
Remarks: Data type of variable newValue must agree with that of the parameter being updated. See Table 3.3 for
a full listing of equipment parameters and their type.
Example:

If SetData( nSCapHnd, SC_dX, dXc ) = 0 Then GoTo HasError

If SetData( nSCapHnd, SC_dX0, dXc ) = 0 Then GoTo HasError
If SetData( nSCapHnd, SC_dR, dRc ) = 0 Then GoTo HasError
If SetData( nSCapHnd, SC_dR0, dRc ) = 0 Then GoTo HasError
If PostData( nSCapHnd ) = 0 Then GoTo HasError 'Save modified data to network database

ASPEN PowerScript V10 SECTION 4 FUNCTION REFERENCE 55

Function ShowFault

Function ShowFault( ByVal nFltIndex&, ByVal nTiers&, ByVal nShowType&, _

ByVal nPerUnit&, ByRef vnShowRelay() as Long ) As Long

Purpose: Show result of a fault simulation case on one-line diagram.

Works in: OneLiner only.

Parameters:
nFltIndex [in] fault number to show or:
SF_FIRST : first fault
SF_NEXT : next fault
SF_PREV : previous fault
SF_LAST : last fault
nTiers [in] number of tiers away from the fault bus
nShowType [in] output type
= 1: zero sequence result
= 2: positive sequence result
= 3: negative sequence result
= 4: phase A result
= 5: phase B result
= 6: phase C result
= 7: relay operating time result
nPerUnit [in] per unit flag; 1 set; 0 - reset
vnShowRelay [in] show relay flag; 1 set; 0 - reset
vnShowRelay(1) - Overcurrent ground relays
vnShowRelay(2) - Overcurrent phase relays
vnShowRelay(3) - Distance ground relays
vnShowRelay(4) - Distance phase relays

Return value:
1 success
0 failure
Remarks:
Example:

Dim vnShowRelay(4)
If ShowFault( 1, 0, 4, 0, vnShowRelay ) = 0 Then GoTo HasError
Do
If GetSCCurrent( HND_SC, vdVal1, vdVal2, 4 ) = 0 Then GoTo HasError
Print #1, FaultDescription(); Chr(10); _
" "; _
Format( vdVal1(1), "####0.0"); "@"; Format( vdVal2(1), "#0.0"), Space(5), _
Format( vdVal1(2), "####0.0"); "@"; Format( vdVal2(2), "#0.0"), Space(5), _
Format( vdVal1(3), "####0.0"); "@"; Format( vdVal2(3), "#0.0")
Loop While ShowFault( SF_NEXT, 0, -999, 0, vnShowRelay ) > 0

56 SECTION 4 FUNCTION REFERENCE ASPEN PowerScript V10

 G
GetBusEquipment 16, 32
GetCurrent 22
GetData 16, 33
Index GetEquipment 16, 34
GetFlow 35
GetPFCurrent 36
GetPFVoltage 37
GetRelay 16, 39
GetRelayTime 22, 40
GetSCCurrent 41
GetSCVoltage 43
GetVoltage 22

B
H
BASIC Language Reference 4
Handles 15
Break Point 8
Pre-defined 15
BusPicker 26

C L
Language Reference 4
Change file See ReadChangeFile

D M
Macros 3
Data
access 16
modification 16 N
Debugging 7
NextBusByName 49
Dialog Box Editor 9
NextBusByNumber 50
DoFault 22, 27
DoPF 23, 29
O
E Object Handles See Handles
Equipment Type Code 16
EquipmentType 31 P
ErrorString 45 Parameter Code 16
Example PickFault 22, 51
Fault location 3 PostData 22, 52
Per-Unit Calculator 5 Power Flow Solution 23
Power flow outage studies 3 PrintTTY 53
Power transfer studies 3 PutData 22

F R
FaulSelector 46 ReadChangeFile 54
FindBusByName 47 Reserved keywords 23
FullBusName 48 Running Script as Program Command 13
Functions list 25

S
Script File

ASPEN PowerScript V10 Index 57

 debugging 7
editing 5
insert break point 8
SetData 55
Short Circuit Solution 22
ShowFault 22, 56
Subroutines list 25

T
Tutorial 5
Type Code See Equipment Type Code

58 Index ASPEN PowerScript V10