PythonReference en

PowerFactory 2021
Python Function Reference

F2021
POWER SYSTEM SOLUTIONS

MADE IN GERMANY
Publisher:
DIgSILENT GmbH
Heinrich-Hertz-Straße 9
72810 Gomaringen / Germany
Tel.: +49 (0) 7072-9168-0
Fax: +49 (0) 7072-9168-88
info@digsilent.de
Please visit our homepage at:

https://www.digsilent.de
Copyright © 2021 DIgSILENT GmbH

All rights reserved. No part of this
publication may be reproduced or
distributed in any form without written
permission of DIgSILENT GmbH.
February 3, 2021
Revision 4
CONTENTS CONTENTS
Contents
1 General Description 1
2 PowerFactory Module 2
3 Application Methods 4
3.1 File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
3.2 Date/Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.3 Dialogue Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
3.4 Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.5 Mathematics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.6 Output Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4 Output Window 46
5 Object Methods 48
5.1 General Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
5.2 Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
5.2.1 ElmArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
5.2.2 ElmAsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
5.2.3 ElmAsmsc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
5.2.4 ElmBbone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5.2.5 ElmBmu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
5.2.6 ElmBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
5.2.7 ElmBranch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
5.2.8 ElmCabsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
5.2.9 ElmComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
5.2.10 ElmCoup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
5.2.11 ElmDsl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
5.2.12 ElmFeeder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
5.2.13 ElmFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
5.2.14 ElmFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
5.2.15 ElmGenstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
2
CONTENTS CONTENTS
5.2.16 ElmGndswt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
5.2.17 ElmLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
5.2.18 ElmLnesec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
5.2.19 ElmNec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
5.2.20 ElmNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
5.2.21 ElmPvsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
5.2.22 ElmRelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.2.23 ElmRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
5.2.24 ElmShnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
5.2.25 ElmStactrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
5.2.26 ElmSubstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
5.2.27 ElmSvs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
5.2.28 ElmSym . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
5.2.29 ElmTerm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
5.2.30 ElmTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
5.2.31 ElmTr3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
5.2.32 ElmTr4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
5.2.33 ElmTrfstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
5.2.34 ElmVac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
5.2.35 ElmVoltreg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
5.2.36 ElmXnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
5.2.37 ElmZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
5.3 Station Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
5.3.1 StaCt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
5.3.2 StaCubic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
5.3.3 StaExtbrkmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
5.3.4 StaExtcmdmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
5.3.5 StaExtdatmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
5.3.6 StaExtfmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
5.3.7 StaExtfuelmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
5.3.8 StaExtimea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
5.3.9 StaExtpfmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
5.3.10 StaExtpmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
5.3.11 StaExtqmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
5.3.12 StaExtsmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
5.3.13 StaExttapmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
5.3.14 StaExtv3mea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
5.3.15 StaExtvmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
5.3.16 StaSwitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
5.4 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
3
CONTENTS CONTENTS
5.4.1 ComAddlabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

5.4.2 ComAddon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
5.4.3 ComAmpacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
5.4.4 ComAuditlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
5.4.5 ComBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
5.4.6 ComCapo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
5.4.7 ComCimdbexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
5.4.8 ComCimdbimp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
5.4.9 ComCimvalidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
5.4.10 ComConreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
5.4.11 ComContingency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
5.4.12 ComCoordreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
5.4.13 ComDllmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.4.14 ComDpl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.4.15 ComFlickermeter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
5.4.16 ComGenrelinc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
5.4.17 ComGridtocim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
5.4.18 ComHostcap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
5.4.19 ComImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
5.4.20 ComInc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
5.4.21 ComLdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
5.4.22 ComLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
5.4.23 ComMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5.4.24 ComMot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
5.4.25 ComNmink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
5.4.26 ComOmr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
5.4.27 ComOpc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
5.4.28 ComOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
5.4.29 ComPfdimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
5.4.30 ComPrjconnector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
5.4.31 ComProtgraphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
5.4.32 ComPvcurves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
5.4.33 ComPython . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
5.4.34 ComRed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
5.4.35 ComRel3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
5.4.36 ComRelpost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
5.4.37 ComRelreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
5.4.38 ComRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
5.4.39 ComShc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
5.4.40 ComShctrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
4
CONTENTS CONTENTS
5.4.41 ComSim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

5.4.42 ComSimoutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
5.4.43 ComSvgexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
5.4.44 ComSvgimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
5.4.45 ComTasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
5.4.46 ComTececo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
5.4.47 ComTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
5.4.48 ComUcte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
5.4.49 ComUcteexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
5.4.50 ComWktimp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
5.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
5.5.1 SetCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
5.5.2 SetColscheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
5.5.3 SetDataext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
5.5.4 SetDeskpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
5.5.5 SetDesktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
5.5.6 SetDistrstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.5.7 SetFilt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.5.8 SetLevelvis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.5.9 SetParalman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.5.10 SetPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
5.5.11 SetSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
5.5.12 SetTboxconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
5.5.13 SetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
5.5.14 SetUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
5.5.15 SetVipage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
5.6 Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
5.6.1 BlkDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
5.6.2 BlkSig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
5.6.3 ChaVecfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
5.6.4 CimModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
5.6.5 CimObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
5.6.6 GrpPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
5.6.7 IntAddonvars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
5.6.8 IntCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
5.6.9 IntComtrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
5.6.10 IntComtradeset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
5.6.11 IntDataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
5.6.12 IntDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
5.6.13 IntDplmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
5
CONTENTS CONTENTS
5.6.14 IntDplvec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

5.6.15 IntEvt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
5.6.16 IntExtaccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
5.6.17 IntGate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
5.6.18 IntGrf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
5.6.19 IntGrfgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
5.6.20 IntGrflayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
5.6.21 IntGrfnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
5.6.22 IntIcon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
5.6.23 IntLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
5.6.24 IntMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
5.6.25 IntMon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
5.6.26 IntOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
5.6.27 IntPlannedout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
5.6.28 IntPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
5.6.29 IntPrj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
5.6.30 IntPrjfolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
5.6.31 IntQlim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
5.6.32 IntRas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
5.6.33 IntRunarrange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
5.6.34 IntScenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
5.6.35 IntScensched . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
5.6.36 IntScheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
5.6.37 IntSscheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
5.6.38 IntSstage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
5.6.39 IntSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
5.6.40 IntThrating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
5.6.41 IntUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
5.6.42 IntUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
5.6.43 IntUserman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
5.6.44 IntVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
5.6.45 IntVecobj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
5.6.46 IntVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
5.6.47 IntViewbookmark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
5.6.48 PltDataseries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
5.6.49 PltLinebarplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
5.6.50 RelZpol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
5.6.51 ScnFreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
5.6.52 ScnFrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
5.6.53 ScnSpeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
6
CONTENTS CONTENTS
5.6.54 ScnSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

5.6.55 ScnVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
5.6.56 ScnVolt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
5.6.57 StoMaint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
5.6.58 TypAsmo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
5.6.59 TypCtcore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
5.6.60 TypLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
5.6.61 TypQdsl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
5.6.62 TypTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
5.6.63 VisBdia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
5.6.64 VisDraw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
5.6.65 VisHrm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
5.6.66 VisMagndiffplt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
5.6.67 VisOcplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
5.6.68 VisPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
5.6.69 VisPcompdiffplt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
5.6.70 VisPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
5.6.71 VisPlot2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
5.6.72 VisPlottz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
5.6.73 VisVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
5.6.74 VisVecres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
5.6.75 VisXyplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Index 509
7
CHAPTER 1. GENERAL DESCRIPTION
1 General Description
This reference manual describes the syntax of all available functions and methods provided
by the PowerFactory module. The used Python interface version is 2 (new in PowerFactory
2016). For syntax of the Python interface version 1 (PowerFactory 15.x) please use the DPL
reference with the extended return values.
Please refer to the PowerFactory User Manual for general information about Python as script-
ing language and its usage.
1
CHAPTER 2. POWERFACTORY MODULE
2 PowerFactory Module
Overview
version
GetApplication
GetApplicationExt
version
Holds the version of PowerFactory e.g. ”17.0.9” for PowerFactory 2017 SP7.
powerfactory.__version__
GetApplication
Creates a powerfactory.Application object and returns it. When the Python script is started from
external PowerFactory will be started. Please hold the created application object as long as
you use PowerFactory from Python and do not call this function twice.
Application powerfactory.GetApplication([str username = None,]
[str password = None,]
[str commandLineArguments = None])
A RGUMENTS
username (optional)
Name of the user to log in to PowerFactory (default None). None enforces the
default behaviour as if PowerFactory was started via shortcut.
password (optional)
The password for the user which should be logged in (default None). None omits
the password.
commandLineArguments (optional)
Additional command line options (default None). These need to be specified in
the same way as if PowerFactory was started via a command shell. None omits
the command line arguments.
R ETURNS
Application object on success, otherwise None.
S EE ALSO
GetApplicationExt()
2
CHAPTER 2. POWERFACTORY MODULE
GetApplicationExt
Same as powerfactory.GetApplication() but throwing an exception with an error code when
PowerFactory was not able to start. Furthermore if PowerFactory exits due to an error, power-
factory.ExitError can be caught in an Python script for doing clean-up. A detailed description of
all error codes can be found in the Error Codes documentation.
When PowerFactory was started by a Python script from external and the application object
is deleted then PowerFactory is terminated but the current process keeps running. In this
situation it is not possible to start PowerFactory again in the same process.
Application powerfactory.GetApplicationExt([str username = None,]
[str password = None,]
[str commandLineArguments = None])
R ETURNS
Application object on success. In the error case an exception with a detailed error code is
thrown.
E XAMPLE
The following example starts PowerFactory from external and handles initialisation errors:
import sys;
sys.path.append(r"C:\Program Files\DIgSILENT\PowerFactory 2017\python\3.6")
import powerfactory
try:
app = powerfactory.GetApplicationExt()
# ... some calculations ...
except powerfactory.ExitError as error:
print(error)
print('error.code = %d' % error.code)
S EE ALSO
GetApplication()
3
CHAPTER 3. APPLICATION METHODS
3 Application Methods
Overview
ActivateProject
ClearRecycleBin
CommitTransaction
CreateFaultCase
CreateProject
DefineTransferAttributes
DeleteUntouchedObjects
ExecuteCmd
GetActiveCalculationStr
GetActiveNetworkVariations
GetActiveProject
GetActiveScenario
GetActiveScenarioScheduler
GetActiveStages
GetActiveStudyCase
GetAllUsers
GetAttributeDescription
GetAttributeUnit
GetBorderCubicles
GetBrowserSelection
GetCalcRelevantObjects
GetClassDescription
GetClassId
GetCurrentDiagram
GetCurrentScript
GetCurrentSelection
GetCurrentUser
GetCurrentZoomScaleLevel
GetDataFolder
GetDiagramSelection
GetFlowOrientation
GetFromStudyCase
GetGlobalLibrary
GetGraphicsBoard
GetInterfaceVersion
GetLanguage
GetLocalLibrary
GetMem
GetProjectFolder
GetRecordingStage
GetSettings
GetSummaryGrid
4
GetUserManager
Hide
ImportDz
ImportSnapshot
IsAttributeModeInternal
IsLdfValid
IsRmsValid
IsScenarioAttribute
IsShcValid
IsSimValid
IsWriteCacheEnabled
LoadProfile
MarkInGraphics
OutputFlexibleData
PostCommand
PrepForUntouchedDelete
Rebuild
ReloadProfile
ResetCalculation
ResGetData
ResGetDescription
ResGetFirstValidObject
ResGetFirstValidObjectVariable
ResGetFirstValidVariable
ResGetIndex
ResGetMax
ResGetMin
ResGetNextValidObject
ResGetNextValidObjectVariable
ResGetNextValidVariable
ResGetObject
ResGetUnit
ResGetValueCount
ResGetVariable
ResGetVariableCount
ResLoadData
ResReleaseData
ResSortToVariable
SaveAsScenario
SearchObjectByForeignKey
SelectToolbox
SetAttributeModeInternal
SetInterfaceVersion
SetShowAllUsers
SetWriteCacheEnabled
Show
SplitLine
StatFileGetXrange
StatFileResetXrange
StatFileSetXrange
WriteChangesToDb
ActivateProject
Activates a project with its name.
int Application.ActivateProject(str name)
5
A RGUMENTS
name Name (”Project”), full qualified name (”Project.IntPrj”) or full qualified path (”\User\Project.IntPrj”)
of a project.
R ETURNS
0 on success and 1 if project can not be found or activated.
ClearRecycleBin
Clears the recylce bin of currently logged in user.
None Application.ClearRecycleBin()
CommitTransaction
Writes pending changes to database.
While a script is running none of the changes are written to the database unless the script
terminates. PowerFactory can be forced to write all pending changes to the database using
this function.
None Application.CommitTransaction()
CreateFaultCase
Create fault cases from the given elements.
int Application.CreateFaultCase(set elms,
int mode,
[int createEvt],
[DataObject folder]
)
A RGUMENTS
elms Selected elements to create fault cases.
mode How the fault cases are created:
0 Single fault case containing all elements.

1 n-1 (multiple cases).
3 Collecting coupling elements and create fault cases for line couplings.
createEvt (optional)
Switch event:
0 Do NOT create switch events.
1 Create switch events.
folder (optional)
Folder in which the fault case is stored.
6
R ETURNS
0 On success.
1 On error.
CreateProject
Creates a new Project inside the parent object. The default project stored in the Configura-
tion/Default folder will be copied and if it contains any Study Cases the first will be used instead
of creating a new one. A new grid will always be created. Returns the newly created project.
DataObject Application.CreateProject(str projectName,
str gridName,
[DataObject parent])
A RGUMENTS
projectName
Name of the new project. Leave empty to open up the IntPrj dialog and let the
user enter a name.
gridName
Name of the grid that‘s created for the new project. Leave empty to open up the
ElmNet dialog and let the user enter a name.
parent The parent for the new project. Can be omitted to use the currently logged on user
as default.
DefineTransferAttributes
Defines for a given classname the attributes for blockwise access via DataObject.GetAttributes()
and DataObject.SetAttributes().
None Application.DefineTransferAttributes(str classname,
str attributes
)
A RGUMENTS
classname
Name of a class.
attributes Comma separated names of attributes.
S EE ALSO
DataObject.GetAttributes(), DataObject.SetAttributes()
DeleteUntouchedObjects
Delete all objects stored in the grid (or stored in set) which are not modified. Requires call
of PrepForUntouchedDelete() first, see Application.PrepForUntouchedDelete(). Hint: function
should only be used when a variation is active. For details please contact support.
int Application.DeleteUntouchedObjects(DataObject grid)
int Application.DeleteUntouchedObjects(list grids)
7
ExecuteCmd
Executes given command string as it would be executed if typed directly into the Input Window.
Current script will continue after the command has been executed.
This function is mainly intended for testing purpose and should be used by experienced users
only.
None Application.ExecuteCmd(str command)
A RGUMENTS
command
The command string
GetActiveCalculationStr
Gets “calculation string” of currently valid calculation.
str Application.GetActiveCalculationStr()
R ETURNS
None basic
Load Flow ldf
AC Load Flow Sensitivities acsens
AC Contingency Analysis accont
DC Load Flow dcldf
DC Load Flow Sensitivities dcsens
DC Contingency Analysis dccont
VDE/IEC Short-Circuit shc
Complete Short-Circuit shcfull
ANSI Short-Circuit shcansi
IEC 61363 shc61363
RMS-Simulation rms
Modal Analysis modal
EMT-Simulation emt
Harmonics/Power Quality harm
Frequency Sweep fsweep
Optimal Power Flow opf
DC Optimal Power Flow dcopf
DC OPF with Contingencies dccontopf
State Estimation est
Reliability rel
General Adequacy genrel
Tie Open Point Opt. topo
Motor Starting Calculation motstart
Arc Flash Calculation arcflash
Optimal Capacitor Placement optcapo
Voltage Plan Optimization mvplan
Backbone Calculation backbone
Optimal RCS Placement optrcs
8
GetActiveNetworkVariations
Returns all active variations for the 'Network Data' folder.
list Application.GetActiveNetworkVariations()
R ETURNS
Returns currently active IntScheme objects. Set is empty in case of no scheme being
currently active.
GetActiveProject
This function returns the currently active project.
DataObject Application.GetActiveProject()
R ETURNS
Returns currently active IntPrj object or None in case of no project being currently active.
GetActiveScenario
Returns the currently active scenario. None is returned if there is no active scenario.
DataObject Application.GetActiveScenario()
R ETURNS
Returns currently active IntScenario object or None in case of no scenario being currently
active.
GetActiveScenarioScheduler
Returns currently active scenario scheduler.
DataObject Application.GetActiveScenarioScheduler()
R ETURNS
Returns currently active IntScensched object or None in case of no scheduler being currently
active.
GetActiveStages
Returns all active stages currently active for a given folder, e.g. 'Network Data' folder.
list Application.GetActiveStages([DataObject variedFolder])
A RGUMENTS
variedFolder (optional)
Folder for which all active stages will be returned; by default, the project folder
'Network Data' is taken.
9
R ETURNS
Returns currently active IntSstage objects. Set is empty in case of no stages being currently
active.
GetActiveStudyCase
Returns the active Study Case. None is returned if there is no active study case.
DataObject Application.GetActiveStudyCase()
R ETURNS
The active study case (IntCase object) or None.
R ETURNS
Returns currently active IntCase object or None in case of no study case being currently
active.
GetAllUsers
Returns all known users, regardless of any Data Manager filters.
A RGUMENTS
forceReload
0 Default, returns the cached state if function was called before.
1 Forces the cache to be cleared, may impact performance.
R ETURNS
Returns a container with all known users.
Returns the description of an attribute.
str Application.GetAttributeDescription(str classname,
str name,
int short = 0)
A RGUMENTS
classname
Name of a class.
name Name of an attribute.
short 0 Return long attribute description (default).
1 Return short attribute description.
R ETURNS
None For an invalid class or attribute name.
str Long or short attribute description.
10
S EE ALSO
Application.GetAttributeUnit()
GetAttributeUnit
Returns the unit of an attribute e.g. km, MW. . . .
str Application.GetAttributeUnit(str classname,
str name
)
A RGUMENTS
classname
Name of a class.
R ETURNS
None For an invalid class or attribute name.
str Attribute unit.
S EE ALSO
Application.GetAttributeDescription()
GetBorderCubicles
This function returns the border cubicles of the parent station of passed element topologically
reachable from that element.
A cubicle (StaCubic) is considered to be a border cubicle if it resides inside the station
• and points to an element that sits outside the station

• or to a branch element that is connected to a terminal outside the station.
list Application.GetBorderCubicles(DataObject element)
A RGUMENTS
element Element from which the search for border cubicles starts
R ETURNS
A set, containing border cubicles StaCubic. If the element does not reside in any substation
or no border cubicles exist, the set is empty.
GetBrowserSelection
Returns all objects marked in the “on top” Data Manager (Browser, right side).
list Application.GetBrowserSelection()
R ETURNS
Objects marked in the “on top” Data Manager (Browser, right side).
11
S EE ALSO
Application.GetCurrentSelection(), Application.GetDiagramSelection()
GetCalcRelevantObjects
Returns all currently calculation relevant objects, i.e. the objects which are used by the calcula-
tions.
The set of objects depends on active study case, active grid(s) and variation(s).
In contrast to DataObject.IsCalcRelevant() it does not return objects of the active study case
e.g. simulation events (Evt*).
list Application.GetCalcRelevantObjects([str nameFilter,]
[int includeOutOfService = 1,]
[int topoElementsOnly = 0,]
[int bAcSchemes = 0])
A RGUMENTS
nameFilter (optional)
(Class) name filter. Wildcards are supported. Multiple filters to be separated by
comma ’,’. Must not contain a backslash ’\’.
If omitted, all objects are returned (corresponds to ’*.*’).
Examples for valid filter strings:
• ’ElmTerm’
• ’A*.ElmTerm’
• ’*.ElmLod,*.ElmSym’
includeOutOfService (optional)
Flag whether to include out of service objects. Default is 1 (=included).
topoElementsOnly (optional)
Flag to filter for topology relevant objects only. Default is 0 (=all objects).
bAcSchemes (optional)
Flag to include hidden objects in active schemes. Default is 0 (=not included).
R ETURNS
The currently calculation relevant objects, according to the given arguments. The order of
the set is undefined.
S EE ALSO
DataObject.IsCalcRelevant()
GetClassDescription
Returns a description for a PowerFactory class.
str Application.GetClassDescription(str name)
A RGUMENTS
name Name of a PowerFactory class
12
R ETURNS
Returns the description of a valid PowerFactory class, otherwise an empty string.
GetClassId
Returns a class identifier number.
Each class name corresponds to one unique number. The mapping of class name might
be different for different build numbers of PowerFactory , but it is guaranteed that it will not
changed while an Api instance exists. (Do not keep these numbers static, get them dynamically
in your code using this method).
int Application.GetClassId(str className)
A RGUMENTS
className
Class name e.g. ”ElmTerm”.
0 Class name invalid.

>0 Class id of valid class name.
GetCurrentDiagram
This function offers access to the current diagram object (IntGrfnet).
DataObject Application.GetCurrentDiagram()
GetCurrentScript
Returns the current script (ComPython).
DataObject Application.GetCurrentScript()
R ETURNS
The current script (ComPython) or None if started from external.
GetCurrentSelection
Returns all objects marked in the “on top” Data Manager (Browser, right side) or diagram.
list Application.GetCurrentSelection()
R ETURNS
Objects marked in the “on top” Data Manager (Browser, right side) or diagram.
S EE ALSO
Application.GetBrowserSelection(), Application.GetDiagramSelection()
13
GetCurrentUser
Returns the PowerFactory user of current session.
DataObject Application.GetCurrentUser()
R ETURNS
Returns an IntUser object, never None.
GetCurrentZoomScaleLevel
Returns the zoom or scale level of the currently active diagram. If the active diagram is geo-
graphic, then the scale level is returned, otherwise the zoom level is returned.
int Application.GetCurrentZoomScale()
R ETURNS
Zoom or scale level of the active diagram as integer.
• For geographic diagrams the scale level is returned. E.g. returns 50000 if 1:50000 is in
the zoom/ratio combo box
• For all other diagrams the zoom level is returned. E.g. returns 150 if 150
A value of -1 is returned in case of no open diagram.
GetDataFolder
This function returns the folder in which the network data for the given class are stored.
DataObject Application.GetDataFolder(str classname,
[int iCreate])
A RGUMENTS
classname
Classname of the elements:
ElmBmu
ElmArea
ElmZone
ElmRoute
ElmOwner
ElmOperator
ElmFeeder
ElmCircuit
ElmBoundary
IntScales
iCreate(optional)
0 The folder is searched and returned if found. If the folder does not
exist, None is returned.
1 The folder is created if it does not exist. The found or created folder is
returned.
14
R ETURNS
The network data folder, which is found or created.
S EE ALSO
DataObject.IsNetworkDataFolder()
GetDiagramSelection
Returns all objects marked in the “on top” diagram.
list Application.GetDiagramSelection()
R ETURNS
Objects marked in the “on top” diagram.
S EE ALSO
Application.GetCurrentSelection(), Application.GetBrowserSelection()
GetFlowOrientation
This function returns the flow orientation setting of the active project.
int Application.GetFlowOrientation()
R ETURNS
-1 No project is active
0 Flow orientation of active project is “MIXED MODE”
1 Flow orientation of active project is “LOAD ORIENTED”
2 Flow orientation of active project is “GENERATOR ORIENTED”
GetFromStudyCase
Returns the first found object of class “className” from the currently active study case. The
object is created when no object of the given name and/or class was found.
For commands the returned instance corresponds to the one that is used if opened via the main
menue load-flow, short-circuit, transient simulation, etc.,
DataObject Application.GetFromStudyCase(str className)
A RGUMENTS
className
Class name of the object (“Class”), optionally preceded by an object name without
wildcards and a dot (“Name.Class”).
R ETURNS
The found or created object.
15
GetGlobalLibrary
Returns the global library for object-types of class “ClassName”. ClassName may be omitted,
in which case the complete global library folder is returned.
DataObject Application.GetGlobalLibrary([str ClassName])
A RGUMENTS
ClassName (optional)
The classname of the objects for which the library folder is sought
R ETURNS
The libary folder
S EE ALSO
Application.GetLocalLibrary()
GetGraphicsBoard
Returns the currently active Graphics Board.
DataObject Application.GetGraphicsBoard()
R ETURNS
The graphics board object
GetInterfaceVersion
Returns the currently set interface version.
It holds the value set with SetInterfaceVersion() or the interface version from the current script
(parameter ’interfaceVersion’) if the python script is executed from within PowerFactory.
Have a look into the PowerFactor user manual to get more informations about the interface
version of a script.
int Application.GetInterfaceVersion()
R ETURNS
The currently set interface version or 0 if PowerFactory is started from external and SetInter-
faceVersion() is not called.
GetLanguage
Returns a string for the current program language setting.
str Application.GetLanguage()
R ETURNS
en English
de German
es Spanish
fr French
16
ru Russian
cn Simplified Chinese
tr Turkish
GetLocalLibrary
Returns the local library for object-types of class “ClassName”. ClassName may be omitted, in
which case the complete local library folder is returned.
DataObject Application.GetLocalLibrary([str ClassName])
A RGUMENTS
ClassName (optional)
The classname of the objects for which the library folder is sought
R ETURNS
The libary folder
S EE ALSO
Application.GetGlobalLibrary()
GetMem
Allows to trace memory consumption (current working set size).
int GetMem([int calculateDelta=0],
[int inMegaByte=0]
)
A RGUMENTS
calculateDelta (optional)
Measure absolute memory consumption if 0, measure the delta since the last time
it was called if 1 (default: 0).
inMegaByte (optional)
Returns consumption in byte if 0, in megabyte if 1 (default: 0).
R ETURNS
The current working set size or the delta since the last call.
GetProjectFolder
Returns the project folder of a given type of active project. For each type (except ‘Generic’)
there exist not more than one folder per type.
DataObject Application.GetProjectFolder(str type, [int create])
A RGUMENTS
type Type of the corresponding project folder. See IntPrjfolder.GetProjectFolderType()
for a list of possible values.
create Optional, default=0. Determines whether folder shall be created if it does not exist
(1=create, 0=don’t create).
17
R ETURNS
An IntPrjFolder object. If no project is currently active or project folder of this type does not
exist and ’create’ is not given as 0, None is returned.
GetRecordingStage
Returns the currently active recording scheme stage.
DataObject Application.GetRecordingStage()
R ETURNS
An IntSstage object; None if there is no recording stage.
GetSettings
Offers read-only access to some selected PowerFactory settings.
str Application.GetSettings(str key)
A RGUMENTS
key
Key Return type Description
username string Name of logged-in user
installationdir string Fully qualified path of installation directory of PowerFac-
tory
workingdir string Fully qualified path of working directory of PowerFactory
tempdir string Fully qualified path of temporary directory used by PowerFac-
tory
sessionid integer ID of current session
db driver string Name of used database driver
logfile string Path of current log file
R ETURNS
Value of settings as string
GetSummaryGrid
Returns the summary grid in the currently active Study Case. The summary grid is the combi-
nation of all active grids in the study case.
DataObject Application.GetSummaryGrid()
R ETURNS
A ElmNet object, or a 'None ' object when no grids are active
GetUserManager
Offers access to the user manager object (IntUserman) stored in the configuration folder.
DataObject Application.GetUserManager()
18
R ETURNS
The user manager object
Hide
Hides the PowerFactory application window.
None Application.Hide()
S EE ALSO
Application.Show()
ImportDz
Imports a DZ file. Overwrites data if it already exists.
[int errorCode,
list importedObjects] Application.ImportDz(DataObject target,
str dzFilePath)
A RGUMENTS
target Target object for imported data.
dzFilePath
Path to the DZ file that should be imported.
importedObjects (out)
Collection of top-level objects imported.
R ETURNS
0 Success
-1 Wrong file extension
nonzero Import failed
ImportSnapshot
Imports a Snapshot DZS file.
[int errorCode,
list importedObjects ] Application.ImportSnapshot(str dzsFilePath)
A RGUMENTS
dzsFilePath
Path to the DZ file that should be imported.
importedObjects (out)
Collection of top-level objects imported.
R ETURNS
0 Success
-1 Wrong file extension
nonzero Import failed
19
IsAttributeModeInternal
Returns whether the attribute values are accessed as internally stored.
int Application.IsAttributeModeInternal()
R ETURNS
0 Attribute values accessed as displayed in PowerFactory (unit conversion ap-
plied).
1 Attribute values accessed as internally stored.
S EE ALSO
Application.SetAttributeModeInternal()
IsLdfValid
Checks to see if the last load-flow results are still valid and available.
int Application.IsLdfValid()
R ETURNS
0 if no load-flow results are available
IsRmsValid
Checks to see if the last RMS simulation results are still valid and available.
int Application.IsRmsValid()
R ETURNS
0 if no RMS simulation results are available
IsScenarioAttribute
Checks if a given attribute of a given class is recorded in scenario. It does not check whether a
concrete instance is recorded at all. The check is just performed against the scenario configu-
ration and is independent of a concrete scenario.
int Application.IsScenarioAttribute(str classname, str attributename)
A RGUMENTS
classname
Name of a PowerFactory class
attributename
Name of an attribute of given class
R ETURNS
1 If attribute is scenario relevant according to current scenario configuration
0 If attribute is not scenario relevant
20
IsShcValid
Checks to see if the last short-circuit results are still valid and available.
int Application.IsShcValid()
R ETURNS
0 if no short-circuit results are available
IsSimValid
Checks to see if the last simulation results are still valid and available.
int Application.IsSimValid()
R ETURNS
0 if no simulation results are available
IsWriteCacheEnabled
Returns whether or not the cache method for optimizing performances is enabled.
int Application.IsWriteCacheEnabled()
R ETURNS
0 Write cache is disabled.
1 Write cache is enabled.
S EE ALSO
Application.SetWriteCacheEnabled(), Application.WriteChangesToDb()
LoadProfile
Activates a profile for current user. This corresponds to the select profile action via main menu
“TOOLS-Profiles”.
int Application.LoadProfile(str profileName)
A RGUMENTS
profileName
Name of profile to be loaded.
R ETURNS
0 On error, e.g. profile with given name not found.
1 On success.
S EE ALSO
Application.ReloadProfile()
21
MarkInGraphics
This function is not supported in GUI-less mode.
Marks all objects in the diagram in which the elements are found by hatch crossing them.
None Application.MarkInGraphics(list objects,
[int searchOpenedDiagramsOnly = 0])
A RGUMENTS
objects Objects to be marked.
searchOpenedDiagramsOnly (optional)
Search can be restricted to currently shown diagrams on the desktop, instead of
all diagrams.
0 Searching all diagrams, not only the ones which are currently shown
on the desktop. If there is more than one occurrence the user will be
prompted which diagrams shall be opened (default).
1 Only search in currently opened diagrams and open the first diagram
in which the elements were found.
OutputFlexibleData
Outputs the Flexible Data of the given objects to the output window.
Has identical functionality to that implemented in the Object Filter dialogue, whereby the user
can right-click on a single row or multiple rows in a Flexible Data page and select Output
. . . Flexible Data. The OutputFlexibleData() function assumes that the user has already defined
a Flexible Data page for the objects in the set. Upon execution of this function, all Flexible
Data defined for the objects in the set is output to the PowerFactory output window in a tabular
format.
None Application.OutputFlexibleData(list objects,
[str flexibleDataPage = ''])
A RGUMENTS
objects Objects to output the Flexible Data for.
flexibleDataPage (optional)
Name of the Flexible Data page to be outputed. If multiple Flexible Data pages
are defined and no or an empty string is given then a dialog to select a Flexible
Data page is shown.
PostCommand
Adds a command to the command pipe of the “input window”. The posted commands will be
executed after the currently running script has finished.
None Application.PostCommand(str command)
A RGUMENTS
command
The command string.
22
PrepForUntouchedDelete
Mark (as not modified) all objects stored in the grid (or stored in set). Required for function
Application.DeleteUntouchedObjects().
void Application.PrepForUntouchedDelete(DataObject grid)
void Application.PrepForUntouchedDelete(list grids)
Rebuild
Rebuilds the currently visible single line diagram or plot.
None Application.Rebuild([int iMode])
A RGUMENTS
iMode (optional)
0 Draws graphic objects only
1 (default) Reads graphic objects (IntGrf) from database and draws
2 For single line diagrams: Reads graphic objects (IntGrf) from database,
re-calculates intersections and draws.
For plot pages: Adjust view to page format and re-create plots.
ReloadProfile
Reloads currently selected user profile. (See main menue “TOOLS-Profiles”)
None Application.ReloadProfile()
S EE ALSO
Application.LoadProfile()
ResetCalculation
Resets all calculations and deletes all calculation results.
Results that have been written to result objects (for display in graphs) will not be destroyed. All
results that are visible in the single line diagrams, however, will be destroyed.
None Application.ResetCalculation()
S EE ALSO
Application.IsAutomaticCalculationResetEnabled(), Application.SetAutomaticCalculationResetEnabled()
ResGetData
This function is deprecated. Please use ElmRes.GetValue() or IntComtrade.GetValue() in-
stead.
[int error,
float d ] Application.ResGetData(DataObject resultObject,
int iX,
[int col])
23
ResGetDescription
This function is deprecated. Please use ElmRes.GetDescription() or
IntComtrade.GetDescription() instead.
str Application.ResGetDescription(DataObject resultObject,
int col,
[int ishort])
ResGetFirstValidObject
This function is deprecated. Please use ElmRes.GetFirstValidObject() instead.
int Application.ResGetFirstValidObject(DataObject resultFile,
int row,
[str classNames]
[str variableName,]
[float limit,]
[int limitOperator,]
[float limit2,]
[int limitOperator2])
int Application.ResGetFirstValidObject([DataObject resultFile,]
[int row,]
[list objects])
ResGetFirstValidObjectVariable
This function is deprecated. Please use ElmRes.GetFirstValidObjectVariable() instead.
int Application.ResGetFirstValidObjectVariable(DataObject resultFile,
[str variableNames])
ResGetFirstValidVariable
This function is deprecated. Please use ElmRes.GetFirstValidVariable() instead.
int Application.ResGetFirstValidVariable(DataObject resultFile,
int row,
ResGetIndex
This function is deprecated. Please use ElmRes.FindColumn() or IntComtrade.FindColumn()
instead.
int Application.ResGetIndex(DataObject resultFile,
DataObject obj,
[str varName])
DataObject obj,
[int colIndex])
[str varName,]
[int colIndex])
24
ResGetMax
This function is deprecated. Please use ElmRes.FindMaxInColumn() or
IntComtrade.FindMaxInColumn() instead.
[int row,
float value] Application.ResGetMax(DataObject resultFile,
int col)
ResGetMin
This function is deprecated. Please use ElmRes.FindMinInColumn() or
IntComtrade.FindMinInColumn() instead.
[int row,
float value] Application.ResGetMin(DataObject resultFile,
int col)
ResGetNextValidObject
This function is deprecated. Please use ElmRes.GetNextValidObject() instead.
int Application.ResGetNextValidObject(DataObject resultFile,
[str classNames]
[str variableName,]
[float limit,]
[float limit2,]
[int limitOperator2])
int Application.ResGetNextValidObject(DataObject resultFile,
list objects)
ResGetNextValidObjectVariable
This function is deprecated. Please use ElmRes.GetNextValidObjectVariable() instead.
int Application.ResGetNextValidObjectVariable(DataObject resultFile,
ResGetNextValidVariable
This function is deprecated. Please use ElmRes.GetNextValidVariable() instead.
int Application.ResGetNextValidVariable(DataObject resultFile,
ResGetObject
This function is deprecated. Please use ElmRes.GetObject() instead.
DataObject Application.ResGetObj(DataObject resultObject,
int col)
25
ResGetUnit
This function is deprecated. Please use ElmRes.GetUnit() or IntComtrade.GetUnit() instead.
str Application.ResGetUnit(DataObject resultObject,
int col)
ResGetValueCount
This function is deprecated. Please use ElmRes.GetNumberOfRows() or
IntComtrade.GetNumberOfRows() instead.
int Application.ResGetValueCount(DataObject resultObject,
[int col])
ResGetVariable
This function is deprecated. Please use ElmRes.GetVariable() or IntComtrade.GetVariable()
instead.
str Application.ResGetVariable(DataObject resultObject,
int col)
ResGetVariableCount
This function is deprecated. Please use ElmRes.GetNumberOfColumns() or
IntComtrade.GetNumberOfColumns() instead.
int Application.ResGetVariableCount(DataObject resultObject)
ResLoadData
This function is deprecated. Please use ElmRes.Load() or IntComtrade.Load() instead.
None Application.ResLoadData(DataObject resultObject)
ResReleaseData
This function is deprecated. Please use ElmRes.Release() or IntComtrade.Release() instead.
None Application.ResReleaseData(DataObject resultObject)
ResSortToVariable
This function is deprecated. Please use ElmRes.SortAccordingToColumn() or
IntComtrade.SortAccordingToColumn() instead.
int Application.ResSortToVariable(DataObject resultObject,
int col)
26
SaveAsScenario
Saves the operational data or relevant network elements as a new scenario.
DataObject Application.SaveAsScenario(str pName,
int iSetActive)
A RGUMENTS
pName Name of the new scenario.
iSetActive
1 Activate the new scenario afterwards.
0 Do not activate the new scenario.
R ETURNS
Returns newly created IntScenario object. None is returned in case of creation of a new
scenario was not allowed (e.g. no active project).
SearchObjectByForeignKey
Searches for an object by foreign key within an active project.
DataObject Application.SearchObjectByForeignKey(str foreignKey)
A RGUMENTS
foreignKey
Foreign key
R ETURNS
Object if found, otherwise None.
SelectToolbox
Sets tool box to be displayed at a switchable tool box group.
int Application.SelectToolbox(int toolbar,
str groupName,
str toolboxName)
A RGUMENTS
toolbar 1 Main tool bar
2 Drawing tool bar (SGL)
groupName
Name of tool box group.
toolboxName
Name of tool box to be selected.
R ETURNS
0 On error, e.g. no matching tool box found.
1 On success.
27
SetAttributeModeInternal
Changes the way how attribute values are accessed.
None Application.SetAttributeModeInternal(int internalMode)
A RGUMENTS
internalMode 0 Access attribute values as displayed in PowerFactory (unit con-
version applied).
1 Access attribute values as internally stored.
S EE ALSO
Application.IsAttributeModeInternal()
SetInterfaceVersion
Sets the current interface version. Only values which can be set to the python script parameter
’interfaceVersion’ are allowed. Setting the interface version does not affect the parameter
’interfaceVersion’ of the current script.
Have a look into the PowerFactor user manual to get more informations about the interface
version of a script.
int Application.SetInterfaceVersion(int version)
A RGUMENTS
version interface version to be set
R ETURNS
0 if the version is successfully set, otherwise 1.
SetShowAllUsers
Enables or disables the filtering of all available users in data manager. All users are only
visualised in data manager when enabled.
int Application.SetShowAllUsers(int enabled)
A RGUMENTS
enabled
0 Disabled, only Demo, Public Area Users and current user are shown
1 Enabled, all available users are listed
R ETURNS
Returns previous setting.
1 If enabled before.
0 If disabled before.
28
SetWriteCacheEnabled
This function intends to optimize performances or disable the value consistency check of at-
tributes. In order to modify objects in PowerFactory , those must be set in a special edit mode
before any value can be changed. Switching back and forth between edit mode and stored
mode is time consuming; enabling the write cache flag will set objects in edit mode and they will
not be switched back until WriteChangeToDb() is called.
Another purpose of this function is to disable the value consistency check executed whenever
an attribute is set. Note: Enabling the write cache delays the value consistency check until
WriteChangeToDb() is called or the write cache is disabled. This might be required when
dependent attributes are set where the object is temporarily left in an invalid state until all
attributes are set. In DPL please use SetConsistencyCheck() for the same purpose.
None Application.SetWriteCacheEnabled(int enabled)
A RGUMENTS
enabled 0 Disables the write cache.
1 Enables the write cache.
S EE ALSO
Application.IsWriteCacheEnabled(), Application.WriteChangesToDb()
Show
Shows the PowerFactory application window (only possible with a full license, not supported
for engine licenses).
None Application.Show()
S EE ALSO
Application.Hide()
SplitLine
Splits the passed line or ElmBranch-object at a given position
DataObject Application.SplitLine(DataObject Line,
[float percent = 50,]
[int createSwitchSide0 = 0,]
[int createSwitchSide1 = 0])
A RGUMENTS
double rPercent (optional)
Position in percent from the first connection side where line shall be split.
int iCreateSwitchSide0 (optional)
0 (default) Do not create switch on first connection side.

1 Create switch on first connection side.
int iCreateSwitchSide1 (optional)
0 (default) Do not create switch on second connection side.

1 Create switch on second connection side.
29
R ETURNS
Inserted terminal
0 = error
StatFileGetXrange
Gets the x-range for the statistic result file.
[int error,
float min,
float max] Application.StatFileGetXrange()
A RGUMENTS
min (out) First point in time considered in statistics.
max (out) Last point in time considered in statistics.
R ETURNS
0 If time range of statistic result file was found.
1 On errors (There is no statistic result file).
StatFileResetXrange
Reset the user defined x-range of the statistic result file. The complete x-range will be consid-
ered in the statistic results after calling this function.
None Application.StatFileResetXrange()
StatFileSetXrange
Sets the user defined x-range of the statistic result file. The statistic results consider only the
given time range.
None Application.StatFileSetXrange(float min,
float max)
A RGUMENTS
min First point in time to be considered in statistics.
max Last point in time to be considered in statistics.
WriteChangesToDb
This function combined with Application.SetWriteCacheEnabled() is meant to optimize perfor-
mances. If the write cache flag is enabled all objects remain in edit mode until WriteChangesToDb
is called and all the modifications made to the objects are saved into the database.
None Application.WriteChangesToDb()
30
3.1. FILE SYSTEM CHAPTER 3. APPLICATION METHODS
S EE ALSO
Application.SetWriteCacheEnabled(), Application.IsWriteCacheEnabled()
3.1 File System

Overview
GetInstallationDirectory
GetTemporaryDirectory
GetWorkspaceDirectory
GetInstallationDirectory
Returns the installation directory of PowerFactory .
str Application.GetInstallationDirectory()
R ETURNS
Full path to installation directory of current PowerFactory .
D EPRECATED N AMES
GetInstallDir
S EE ALSO
Application.GetTemporaryDirectory(), Application.GetWorkspaceDirectory()
GetTemporaryDirectory
Returns the temporary directory of used by PowerFactory .
str Application.GetTemporaryDirectory()
R ETURNS
Full path to a directory where temporary data can be stored. This directory is also used by
PowerFactory to store temporary data.
D EPRECATED N AMES
GetTempDir
S EE ALSO
Application.GetWorkspaceDirectory(), Application.GetInstallationDirectory()
GetWorkspaceDirectory
Returns the workspace directory of PowerFactory .
str Application.GetWorkspaceDirectory()
R ETURNS
Full path to the directory where currently used workspace is stored.
31
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS
D EPRECATED N AMES
GetWorkingDir
S EE ALSO
Application.GetTemporaryDirectory(), Application.GetInstallationDirectory()
3.2 Date/Time
Overview
GetStudyTimeObject
GetStudyTimeObject
Returns the date and time object (SetTime) from the study case. This is the object being used
by the characteristics, scenarios, ...
R ETURNS
SetTime or None.
3.3 Dialogue Boxes

Overview
CloseTableReports
GetTableReports
ShowModalBrowser
ShowModalSelectBrowser
ShowModelessBrowser
UpdateTableReports
CloseTableReports
Closes all open table reports.

Please note: Table reports currently running one of their scripts are not closed.
None Application.CloseTableReports()
GetTableReports
Returns all open table reports.

list Application.GetTableReports()
32
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS
ShowModalBrowser
Opens a modal browser window and lists all given objects.

None Application.ShowModalBrowser(list objects,
[int detailMode = 0,]
[str title = '',]
[str page = ''])
A RGUMENTS
objects Objects to be listed. The listing is in detailed mode, if only one kind of objects (e.g.
only ElmTerm) is contained.
detailMode (optional)
0 Show browser in normal mode (default).
1 Show browser in detail mode.
title (optional)
String for user defined window title. The default window title is shown when no or
an empty string is given.
page (optional)
Name of page to be shown in browser e.g. 'Flexible Data' (only in detailed mode).
The default page is shown when no or an empty string is given.
ShowModalSelectBrowser
Opens a modal browser window and lists all given objects. The user can make a selection from
the list.
list Application.ShowModalSelectBrowser(list objects,
[str title,]
[str classFilter,]
[str page = ''])
A RGUMENTS
title (optional)
classFilter (optional)
Class name filter. If set, only objects matching that filter will be listed in the dialog
e.g. ’Elm*’, ’ElmTr?’ or ’ElmTr2,ElmTr3’.
page (optional)
33
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS
R ETURNS
Set of selected objects. The set is empty if “cancel” is pressed.
ShowModelessBrowser
Opens a modeless browser window and lists all given objects.

None Application.ShowModelessBrowser(list objects,
[int detailMode = 0,]
[str title = '',]
[str page = ''])
A RGUMENTS
detailMode (optional)
0 Show browser in normal mode (default).
1 Show browser in detail mode.
title (optional)
page (optional)
UpdateTableReports
Updates all open table reports.

None Application.UpdateTableReports()
3.4 Environment
Overview
EchoOff
EchoOn
IsAutomaticCalculationResetEnabled
IsFinalEchoOnEnabled
SetAutomaticCalculationResetEnabled
SetFinalEchoOnEnabled
SetGraphicUpdate
SetGuiUpdateEnabled
SetProgressBarUpdatesEnabled
SetUserBreakEnabled
34
EchoOff
Freezes (de-activates) the user-interface. For each EchoOff(), an EchoOn() should be called.
An EchoOn() is automatically executed at the end of the execution of a ComDpl or ComPython.
This could be changed with Application.SetFinalEchoOnEnabled().
None Application.EchoOff()
S EE ALSO
Application.EchoOn(), Application.IsFinalEchoOnEnabled(), Application.SetFinalEchoOnEnabled()
EchoOn
Re-activates the user interface. For more informations see Application.EchoOff().
None Application.EchoOn()
S EE ALSO
Application.EchoOff(), Application.IsFinalEchoOnEnabled(), Application.SetFinalEchoOnEnabled()
IsAutomaticCalculationResetEnabled
Returns whether the automatic calculation reset while setting attributes is enabled. See Appli-
cation.SetAutomaticCalculationResetEnabled() for more informations.
int Application.IsAutomaticCalculationResetEnabled()
S EE ALSO
Application.SetAutomaticCalculationResetEnabled(), Application.ResetCalculation()
IsFinalEchoOnEnabled
Returns whether the automatic Application.EchoOn() at the end of each ComDpl or ComPython
is enabled.
int Application.IsFinalEchoOnEnabled();
R ETURNS
1 Final Application.EchoOn() is enabled.
0 Final Application.EchoOn() is disabled.
S EE ALSO
Application.SetFinalEchoOnEnabled(), Application.EchoOn(), Application.EchoOff()
SetAutomaticCalculationResetEnabled
Enables or disables the automatic calculation reset while setting attributes.
In Python/API the automatic calculation reset is by default enabled. Thus changing an object
attribute could lead to a calculation reset, e.g. changing the scaling factor of a load, but do not
have to, e.g. renaming an object.
35
Even if the automatic calculation reset is disabled, changing the ”outserv” attribute of an arbitrary
network element or the ”on off” attribute of a switch device resets automatically the current
calculation.
When the calculation is reset the load-flow will be calculated with a flat start. Thus switching
the automatic calculation reset off can be helpful e.g. when calculating a load-flow without a flat
start. On the other side it could lead to wrong results e.g. doing short-circuit calculations after
changing the short-circuit-location of a branch without calling Application.ResetCalculation().
None Application.SetAutomaticCalculationResetEnabled(int enabled)
S EE ALSO
Application.IsAutomaticCalculationResetEnabled(), Application.ResetCalculation()
SetFinalEchoOnEnabled
Enables or disables the automatic Application.EchoOn() at the end of each ComDpl or ComPython.
None Application.SetFinalEchoOnEnabled(int enabled);
A RGUMENTS
enabled
1 Enables the final Application.EchoOn().
0 Disables the final Application.EchoOn().
S EE ALSO
Application.IsFinalEchoOnEnabled(), Application.EchoOn(), Application.EchoOff()
SetGraphicUpdate
Enables or disables the updates of the single line graphics.
None Application.SetGraphicUpdate(int enabled)
A RGUMENTS
enabled
0 disabled (graphic will not be updated automatically)
1 enabled
SetGuiUpdateEnabled
Enables or disables updates of the graphical user interface (e.g. application window) while the
script is running.
This can be useful to get maximum execution performance. However, the user interface might
look frozen and becomes not responsive.
Please note that the progress bar, which is located in the status bar of the application window,
is not affected by this. Updates of the progress bar can be enabled or disabled separately by
invoking Application.SetProgressBarUpdatesEnabled().
The updates will automatically be re-enabled after termination of the script. In case of sub-
scripts, the restore is done at termination of main script.
36
int Application.SetGuiUpdateEnabled(int enabled)
A RGUMENTS
enabled
0 Disables GUI updates.
1 Enables GUI updates.
R ETURNS
Previous state before the function was called
0 GUI updates were disabled before.

1 GUI updates were enabled before.
D EPRECATED N AMES
SetRescheduleFlag
S EE ALSO
Application.SetProgressBarUpdatesEnabled(), Application.SetGraphicUpdate()
SetProgressBarUpdatesEnabled
Enables or disables updates of the progress bar (located in the status bar of the application
window) while the script is running. Other components of the status bar are not affected.
If a script executes a high number of small, fast commands that report progress (noticable by
the progress bar repeatedly and quickly filling up), disabling progress bar updates can provide
an immense performance boost.
The updates will automatically be re-enabled after termination of the script. In case of sub-
scripts, the restore is done at termination of main script.
int Application.SetProgressBarUpdatesEnabled(int enabled)
A RGUMENTS
enabled
0 Disables progress bar updates.
1 Enables progress bar updates.
R ETURNS
Previous state before the function was called
0 Progress bar updates were disabled before.

1 Progress bar updates were enabled before.
S EE ALSO
Application.SetGuiUpdateEnabled(), Application.SetGraphicUpdate()
SetUserBreakEnabled
Enables or disables the “Break” button in main tool bar. After script execution it is disabled
automatically.
None Application.SetUserBreakEnabled(int enabled)
37
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS
A RGUMENTS
enabled
0 Disables “Break” button.
1 Enable “Break” button.
D EPRECATED N AMES
SetEnableUserBreak
3.5 Mathematics
Overview
GetRandomNumber
GetRandomNumberEx
InvertMatrix
RndExp
RndGetMethod
RndGetSeed
RndNormal
RndSetup
RndUnifInt
RndUnifReal
RndWeibull
SetRandomSeed
GetRandomNumber
This method is marked as deprecated since PowerFactory 2017. Please use Application.RndUnifReal()
instead.
Draws a uniformly distributed random number. Uses the ’global random number generator’. If
x1 and x2 are omitted, the distribution will be uniform in the interval [0, 1]. If only x1 is given, the
distribution is uniform in [0, x1] and with both x1 and x2, the distribution is uniform in [x1, x2].
float Application.GetRandomNumber([float x1,]
[float x2])
A RGUMENTS
x1 (optional)
x2 not given: maximum; x1 and x2 given: minimum
x2 (optional)
maximum
R ETURNS
A uniformly distributed random number
GetRandomNumberEx
This method is marked as deprecated since PowerFactory 2017. Please use Application.RndUnifReal(),
Application.RndNormal() or Application.RndWeibull() instead.
38
Draws a random number according to a specific probability distribution. Uses the ’global random
number generator’.
float Application.GetRandomNumberEx(int distribution,
[float p1,]
[float p2])
A RGUMENTS
distribution
0 uniform distribution
1 normal distribution
2 weibull distribution
else returns 0.0
p1 (optional)
distribution = 0 (uniform), argument p2 is also given: min
distribution = 0 (uniform), argument p2 is not given: max (min is as-
sumed to be 0).
distribution = 1 (normal) : mean
distribution = 2 (weibull) : scale
p2 (optional)
distribution = 0 (uniform) : max
distribution = 1 (normal) : stddev
distribution = 2 (weibull) : weibull
R ETURNS
double Newly drawn random number from the specified distribution.
0.0 On failure e.g. non-supported mode.
InvertMatrix
This routine calculates the inverse matrix by the Gauss-Jordan method. It uses scaled partial
pivoting preceeded by column equilibration of the input matrix. The routine can be called in two
different versions:
• Real Inversion: Only one matrix, realP art, is provided as an input to the function. Then,
realP art is inverted and the result, realP art−1 , is stored into the input matrix realP art on
success.
• Complex Inversion: Two matrices, realP art and imaginaryP art, are provided as inputs
to this function. Then, a complex matrix C is formed, with entries
C(i,j) = A(i,j) + j · imaginaryP art(i,j).
The complex matrix C is inverted and, on success, the resulting real part of C −1 is written
to realP art whereas the resulting imaginary part of C −1 is written to imaginaryP art.
Please note that realP art and imaginaryP art must have the same dimensions.
int Application.InvertMatrix(DataObject realPart,

[DataObject imaginaryPart])
39
A RGUMENTS
realPart If imaginaryPart is not set, realpart is the matrix to invert on input. In case of
success, it will be overwritten by the inverted input matrix. If imaginaryPart is set,
it holds the real part of the complex matrix to invert on input and is overwritten by
the real part of the inverted complex matrix on output.
imaginaryPart
If this is set, it should hold the imaginary part of the matrix to invert on input and
is overwritten by the imaginary part of the inverted matrix on output.
R ETURNS
1 Matrix inversion failed. The provided input matrix is singular.
0 Matrix inversion was successful. Resulting inverted matrix returned in input ma-
trix/matrices.
RndExp
Returns a random number distributed according to exponential distribution with given rate. See
the example given in the DPL description of Application.RndSetup().
float RndExp(float rate, [int rngNum])
A RGUMENTS
rate Rate of exponetial distribution.
rngNum (optional)
Number of the random number generator.
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.
R ETURNS
double Random number
RndGetMethod
Returns the used method of a random number generator. See the example given in the DPL
description of Application.RndSetup().
str RndGetMethod([int rngNum])
A RGUMENTS
rngNum (optional)
Number of the random number generator of which the method type is returned.
R ETURNS
string Name of the used method
40
RndGetSeed
Returns the used seed of a random number generator. See the example given in the DPL
description of Application.RndSetup().
int RndGetSeed([int rngNum])
A RGUMENTS
rngNum (optional)

R ETURNS
int Used seed
RndNormal
Returns a random number distributed according to normal distribution with given mean and
standard deviation. See the example given in the DPL description of Application.RndSetup().
float RndNormal(float mean, float stddev, [int rngNum])
A RGUMENTS
mean Mean of normal distribution.
stddev Standard deviation of normal distribution.
rngNum (optional)
R ETURNS
RndSetup
Initializes a random number generator. Allows to choose:
1. Whether to seed automatically or not.
2. The seed, if not automatically seeded.

3. The type or random number generator.
4. The random number generator to use.
Supported types of random number generators:
1. Mersenne Twister,
2. Linear Congruential,
41
3. Additive Lagged Fibonacci.
Internally a vector of random number generators is used. These can be accessed via the
number passed as last argument. Number 0 corresponds to the ’global random number gener-
ator’, updated also in ComInc and ComGenrelinc. Numbers 1,2, . . . will access different random
number generators, which can be setup individually.
None RndSetup(int seedAutomatic, [int seed], [int rngType], [int rngNum])
A RGUMENTS
seedAutomatic
Seed the random number generator automatically
0 Do not seed automatically.
1 Seed automatically.
seed (optional)
Seed for the random number generator. (default: 0) Note, that for the Additive
Lagged Fibonacci generator, only the seeds 0,...,9 are supported.
rngType (optional)
Type of random number generator
0 Mersenne Twister (recommended) (default).

1 Linear Congruential.
2 Additive Lagged Fibonacci.
rngNum (optional)
Number of random number generator to be used
RndUnifInt
Returns a random number distributed according to uniform distribution on the set of numbers
{min, . . . , max}. See the example given in the DPL description of Application.RndSetup().
int RndUnifInt(int min, int max, [int rngNum])
A RGUMENTS
min Smallest possible number
max Largest possible number
rngNum (optional)
R ETURNS
int Random number
42
RndUnifReal
Returns a random number distributed according to uniform distribution on the intervall [min,max].
See the example given in the DPL description of Application.RndSetup().
float RndUnifReal(float min, float max, [int rngNum])
A RGUMENTS
min Lower endpoint of interval [min, max]
max Upper endpoint of interval [min, max]
rngNum (optional)
R ETURNS
RndWeibull
Returns a random number distributed according to Weibull distribution with given shape and
scale parameters. See the example given in the DPL description of Application.RndSetup().
float RndWeibull(float shape, float scale, [int rngNum])
A RGUMENTS
shape Shape parameter of Weibull distribution.
scale Scale parameter of Weibull distribution.
rngNum (optional)

R ETURNS
SetRandomSeed
This method is marked as deprecated since PowerFactory 2017. Please use Application.RndSetup()
instead.
Initializes the ’global random number generator’ as Additive Lagged Fibonacci random number
generator. Sets the seed for the random number generator. One out of 10 predefined initializa-
tion seeds can be selected.
None Application.SetRandomSeed(int seed)
43
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS
A RGUMENTS
seed seed 0..9
3.6 Output Window

Overview
ClearOutputWindow
GetOutputWindow
PrintError
PrintInfo
PrintPlain
PrintWarn
SetOutputWindowState
ClearOutputWindow
Clears the output window.
None Application.ClearOutputWindow()
GetOutputWindow
Returns the PowerFactory Output Window.
OutputWindow Application.GetOutputWindow()
R ETURNS
An instance of the class OutputWindow.
E XAMPLE
import powerfactory
app = powerfactory.GetApplication()
outputWindow = app.GetOutputWindow()
outputWindow.Print(powerfactory.OutputWindow.MessageType.Plain, "Hello World!")
PrintError
Prints a message as error into the PowerFactory Output Window. See OutputWindow.Print()
for more informations.
None Application.PrintError(str message)
PrintInfo
Prints a message as information into the PowerFactory Output Window. See OutputWin-
dow.Print() for more informations.
None Application.PrintInfo(str message)
44
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS
PrintPlain
Prints a message as normal text into the PowerFactory Output Window. See OutputWin-
dow.Print() for more informations.
None Application.PrintPlain(str message)
PrintWarn
Prints a message as warning into the PowerFactory Output Window. See OutputWindow.Print()
for more informations.
None Application.PrintWarn(str message)
SetOutputWindowState
Changes the display state of the output window.
None Application.SetOutputWindowState(int newState)
A RGUMENTS
newState
0 Minimized output window.
1 Maximized output window.
-1 Restore previous state.
45
CHAPTER 4. OUTPUT WINDOW
4 Output Window
Overview
Clear
GetContent
Print
Save
SetState
Clear
Clears the output window.
None OutputWindow.Clear()
GetContent
Returns the content (unfiltered or filtered) of the output window.
[str] OutputWindow.GetContent()
[str] OutputWindow.GetContent(OutputWindow.MessageType filter)
A RGUMENTS
filter (optional)
If given, then only text from messages of this type will be returned.
R ETURNS
List of texts of output window messages (unfiltered or filtered).
S EE ALSO
OutputWindow.Print()
Print
Prints a message as normal text, as information, as warning or as error into the PowerFactory
Output Window.
None OutputWindow.Print(str message)
None OutputWindow.Print(OutputWindow.MessageType type, str message)
A RGUMENTS
type Type of message to print:
46
CHAPTER 4. OUTPUT WINDOW
OutputWindow.MessageType.Plain Normal text.

OutputWindow.MessageType.Info Information.
OutputWindow.MessageType.Warn Warning.
OutputWindow.MessageType.Error Error.
The message is printed as normal text if no message type is given.
message Message to print.
E XAMPLE
import powerfactory
app = powerfactory.GetApplication()
outputWindow = app.GetOutputWindow()
outputWindow.Print(powerfactory.OutputWindow.MessageType.Plain, "Hello World!")
Save
Saves the content of current output window to a file.
None OutputWindow.Save(str filePath)
A RGUMENTS
filePath Full file name with path e.g. d:\data\output.txt. Possible file formats are html, txt
and out.
SetState
Changes the display state of the output window.
None OutputWindow.SetState(int newState)
A RGUMENTS
newState
0 Minimized output window.
1 Maximized output window.
-1 Restore previous state.
47
CHAPTER 5. OBJECT METHODS
5 Object Methods
5.1 General Methods

Overview
AddCopy
ContainsNonAsciiCharacters
CopyData
CreateObject
Delete
Energize
GetAttribute
GetAttributeLength
GetAttributes
GetAttributeShape
GetAttributeType
GetAttributeUnit
GetChildren
GetClassName
GetCombinedProjectSource
GetConnectedElements
GetConnectionCount
GetContents
GetControlledNode
GetCubicle
GetFullName
GetImpedance
GetInom
GetNode
GetOperator
GetOwner
GetParent
GetReferences
GetRegion
GetSupplyingSubstations
GetSupplyingTransformers
GetSupplyingTrfstations
GetSystemGrounding
GetUnom
GetZeroImpedance
HasAttribute
HasResults
IsCalcRelevant
48
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS
IsDeleted
IsEarthed
IsEnergized
IsHidden
IsInFeeder
IsNetworkDataFolder
IsNode
IsObjectActive
IsObjectModifiedByVariation
Isolate
IsOutOfService
IsReducible
IsShortCircuited
MarkInGraphics
Move
PasteCopy
PurgeUnusedObjects
ReplaceNonAsciiCharacters
ReportNonAsciiCharacters
ReportUnusedObjects
SearchObject
SetAttribute
SetAttributeLength
SetAttributes
SetAttributeShape
ShowEditDialog
ShowModalSelectTree
SwitchOff
SwitchOn
WriteChangesToDb
AddCopy
Adds a copy of a single object or a set of objects to this object (= target object).
When copying a single object it is possible to give the new name. The new name will be
concatenated by the given name parts. This is not possible for a project (IntPrj).
The target object must be able to receive a copy of the objects.
Copying a set of objects will respect all internal references between those objects. Copying a
set of lines and their types, for example, will result in a set of copied lines and line types, where
the copied lines will use the copied line types.
When source object(s) and target object are inside different projects the method DataOb-
ject.PasteCopy() has to be used instead, since it adapts all references automatically.
DataObject DataObject.AddCopy(DataObject objectToCopy,
[int|str partOfName0,]
[...])
DataObject DataObject.AddCopy(list objectsToCopy)
A RGUMENTS
objectToCopy
Object to copy.
objectNameParts (optional)
Parts of the name of the new copy which will be concatenated to the object name.
49
objectsToCopy
Set of objects to copy.
R ETURNS
Returns the copy that has been created on success or None, when copying a single object.
S EE ALSO
DataObject.PasteCopy(), DataObject.Move(), Application.Delete()
ContainsNonAsciiCharacters
Checks whether an object contains texts attributes with non-ASCII characters.
int DataObject.ContainsNonAsciiCharacters()
R ETURNS
Returns 1 if the object contains at least one non-ASCII characters. Otherwise 0.
CopyData
Copies all parameters except for loc name and containers from one object to another.
None DataObject.CopyData(DataObject source)
A RGUMENTS
source Object from which parameters are to be copied
R ETURNS
0 ok
1 error
CreateObject
Creates a new object of given class and name in the target object. The object name will be
concatenated by the given object name parts. The target object must be able to store an object
of the given class in its content otherwise the currently running script will stop with an error.
DataObject DataObject.CreateObject(str className,
[int|str objectNamePart0,]
[...]
)
A RGUMENTS
className
The class name of the object to create.
objectNameParts (optional)
Parts of the name of the object to create (without classname) which will be con-
catenated to the object name.
50
R ETURNS
object Newly created object.
None When no object was created.
Delete
Deletes the object from the database. The object is not destroyed but moved to the recycle bin.
int DataObject.Delete()
R ETURNS
0 Object successfully deleted.
6= 0 Deletion failed e.g. not allowed.
S EE ALSO
DataObject.CreateObject()
Energize
Performs an “energize” action on the network element. This corresponds to removing earthings
from current region (if any) followed by a “switch on” action on the element.
The action is identical to that in the context menue.
[int error,
list changedSwitches] DataObject.Energize([int resetRA])
A RGUMENTS
changedSwitches (optional, out)
All switches whose switching state was changed by the action are filled into this
set.
resetRA (optional)
Determines whether an active running arrangement that would prevent switching
action should be deactivated or not.
1 All running arrangements that cause blocking of relevant switches are
applied and reset automatically before the switching is performed.
0 (default) Active running arrangements are not reset. Blocked switches
will cause the switching action to fail.
R ETURNS
Information about the success of the action:
0 Action was successful.

1 Action failed.
S EE ALSO
DataObject.SwitchOn(), DataObject.SwitchOff(), DataObject.Isolate()
51
GetAttribute
Returns the value of an attribute.
int|float|str|DataObject|list DataObject.GetAttribute(str name)
A RGUMENTS
R ETURNS
Value of an attribute name in its current unit (like in the edit dialog seen). An
exception is thrown for invalid attribute names.
S EE ALSO
DataObject.SetAttribute(), DataObject.GetAttributeType()
Returns the description of an attribute.
str DataObject.GetAttributeDescription(str name,
int short = 0)
A RGUMENTS
short 0 Return long attribute description (default).

1 Return short attribute description.
R ETURNS
None For an invalid attribute name.
str Long or short attribute description.
S EE ALSO
DataObject.GetAttributeType(), DataObject.GetAttributeUnit()
GetAttributeLength
Returns the length of a vector or matrix attribute. The length of a matrix attribute is the number
of rows.
int DataObject.GetAttributeLength(str name)
A RGUMENTS
R ETURNS
>0 Length of a valid vector or matrix attribute.
0 All other valid attributes.
−1 For invalid attribute names.
52
S EE ALSO
DataObject.GetAttributeShape(), DataObject.SetAttributeLength(), DataObject.GetAttributeType()
GetAttributes
Gets the values of the transfer attributes defined via Application.DefineTransferAttributes().
list DataObject.GetAttributes()
R ETURNS
List of values for the defined transfer attributes. An exception is thrown for invalid attribute
names.
S EE ALSO
DataObject.SetAttributes(), Application.DefineTransferAttributes()
GetAttributeShape
Returns the shape of an attribute. The shape is a list of the form [number of rows, number of
colums].
[int rows,
int columns ] DataObject.GetAttributeShape(str name)
A RGUMENTS
R ETURNS
[≥ 0, ≥ 0 ] Shape of a valid vector or matrix attribute.
[0, 0 ] All other valid attributes.
[−1, 0 ] For invalid attribute names.
S EE ALSO
DataObject.GetAttributeLength(), DataObject.SetAttributeShape(), DataObject.GetAttributeType()
GetAttributeType
Returns the type of an attribute.
The following attribute types exist:
AttributeType.INVALID Attribute does not exist.
AttributeType.INTEGER Integer attribute.
AttributeType.INTEGER VEC Integer vector attribute.
AttributeType.DOUBLE Double attribute.
AttributeType.DOUBLE VEC Double vector attribute.
AttributeType.DOUBLE MAT Double matrix attribute.
AttributeType.OBJECT Data object attribute.
AttributeType.OBJECT VEC Data object vector attribute.
AttributeType.STRING String attribute.
AttributeType.STRING VEC String vector attribute.
AttributeType.INTEGER64 64-bit integer attribute.
AttributeType.INTEGER64 VEC 64-bit integer vector attribute.
53
AttributeType DataObject.GetAttributeType(str name)
A RGUMENTS
R ETURNS
The type of an attribute or AttributeType.INVALID for an invalid attribute name.
S EE ALSO
DataObject.GetAttribute(), DataObject.SetAttribute()
GetAttributeUnit
Returns the unit of an attribute e.g. km, MW. . . .
str DataObject.GetAttributeUnit(str name)
A RGUMENTS
R ETURNS
None For an invalid attribute name.
str Attribute unit.
S EE ALSO
DataObject.GetAttributeType(), DataObject.GetAttributeDescription()
GetChildren
This function returns the objects that are stored within the object the function was called on.
In contrast to DataObject.GetContents() this function gives access to objects that are currently
hidden due to scheme management.
list DataObject.GetChildren(int hiddenMode,
[str filter,]
[int subfolders])
A RGUMENTS
hiddenMode
Determines how hidden objects are handled.
0 Hidden objects are ignored. Only nonhidden objects are returned.
1 Hidden objects and nonhidden objects are returned.
2 Only hidden objects are returned. Nonhidden objects are ignored.
filter (optional)
Name filter, possibly containing '*' and '?' characters.
subfolder (optional)
Determines if children of subfolders are returned.
0 Only direct children are returned, children of subfolders are ignored
(Default).
1 Also children of subfolders are returned.
54
R ETURNS
Objects that are stored in the called object.
S EE ALSO
DataObject.GetContents()
GetClassName
Returns the class name of the object.
str DataObject.GetClassName()
R ETURNS
The class name of the object.
GetCombinedProjectSource
For an object in a combined project return the intermediate folder where the object is contained,
indicating the original source project.
DataObject DataObject.GetCombinedProjectSource()
R ETURNS
The intermediate folder for that object or nothing when not applicable.
GetConnectedElements
Returns the set of connected elements. Only electrically connected elements are returned when
the conditions of all switches are regarded. Possible connections will also be returned when rBrk
and/or rDis is zero, in the case of open breakers and/or disconnectors. The default values are
(0,0,0).
list DataObject.GetConnectedElements([int rBrk],
[int rDis],
[int rOut])
A RGUMENTS
rBrk (optional)
if 1, regards position of breakers
rDis (optional)
if 1, regards position of disconnectors
rOut (optional)
if 1, regards in-service or out-of-service status
R ETURNS
The set of connected elements.
55
GetConnectionCount
Returns the number of electrical connections.
int DataObject.GetConnectionCount()
R ETURNS
The number of electrical connections.
GetContents
Returns the objects that are stored in the object and whose name matches the argument name.
No object is returned if the object's container is empty, or if the object is not capable of storing
objects. The argument name may contain the complete name and classname, or parts of the
name with wildcard and class name.
list DataObject.GetContents([str Name,]
[int recursive])
A RGUMENTS
Name (optional)
loc name.class name, name possibly contains wildcards: '*' and '?' characters
recursive (optional)
1 All contained objects will be added recursively.
0 (default) Only direct children of current object will be collected.
R ETURNS
Objects that are stored in the object.
GetControlledNode
Returns the target terminal and the resulting target voltage for generators and other voltage
regulating units.
[DataObject node,
float targetVoltage] DataObject.GetControlledNode(int bus,
[int check])
A RGUMENTS
bus)
-1 currently controlled bus
0 HV bus
1 MV/ LV bus
2 LV bus
targetVoltage (out)
The target voltage of the voltage regulating unit in pu.
check (optional)
0 (default) Do not check if the control mode is set to voltage control.
1 Only return the controlled node if the control mode is set to voltage
control.
56
R ETURNS
Controlled node, None if no controlled terminal exists (or not voltage controlled if check=1)
GetCubicle
Returns the cubicle of an object at the connection with index n, or None if there is no cubicle
inside the object.
DataObject DataObject.GetCubicle(int side)
A RGUMENTS
side The connection number.
R ETURNS
The cubicle object or None.
GetFullName
Returns the full name of the object as a string.
str DataObject.GetFullName([int type])
A RGUMENTS
type(optional)
Is used to determine the format of the returned full name:
not given
No special formatting.
=0
The full name (complete database path including the name and class name)
of the object. It becomes a clickable link if printed to the output window.
> 0 (but less or equal to 190)
Formatted exactly to this length and also clickable if printed to the output
window.
R ETURNS
The fullname (complete database path including the name and class name) of the object.
GetImpedance
Returns the positive sequence impedance of an element referred to a given voltage.
[int error,
float real,
float imag] DataObject.GetImpedance(float refVoltage,
[int i3Trf])
A RGUMENTS
real (out) Real part of the impedance in Ohm.
imag (out)
Imaginary part of the impedance in Ohm.
57
refVoltage
Reference voltage for the impedance in kV.
i3Trf (optional)
When used with an ElmTr3
0 Return the HV-MV impedance.
1 Return the HV-LV impedance.
2 Return the MV-LV impedance.
R ETURNS
1 An error occurred.
0 Otherwise.
S EE ALSO
object.GetZeroImpedance()
GetInom
Returns the nominal current of the object at given bus index.
float DataObject.GetInom([int busIndex = 0],
[int inclChar = 0])
A RGUMENTS
busIndex (optional)
Bus index, default value is 0.
inclChar (optional)
option to consider thermal rating objects and values modified by characteristics
on the (de-)rating factor.
0 Not considering thermal rating objects or values modified by charac-
teristics on the (de-)rating factor (default).
1 Considering thermal rating objects and values modified by character-
istics on the (de-)rating factor.
2 Considering thermal rating objects but not values modified by charac-
teristics on the (de-)rating factor.
R ETURNS
The nominal current at bus index.
S EE ALSO
DataObject.GetUnom()
GetNode
Returns the node connected to the object at specified bus index.
DataObject DataObject.GetNode(int busIndex,
[int considerSwitches = 0])
58
A RGUMENTS
busIndex Bus index.
considerSwitches (optional)
0 Ignore the status of the switches (default).
1 Consider the status of the switches.
R ETURNS
object Connected node object at specified bus index.
None If no node at bus index is found.
GetOperator
Returns the element’s operator (ElmOperator ).
DataObject DataObject.GetOperator()
R ETURNS
Object of class ElmOperator determined according to following rules
• If operator is set in current object instance (attribute “pOperator”) this operator object is
retured.
• Else the operator inherited from its parent is used (recursively applied).
• None if none if its parents have an operator set.
GetOwner
Returns the elements’s owner (ElmOwner ).
DataObject DataObject.GetOwner()
R ETURNS
Object of class ElmOwner determined according to following rules
• If owner is set in current object instance (attribute “pOwner”) this owner object is retured.
• Else the owner inherited from its parent is used (recursively applied).
• None if none if its parents have an operator set.
GetParent
Returns the parent folder object (same as parameter ’fold id’).
DataObject DataObject.GetParent()
R ETURNS
DataObject The parent folder object.
None On the root database folder e.g. parent of a user.
59
S EE ALSO
DataObject.GetContents()
GetReferences
Returns a set containing all objects with references to the object the method was called on. By
default, references from IntSubset objects or hidden objects are ignored.
list DataObject.GetReferences([str filter = '*',]
[int includeSubsets = 0,]
[int includeHiddenObjects = 0])
A RGUMENTS
filter (optional)
Object filter to get only objects whose name matches this filter string, e.g. '*.ElmLne'.
(default: ’*’)
includeSubsets (optional)
Forces references from IntSubset objects to be evaluated. These are normally not
included for performance reasons. (default: 0)
includeHiddenObjects (optional)
Include also hidden objects. By default they are not included. In contrast hidden
objects are always included in the ’Reference List’ output of the data browser.
(default: 0)
R ETURNS
Set of objects with references to the object the method was called on.
GetRegion
All network components are internally associated with an artificial region. A region consists of
topologically connected elements. This means, two elements elm1 and elm2 are topologically
connected ⇔ elm1.GetRegion() == elm2.GetRegion().
A region is simply identified by a number that can be access via this function.
int DataObject.GetRegion()
R ETURNS
Region index >0. A value of ‘-1’ means status is unknown for that element (normally for not
topology relevant elements).
GetSupplyingSubstations
Returns the closest supplying substation(s) for a network component.
“Closest” means that there is no other supplying element of same type in topological path
between network component and the supplying component(s) returned by this function.
list DataObject.GetSupplyingSubstations()
R ETURNS
List of substations (objects of class ElmSubstat). Can be empty.
60
S EE ALSO
ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(),

ElmTrfstat.GetSuppliedElements(), DataObject.GetSupplyingTransformers(), DataObject.GetSupplyingTrfstations
GetSupplyingTransformers
Returns the closest supplying transformer(s) for a network component. “Closest” means that
there is no other supplying element of same type in topological path between network compo-
nent and the supplying component(s) returned by this function.
list DataObject.GetSupplyingTransformers()
R ETURNS
List of transformers (objects of class ElmTr2 or ElmTr3). Can be empty.
S EE ALSO

ElmTrfstat.GetSuppliedElements(), DataObject.GetSupplyingSubstations(), DataObject.GetSupplyingTrfstations()
GetSupplyingTrfstations
Returns the closest supplying transformer station(s) for a network component.
“Closest” means that there is no other supplying element of same type in topological path
between network component and the supplying component(s) returned by this function.
list DataObject.GetSupplyingTrfstations()
R ETURNS
List of transformer stations (objects of class ElmTrfstat). Can be empty.
S EE ALSO

ElmTrfstat.GetSuppliedElements(), DataObject.GetSupplyingTransformers(), DataObject.GetSupplyingSubstation
GetSystemGrounding
Returns the grounding type employed in the grounding area of the grid the object belongs to.
The grounding area is defined by network components separating the zero sequence system
(e.g. star-delta transformers).
int DataObject.GetSystemGrounding()
R ETURNS
-1 grounding type can not be determined
0 system is solidly grounded
1 system is compensated
2 system is isolated
61
GetUnom
Returns the nominal voltage of the object.
float DataObject.GetUnom([int busIndex = 0])
A RGUMENTS
busIndex (optional)
Bus index, default value is 0.
R ETURNS
The nominal voltage at bus index.
S EE ALSO
DataObject.GetInom()
GetZeroImpedance
Returns the zero sequence impedance of an element referred to a given voltage.
[int error,
float real,
float imag] DataObject.GetZeroImpedance(float refVoltage,
[int i3Trf])
A RGUMENTS
imag (out)
refVoltage
Reference voltage for the impedance in kV.
i3Trf (optional)
When used with an ElmTr3
0 Return the HV-MV impedance.

1 Return the HV-LV impedance.
2 Return the MV-LV impedance.
R ETURNS
0 Otherwise.
S EE ALSO
object.GetImpedance()
HasAttribute
Returns whether the given name is a currently valid attribute name.
int DataObject.HasAttribute(str name)
62
A RGUMENTS
R ETURNS
0 Given name is not a currently valid attribute name.
1 Given name is a currently valid attribute name.
S EE ALSO
DataObject.GetAttribute(), DataObject.SetAttribute()
HasResults
Checks if the object has calculated result parameters.
int DataObject.HasResults([int ibus])
A RGUMENTS
ibus (optional)
Bus index
-1(default) Checks if “c:” quantities exist

>= 0 Checks if 'm:xxxx:bus ' quantities exist for bus index=ibus
2 Hidden objects are returned
R ETURNS
0 no results available
1 results exist
IsCalcRelevant
Returns whether the object is relevant for calculation.
In contrast to Application.GetCalcRelevantObjects() it also returns 1 for objects in the active
study case e.g. simulation events (Evt*).
int DataObject.IsCalcRelevant()
R ETURNS
0 When the object is not used for calculations.
1 When the object is currently used for calculations.
S EE ALSO
Application.GetCalcRelevantObjects()
IsDeleted
Returns 1 if the object is deleted.
int DataObject.IsDeleted()
63
R ETURNS
1 Object is already deleted.
0 Object is not deleted.
IsEarthed
Checks if a network component is topologically connected to any earthed component. Earthing
components are terminals / busbars (ElmTerm) with attribute ‘iEarth’ = 1 and all closed ground-
ing switches (ElmGndswt). An energized component is never considered to be earthed.
int DataObject.IsEarthed()
R ETURNS
1 Component is earthed (connected to an earthing component)
0 Component is not earthed
IsEnergized
Checks if a network component is energized. A component is considered to be energized, if it is
topologically connected to a generator. All other elements are considered to be deenergized.
int DataObject.IsEnergized()
R ETURNS
1 Component is energized
0 Component is deenergized
-1 Component has no energizing status (status unknown)
IsHidden
Checks whether an object is hidden with respect to currently activated variation. An object is
hidden if it is
• deleted in currently active variation or

• added in a variation that is currently not active
int DataObject.IsHidden()
R ETURNS
0 not hidden, currently ’active’
1 hidden, currently ’inactive’
IsInFeeder
Checks if the object is part of the given feeder. A network element is considered being part of a
feeder if a topological path from the feeder definition to the element exists.
This function is based on load flow calculation results. Therefore, it can only be used after such
a calculation has been successfully executed and as long as the results are available.
int DataObject.IsInFeeder(DataObject Feeder,
[int OptNested=0])
64
A RGUMENTS
Feeder The Feeder definition object ElmFeeder
OptNested (optional
0 Nested feeders are not considered.
1 Nested feeders are considered.
R ETURNS
1 If “Feeder” is a feeder definition and the object is part of that feeder.
0 Otherwise
S EE ALSO
ElmFeeder.GetAll()
IsNetworkDataFolder
Checks whether given object is a special folder within a project that stores specific data ele-
ments. Each project can not have more than one instance per folder type.
The following folder types are distinguished (PowerFactory class names):
IntArea stores ElmArea objects

IntBbone stores ElmBbone and SetBbone objects
IntBmu stores ElmBmu objects
IntBoundary stores ElmBoundary objects
IntCircuit stores ElmCircuit objects

IntFeeder stores ElmFeeder objects
IntMeteostat stores ElmMeteostat objects
IntOperator stores ElmOperator objects
IntOwner stores ElmOwner objects

IntPath stores SetPath objects
IntRoute stores ElmRoute objects
IntScales stores Tri* objects
int DataObject.IsNetworkDataFolder()
R ETURNS
0 false, object is not a network data folder
1 true, object is a network data folder
S EE ALSO
Application.GetDataFolder()
65
IsNode
Indicates wtheter an object is a node (terminal or busbar).
int DataObject.IsNode()
R ETURNS
1 Object is a node.
0 Otherwise.
IsObjectActive
Check if an object is active for specific time.
int DataObject.IsObjectActive(int time)
A RGUMENTS
time Time in seconds since 01.01.1970 00:00:00.
R ETURNS
0 Object is not active (hidden or deleted).
1 Object is active.
IsObjectModifiedByVariation
Check if an object is active for specific time.
int DataObject.IsObjectModifiedByVariation(int considerADD, int considerDEL, int considerDELTA)
A RGUMENTS
considerADD
checks if an ADD-object exists
0 ignore ADD-objects
1 consider ADD-objects
considerDEL
check if a DELETE-Object exists or exist for the parent objects
0 ignore DELETE-objects
1 consider DELETE-objects
considerDELTA
check if a DELTA-Object exists
0 ignore DELTA-objects
1 consider DELTA-objects
R ETURNS
0 Object is not modified by an active variation
1 Object is modified by an active variation
66
Isolate
Performs an “isolate” action on the network element. This corresponds to performing a “switch
off” action followed by an additional earthing of switched off region.
The action is identical to that in the context menue.
[int error,
list changedSwitches] DataObject.Isolate([int resetRA,]
[int isolateCBs])
A RGUMENTS
set
resetRA (optional)
will cause the switching action to fail
isolateCBs (optional)
Determines if, in addition, circuit breakers should be isolated by opening its adja-
cent disconnectors (if not given, default will be taken from project settings)
0 No additional opening of disconnectors
1 Also open disconnectors adjacent to switched circuit breakers)
R ETURNS
0 Action was successful

1 Action failed
S EE ALSO
DataObject.SwitchOn(), DataObject.SwitchOff(), DataObject.Energize()
IsOutOfService
Indicates whether or not the object is currently out of service.
int DataObject.IsOutOfService()
R ETURNS
0 When the object is in service.
1 When the object is out of service.
IsReducible
Checks if object can be reduced during network reduction.
int DataObject.IsReducible()
67
R ETURNS
0 object can never be reduced.
1 object can be reduced (e.g. switch, zero-length lines)
2 in principle the object can be reduced, but not now (e.g. switch that is set to be
detailed)
IsShortCircuited
Returns whether an element is short-circuited or not.
int DataObject.IsShortCircuited()
R ETURNS
0 No short-circuit found.
1 Element is short-circuited.
MarkInGraphics
Marks the object in the diagram in which the element is found by hatch crossing it. By default
all the currently opened diagrams are searched for the element to mark beginning with the
diagram shown. The first diagram in which the element is found will be opened and the element
is marked.
Alternatively the search can be extended to all existing diagrams by passing 1 as parameter. If
the element exists in more than one diagram the user can select from a list of diagrams which
diagram shall be opened.
None DataObject.MarkInGraphics([int searchAllDiagramsAndSelect = 0])
A RGUMENTS
searchAllDiagramsAndSelect (optional)
Search can be extended to all diagrams, not only the ones which are currently
shown on the desktop.
0 Only search in currently opened diagrams and open the first diagram
in which the element was found. (default)
1 Searching all diagrams, not only the ones which are currently shown
on the desktop. If there is more than one occurrence the user will be
prompted which diagrams shall be opened.
R ETURNS
A diagram in which the element is drawn is opened and the element is marked.
Move
Moves an object or a set of objects to this folder.
int DataObject.Move(DataObject objectToMove)
int DataObject.Move(list objectsToMove)
68
A RGUMENTS
objectToMove
Object to move.
objectToMove
Set of objects to move.
R ETURNS
0 On success.
1 On error.
S EE ALSO
DataObject.AddCopy(), DataObject.PasteCopy(), Application.Delete()
PasteCopy
Pastes a copy of a single object or a set of objects to this object (= target object) using the
merge tool when source object(s) and target object are inside different projects (equivalent to a
manual copy&paste operation).
[int error,
DataObject newObject] DataObject.PasteCopy(DataObject objectToCopy,
[int resetMissingReferences = 0])
int DataObject.PasteCopy(list objectsToCopy)
A RGUMENTS
objectToCopy
Object to be copied.
objectsToCopy
Set of objects to copy.
newObject (out)
The new object copy of objectToCopy is assigned on success.
resetMissingReferences (optional)
Determines how to handle missing references.
0 No action is taken, the operation is cancelled with an error (default).
1 Missing references are automatically reset.
R ETURNS
0 Object(s) successfully copied.
1 Error.
S EE ALSO
DataObject.AddCopy(), DataObject.Move(), Application.Delete()
PurgeUnusedObjects
The function deletes the following child objects:
1. All 'hidden' objects without corresponding ”Add” object. These objects are only deleted, if
the condition is fulfilled for all child objects (hidden without corresponding 'Add' object).
69
2. All internal expansion stage objects with invalid target object (target object reference is
missing).
It’s crucial that there is no study case active when executing the function.
None DataObject.PurgeUnusedObjects()
S EE ALSO
DataObject.ReportUnusedObjects()
ReplaceNonAsciiCharacters
Replaces all non-ASCII characters in all text attributes by similar ASCII characters. Emits a
warning if a charcter can not replaced, because no replacement character was defined.
int DataObject.ReplaceNonAsciiCharacters(DataObject map,
str defaultReplacementCharacter)
A RGUMENTS
map IntMat object with two columns: the first column contains the codes of the non-
ASCII character, the second column contains the code of the ASCII character.
defaultReplacementCharacter
String containing one ASCII character. If map does not contain a replacement for
a non-ASCII character, it is replaced by defaultReplacementCharacter.
R ETURNS
Returns 1 when the function was executed successfully.
ReportNonAsciiCharacters
Reports all text attributes of this objects containing non-ASCII characters in the output window.
None DataObject.ReportNonAsciiCharacters()
ReportUnusedObjects
Prints a report in the PowerFactory output window, which object will be deleted when function
DataObject.PurgeUnusedObjects() is called. It’s crucial that there is no study case active when
executing the function.
None DataObject.ReportUnusedObjects()
S EE ALSO
DataObject.PurgeUnusedObjects()
SearchObject
Searches for an object with a full name, such as
'rootfolder.class\subfolder.class\...\locname.class '.
DataObject DataObject.SearchObject(str name)
70
A RGUMENTS
name string to search
R ETURNS
Returns the searched object.
S EE ALSO
DataObject.GetFullName()
SetAttribute
Sets the value of an attribute.
None DataObject.SetAttribute(str name,
int|float|str|DataObject|list value)
A RGUMENTS
value Value to be set in its current unit (like in the edit dialog seen). An exception is
thrown for invalid attribute names.
S EE ALSO
DataObject.GetAttribute(), DataObject.GetAttributeType()
SetAttributeLength
Sets the length of a vector or matrix attribute. The length of a matrix attribute is the number of
rows.
int DataObject.SetAttributeLength(str name, int length)
A RGUMENTS
length New length of the attribute.
R ETURNS
0 On success.
1 On error.
S EE ALSO
DataObject.SetAttributeShape(), DataObject.GetAttributeLength(), DataObject.GetAttributeType()
SetAttributes
Sets the values of the transfer attributes defined via Application.DefineTransferAttributes().
None DataObject.SetAttributes(list values)
71
A RGUMENTS
values Values to be set in its current unit (like in the edit dialog seen). The internal unit
can be used with Application.SetAttributeModeInternal(). An exception is thrown
for invalid attribute names or values.
S EE ALSO
Application.DefineTransferAttributes(), DataObject.GetAttributes()
SetAttributeShape
Sets the shape of a matrix or vector attribute. The shape is a list of the form [number of rows,
number of colums]. Number of colums has to be 0 for vectors.
int DataObject.SetAttributeShape(str name, list(int, int) shape)
A RGUMENTS
shape New shape of the attribute.
R ETURNS
0 On success.
1 On error.
S EE ALSO
DataObject.SetAttributeLength(), DataObject.GetAttributeShape(), DataObject.GetAttributeType()
ShowEditDialog
Opens the edit dialogue of the object. Command objects (such as ComLdf ) will have their
“Execute” button disabled. The execution of the running script will be halted until the edit
dialogue is closed again.
Editing of command objects (ComDPL, ComPython) is not supported.
int DataObject.ShowEditDialog()
R ETURNS
1 Edit dialogue was cancelled by the user.
0 Otherwise.
ShowModalSelectTree
Shows a modal window with the database object tree of the object on which the function is
called on.
DataObject DataObject.ShowModalSelectTree([str title,]
[str filter])
72
A RGUMENTS
title (optional)
Title of the dialog. If omitted, a default title will be used.
filter (optional)
Classname filter e.g. 'ElmLne' or 'Com*'. If set, a selection is only accepted if the
classname of the selected object matches that filter.
R ETURNS
DataObject Selected object.
None No object selcted e.g. 'Cancel' clicked.
SwitchOff
Performs a “switch off” action on the network element. This action is identical to that in the
context menue.
[int error,
list changedSwitches] DataObject.SwitchOff([int resetRA,]
[int simulateOnly])
A RGUMENTS
set
resetRA (optional)
simulateOnly (optional)
Can be used to get the switches that would be changed. No switching is performed
if set to ‘1’. (default is ’0’)
R ETURNS

1 Action failed
S EE ALSO
DataObject.SwitchOn(), DataObject.Isolate(), DataObject.Energize()
SwitchOn
Performs a “switch on” action on the network element. This action is identical to that in the
context menue.
73
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS
[int error,
list changedSwitches] DataObject.SwitchOn([int resetRA,]
[int simulateOnly])
A RGUMENTS
set
resetRA (optional)
simulateOnly (optional)
Can be used to get the switches that would be changed. No switching is performed
if set to ‘1’. (default is ’0’)
R ETURNS
Iinformation about the success of the action:

1 Action failed
S EE ALSO
DataObject.SwitchOff(), DataObject.Isolate(), DataObject.Energize()
WriteChangesToDb
See Application.WriteChangesToDb() for a detailed description.
None DataObject.WriteChangesToDb()
5.2 Network Elements
5.2.1 ElmArea
Overview
CalculateInterchangeTo
DefineBoundary
GetAll
GetBranches
GetBuses
GetObjs
74
Calculates interchange power to the given area (calculated quantities are: Pinter, Qinter, Pex-
port, Qexport, Pimort, Qimport). Prior the calculation the valid load flow calculation is required.
int ElmArea.CalculateInterchangeTo(DataObject area)
A RGUMENTS
area Area to which the interchange is calculated
R ETURNS
<0 Calculation error (i.e. no valid load flow, empty area...)
0 No interchange power to the given area
1 Interchange power calculated
DefineBoundary
Defines boundary with this area as interior part. Resulting cubicles of boundary are busbar-
oriented towards the area.
DataObject ElmArea.DefineBoundary(int shift)
A RGUMENTS
shift Elements outside the area that are within a distance of shift many elements to
a boundary cubicle of the area are added to the interior part of the resulting
boundary
R ETURNS
The defined boundary is returned in case of success. Otherwise NULL, if an error appeared
in the definition of the boundary.
GetAll
Returns all objects which belong to this area.
list ElmArea.GetAll()
R ETURNS
The set of contained objects.
GetBranches
Returns all branches which belong to this area.
list ElmArea.GetBranches()
R ETURNS
The set of branch objects.
75
GetBuses
Returns all buses which belong to this area.
list ElmArea.GetBuses()
R ETURNS
The set of objects.
GetObjs
Returns all objects of the given class which belong to this area.
list ElmArea.GetObjs(str classname)
A RGUMENTS
classname
Name of the class (i.e. ”ElmTr2”).
R ETURNS
The set of objects.
5.2.2 ElmAsm
Overview
CalcEfficiency
GetAvailableGenPower
GetElecTorque
GetGroundingImpedance
GetMechTorque
GetMotorStartingFlag
GetStepupTransformer
IsPQ
CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float ElmAsm.CalcEfficiency(float activePowerMW)
A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.
R ETURNS
Returns the resulting efficiency in p.u.
Returns the available power that can be dispatched from the generator, for the particular study
time.
76
For the case of conventional generators (no wind generation selected), the available power is
equal to the nominal power specified.
For wind generators, the available power will depend on the wind model specified:
• No Wind Model: No available power.

• Stochastic Wind Model: Given the specified mean wind speed, the available power is
calculated from the Power Curve. If the units of the Power Curve are in MW, the returned
value is directly the available power. In the other hand, if the units are in PU, the returned
value is multiplied by the nominal power of the generator to return the available power.
• Time Series Characteristics of Active Power Contribution: The available power is the
average of the power values (in MW) obtained from all the specified time characteristics
for the current study time.
• Time Series Characteristics of Wind Speed: The available power is calculated with the
average of the power values (in MW) calculated for all the specified time characteristics.
A power value for any time characteristic is calculated by obtaining the wind speed for the
current study time, and then calculating the power from the specified Power Curve. If the
units of the Power Curve are in MW, the returned value is directly the power value. In the
other hand, if the units are in PU, the returned value is multiplied by the nominal power of
the generator to return the power value.
For motors, the available power is zero.

float ElmAsm.GetAvailableGenPower()
R ETURNS
Available generation power
GetElecTorque
Calculates the electrical torque for a given speed and voltage.
float ElmAsm.GetElecTorque(float speed,
float uReal,
[float addZReal,]
[float addZImag]
)
A RGUMENTS
speed speed value in p.u.
uReal voltage value (real part) in p.u.
addZReal (optional)
additional impedance (real part) in p.u.
addZImag (optional)
additional impedance (imaginary part) in p.u.
R ETURNS
Returns the calculated electrical torque.
77
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmAsm.GetGroundingImpedance(int busIdx)
A RGUMENTS
busIdx Bus index where the grounding should be determined.
resistance (out)
Real part of the grounding impedance in Ohm.
reactance (out)
Imaginary part of the grounding impedance in Ohm.
R ETURNS
0 The values are invalid (e.g. because there is no internal grounding)
1 The values are valid.
GetMechTorque
Calculates the electrical torque for a given speed and voltage.
float ElmAsm.GetMechTorque(float speed,
float uReal
)
A RGUMENTS
speed speed value in p.u.
uReal voltage value (real part) in p.u.
R ETURNS
Returns the calculated mechanical torque.
Returns the starting motor condition.
int ElmAsm.GetMotorStartingFlag()
R ETURNS
Returns the motor starting condition. Possible values are:
-1 in the process of being calculated

0 not calculated
1 successful start
2 unsuccessful start
78
Performs a topological search to find the step-up transformer of the asynchronous machine.
DataObject ElmAsm.GetStepupTransformer(float Voltage,
int swStatus
)
A RGUMENTS
hvVoltage
voltage level at which the search will stop
ignSwtStatus
consideration of switch status. Possible values are:
0 consider all switch status

1 ignore breaker status
2 ignore all switch status
R ETURNS
Returns the first collected step-up transformer object. It is empty if not found (e.g. start
terminal already at hvVoltage).
IsPQ
Informs whether or not it is a ”PQ” machine (constant Q control mode).
int ElmAsm.IsPQ()
R ETURNS
Returns 1 if it is a ”PQ” machine.
5.2.3 ElmAsmsc
Overview
time.
79

float ElmAsmsc.GetAvailableGenPower()
R ETURNS
[int valid,
float resistance,
float reactance ] ElmAsmsc.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
Performs a topological search to find the step-up transformer of the asynchronous machine.
DataObject ElmAsmsc.GetStepupTransformer(float Voltage,
int swStatus
)
A RGUMENTS
hvVoltage
voltage level at which the search will stop
ignSwtStatus
consideration of switch status. Possible values are:
80

R ETURNS
5.2.4 ElmBbone
Overview
CheckBbPath
GetBbOrder
GetCompleteBbPath
GetFOR
GetMeanCs
GetMinCs
GetTieOpenPoint
GetTotLength
HasGnrlMod
CheckBbPath
Check whether the backbone object is still valid. This means:
a Terminals determining backbone path are still directly connected.

b One switch is open on the path of an inter-feeder backbone.
c Contents of backbone match specified starting-feeder (and end feeder).
d Start and end of feeder are calculation-relevant.
e Path is unique via the defined terminals (no parallel elements (only warning!)).
int ElmBbone.CheckBbPath(int outputMsg)
A RGUMENTS
outputMsg
1 Output resulting messages of check function.
0 Only check, no output of messages.
R ETURNS
0 Backbone is valid.
1 Backbone is invalid because of one or more of the above listed reasons.
GetBbOrder
Get order of backbone object, determined by backbone calculation according to the selected
criterion.
int ElmBbone.GetBbOrder()
81
R ETURNS
The order of the backbone object. The smaller the returned value, the better the backbone
according to chosen criterion. The order 1 is returned for the best backbone.
GetCompleteBbPath
Get the complete (ordered) path containing all terminals and connecting elements of the back-
bone.
list ElmBbone.GetCompleteBbPath(int iReverse,
[int iStopAtTieOpen = 0])
A RGUMENTS
AllElmsOnBb (out)
Ordered path containing all terminals and connecting elements of the backbone.
iReverse
0 Return ordered path from start feeder to end feeder
1 Return ordered path from end feeder to start feeder
iStopAtTieOpen
0 return complete path
1 only return part of path in start feeder (iReverse=0) / in end feeder
(iReverse=1)
GetFOR
Get aggregated forced outage rate (FOR) of all elements on the path of the backbone.
float ElmBbone.GetFOR()
R ETURNS
The aggregated forced outage rate (FOR) of all elements on the path of the backbone [in
1/a].
GetMeanCs
Get mean cross section value of all elements on the path of the backbone. Every cross section
value is weighted with the relative length corresponding to the total length of the backbone.
float ElmBbone.GetMeanCs()
R ETURNS
The mean cross section of the elements on the backbone path [in mm2].
GetMinCs
Get minimum cross section value of all elements on the path of the backbone. Optional: a set
with all elements on the backbone path featuring this cross section may be returned.
[float minCs,
set ElmsMinCs] ElmBbone.ElmBoundary.IsSplitting()
82
A RGUMENTS
ElmsMinCs
Elements on the backbone path featuring minimum cross section value.
R ETURNS
The minimum cross section of all elements on the backbone path [in mm2].
GetTieOpenPoint
Search and obtain the first open switching device (ElmCoup, StaSwitch) on the backbone path
(starting from the infeeding point of the starting feeder).
DataObject ElmBbone.GetTieOpenPoint()
R ETURNS
The switching device (ElmCoup or StaSwitch) or None if backbone is invalid.
GetTotLength
Get total lenth of all elements on the path of the backbone.
float ElmBbone.GetTotLength()
R ETURNS
The total length of the backbone path [in km].
HasGnrlMod
Check whether backbone object ElmBbone has a valid CalBbone where corresponding results
are stored. This is only the case after a backbone calculation by scoring method (until the
calculation is reset).
int ElmBbone.HasGnrlMod()
R ETURNS
1 ElmBbone has a calculation model,
0 no calculation model available.
5.2.5 ElmBmu
Overview
Apply
Update
Apply
Applies the power dispatch. Depending on the selected 'Distribution Mode ' this is done by a
built-in algorithm based on 'Merit Order' or by a user-defined DPL script that is stored in the
contents of the virtual power plant object.
83
int ElmBmu.Apply()
R ETURNS
0 on success, no error occurred
1 error during dispatch by virtual power plant. Please note, a value of 1 is also
returned in case the power plant is current set out-of-service.
Update
Updates the list of machines in the tables: 'Dispatchable Machines' and 'Non-dispatchable
(fixed) Machines'.
None ElmBmu.Update()
5.2.6 ElmBoundary
Overview
AddCubicle
CalcShiftedReversedBoundary
Clear
GetInterior
IsSplitting
Resize
Update
AddCubicle
Adds a given cubicle with given orientation to an existing boundary. The cubicle is added only if
it is not already contained within the boundary.
int ElmBoundary.AddCubicle(DataObject cubicle,
int orientation
)
R ETURNS
0 cubicle was successfully added
1 cubicle was not added because it is already contained (including given orienta-
tion)
CalcShiftedReversedBoundary
Defines boundary where exterior and interior part of this boundary are exchanged. Resulting
boundary cubicles are branch-oriented.
[int error,
DataObject boundary] ElmBoundary.CalcShiftedReversedBoundary(float shift)
A RGUMENTS
shift Elements that are within a distance of shift many elements to a boundary cubicle
of this boundary are added to the exterior part of the resulting boundary.
84
boundary (out)
Defined boundary.
R ETURNS
0 Successful call, boundary defined.
1 Error during determination of boundary cubicles.
Clear
Removes all boundary cubicles from an existing boundary.
None ElmBoundary.Clear()
GetInterior
Returns a set of all elements that are contained in the interior region of the boundary.
list ElmBoundary.GetInterior()
R ETURNS
Returns the set of interior elements.
IsSplitting
Checks if the boundary splits the network into two regions. A boundary is called splitting, if and
only if, for each boundary cubicle, the adjacent terminal and the adjacent branch component
belong to different sides of the boundary.
[int isSplitting,
list notSplittingCubicles] ElmBoundary.IsSplitting()
A RGUMENTS
notSplittingCubicles (optional, out)
All cubicles that prevent the boundary from being splitting are filled into this set.
R ETURNS
0 not splitting boundary
1 splitting boundary
Resize
Resizes the boundary cubicle vector or the cubicle orientation vector. It is strongly advised that
the size of both vectors must be the same.
None ElmBoundary.Resize(float size,
str name
)
A RGUMENTS
size size of the referenced vector (number of cubicles)
name reference to the vector (’iorient’ or ’cubicles’)
85
R ETURNS
If the resize is unsuccessful the error message shall be issued.
Update
Updates cached information (such as topological interiour). Required when boundary definition
was changed via DPL or Python.
None ElmBoundary.Update()
5.2.7 ElmBranch
Overview
Update
Update
Updates connection points and contained elements of the branch. If the branch element exter-
nally modified by the user, then the update shall refresh all connections in the correct manner.
Behaves same as the update button within the ElmBranch.
None ElmBranch.Update()
5.2.8 ElmCabsys
Overview
FitParams
GetLineCable
Update
FitParams
Calculates distributed parameters for cable system elements. Whether this function calculates
constant parameters or frequency dependent parameters depends on the user setting of the
parameter 'i model' in the ElmCabsys dialog. The settings are as follows: i model=0: constant
parameters; i model=1: frequency dependent parameters.
int ElmCabsys.FitParams()
R ETURNS
0 on success
1 on error
GetLineCable
Gets cable type for the corresponding line, within the cable system.
DataObject ElmCabsys.GetLineCable(int line)
86
A RGUMENTS
line Index of line.
R ETURNS
cable type On success.
None On error.
Update
Updates cable system element depending on configuration of the associated cable system
type.
int ElmCabsys.Update()
R ETURNS
1 On success.
0 On error.
5.2.9 ElmComp
Overview
SlotUpdate
SlotUpdate
Performs a slot update for the composite model, to try to reassign each model found in the
composite model contents to the corresponding slot.
None ElmComp.SlotUpdate()
D EPRECATED N AMES
Slotupd
5.2.10 ElmCoup
Overview
Close
GetRemoteBreakers
IsBreaker
IsClosed
IsOpen
Open
Close
Closes the switch by changing its status to ’close’. This action will fail if the status is currently
determined by an active running arrangement.
int ElmCoup.Close()
87
R ETURNS
0 On success
6= 0 On error
S EE ALSO
ElmCoup.Open()
GetRemoteBreakers
Returns the remote circuit breakers or connected bus bars.
This information is determined by a topological search that starts at given breaker in all direc-
tions, generally stopping at
• switches of type circuit breaker
• switches that are open

• busbars (ElmTerm::iUsage == 0)
If the search reaches a busbar while only reducible components have been passed (see DataOb-
ject.IsReducible()) it stops and returns the connected busbar (no breaker found). In case of
non-redubicle components have been passed, the search continues until next circuit breaker is
found. Only breakers with given breaker state are returned.
[list remoteBreakers,
list foundBreakers,
list foundBusbars ] ElmCoup.GetRemoteBreakers(int desiredBreakerState)
A RGUMENTS
desiredBreakerState
Only breakers with given status are collected.
-1 Return all remote circuit breakers

1 Return all closed remoted circuit breakers
0 Return all opened remoted circuit breakers
foundBreakers (out)
The list of the remote circuit breakers
foundBusbars (optional, out)

The list of the local bus bars
IsBreaker
Checks if type of current switch is ’circuit-breaker’.
int ElmCoup.IsBreaker()
R ETURNS
1 Switch is a circuit-breaker.
0 Switch is not a circuit-breaker.
88
IsClosed
Returns information about current switch state.
int ElmCoup.IsClosed()
R ETURNS
1 switch is closed
0 switch is open
S EE ALSO
ElmCoup.IsOpen()
IsOpen
int ElmCoup.IsOpen()
R ETURNS
1 switch is open
0 switch is closed
S EE ALSO
ElmCoup.IsClosed()
Open
Opens the switch by changing its status to ’open’. This action will fail if the status is currently
int ElmCoup.Open()
R ETURNS
0 On success
6= 0 On error
S EE ALSO
ElmCoup.Close()
5.2.11 ElmDsl
Overview
ExportToClipboard
ExportToFile
ExportToClipboard
Export the parameter list to clipboard.
None ElmDsl.ExportToClipboard([str colSeparator],
89
[int useLocalHeader]
)
A RGUMENTS
colSeparator (optional)
Separator between the columns (default: tab character).
useLocalHeader (optional)
Use the localised version of the header. Possible values are:
1 Yes (default).
0 No (use English language header).
ExportToFile
Export the parameter list to CSV file(s).
None ElmDsl.ExportToFile(str filePath,
[str colSeparator],
[int useLocalHeader]
)
A RGUMENTS
filePath Path of the CSV target file. In case of array and matrix parameters (names:
“array NAME” and “matrix NAME”), additional CSV files are created in the same
location with names obtained by appending “ array NAME” and “ matrix NAME”
to the target file name.
colSeparator (optional)
Separator between the columns (default: “;”).
useLocalHeader (optional)
Use the localised version of the header. Possible values are:
1 Yes (default).
0 No (use English language header).
5.2.12 ElmFeeder
Overview
CalcAggrVarsInRadFeed
GetAll
GetBranches
GetBuses
GetNodesBranches
GetObjs
CalcAggrVarsInRadFeed
Computes all the aggregated variables in radial feeders.
int ElmFeeder.CalcAggrVarsInRadFeed([int lookForRoot,]
[int considerNested])
90
A RGUMENTS
lookForRoot (optional)
Calculates the variables from the deepest root. Possible values are:
0 Start from this feeder
1 (default) Find the deepest root.
considerNested (optional)
Calculates the variables also for any nested subfeeders. Possible values are:
0 Ignore any nested feeders
1 (default) Consider nested feeders.
R ETURNS
Returns whether or not the aggregated variables were calculated. Possible values are:
0 error during calculation

1 calculated correctly
GetAll
Returns a set with all objects belonging to this feeder.
list ElmFeeder.GetAll([int iNested])
A RGUMENTS
iNested (optional)
Affects the collection of objects in case of nested feeders:
0 Only the objects of this feeder will be returned.
1 (default) All elements including those of nested feeders will be re-
turned.
R ETURNS
The set of network elements belonging to this feeder. Can be empty.
S EE ALSO
DataObject.IsInFeeder()
GetBranches
Returns a set with all branch elements belonging to this feeder.
list ElmFeeder.GetBranches([int iNested])
A RGUMENTS
iNested (optional)
turned.
91
R ETURNS
The set of bus and branch elements in feeder.
GetBuses
Returns a set with all buses belonging to this feeder.
list ElmFeeder.GetBuses([int iNested])
A RGUMENTS
iNested (optional)
turned.
R ETURNS
The set of bus elements in feeder.
GetNodesBranches
Returns a set with all buses and branches belonging to this feeder.
list ElmFeeder.GetNodesBranches([int iNested])
A RGUMENTS
iNested (optional)

turned.
R ETURNS
The set of bus and branch elements in feeder.
GetObjs
Returns a set with all objects of class 'ClassName' which belong to this feeder.
list ElmFeeder.GetObjs(str ClassName,
[int iNested])
A RGUMENTS
iNested (optional)
turned.
92
R ETURNS
The set of feeder objects.
5.2.13 ElmFile
Overview
LoadFile
SaveFile
LoadFile
(Re)Loads the file into a buffer.
int ElmFile.LoadFile([int loadComplete = 1])
A RGUMENTS
loadComplete (optional)
0 Removes all points in the future simulation time and adds all points
from the file (including the current interpolated value).
1 Clears the buffer and reloads the complete file (default).
R ETURNS
0 On success.
6= 0 On error.
SaveFile
Saves the buffer and overwrites the file.
int ElmFile.SaveFile()
R ETURNS
0 On success.
6= 0 On error.
5.2.14 ElmFilter
Overview
Returns the impedance of the internal grounding. Single phase filters connected to neutral
are considered as grounding devices themselves; i.e. instead of the dedicated grounding
parameters, the filters parameters are used.
[int valid,
float resistance,
93
float reactance ] ElmFilter.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
5.2.15 ElmGenstat
Overview
CalcEfficiency
Derate
Disconnect
IsConnected
Reconnect
ResetDerating
CalcEfficiency
float ElmGenstat.CalcEfficiency(float activePowerMW)
A RGUMENTS
activePowerMW
R ETURNS
Derate
Derates the value of the Max. Active Power Rating according to the specified value given in
MW.
The following formula is used: P max uc = P max uc − ”Deratingvalue”.
None ElmGenstat.Derate(float deratingP)
A RGUMENTS
deratingP Derating value
94
Disconnect
Disconnects a static generator by opening the first circuit breaker. The topological search
performed to find such a breaker, stops at any busbar.
int ElmGenstat.Disconnect()
R ETURNS
0 breaker already open or successfully opened
1 an error occurred (no breaker found, open action not possible (earthing / RA))
time.


float ElmGenstat.GetAvailableGenPower()
R ETURNS
[int valid,
float resistance,
float reactance ] ElmGenstat.GetGroundingImpedance(int busIdx)
95
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
Performs a topological search to find the step-up transformer of the static generator.
DataObject ElmGenstat.GetStepupTransformer(float voltage,
int swStatus
)
A RGUMENTS
voltage voltage level at which the search will stop
swStatus consideration of switch status. Possible values are:
R ETURNS
IsConnected
Checks if generator is topologically connected to any busbar.
int ElmGenstat.IsConnected()
R ETURNS
0 false, not connected to a busbar
1 true, generator is connected to a busbar
Reconnect
Connects a static generator by closing all switches (breakers and isolators) up to the first breaker
on the HV side of a transformer. The topological search to find all the switches, stops at any
busbar.
int ElmGenstat.Reconnect()
96
R ETURNS
0 the machine was successfully closed
1 a error occurred and the machine could not be connected to any busbar
ResetDerating
Resets the derating value, setting the Max. Active Power Rating according to the rating factor.
The following formula is used: P max uc = pmaxratf ∗ P n ∗ ngnum.
None ElmGenstat.ResetDerating()
5.2.16 ElmGndswt
Overview
Close
IsClosed
IsOpen
Open
Close
Closes the switch by changing its status to ’close’. If closed, the connected node will be
considered as being earthed.
int ElmGndswt.Close()
R ETURNS
1, always
S EE ALSO
ElmGndswt.Open()
Returns the impedance of the internal grounding. ElmGndswt is only considered to have an
internal grounding if it is single phase and connected to neutral.
[int valid,
float resistance,
float reactance ] ElmGndswt.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
97
R ETURNS
IsClosed
int ElmGndswt.IsClosed()
R ETURNS
1 switch is closed
0 switch is open
S EE ALSO
ElmGndswt.IsOpen()
IsOpen
int ElmGndswt.IsOpen()
R ETURNS
1 switch is open
0 switch is closed
S EE ALSO
ElmGndswt.IsClosed()
Open
Opens the switch by changing its status to ’open’.
int ElmGndswt.Open()
R ETURNS
0, always
S EE ALSO
ElmGndswt.Close()
98
5.2.17 ElmLne
Overview
AreDistParamsPossible
CreateFeederWithRoutes
FitParams
GetIthr
GetType
GetY0m
GetY1m
GetZ0m
GetZ1m
GetZmatDist
HasRoutes
HasRoutesOrSec
IsCable
IsNetCoupling
MeasureLength
SetDetailed
AreDistParamsPossible
Check if the line fulfils conditions for the calculation of distributed parameters:
ElmLne No routes, no sections

TypTow only 1 circuit x 3 phases
TypGeo only 1 circuit x 3 phases
TypLne AC system, 3 phases and 0 neutral

TypCabsys only 1 circuit x 3 phases
int ElmLne.AreDistParamsPossible()
R ETURNS
The returned value are:
0 All conditions fulfilled

1 Line contains routes
2 Line contains sections
3 Line has no type
4 TypTow/TypCabsys does not fulfil conditions for distributed paramters
5 TypLne does not fulfil conditions for distributed parameters
6 Short-circuit flag is set (EMT or RMS simulations)
7 TypLne/TypTow: B0 and B1 = 0
8 Error, no condition state could be determined
99
CreateFeederWithRoutes
Creates a new feeder in the line by splitting the line into 2 routes and inserting a terminal.
int ElmLne.CreateFeederWithRoutes(float dis,
float rem,
DataObject O)
int ElmLne.CreateFeederWithRoutes(float dis,
float rem,
DataObject O,
[int sw0,]
[int sw1])
A RGUMENTS
dis Inserting operation occurs after this distance
rem Remaining distance, percentage of distance ’dis’

O Branch object that is to be connected at the inserted terminal
sw0 If set to (1), switch is inserted on the first side
sw1 If set to (1), switch is inserted on the second side
R ETURNS
0 Success, feeders created
1 Error
FitParams
Calculates distributed parameters of the line element. Whether this function calculates constant
parameters or frequency dependent parameters depends on the user setting of the parameter
'i model' in the ElmLne dialogue. The settings are as follows: i model=0: constant parameters;
i model=1: frequency dependent parameters.
int ElmLne.FitParams([int isRMSModel = 0,]
[int modify = 1])
A RGUMENTS
isRMSModel
modify
R ETURNS
0 Success
1 Error
GetIthr
Returns the rated short-time current of the line element.
float ElmLne.GetIthr()
100
R ETURNS
Returns rated short-time current value
GetType
Returns the line type object.
DataObject ElmLne.GetType()
R ETURNS
The TypLne object if exists or None
GetY0m
The function returns the zero-sequence mutual coupling admittance (G0m, B0m) in Ohm of the
line and input argument line (object Lne2). When Lne2 = line, the function returns the zero-
sequence self admittance.
[int error,
float G0m,
float B0m ] ElmLne.GetY0m(DataObject Lne2)
A RGUMENTS
Lne2 Line element
G0m (out)
Resulting G0m value
B0m (out)
Resulting B0m value
R ETURNS
0 Success, data obtained
1 Error, e.g. no coupling objects defined
GetY1m
The function returns the positive-sequence mutual coupling admittance (G1m, B1m) in Ohm
of the line and input argument line (object Lne2). When Lne2 = line, the function returns the
positive-sequence self admittance.
[int error,
float G1m,
float B1m ] ElmLne.GetY1m (DataObject Lne2)
A RGUMENTS
Lne2 Line element
G1m (out)
Resulting G1m value
B1m (out)
Resulting B1m value
101
R ETURNS
GetZ0m
Gets the zero-sequence mutual coupling impedance (R0m, X0m) in Ohm of the line and input
argument line (object otherLine). When otherLine = line, the function returns the zero-sequence
self impedance.
[int error,
float R0m,
float X0m ] ElmLne.GetZ0m(DataObject otherLine)
A RGUMENTS
otherLine Line element
R0m (out)
To be obtained R0m value
X0m (out)
To be obtained X0m value
R ETURNS
GetZ1m
The function returns the positive-sequence mutual coupling impedance (R1m, X1m) in Ohm
of the line and input argument line (object Lne2). When Lne2 = line, the function returns the
positive-sequence self impedance.
[int error,
float R1m,
float X1m ] ElmLne.GetZ1m(DataObject Lne2)
A RGUMENTS
Lne2 Line element
R1m (out)
Resulting R1m value
X1m (out)
Resulting X1m value
R ETURNS
102
GetZmatDist
The function gets impedance matrix in phase domain (only amplitudes), for a line with distributed
parameters, short-circuit ended.
int ElmLne.GetZmatDist(float frequency,
int exact,
DataObject matrix)
A RGUMENTS
frequency
Frequency for which the calculation is carried out
exact 0: Approximated solution, 1: Exact solution for ‘frequency’
matrix Impedance matrix to be filled with the impedance amplitudes
R ETURNS
The returned value reports if the impedance matrix acquired:
1 Error, no matrix acquired

0 Success, matrix acquired
HasRoutes
Checks if the line is subdivided into routes.
int ElmLne.HasRoutes()
R ETURNS
0 When the line is a single line
1 When the line is subdivided into routes
HasRoutesOrSec
Checks if the line is subdivided into routes or sections.
int ElmLne.HasRoutesOrSec()
R ETURNS
0 When the line is a single line
1 When the line is subdivided into routes
2 When the line is subdivided into sections
IsCable
Checks if this line is a cable.
int ElmLne.IsCable()
103
R ETURNS
1 Line is a cable
0 Line is not a cable
IsNetCoupling
Checks if the line connects two grids.
int ElmLne.IsNetCoupling()
R ETURNS
The returned value reports if the line is a coupler:
1 The line is a coupler (connects two grids)

0 The line is not a coupler
MeasureLength
Measures the length of this line using the active diagram. For graphical measurement the active
diagram needs to have a scaling factor. Geographic diagrams by default have a scaling factor.
If iUseGraphic = 1, the line length is determined directly from the positions given in (latitude/lon-
gitude) considering the earth as a perfect sphere. In this case no graphic needs to be open.
float ElmLne.MeasureLength([int iUseGraphic])
A RGUMENTS
iUseGraphic (optional)
Use SGL diagram for calculation or not.
1 Use displayed diagram for calculation (default)
0 Calculate distance without diagram
R ETURNS
≥0 Returns the graphical length of this line in its current unit
<0 Error: E.g. when line is not represented in the active diagram and iUseGraphic=1
SetDetailed
The function can be used to prevent the automatically reduction of a line e.g. if the line is a line
dropper (length = 0). The function should be called when no calculation method is valid (before
first load flow). The internal flag is automatically reset after the first calculation is executed.
int ElmLne.SetDetailed()
5.2.18 ElmLnesec
Overview
IsCable
104
IsCable
Checks if this line section is a cable.
int ElmLnesec.IsCable()
R ETURNS
1 Line section is a cable
0 Line section is not a cable
-1 Error
5.2.19 ElmNec
Overview
[int valid,
float resistance,
float reactance ] ElmNec.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
5.2.20 ElmNet
Overview
Activate
Deactivate
DefineBoundary
Activate
Adds a grid to the active study case. Can only be applied if there are is no currently active
calculation (i.e. running contingency analysis).
int ElmNet.Activate()
105
R ETURNS
0 on success
1 on error
This function calculates the power flow from current grid to a connected grid. The values are
stored in current grid in the following attributes (values from the previous load flow calculation
are overwritten):
- Pinter: Active Power Flow
- Qinter: Reactive Power Flow

- ExportP: Export Active Power Flow
- ExportQ: Export Reactive Power Flow
- ImportP: Import Active Power Flow
- ImportQ: Import Reactive Power Flow
int ElmNet.CalculateInterchangeTo(DataObject net)
A RGUMENTS
net Connected grid
R ETURNS
<0 error
=0 grids are not connected, no interchange exists
>0 ok
Deactivate
Removes a grid from the active study case.Can only be applied if there are is no currently active
calculation.
int ElmNet.Deactivate()
R ETURNS
0 on success
1 on error
DefineBoundary
Defines boundary with this grid as interior part. Resulting cubicles of boundary are busbar-
oriented towards the grid.
DataObject ElmNet.DefineBoundary(int shift)
106
A RGUMENTS
shift Elements outside the grid that are within a distance of shift many elements to
a boundary cubicle of the grid are added to the interior part of the resulting
boundary
R ETURNS
5.2.21 ElmPvsys
Overview
CalcEfficiency
Derate
Disconnect
IsConnected
Reconnect
ResetDerating
CalcEfficiency
float ElmPvsys.CalcEfficiency(float activePowerMW)
A RGUMENTS
activePowerMW
R ETURNS
Derate
MW.
None ElmPvsys.Derate(float deratingP)
A RGUMENTS
Disconnect
Disconnects a PV system by opening the first circuit breaker. The topological search performed
to find such a breaker, stops at any busbar.
int ElmPvsys.Disconnect()
107
R ETURNS
time.


float ElmPvsys.GetAvailableGenPower()
R ETURNS
[int valid,
float resistance,
float reactance ] ElmPvsys.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
108
R ETURNS
IsConnected
Checks if a PV system is already connected to any busbar.
int ElmPvsys.IsConnected()
R ETURNS
Reconnect
Connects a PV system by closing all switches (breakers and isolators) up to the first breaker
busbar.
int ElmPvsys.Reconnect()
R ETURNS
ResetDerating
None ElmPvsys.ResetDerating()
5.2.22 ElmRelay
Overview
CheckRanges
GetCalcRX
GetMaxFdetectCalcI
GetSlot
GetUnom
IsStarted
SetImpedance
SetMaxI
SetMaxIearth
SetMinI
SetMinIearth
SetOutOfService
SetTime
SlotUpdate
109
CheckRanges
Checks the settings of all elements in the relay for range violations.
int ElmRelay.CheckRanges()
R ETURNS
0 All settings are valid.
1 At least one setting was forced into range.
-1 An error occurred.
GetCalcRX
Gets the calculated impedance from the polarising unit.
[int error,
float real,
float imag ] ElmRelay.GetCalcRX(int inSec,
int unit)
A RGUMENTS
inSec
0 Get the value in pri. Ohm.
1 Get the value in sec. Ohm.
unit
0 Get the value from Phase-Phase or Multifunctional polarizing.
1 Get the value from Phase-Earth or Multifunctional polarizing.
2 Get the value from Multifunctional polarizing
imag (out)
R ETURNS
0 No error occurred, the output is valid.
1 An error occurred, the output is invalid.
GetMaxFdetectCalcI
Get the current measured by the starting unit.
[int error,
float Iabs ] ElmRelay.GetMaxFdetectCalcI(int earth,
int unit
)
A RGUMENTS
Iabs (out) The measured current in A
earth
0 Get the phase current.
110
1 Get the earth current.
unit
0 Get the current in pri. A.
1 Get the current in sec. A.
R ETURNS
0 No error, output is valid.
1 An error occurred, the output is invalid.
GetSlot
Returns the element in the slot with the given name.
DataObject ElmRelay.GetSlot(str name,
[int iShowErr]
)
A RGUMENTS
name Exact name of the slot to search for (no wildcards).
iShowErr (optional)
0 Do not show error messages.
1 Show error messages if a slot is not found or empty.
R ETURNS
The object in the slot or None.
GetUnom
Returns the nominal voltage of the local bus of the relay.
float ElmRelay.GetUnom()
R ETURNS
The nominal voltage of the local bus of the relay in kV.
IsStarted
Checks if the starting unit detected a fault.
int ElmRelay.IsStarted()
R ETURNS
0 No fault was detected.
1 Fault was detected.
-1 An error occurred.
111
SetImpedance
Sets the the given impedance to the distance blocks matching the criteria.
int ElmRelay.SetImpedance(float real,
float imag,
int inSec,
int zone,
int unit
)
int ElmRelay.SetImpedance(float real,
float imag,
float lineAngle,
float Rarc,
int inSec,
int zone,
int unit
)
A RGUMENTS
real Real part of the impedance in Ohm.
imag Imaginary part of the impedance in Ohm.
inSec
0 The values are in pri. Ohm.
1 The values are in sec. Ohm.
zone Set the impedance for elments with this zone number.
unit
0 Set the impedance for Phase - Phase or Multifunctional elements.
1 Set the impedance for Phase - Earth or Multifunctional elements.
2 Set the impedance for Multifunctional elements.
A RGUMENTS
real Real part of the impedance in Ohm.
imag Imaginary part of the impedance in Ohm.
lineAngle The line angle in deg.
Rarc The arc resistance in Ohm.
inSec
0 The values are in pri. Ohm.
1 The values are in sec. Ohm.
zone Set the impedance for elments with this zone number.
unit
0 Set the impedance for Phase - Phase or Multifunctional elements.
1 Set the impedance for Phase - Earth or Multifunctional elements.
2 Set the impedance for Multifunctional elements.
R ETURNS
0 No error occurred.
1 An error occurred or no element was found.
112
SetMaxI
Sets the “Max. Phase Fault Current” of the relay to the currently measured value.
None ElmRelay.SetMaxI()
SetMaxIearth
Sets the “Max. Earth Fault Current” of the relay to the currently measured value.
None ElmRelay.SetMaxIearth()
SetMinI
Sets the “Min. Phase Fault Current” of the relay to the currently measured value.
None ElmRelay.SetMinI()
SetMinIearth
Sets the “Min. Earth Fault Current” of the relay to the currently measured value.
None ElmRelay.SetMinIearth()
SetOutOfService
Sets the “Out of Service” flag of elements contained in the relay.
int ElmRelay.SetOutOfService(int outServ,
int type,
int zone,
int unit
)
A RGUMENTS
outServ
0 Set elements in service.
1 Set Elements out of service.
type
1 Set the flag for overcurrent elements.
2 Set the flag for distance elements.
zone Set the flag for elments with this zone number (only when settings distance ele-
ments).
unit
0 Set the flag for Phase-Phase or Multifunctional elements.
1 Set the flag for Phase-Earth or Multifunctional elements.
2 Set the flag for Multifunctional elements.
113
R ETURNS
SetTime
Sets the tripping time for elements contained in the relay.
int ElmRelay.SetTime(int time,
int type,
int zone,
int unit
)
A RGUMENTS
time Time in s.
type
1 Set the time for overcurrent elements.
2 Set the time for distance elements.
zone Set the time for elments with this zone number (only when settings distance
elements).
unit
0 Set the time for Phase-Phase or Multifunctional elements.
1 Set the time for Phase-Earth or Multifunctional elements.
2 Set the time for Multifunctional elements.
R ETURNS
SlotUpdate
Triggers a slot update of the relay.
None ElmRelay.SlotUpdate()
D EPRECATED N AMES
slotupd
114
5.2.23 ElmRes
Overview
AddVariable
Clear
FindColumn
FindMaxInColumn
FindMaxOfVariableInRow
FindMinInColumn
FindMinOfVariableInRow
FinishWriting
Flush
GetDescription
GetFirstValidObject
GetFirstValidObjectVariable
GetFirstValidVariable
GetNextValidObject
GetNextValidObjectVariable
GetNextValidVariable
GetNumberOfColumns
GetNumberOfRows
GetObj
GetObject
GetObjectValue
GetRelCase
GetSubElmRes
GetUnit
GetValue
GetVariable
InitialiseWriting
Load
Release
SetAsDefault
SetObj
SetSubElmResKey
SortAccordingToColumn
Write
WriteDraw
AddVariable
Adds a variable to the list of monitored variables for the Result object.
None ElmRes.AddVariable(DataObject element,
str varname)
A RGUMENTS
element An object.
varname Variable name for object O.
D EPRECATED N AMES
AddVars
115
Clear
Clears all data (calculation results) written to the result file. The Variable definitions stored in
the contents of ElmRes are not modified.
int ElmRes.Clear()
R ETURNS
Always 0 and can be ignored.
FindColumn
Returns the index of the first header column matching the given object and/or variable name.
int ElmRes.FindColumn(DataObject obj,
[str varName]
)
[int startCol]
)
str varName
)
A RGUMENTS
obj (optional)
Object of matching column
varName (optional)
Variable name of matching column
startCol (optional)
Index of first checked column; Search starts at first column if colIndex is not given
R ETURNS
≥0 column index
<0 no valid column found
The index can be used in the ElmRes method GetData to retrieve the value of the column.
FindMaxInColumn
Find the maximum value of the variable in the given column.
[int row,
float value] ElmRes.FindMaxInColumn(int column)
A RGUMENTS
column The column index.
value (optional, out)
The maximum value found. The value is 0. in case that the maximum value was
not found.
116
R ETURNS
<0 The maximum value of column was not found.
≥0 The row with the maximum value of the column.
FindMaxOfVariableInRow
Find the maximum value for the given row and variable.
[int col,
float maxValue] ElmRes.FindMaxOfVariableInRow(str variable,
int row)
A RGUMENTS
variable The variable name
variable The row

maxValue (optional)
The corresponding maximum value.
R ETURNS
<0 There is no valid value of the corresponding variable in the row.
≥0 Column index of variable.
FindMinInColumn
Find the minimum value of the variable in the given column.
[int row,
float value] ElmRes.FindMinInColumn(int column)
A RGUMENTS
The minimum value found. The value is 0. in case that the minimum value was
not found.
R ETURNS
<0 The minimum value of column was not found.
≥0 The row with the minimum value of the column.
FindMinOfVariableInRow
Find the minimum value for the given row and variable.
[int col,
float minValue] ElmRes.FindMinOfVariableInRow(str variable,
int row)
117
A RGUMENTS
variable The variable name
variable The row
minValue (optional, out)
The corresponding minimum value.
R ETURNS
<0 There is no valid value of the corresponding variable in the row.
≥0 Column index of variable.
FinishWriting
Finishes the writing of values to a result file.
None ElmRes.FinishWriting()
D EPRECATED N AMES
Close
S EE ALSO
ElmRes.InitialiseWriting(), ElmRes.Write(), ElmRes.WriteDraw()
Flush
This function is required in scripts which perform both file writing and reading operations. While
writing to a results object (ElmRes), a small portion of this data is buffered in memory. This
is required for performance reasons. Therefore, all data must be written to the disk before
attempting to read the file. 'Flush' copies all data buffered in memory to the disk. After calling
'Flush'all data is available to be read from the file.
int ElmRes.Flush()
GetDescription
Get the description of a column.
str ElmRes.GetDescription([int column],
[int short]
)
A RGUMENTS
column (optional)
The column index. The description name of the default variable is returned if the
parameter is nor passed to the function.
short (optional)
0 long desc. (default)
1 short description
118
R ETURNS
Returns the description which is empty in case that the column index is not part of the data.
GetFirstValidObject
Gets the index of the column for the first valid variable in the given line. Starts at the beginning
of the given line and sets the internal iterator of the result file to the found position.
int ElmRes.GetFirstValidObject(int row,
[str classNames,]
[str variableName,]
[float limit,]
[float limit2,]
[int limitOperator2]
)
int ElmRes.GetFirstValidObject(int row,
list objects
)
A RGUMENTS
row Result file row
classNames (optional)
Comma separated list of class names for valid objects. The next object of one
of the given classes is searched. If not set all objects are considered as valid
(default).
variableName (optional)
Name of the limiting variable. The searched object must have this variable. If not
set variables are not considered (default).
limit (optional)
Limiting value for the variable.
limitOperator (optional)
Operator for checking the limiting value:
0 all values are valid (default)
1 valid values must be < limit
2 valid values must be ≤ limit
3 valid values must be > limit
4 valid values must be ≥ limit
limit2 (optional)
Second limiting value for the variable.
limitOperator2 (optional)
Operator for checking the second limiting value:
<0 first OR second criterion must match,
>0 first AND second criterion must match,
1/-1 valid values must be < limit2
2/-2 valid values must be ≤ limit2
119
3/-3 valid values must be > limit2

4/-4 valid values must be ≥ limit2
objects Valid objects
R ETURNS
≥0 column index
GetFirstValidObjectVariable
Gets the index of the first valid variable of the current object in the current line. Starts at the
internal iterator of the given result file and sets it to the position found.
int ElmRes.GetFirstValidObjectVariable([str variableNames])
A RGUMENTS
variableNames (optional)
Comma separated list of valid variable names. The next column with one of
the given variables is searched. If empty all variables of the current object are
considered as valid (default).
R ETURNS
≥0 column index
GetFirstValidVariable
Gets the index of the column for the first valid variable in the given line. Starts at the beginning
of the given line and sets the internal iterator of the result file to the found position.
int ElmRes.GetFirstValidVariable(int row,
[str variableNames]
)
A RGUMENTS
row Result file row
the given variables is searched. If not set all variables are considered as valid
(default).
R ETURNS
≥0 column index
GetNextValidObject
Gets the index of the column for the next valid variable (after current iterator) in the given line.
Sets the internal iterator of the result file to the position found.
120
int ElmRes.GetNextValidObject([str classNames,]

[str variableName,]
[float limit,]
[float limit2,]
[int limitOperator2]
)
int ElmRes.GetNextValidObject(list objects)
A RGUMENTS
row Result file row
classNames (optional)
Comma separated list of class names for valid objects. The next object of one
of the given classes is searched. If not set all objects are considered as valid
(default).
variableName (optional)
Name of the limiting variable. The searched object must have this variable. If not
set variables are not considered (default).
limit (optional)
Limiting value for the variable.
limitOperator (optional)
Operator for checking the limiting value:
1 valid values must be < limit
2 valid values must be ≤ limit
3 valid values must be > limit
4 valid values must be ≥ limit
limit2 (optional)
Second limiting value for the variable.
limitOperator2 (optional)
Operator for checking the second limiting value:
<0 first OR second criterion must match,
>0 first AND second criterion must match,
1/-1 valid values must be < limit2
2/-2 valid values must be ≤ limit2
3/-3 valid values must be > limit2
4/-4 valid values must be ≥ limit2
objects Valid objects
R ETURNS
≥0 column index
121
GetNextValidObjectVariable
Gets the index of the column for the next valid variable of the current object in the current line.
Starts at the internal iterator of the given result file and sets it to the found position.
int ElmRes.GetNextValidObjectVariable([str variableNames])
A RGUMENTS
(default).
R ETURNS
≥0 column index
GetNextValidVariable
Gets the index of the column for the next valid variable in the given line. Starts at the internal
iterator of the given line and sets the internal iterator of the result file to the found position.
int ElmRes.GetNextValidVariable([str variableNames])
A RGUMENTS
(default).
R ETURNS
≥0 column index
GetNumberOfColumns
Returns the number of variables (columns) in result file excluding the default variable (e.g. time
for time domain simulation).
int ElmRes.GetNumberOfColumns()
R ETURNS
Number of variables (columns) in result file.
GetNumberOfRows
Returns the number of values per column (rows) stored in result object.
int ElmRes.GetNumberOfRows()
122
R ETURNS
Returns the number of values per column stored in result object.
GetObj
Returns an object used in the result file. Positive index means objects for which parameters
are being monitored (i.e. column objects). Negative index means objects which occur in written
result rows as values.
DataObject ElmRes.GetObj(int index)
A RGUMENTS
index index of the object.
R ETURNS
The object found or None.
GetObject
Get object of given column.
DataObject ElmRes.GetObject([int column])
A RGUMENTS
col Column index. Object of default column is returned if col is not passed.
R ETURNS
The object of the variable stored in column ’column’.
GetObjectValue
Returns a value from a result object for row iX of curve col.
[int error,
DataObject o ] ElmRes.GetObjectValue(int iX,
[int col])
A RGUMENTS
o (out) The object retrieved from the data.
iX The row.
col (optional)
The curve number, which equals the variable or column number, first column value
(time,index, etc.) is returned when omitted.
R ETURNS
0 when ok
1 when iX out of bound
2 when col out of bound
123
3 when invalid value is returned from a sparse file. Sparse files are written e.g.
by the contingency analysis, the value is invalid in case that it was not written,
because it was below the recording limit. Result files created using DPL/Python
are always full and will not return invalid values.
GetRelCase
Get the contingency object for the given case number from the reliability result file.
DataObject ElmRes.GetRelCase(int caseNumber)
A RGUMENTS
caseNumber
The reliability case number
R ETURNS
Returns the contingency of case number. None is returned if there is no corresponding
contingency.
GetSubElmRes
Get sub-result file stored inside this.
DataObject ElmRes.GetSubElmRes(int value)
DataObject ElmRes.GetSubElmRes(DataObject obj)
A RGUMENTS
value The cnttime to look for
obj The pResElm to look for
R ETURNS
None The sub result file with value=cnttime (obj=pResElm) was not found.
any other value The sub result file with value=cnttime (obj=pResElm).
GetUnit
Get the unit of a column.
str ElmRes.GetUnit([int column])
A RGUMENTS
column (optional)
The column index. The unit of the default variable is returned if the parameter is
nor passed to the function.
R ETURNS
Returns the unit which is empty in case that the column index is not part of the data.
124
GetValue
[int error,
float d ] ElmRes.GetValue(int iX,
[int col])
A RGUMENTS
d (out) The value retrieved from the data.
iX The row.
col (optional)
R ETURNS
0 when ok
GetVariable
Get variable name of column
str ElmRes.GetVariable([int column])
A RGUMENTS
column (optional)
The column index. The variable name of the default variable is returned if the
R ETURNS
Returns the variable name which is empty in case that the column index is not part of the
data.
InitialiseWriting
Opens the result object for writing. This function must be called before writing data for result
files not stored in the script object. If arguments are passed to the function they specify the
variable name, unit... of the default variable (e.g. to be used by plots as x-axis).
int ElmRes.InitialiseWriting()
int ElmRes.InitialiseWriting(str variableName,
str unit,
str description,
[str shortDescription]
)
125
A RGUMENTS
variableName
The variable name for the default variable (e.g. “distance”)
unit The unit (e.g. “km”)
description
The description of the variable (e.g. “Distance from infeed”)
shortDescription
The short description (e.g. “Dist. Infeed”)
R ETURNS
Always 0 and can be ignored
D EPRECATED N AMES
Init
S EE ALSO
ElmRes.FinishWriting(), ElmRes.Write(), ElmRes.WriteDraw()
Load
Loads the data of a result object (ElmRes) in memory for reading.
None ElmRes.Load()
Release
Releases the data loaded to memory. This function should be used whenever several result
objects are processed in a loop. Data is always released from memory automatically after
execution of the current script.
None ElmRes.Release()
SetAsDefault
Sets this results object as the default results object. Plots using the default result file will use
this file for displaying data.
None ElmRes.SetAsDefault()
SetObj
Adds an object to the objects assigned to the result file
int ElmRes.SetObj(DataObject element)
A RGUMENTS
element Element to store in result file
126
R ETURNS
The index which can be used to retrieve the object from the results file. The index is < 0 if
no results are recorded for the given object (e.g. a contingency in reliability calculation). The
index is ≥ if variables are recorded for the object.
SetSubElmResKey
Assigns a value or an object to the according ElmRes parameter.
None ElmRes.SetSubElmResKey(int value)
None ElmRes.SetSubElmResKey(DataObject obj)
A RGUMENTS
value Value to be assigned to parameter cnttime of ElmRes
value Object to be assigned to parameter pResElm of ElmRes
Sorts all rows in the data loaded according to the given column. The ElmRes itself remains
unchanged.
int ElmRes.SortAccordingToColumn(int column)
A RGUMENTS
col The column number.
R ETURNS
0 The function executed correctly, the data was sorted correctly according to the
given column.
1 The column with index column does not exist.
Write
Writes the current results to the result object.
int ElmRes.Write([float defaultValue])
R ETURNS
0 on success
S EE ALSO
ElmRes.WriteDraw(), ElmRes.InitialiseWriting(), ElmRes.FinishWriting()
WriteDraw
Writes current results to the result objects and updates all plots that display values from the
result object.
int ElmRes.WriteDraw()
127
R ETURNS
0 on success
5.2.24 ElmShnt
Overview
Returns the impedance of the internal grounding. Single phase shunts connected to neutral
are considered as grounding devices themselves; i.e. instead of the dedicated grounding
parameters, the shunt parameters are used.
[int valid,
float resistance,
float reactance ] ElmShnt.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
5.2.25 ElmStactrl
Overview
GetControlledHVNode
GetControlledLVNode
Info
GetControlledHVNode
Returns the corresponding voltage controlled HV node for the machine at the specified index.
Switch status are always considered.
DataObject ElmStactrl.GetControlledHVNode([int index = 0])
A RGUMENTS
index (optional)
Index of machine (starting from 0 − . . . ). Default is 0.
128
R ETURNS
object Busbar/Terminal ()
None not found
GetControlledLVNode
Returns the corresponding voltage controlled LV node for the machine at specified index. Switch
status are always considered.
DataObject ElmStactrl.GetControlledLVNode(int index)
A RGUMENTS
index Index of machine (starting from 0 − . . . ).
R ETURNS
object Terminal ()
None not found
Performs a topological search to find the step-up transformer of the machine at the specified
index.
DataObject ElmStactrl.GetStepupTransformer([int index,]
[int iBrkMode]
)
A RGUMENTS
index Index of machine (starting from 0 − . . . ).
iBrkMode (optional)
0 (default) All switch status (open,close) are considered
1 Ignore breaker status (jump over open breakers)
2 Ignore all switch status (jump over open switches)
R ETURNS
object step-up transformer
None step-up transformer not found
Info
Prints the control information in the output window. It is the same information that the button
”Info” of the Station Control dialog prints.
int ElmStactrl.Info()
129
5.2.26 ElmSubstat
Overview
ApplyAndResetRA
GetSplit
GetSplitCal
GetSplitIndex
GetSuppliedElements
OverwriteRA
ResetRA
SaveAsRA
SetRA
ApplyAndResetRA
This function applies switch statuses of currently selected running arrangement to correspond-
ing switches and resets the running arrangement selection afterwards. Nothing happens if no
running arrangement is selected.
int ElmSubstat.ApplyAndResetRA()
R ETURNS
1 on success
0 otherwise, especially if no running arrangement is selected
GetSplit
A split of a station is a group of topologically connected elements. Such a group is called split
if all contained components are energized and there is at least one busbar (terminal of usage
'busbar') contained or it has connections to at least two main components (= all components
except switch devices and terminals).
These splits are ordered according to the count of nodes contained and according to their
priority. So each split becomes a unique index.
The function GetSplit offers access to the elements contained in a split. By calling GetSplit with
an index from 0 to n, the elements belonging to the corresponding split are filled into given sets
and returned.
[int error
list mainNodes,
list connectionCubicles,
list allElements ] ElmSubstat.GetSplit(int index)
A RGUMENTS
index Index of the split used to access the elements of the corresponding split. Value
must be ≥ 0.
mainNodes (out)
Terminals of same usage considered to form the most important nodes for that
group. In most cases, this is the group of contained busbars.
connectionCubicles (optional, out)
All cubicles (of terminals inside the station) that point to an element that sits out-
side the station or to an element that is connected to a terminal outside the station
are filled into the set connectionCubicles. (The connection element (branch) can
130
be accessed by calling GetBranch() on each of these cubicles. The terminals

of these cubicles (parents) must not necessarily be contained in any split. They
could also be separated by a disconnecting component.)
allElements(optional, out)
All elements (class Elm*) of the split that have no connection to elements outside
the station are filled into this set.
R ETURNS
0 success, split of that index exists and is returned.
1 indicates that there exists no split with given index. (Moreover, this means that
there is no split with index n greater than this value.)
S EE ALSO
ElmSubstat.GetSplitCal(), ElmSubstat.GetSplitIndex(),
GetSplitCal
This function determines the elements that belong to a split. In contrast to ElmSubstat.GetSplit()
it is based on calculation instead of pure edit object topology. This means the returned nodes
correspond to the calculation nodes, the interconnecting cubicles are those connecting nodes
of different splits.
Note: As this function relies on calculation nodes it can only be executed after a calculation has
been performed (e.g. load flow calculation).
[int error,
list nodes,
list elements ] ElmSubstat.GetSplitCal(int index)
A RGUMENTS
index Index of the split used to access the elements of the corresponding split. Refers
to same split as index in ElmSubstat.GetSplit().
Value must be ≥ 0.
nodes (out)
A set that is filled with terminals. There is one terminal returned for each calcula-
tion node in the split.

This set is filled with all cubicles that point from a calculation node of current split
to another calculation node that does not belong to that split. The connecting
element can be accessed by calling GetBranch() on such a cubicle.
elements (optional, out)
This set is filled with network elements that are connected to a calculation node of
current split and have exactly one connection, i.e. these elements are completely
contained in the split.
R ETURNS
131
S EE ALSO
ElmSubstat.GetSplit()
GetSplitIndex
This function returns the index of the split that contains passed object.
int ElmSubstat.GetSplitIndex(DataObject o)
A RGUMENTS
o Object for which the split index is to be determined.
R ETURNS
≥0 index of split in which element is contained
-1 given object does not belong to any split of that station
S EE ALSO
ElmSubstat.GetSplit()
GetSuppliedElements
Returns the network components that are supplied by the transformer (located in the station). A
network component is considered to be supplied by a transformer if a topological path from the
transformer to the component exists. A valid topological path in this sense is a path that starts
at the transformer’s HV side in direction of transformer (not in direction of HV connected node)
and stops at
• network components that are out of calculation,

• network components that are not active (e.g. hidden or those of currently inactive grids),
• open switches,
• connections leading to a higher voltage level.
Generally, all network components of such a path are considered to be supplied by the trans-
former.
Exceptions are components that are out of calculation or in-active. Those components are never
considered to be supplied by any transformer. A transformer is never considered to supply itself.
Composite components such as ElmBranch, ElmSubstat, ElmTrfstat are considered to be sup-
plied by a transformer if all energized components inside that composite are supplied by the
transformer.
list ElmSubstat.GetSuppliedElements([int inclNested])
A RGUMENTS
inclNested (optional)
0 Do not include components that are supplied by nested supplying sta-
tions
1 (default) Include components that are supplied by nested stations
132
S EE ALSO
ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements()
OverwriteRA
This function overwrites switch statuses stored in an existing running arrangement with actual
switch statuses of the substation. This is only possible if the substation has no running arrange-
ment selected and given running arrangement is valid for substation the method was called
on.
int ElmSubstat.OverwriteRA(DataObject ra)
A RGUMENTS
ra Given running arrangement
R ETURNS
1 If given running arrangement was successfully overwritten;
0 otherwise
ResetRA
This function resets the running arrangement selection for the substation it was called on.
None ElmSubstat.ResetRA()
SaveAsRA
When called on a substation that has no running arrangement selected, a new running ar-
rangement is created and all switch statuses of all running arrangement relevant switches (for
that substation) are saved in it. The running arrangement is stored in project folder ”Running
Arrangement” and its name is set to given locname. The new running arrangement is not
selected automatically.
(No new running arrangement is created if this method is called on a substation that has
currently a running arrangement selected).
DataObject ElmSubstat.SaveAsRA(str locname)
A RGUMENTS
locname Name of the new running arrangement (if name is already used, an increment
(postfix) is added to make it unique).
R ETURNS
Newly created 'IntRunarrange' object on success, otherwise None.
SetRA
This function sets the running arrangement selection for the substation it was called on. The
switch statuses are now determined by the values stored in the running arrangement.
int ElmSubstat.SetRA(DataObject ra)
133
A RGUMENTS
ra running arrangement that is valid for the substation
R ETURNS
1 If given running arrangement was successfully set;
0 otherwise (e.g. given ra is not valid for that substation)
5.2.27 ElmSvs
Overview
Performs a topological search to find the step-up transformer of the static VAR system.
DataObject ElmSvs.GetStepupTransformer(float voltage,
int swStatus
)
A RGUMENTS
R ETURNS
5.2.28 ElmSym
Overview
CalcEfficiency
Derate
Disconnect
IsConnected
Reconnect
ResetDerating
134
CalcEfficiency
float ElmSym.CalcEfficiency(float activePowerMW)
A RGUMENTS
activePowerMW
R ETURNS
Derate
MW.
None ElmSym.Derate(float deratingP)
A RGUMENTS
Disconnect
Disconnects a synchronous machine by opening the first circuit breaker. The topological search
int ElmSym.Disconnect()
R ETURNS
time.

135

float ElmSym.GetAvailableGenPower()
R ETURNS
[int valid,
float resistance,
float reactance ] ElmSym.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
Returns the starting motor condition.
int ElmSym.GetMotorStartingFlag()
R ETURNS
Returns the motor starting condition. Possible values are:
-1 in the process of being calculated

0 not calculated
1 successful start
2 unsuccessful start
136
Performs a topological search to find the step-up transformer of the synchronous machine.
DataObject ElmSym.GetStepupTransformer(float voltage,
int swStatus
)
A RGUMENTS
R ETURNS
IsConnected
Checks if a synchronous machine is already connected to any busbar.
int ElmSym.IsConnected()
R ETURNS
Reconnect
Connects a synchronous machine by closing all switches (breakers and isolators) up to the first
breaker on the HV side of a transformer. The topological search to find all the switches, stops
at any busbar.
int ElmSym.Reconnect()
R ETURNS
ResetDerating
None ElmSym.ResetDerating()
137
5.2.29 ElmTerm
Overview
GetBusType
GetCalcRelevantCubicles
GetConnectedBrkCubicles
GetConnectedCubicles
GetConnectedMainBuses
GetConnectionInfo
GetEquivalentTerminals
GetMinDistance
GetNextHVBus
GetNodeName
GetSepStationAreas
HasCreatedCalBus
IsElectrEquivalent
IsEquivalent
IsInternalNodeInStation
UpdateSubstationTerminals
GetBusType
Gets busbar calculation type.
int ElmTerm.GetBusType()
R ETURNS
0 No valid calculation (load flow).
1 PQ busbar.
2 PV busbar.
3 Slack busbar.
GetCalcRelevantCubicles
This function gets calculation relevant cubicles of this terminal.
list ElmTerm.GetCalcRelevantCubicles()
R ETURNS
Set of calculation relevant cubicles.
GetConnectedBrkCubicles
Function gets the set of cubicles connected with the breaker and this terminal.
list ElmTerm.GetConnectedBrkCubicles([int ignoreSwitchStates])
A RGUMENTS
ignoreSwitchStates (optional)
Ignore switch status flag 1 or not 0 (=default).
138
R ETURNS
Set of cubicles.
GetConnectedCubicles
Function gets the set of cubicles connected with this terminal.
list ElmTerm.GetConnectedCubicles([int ignoreSwitchStates])
A RGUMENTS
ignoreSwitchStates (optional)
Ignore switch status flag 1 or not 0 (=default).
R ETURNS
Set of cubicles.
GetConnectedMainBuses
Function gets the set of connected main buses.
list ElmTerm.GetConnectedMainBuses([int considerSwitches])
A RGUMENTS
Consider switch state (default 1).
R ETURNS
Set of main buses connected to the terminal.
GetConnectionInfo
Gets connection information of this terminal. Requires valid load flow calculation. Input argu-
ments are filled with the value after function call.
[int error,
float closedSwitches,
float allSwitches,
float nonSwitchingDevices,
float closedAndNonSwitchingDevices,
float allDevices,
float connectedNodes,
float mainNodes] ElmTerm.GetConnectionInfo()
A RGUMENTS
closedSwitches
Number of closed switch devices.
allSwitches
Number of total switch devices.
nonSwitchingDevices
Number of non-switch devices.
139
closedAndNonSwitchingDevices
Number of total closed and non-switch devices (closedSwitches+nonSwitchingDevices).
allDevices
Number of total switch and non-switch devices (allSwitches+nonSwitchingDevices).
connectedNodes
Number of total nodes connected via couplers.
mainNodes
Number of total main nodes.
R ETURNS
Return value is always 0 and has no meaning.
GetEquivalentTerminals
Returns a set of all terminals that are equivalent to current one. Euqivalent means that those
terminals are topologically connected only by
• closed switching devices (ElmCoup, RelFuse) or
• lines of zero length (line droppers).
list ElmTerm.GetEquivalentTerminals()
R ETURNS
All terminals that are equivalent to current one. Current one is also included so the set is
never empty.
S EE ALSO
ElmTerm.IsEquivalent()
GetMinDistance
This function determines the shortest path between the terminal the function was called on and
the terminal that was passed as first argument. The distance is determined on network topology
regarding the length of the traversed component (i.e. only lines have an influence on distance).
float ElmTerm.GetMinDistance(DataObject term)
[float minDistance,
list path ] ElmTerm.GetMinDistance(DataObject term,
[int considerSwitches,]
[list limitToNodes,]
[list elementsToIgnore,]
)
A RGUMENTS
term Terminal to which the shortest path is determined.
0 Traverse all components, ignore switch states
1 Do not traverse open switch devices (default)
140
path (optional, out)

If given, all components of the found shortest path are put into this set.
limitToNodes(optional)
If given, the shortest path is searched only within this set of nodes. Please note,
when limiting search to a given set of nodes, the start and end terminals (for which
the distance is determined) must be part of this set (otherwise distance =-1).
elementsToIgnore(optional)
If given, these objects (e.g. nodes) are ignored in the search and not traversed
(=considered as not existing).
R ETURNS
<0 If there is no path between the two terminals
≥0 Distance of shortest path in km
GetNextHVBus
This function returns the nearest connected busbar that has a higher voltage level. To detect
this bus, a breadth-first search on the net topology is executed. The traversal stops on each
element that is out of service and on each opened switch device. The criterion for higher voltage
level is passing a transformer to HV side. No junction nor internal nodes shall be considered.
Two winding transfomers with equal voltage on both sides are ignored (simply passed by the
search).
DataObject ElmTerm.GetNextHVBus()
R ETURNS
object First busbar found.
None If no busbar was found.
GetNodeName
For terminals inside a station, this function returns a unique name for the split the terminal is
located in. The name is built on first five characters of the station‘s short name plus the split
index separated by an underscore. E.g. “USTAT 1”.
For terminals inside a branch (ElmBranch) the returned name is just a concatenation of the
branch name and the terminal‘s name.
For all other terminals not inside a branch or a station the node name corresponds to the
terminal‘s name.
str ElmTerm.GetNodeName()
R ETURNS
Node name as described above. Never empty.
GetSepStationAreas
Function gets all separate areas within the substation linked to this terminal. In this manner,
area is any part between two nodes.
list ElmTerm.GetSepStationAreas([int considerSwitches])
141
A RGUMENTS
Consider switch state (default 1).
R ETURNS
Set of all separate areas in this substation.
HasCreatedCalBus
This function checks if the valid calculation exists for this terminal (i.e. load flow). If it exists,
then the calculation parameters could be retrieved.
int ElmTerm.HasCreatedCalBus()
R ETURNS
1 Valid calculation exists.
0 No valid calculation.
IsElectrEquivalent
Function checks if two terminals are electrically equivalent. Two terminals are said to be
electrically equivalent if they are topologically connected only by

• lines of zero length (line droppers) or
• branch components whose impedance is below given thresholds (R ≤ maxR and X ≤
maxX)
int ElmTerm.IsElectrEquivalent(DataObject terminal,

float maxR,
float maxX
)
A RGUMENTS
terminal Terminal to which the 'method called terminal' is connected to.
maxR Given threshold for the resistance of branch elements (must be given in Ohm).
maxX Given threshold for the reactance of branch elements (must be given in Ohm).
R ETURNS
1 If terminal on which the method was called is electrical equivalent to terminal that
was passed as argument
0 Otherwise
S EE ALSO
ElmTerm.IsEquivalent()
142
IsEquivalent
Function checks if two terminals are topologically connected only by
• lines of zero length (line droppers).
IsEquivalent defines a relation that is
• symmetric (Term1.IsEquivalent(Term2) -> Term2.IsEquivalent(Term1)),

• reflexive (Term1.IsEquivalent(Term1)) and
• transitive (Term1.IsEquivalent(Term2) and Term2.IsEquivalent(Term3) -> Term1.IsEquivalent(Term3));
int ElmTerm.IsEquivalent(DataObject terminal)
A RGUMENTS
terminal Terminal (object of class ElmTerm) that is checked to be equivalent to the terminal
on which the function was called on. Passing None is not allowed and will result
in a scripting error.
R ETURNS
1 If terminal on which the method was called is connected to terminal that was
passed as argument only by closed switching devices or by lines of zero length
0 Otherwise (terminals are not connected or connected by other components than
switching devices / lines of zero length)
S EE ALSO
ElmTerm.GetEquivalentTerminals() ElmTerm.IsElectrEquivalent()
IsInternalNodeInStation
Function checks if the terminal is an internal node located in a station (ElmSubstat, ElmTrfstat).
int ElmTerm.IsInternalNodeInSubStation()
R ETURNS
1 Terminal is a node of usage ‘internal’ and is located in a station.
0 Not internal node or not in a station, or both.
UpdateSubstationTerminals
Updates all nodes within the substation to the new voltage and/or phase technology. Applicable
for all busbars and junction nodes. The highest voltage is taken as the leading one.
None ElmTerm.UpdateSubstationTerminals(int volt,
int phs
)
143
A RGUMENTS
volt Updates nominal voltages (<> 0)
phs Updates phase technology (<> 0)
5.2.30 ElmTr2
Overview
CreateEvent
GetSuppliedElements
GetTapPhi
GetTapRatio
GetZ0pu
GetZpu
IsQuadBooster
NTap
CreateEvent
For the corresponding transformer, a Tap Event (EvtTap) is created for the simulation.
int ElmTr2.CreateEvent([int tapAction,]
[int tapPos]
)
A RGUMENTS
tapAction (optional)
0=increase tap; 1=decrease tap; 2=set tap to tapPos; 3=manual; 4=automatic
tapPos (optional)
Position of tap.
R ETURNS
0 on success
[int valid,
float resistance,
float reactance ] ElmTr2.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
144
R ETURNS
GetSuppliedElements
Returns the network components that are supplied by the transformer.
A network component is considered to be supplied by a transformer if a topological path from
the transformer to the component exists. A valid topological path in this sense is a path that
starts at the transformer's HV side in direction of transformer (not in direction of HV connected
node) and stops at

• open switches,
Generally all network components of such a path are considered to be supplied by the trans-
former. Exceptions are components that are out of calculation or in-active. Those components
are never considered to be supplied by any transformer.
A transformer is never considered to supply itself.
transformer.
list ElmTr2.GetSuppliedElements([int inclNested])
A RGUMENTS
0 Only include components which are directly supplied by the transformer
(not nested components)
1 Include nested components and components that are directly supplied
by the transformer (default)
S EE ALSO
ElmTr3.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(), ElmTrfstat.GetSuppliedElements()
GetTapPhi
Gets the tap phase shift in deg of the transformer for given tap position.
float ElmTr2.GetTapPhi(int itappos,
int inclPhaseShift
)
A RGUMENTS
itappos Tap position
inclPhaseShift
1 = Includes the vector group phase shift, 0 = consider only the tap phase shift
145
R ETURNS
Returns the tap phase shift angle of the transformer for given tap position
GetTapRatio
Gets the voltage ratio of the transformer for given tap position.
float ElmTr2.GetTapRatio(int itappos,
int onlyTapSide,
int includeNomRatio
)
A RGUMENTS
onlyTapSide
1 = ratio only for given side., 0 = total ratio
includeNomRatio
1 = Includes nominal ratio of the transformer, 0 = consider only tap ratio
R ETURNS
Returns the voltage ratio of the transformer for given tap position
GetZ0pu
Gets the zero-sequence impedance in p.u. of the transformer for the specified tap position. If
the tap position is out of the tap changer range, the respective min. or max. position will be
used.
[float r0pu,
float x0pu ] ElmTr2.GetZ0pu(int itappos,
int systembase)
A RGUMENTS
r0pu (out)
Resistance in p.u.
x0pu (out)
Reactance in p.u.
systembase
0 p.u. is based on rated power.
1 p.u. is based on system base (e.g. 100MVA).
GetZpu
Gets the impedance in p.u. of the transformer for the specified tap position. If the tap position is
out of the tap changer range, the respective min. or max. position will be used.
[float rpu,
float xpu ] ElmTr2.GetZpu(int itappos,
int systembase)
146
A RGUMENTS
rpu (out) Resistance in p.u.
xpu (out) Reactance in p.u.
systembase
IsQuadBooster
Returns whether transformer is a quadbooster; i.e. checks phase shift angle modulus 180◦ .
int ElmTr2.IsQuadBooster()
R ETURNS
'1' if quadbooster, else '0'
NTap
Gets the transformer tap position.
int ElmTr2.NTap()
R ETURNS
The tap position.
5.2.31 ElmTr3
Overview
CreateEvent
GetSuppliedElements
GetTapPhi
GetTapRatio
GetTapZDependentSide
GetZ0pu
GetZpu
IsQuadBooster
NTap
CreateEvent
None ElmTr3.CreateEvent([int tapAction = 2,]
[int tapPos = 0,]
[int busIdx = 0]
)
147
A RGUMENTS
tapPos (optional)
Position of tap.
busIdx (optional)
Bus index.
[int valid,
float resistance,
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
GetSuppliedElements
node) and stops at

• open switches,
transformer.
148
A RGUMENTS
S EE ALSO
GetTapPhi
Gets the tap phase shift in deg of the transformer for given tap position and side.
float ElmTr2.GetTapPhi(int iSide,
int itappos,
int inclPhaseShift
)
A RGUMENTS
iSide for tap at side (0=Hv, 1=Mv, 2=Lv)
itappos Tap position for corresponding side
inclPhaseShift
R ETURNS
Returns the tap phase shift angle of the transformer for given tap position and side
GetTapRatio
Gets the voltage ratio of the transformer for given tap position and side.
float ElmTr2.GetTapRatio(int iSide,
int itappos,
int includeNomRatio
)
A RGUMENTS
iSide for tap at side (0=Hv, 1=Mv, 2=Lv)
itappos Tap position at corresponding side
includeNomRatio
R ETURNS
Returns the voltage ratio of the transformer for given tap position and side
Get tap side used for the dependent impedance
int ElmTr3.GetTapZDependentSide()
149
R ETURNS
-1 if no tap dependent impedance is defined
0 for HV tap
1 for MV tap
2 for LV tap
GetZ0pu
used.
[float r0pu,
int iSide,
int systembase)
A RGUMENTS
itappos Tap position of the z-dependent tap
iSide
0 Get the HV-MV impedance.
1 Get the MV-LV impedance.
2 Get the LV-HV impedance.
r0pu (out)
Resistance in p.u.
x0pu (out)
Reactance in p.u.
systembase
GetZpu
[float rpu,
int iSide,
int systembase)
A RGUMENTS
iSide
0 Get the HV-MV impedance.
1 Get the MV-LV impedance.
2 Get the LV-HV impedance.
150

systembase
IsQuadBooster
Returns whether transformer is a quadbooster or not, i.e. checks phase shift angle modulus
180◦ .
R ETURNS
'1' if the transformer phase shift angle modulus 180◦ does not equal 0 at any of the sides LV,
MV, HV, else '0'
NTap
Gets the transformer tap position of a given bus.
int ElmTr3.NTap(int bus)
A RGUMENTS
bus 0=HV, 1=MV, 2=LV
R ETURNS
The tap position.
5.2.32 ElmTr4
Overview
CreateEvent
GetSuppliedElements
GetTapPhi
GetTapRatio
GetZ0pu
GetZpu
IsQuadBooster
NTap
CreateEvent
None ElmTr4.CreateEvent([int tapAction = 2,]
[int tapPos = 0,]
151
[int busIdx = 0]
)
A RGUMENTS
tapPos (optional)
Position of tap.
busIdx (optional)
Bus index.
[int valid,
float resistance,
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
GetSuppliedElements
node) and stops at

• open switches,
152

transformer.
A RGUMENTS
S EE ALSO
GetTapPhi
Gets the tap phase shift in deg of the transformer for given tap position and side.
float ElmTr4.GetTapPhi(int iSide,
int itappos,
int inclPhaseShift
)
A RGUMENTS
iSide for tap at side (0=HV, 1=LV1, 2=Lv2, 3=Lv3)
itappos Tap position for corresponding side

inclPhaseShift
R ETURNS
Returns the tap phase shift angle of the transformer for given tap position and side
GetTapRatio
Gets the voltage ratio of the transformer for given tap position and side.
float ElmTr4.GetTapRatio(int iSide,
int itappos,
int includeNomRatio
)
A RGUMENTS
iSide for tap at side (0=HV, 1=LV1, 2=Lv2, 3=Lv3)
itappos Tap position at corresponding side
includeNomRatio
153
R ETURNS
Returns the voltage ratio of the transformer for given tap position and side
Get tap side used for the dependent impedance
int ElmTr4.GetTapZDependentSide()
R ETURNS
-1 if no tap dependent impedance is defined
0 for HV tap
1 for LV1 tap
2 for LV2 tap
2 for LV3 tap
GetZ0pu
used.
[float r0pu,
int iSide,
int systembase)
A RGUMENTS
iSide
0 Get the HV-LV1 impedance.
3 Get the LV1-LV2 impedance.
r0pu (out)
Resistance in p.u.
x0pu (out)
Reactance in p.u.
systembase
154
GetZpu
[float rpu,
int iSide,
int systembase)
A RGUMENTS
iSide

systembase
IsQuadBooster
Returns whether transformer is a quadbooster or not, i.e. checks phase shift angle modulus
180◦ .
R ETURNS
'1' if the transformer phase shift angle modulus 180◦ does not equal 0 at any of the sides HV,
LV1, LV2, LV3, else '0'
NTap
Gets the transformer tap position.
int ElmTr4.NTap(float busIdx)
A RGUMENTS
busIdx 0=HV, 1=MV, 2=LV
155
R ETURNS
The tap position.
5.2.33 ElmTrfstat
Overview
GetSplit
GetSplitCal
GetSplitIndex
GetSuppliedElements
GetSplit
A split of a station is a group of topologically connected elements. Such a group is called split
if all contained components are energized and there is at least one busbar (terminal of usage
'busbar') contained or it has connections to at least two main components (= all components
except switch devices and terminals).
These splits are ordered according to the count of nodes contained and according to their
priority. So each split becomes a unique index.
The function GetSplit offers access to the elements contained in a split. By calling GetSplit with
an index from 0 to n, the elements belonging to the corresponding split are filled into given sets
and returned.
[int error
list mainNodes,
list allElements ] ElmTrfstat.GetSplit(int index)
A RGUMENTS
index Index of the split used to access the elements of the corresponding split. Value
must be ≥ 0.
mainNodes (out)
Terminals of same usage considered to form the most important nodes for that
group. In most cases, this is the group of contained busbars.
All cubicles (of terminals inside the station) that point to an element that sits out-
side the station or to an element that is connected to a terminal outside the station
are filled into the set connectionCubicles. (The connection element (branch) can
be accessed by calling GetBranch() on each of these cubicles. The terminals
of these cubicles (parents) must not necessarily be contained in any split. They
could also be separated by a disconnecting component.)
allElements(optional, out)
All elements (class Elm*) of the split that have no connection to elements outside
the station are filled into this set.
R ETURNS
156
S EE ALSO
ElmTrfstat.GetSplitCal(), ElmTrfstat.GetSplitIndex(),
GetSplitCal
This function determines the elements that belong to a split. In contrast to ElmTrfstat.GetSplit()
it is based on calculation instead of pure edit object topology. This means the returned nodes
correspond to the calculation nodes, the interconnecting cubicles are those connecting nodes
of different splits.
Note: As this function relies on calculation nodes it can only be executed after a calculation has
been performed (e.g. load flow calculation).
[int error,
list nodes,
list elements ] ElmTrfstat.GetSplitCal(int index)
A RGUMENTS
index Index of the split used to access the elements of the corresponding split. Refers
to same split as index in ElmTrfstat.GetSplit().
Value must be ≥ 0.
nodes (out)
A set that is filled with terminals. There is one terminal returned for each calcula-
tion node in the split.
This set is filled with all cubicles that point from a calculation node of current split
to another calculation node that does not belong to that split. The connecting
element can be accessed by calling GetBranch() on such a cubicle.
elements (optional, out)
This set is filled with network elements that are connected to a calculation node of
current split and have exactly one connection, i.e. these elements are completely
contained in the split.
R ETURNS
S EE ALSO
ElmTrfstat.GetSplit()
GetSplitIndex
This function returns the index of the split that contains passed object.
int ElmTrfstat.GetSplitIndex(DataObject o)
A RGUMENTS
o Object for which the split index is to be determined.
157
R ETURNS
≥0 index of split in which element is contained
-1 given object does not belong to any split of that station
S EE ALSO
ElmTrfstat.GetSplit()
GetSuppliedElements
Returns the network components that are supplied by the transformer (located in the station). A
network component is considered to be supplied by a transformer if a topological path from the
transformer to the component exists. A valid topological path in this sense is a path that starts
at the transformer’s HV side in direction of transformer (not in direction of HV connected node)
and stops at

• open switches,
Generally, all network components of such a path are considered to be supplied by the trans-
former.
Exceptions are components that are out of calculation or in-active. Those components are never
considered to be supplied by any transformer. A transformer is never considered to supply itself.
transformer.
list ElmTrfstat.GetSuppliedElements([int inclNested])
A RGUMENTS
0 Do not include components that are supplied by nested supplying sta-
tions
1 (default) Include components that are supplied by nested stations
S EE ALSO
ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements()
5.2.34 ElmVac
Overview
158
Returns the impedance of the internal grounding. Single phase voltage source connected to
neutral are considered as grounding devices themselves; i.e. instead of the dedicated grounding
parameters, the R1,X1 parameters are used.
[int valid,
float resistance,
float reactance ] ElmVac.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
5.2.35 ElmVoltreg
Overview
CreateEvent
GetZpu
NTap
CreateEvent
For the corresponding voltage regulator, a Tap Event (EvtTap) is created for the simulation.
None ElmVoltreg.CreateEvent([int tapAction = 2,]
[float tapPos = 0]
)
A RGUMENTS
tapPos (optional)
Position of tap
[int valid,
float resistance,
float reactance ] ElmVoltreg.GetGroundingImpedance(int busIdx)
159
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
GetZpu
Gets the impedance in p.u. of the voltage regulator for the specified tap position. If the tap
position is out of the tap changer range, the respective min. or max. position will be used.
[float rpu,
float xpu ] ElmVoltreg.GetZpu(int itappos,
int systembase)
A RGUMENTS
systembase
NTap
Gets the voltage regulator tap position.
int ElmVoltreg.NTap(int tap)
A RGUMENTS
tap 0=Tap 1, 1=Tap 2, 2=Tap 3
R ETURNS
The tap position.
5.2.36 ElmXnet
Overview
CalcEfficiency
Disconnect
160
Reconnect
CalcEfficiency
float ElmXnet.CalcEfficiency(float activePowerMW)
A RGUMENTS
activePowerMW
R ETURNS
Disconnect
Disconnects a static generator by opening the first circuit breaker. The topological search
int ElmXnet.Disconnect()
R ETURNS
[int valid,
float resistance,
float reactance ] ElmXnet.GetGroundingImpedance(int busIdx)
A RGUMENTS
resistance (out)
reactance (out)
R ETURNS
Performs a topological search to find the step-up transformer of an external grid
DataObject ElmXnet.GetStepupTransformer(float voltage,
int swStatus
)
161
A RGUMENTS
R ETURNS
Reconnect
Connects a static generator by closing all switches (breakers and isolators) up to the first breaker
busbar.
int ElmXnet.Reconnect()
R ETURNS
5.2.37 ElmZone
Overview
DefineBoundary
GetAll
GetBranches
GetBuses
GetObjs
SetLoadScaleAbsolute
Calculates interchange power to the given zone (calculated quantities are: Pinter, Qinter, Pex-
port, Qexport, Pimort, Qimport). Prior the calculation the valid load flow calculation is required.
int ElmZone.CalculateInterchangeTo(DataObject zone)
A RGUMENTS
zone zone to which the interchange is calculated
R ETURNS
<0 calculation error (i.e. no valid load flow, empty zone...)
0 no interchange power to the given zone
1 interchange power calculated
162
DefineBoundary
Defines boundary with this zone as interior part. Resulting cubicles of boundary are busbar-
oriented towards the zone.
DataObject ElmZone.DefineBoundary(int shift)
A RGUMENTS
shift Elements outside the zone that are within a distance of shift many elements to
a boundary cubicle of the zone are added to the interior part of the resulting
boundary
R ETURNS
GetAll
Returns all objects which belong to this zone.
list ElmZone.GetAll()
R ETURNS
The set of objects.
GetBranches
Returns all branches which belong to this zone.
list ElmZone.GetBranches()
R ETURNS
The set of branch objects.
GetBuses
Returns all buses which belong to this zone.
list ElmZone.GetBuses()
R ETURNS
The set of objects.
GetObjs
Returns all objects of the given class which belong to this zone.
list ElmZone.GetObjs(str classname)
A RGUMENTS
classname
name of the class (i.e. ”ElmTr2”)
163
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS
R ETURNS
The set of contained objects.
SetLoadScaleAbsolute
Readjusts zonal load scaling factor to the given active power. The zonal load scaling factor is
the ratio of the given active power and the loads total actual power.
None ElmZone.SetLoadScaleAbsolute(float Pin)
A RGUMENTS
Pin active power in MW used for the load scaling factor.
5.3 Station Elements
5.3.1 StaCt
Overview
SetPrimaryTap
SetPrimaryTap
Determines the best matching primary tap for the connected branch, so that IN om,Branch ·
mltF actor ≤ IP ri. If no tap satisfies the equation, the largest tap is used.
int StaCt.SetPrimaryTap([float mltFactor])
A RGUMENTS
mltFactor (optional)
Multiplication factor (default 1.0)
R ETURNS
0 Correctly set.
1 Error.
5.3.2 StaCubic
Overview
GetAll
GetBranch
GetConnectedMajorNodes
GetConnections
GetNearestBusbars
GetPathToNearestBusbar
IsClosed
IsConnected
164
GetAll
This function returns a set of network components that are collected by a topological traversal
starting from this cubicle.
list StaCubic.GetAll([int direction = 1,]
[int ignoreOpenSwitches = 0]
)
A RGUMENTS
direction (optional)
Specifies the direction in which the network topology is traversed.
1 Traversal to the branch element (default).
0 Traversal to the terminal element.
ignoreOpenSwitches (optional)
Determines whether to pass open switches or to stop at them.
0 The traversal stops in a direction if an open switch is reached (default).
1 Ignore all switch statuses and pass every switch.
R ETURNS
A set of network components that are collected by a topological traversal starting at the
cubicle (StaCubic) where the function is called.
GetBranch
Function gets the branch of this cubicle.
DataObject StaCubic.GetBranch()
R ETURNS
Branch object.
GetConnectedMajorNodes
This function returns all busbars being part of a split (inside a station) that can be reached by
starting a topology search from the cubicle in direction of the branch element.
list StaCubic.GetConnectedMajorNodes ([float swtStat])
A RGUMENTS
swtStat
0 (default) First perform a search that respects switch states (stoping at open
switches). If no switches are found, an additional search with ignoring
switch states.
1 Perform one search ignoring switch states (passing open and closed
switches).
2 Search with respecting switch states. But do no additional search when
switch is found.
165
R ETURNS
A set of all busbars that can be reached starting a topology search from the cubicle in
direction of the branch element.
GetConnections
Function gets all elements connected with this cubicle.
list StaCubic.GetConnections(int swtStat)
A RGUMENTS
swtStat Consider switch status (1) or not (0).
R ETURNS
Set of elements.
GetNearestBusbars
Function searches for connected and connectable nearest busbars starting at the cubicle.
Search stops at the nearest busbars and out of service elements. Internal and junction nodes,
all types of branch elements and all types of switches - i.e. circuit breakers and disconnectors -
are passed.
Connected busbars are all busbars which are topologically connected to the start cubicle without
passing open switches. Connectable busbars are all busbars which are connectable to the start
cubicle by closing switches. If the start cubicles terminal is a busbar then this busbar is not
included in the result sets.
If more than one path exists between cubicle and a nearest busbar the relevant busbar is added
only once to the result set.
[list connectedBusbars,
list connectableBusbars] StaCubic.GetNearestBusbars(int searchDirection, [int excludeZPUs])
A RGUMENTS
connectedBusbars (out)
Found connected busbars.
connectableBusbars (out)
Found connectable busbars.
searchDirection
Direction of the search relative to the cubicle. Possible values are
0 search in all directions
1 search in direction of cubicles terminal
2 search towards connected branch element
excludeZPUs (optional)
Whether ZPU (ElmZpu) should be ignored in the search. Default=0.
166
GetPathToNearestBusbar
Function determines the path from the cubicle to the given busbar. The busbar must be
connected or connectable to the start cubicle without passing additional busbars. If the given
busbar is not a nearest busbar in relation to the cubicle an empty path is returned.
If more than one closed path exists between cubicle and busbar the elements of all these paths
are combined.
list StaCubic.GetPathToNearestBusbar(DataObject nearestBusbar, [int excludeZPUs])
A RGUMENTS
nearestBusbar
Nearest busbar in relation to cubicle.
excludeZPUs (optional)
Whether ZPU (ElmZpu) should be ignored in the search. Default=0.
R ETURNS
Net elements of the path from cubicle to busbar.
IsClosed
Function checks if this cubicle is directly connected with the busbar, considering the switch
status.
int StaCubic.IsClosed()
R ETURNS
0 Disconnected cubicle.
1 Connected cubicle.
IsConnected
Function checks if the cubicle is connected to the passed terminal or coupler.
int StaCubic.IsConnected(DataObject elm,
int swtStat
)
A RGUMENTS
elm Terminal or coupler to check connection with.
swtStat Consider switch status (1) or not (0).
R ETURNS
0 Not connected.
1 Connected.
167
5.3.3 StaExtbrkmea
Overview
CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtbrkmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for the switch position currently stored in the measurement object.
[int error,
float value] StaExtbrkmea.GetMeaValue()
A RGUMENTS
value (out)
Value for switch status.
R ETURNS
Return value has no meaning. It is always 0.
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtbrk-
mea.SetStatus() for details on the status bits.
int StaExtbrkmea.GetStatuts()
R ETURNS
Status bitfield as an integer value.
168
GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtbrkmea.SetStatus() for details on the status bits.
int StaExtbrkmea.GetStatusTmp()
R ETURNS
InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtbrkmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtbrkmea.SetStatus() for details
on the status bits.
int StaExtbrkmea.IsStatusBitSet(int mask)
R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtbrk-
int StaExtbrkmea.IsStatusBitSetTmp(int mask)
R ETURNS
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtbrkmea.SetStatus() for details on the status
bits.
None StaExtbrkmea.ResetStatusBit(int mask, int dbSync)
169
A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtbrkmea.SetStatus()
for details on the status bits.
None StaExtbrkmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
Sets the value for the switch position currently stored in the measurement object.
int StaExtbrkmea.SetMeaValue(int value)
A RGUMENTS
value New value for switch status.
R ETURNS
SetMeaValue
Sets the value stored in the measurement object.
int StaExtbrkmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus
Sets the status flags of the measurement object. Please note, this value is interpreted as
a bitfield where the bits have the following meaning. An option is considered enabled if the
corresponding bit is set to 1.
bit0 0x00000001 Manually entered data
170
bit1 0x00000002 Tele-Measurement
bit2 0x00000004 Disturbance

bit3 0x00000008 Protection
bit4 0x00000010 Marked suspect
bit5 0x00000020 Violated constraint
bit6 0x00000040 On Event

bit7 0x00000080 Event Block.
bit8 0x00000100 Alarm Block.
bit9 0x00000200 Update Block.
bit10 0x00000400 Control Block.

bit29 0x20000000 Read
bit30 0x40000000 Write
bit31 0x80000000 Neglected by SE
None StaExtbrkmea.SetStatus(int status, int dbSync)
A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtbrkmea.SetStatus() for details on the status
bits.
None StaExtbrkmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtbrkmea.SetStatus()
None StaExtbrkmea.SetStatusBitTmp(int mask)
171
A RGUMENTS
SetStatusTmp
Sets the temporary (in memory) status flags of the measurement object. This temporary value
is used during calculations so that changes do not lead to object modifications and initial value
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtbrkmea.SetStatus() for details on
the status bits.
None StaExtbrkmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtbrkmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
0 Value is copied in memory only
1 Default, copied value is stored on db (persistent)
R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name
UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
int StaExtbrkmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
172
R ETURNS
0 on success
5.3.4 StaExtcmdmea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtcmdmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for command interpreted as floating point value.
[int error,
float value] StaExtcmdmea.GetMeaValue()
A RGUMENTS
value (out)
Value obtained by parsing stored command string as floating point value.
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtcmd-
int StaExtcmdmea.GetStatuts()
173
R ETURNS
GetStatusTmp
bitfield. See StaExtcmdmea.SetStatus() for details on the status bits.
int StaExtcmdmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtcmdmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtcmdmea.SetStatus() for details
on the status bits.
int StaExtcmdmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtcmd-
int StaExtcmdmea.IsStatusBitSetTmp(int mask)
R ETURNS
174
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtcmdmea.SetStatus() for details on the
status bits.
None StaExtcmdmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtcmdmea.SetStatus()
None StaExtcmdmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtcmdmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

175

bit29 0x20000000 Read

None StaExtcmdmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtcmdmea.SetStatus() for details on the status
bits.
None StaExtcmdmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtcmdmea.SetStatus()
None StaExtcmdmea.SetStatusBitTmp(int mask)
A RGUMENTS
176
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtcmdmea.SetStatus() for details on
the status bits.
None StaExtcmdmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtcmdmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtcmdmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
177
5.3.5 StaExtdatmea
Overview
CreateEvent
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtdatmea.CopyExtMeaStatusToStatusTmp()
CreateEvent
Creates a “parameter change” event for controller object (’pCtrl’) and attribute (’varName’). The
event is stored in simulation event list and executed immediately.
None StaExtdatmea.CreateEvent()
GetMeaValue
Returns the value stored in the measurement object.
[int error,
float value] StaExtdatmea.GetMeaValue(int unused,
int applyMultiplicator)
A RGUMENTS
value (out)
Value, optionally modified by configured multiplicator
unused Not used.

applyMultiplicator
If 1 (default), returned value will be modified by the multiplicator stored in the
measurement object (depending on Mode incremental/absolute). If 0, raw value
will be returned.
178
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtdat-
int StaExtdatmea.GetStatuts()
R ETURNS
GetStatusTmp
bitfield. See StaExtdatmea.SetStatus() for details on the status bits.
int StaExtdatmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtdatmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtdatmea.SetStatus() for details
on the status bits.
int StaExtdatmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtdat-
179
int StaExtdatmea.IsStatusBitSetTmp(int mask)
R ETURNS
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtdatmea.SetStatus() for details on the status
bits.
None StaExtdatmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtdatmea.SetStatus()
None StaExtdatmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtdatmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus
180



bit29 0x20000000 Read
None StaExtdatmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtdatmea.SetStatus() for details on the status
bits.
None StaExtdatmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtdatmea.SetStatus()
None StaExtdatmea.SetStatusBitTmp(int mask)
181
A RGUMENTS
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtdatmea.SetStatus() for details on
the status bits.
None StaExtdatmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtdatmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtdatmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
182
R ETURNS
0 on success
5.3.6 StaExtfmea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtfmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for frequency currently stored in the measurement object.
[int error,
float value] StaExtfmea.GetMeaValue()
A RGUMENTS
value (out)
Value for frequency.
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtfmea.SetStatus()
int StaExtfmea.GetStatuts()
183
R ETURNS
GetStatusTmp
bitfield. See StaExtfmea.SetStatus() for details on the status bits.
int StaExtfmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtfmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtfmea.SetStatus() for details on
the status bits.
int StaExtfmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtfmea.SetStatus()
int StaExtfmea.IsStatusBitSetTmp(int mask)
R ETURNS
184
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtfmea.SetStatus() for details on the status
bits.
None StaExtfmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtfmea.SetStatus()
None StaExtfmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtfmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

185

bit29 0x20000000 Read

None StaExtfmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtfmea.SetStatus() for details on the status bits.
None StaExtfmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtfmea.SetStatus() for
details on the status bits.
None StaExtfmea.SetStatusBitTmp(int mask)
A RGUMENTS
186
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtfmea.SetStatus() for details on the
status bits.
None StaExtfmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtfmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtfmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
187
5.3.7 StaExtfuelmea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtfuelmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for fuel currently stored in the measurement object.
[int error,
float value] StaExtfuelmea.GetMeaValue(int unused,
A RGUMENTS
value (out)
Value for fuel, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
If 1 (default), returned value will be multiplied by the multiplicator stored in the
measurement object. If 0, raw value will be returned.
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtfu-
elmea.SetStatus() for details on the status bits.
int StaExtfuelmea.GetStatuts()
188
R ETURNS
GetStatusTmp
bitfield. See StaExtfuelmea.SetStatus() for details on the status bits.
int StaExtfuelmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtfuelmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtfuelmea.SetStatus() for details
on the status bits.
int StaExtfuelmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtfu-
elmea.SetStatus() for details on the status bits.
int StaExtfuelmea.IsStatusBitSetTmp(int mask)
R ETURNS
189
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtfuelmea.SetStatus() for details on the status
bits.
None StaExtfuelmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtfuelmea.SetStatus()
None StaExtfuelmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtfuelmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

190

bit29 0x20000000 Read

None StaExtfuelmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtfuelmea.SetStatus() for details on the status
bits.
None StaExtfuelmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtfuelmea.SetStatus()
None StaExtfuelmea.SetStatusBitTmp(int mask)
A RGUMENTS
191
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtfuelmea.SetStatus() for details on
the status bits.
None StaExtfuelmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtfuelmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtfuelmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
192
5.3.8 StaExtimea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtimea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for current currently stored in the measurement object.
[int error,
float value] StaExtimea.GetMeaValue(int unused,
A RGUMENTS
value (out)
Value for current, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaEx-
timea.SetStatus() for details on the status bits.
int StaExtimea.GetStatuts()
193
R ETURNS
GetStatusTmp
bitfield. See StaExtimea.SetStatus() for details on the status bits.
int StaExtimea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtimea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtimea.SetStatus() for details on
the status bits.
int StaExtimea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaEx-
timea.SetStatus() for details on the status bits.
int StaExtimea.IsStatusBitSetTmp(int mask)
R ETURNS
194
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtimea.SetStatus() for details on the status
bits.
None StaExtimea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtimea.SetStatus()
None StaExtimea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtimea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

195

bit29 0x20000000 Read

None StaExtimea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtimea.SetStatus() for details on the status bits.
None StaExtimea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtimea.SetStatus() for
None StaExtimea.SetStatusBitTmp(int mask)
A RGUMENTS
196
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtimea.SetStatus() for details on the
status bits.
None StaExtimea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtimea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtimea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
197
5.3.9 StaExtpfmea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtpfmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for power factor currently stored in the measurement object.
[int error,
float value] StaExtpfmea.GetMeaValue(int unused,
A RGUMENTS
value (out)
Value for current, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtpfmea.SetStatus()
int StaExtpfmea.GetStatuts()
198
R ETURNS
GetStatusTmp
bitfield. See StaExtpfmea.SetStatus() for details on the status bits.
int StaExtpfmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtpfmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtpfmea.SetStatus() for details on
the status bits.
int StaExtpfmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtpfmea.SetStatus()
int StaExtpfmea.IsStatusBitSetTmp(int mask)
R ETURNS
199
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtpfmea.SetStatus() for details on the status
bits.
None StaExtpfmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtpfmea.SetStatus()
None StaExtpfmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtpfmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

200

bit29 0x20000000 Read

None StaExtpfmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtpfmea.SetStatus() for details on the status
bits.
None StaExtpfmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtpfmea.SetStatus() for
None StaExtpfmea.SetStatusBitTmp(int mask)
A RGUMENTS
201
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtpfmea.SetStatus() for details on
the status bits.
None StaExtpfmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtpfmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtpfmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
202
5.3.10 StaExtpmea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtpmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for active power stored in the measurement object.
[int error,
float value] StaExtpmea.GetMeaValue(int unused,
A RGUMENTS
value (out)
Value for active power, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtp-
int StaExtpmea.GetStatuts()
203
R ETURNS
GetStatusTmp
bitfield. See StaExtpmea.SetStatus() for details on the status bits.
int StaExtpmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtpmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtpmea.SetStatus() for details on
the status bits.
int StaExtpmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtp-
int StaExtpmea.IsStatusBitSetTmp(int mask)
R ETURNS
204
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtpmea.SetStatus() for details on the status
bits.
None StaExtpmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtpmea.SetStatus()
None StaExtpmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtpmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

205

bit29 0x20000000 Read

None StaExtpmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtpmea.SetStatus() for details on the status
bits.
None StaExtpmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtpmea.SetStatus() for
None StaExtpmea.SetStatusBitTmp(int mask)
A RGUMENTS
206
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtpmea.SetStatus() for details on
the status bits.
None StaExtpmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtpmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtpmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
207
5.3.11 StaExtqmea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtqmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for reactive power currently stored in the measurement object.
[int error,
float value] StaExtqmea.GetMeaValue(int unused,
A RGUMENTS
value (out)
Value for reactive power, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaEx-
tqmea.SetStatus() for details on the status bits.
int StaExtqmea.GetStatuts()
208
R ETURNS
GetStatusTmp
bitfield. See StaExtqmea.SetStatus() for details on the status bits.
int StaExtqmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtqmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtqmea.SetStatus() for details on
the status bits.
int StaExtqmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaEx-
tqmea.SetStatus() for details on the status bits.
int StaExtqmea.IsStatusBitSetTmp(int mask)
R ETURNS
209
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtqmea.SetStatus() for details on the status
bits.
None StaExtqmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtqmea.SetStatus()
None StaExtqmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtqmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

210

bit29 0x20000000 Read

None StaExtqmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtqmea.SetStatus() for details on the status
bits.
None StaExtqmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtqmea.SetStatus() for
None StaExtqmea.SetStatusBitTmp(int mask)
A RGUMENTS
211
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtqmea.SetStatus() for details on
the status bits.
None StaExtqmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtqmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtqmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
212
5.3.12 StaExtsmea
Overview
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtsmea.CopyExtMeaStatusToStatusTmp()
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtsmea.SetStatus()
int StaExtsmea.GetStatuts()
R ETURNS
GetStatusTmp
bitfield. See StaExtsmea.SetStatus() for details on the status bits.
int StaExtsmea.GetStatusTmp()
R ETURNS
InitTmp
213
loop is executed.
None StaExtsmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtsmea.SetStatus() for details on
the status bits.
int StaExtsmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtsmea.SetStatus()
int StaExtsmea.IsStatusBitSetTmp(int mask)
R ETURNS
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtsmea.SetStatus() for details on the status
bits.
None StaExtsmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtsmea.SetStatus()
None StaExtsmea.ResetStatusBitTmp(int mask)
214
A RGUMENTS
SetMeaValue
int StaExtsmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus




bit29 0x20000000 Read

None StaExtsmea.SetStatus(int status, int dbSync)
215
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtsmea.SetStatus() for details on the status
bits.
None StaExtsmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtsmea.SetStatus() for
None StaExtsmea.SetStatusBitTmp(int mask)
A RGUMENTS
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtsmea.SetStatus() for details on
the status bits.
None StaExtsmea.SetStatusTmp(int status)
A RGUMENTS
216
UpdateControl
afterwards.
int StaExtsmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtsmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
5.3.13 StaExttapmea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
217
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExttapmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for tap position and tap info currently stored in the measurement object.
[int error,
float value] StaExttapmea.GetMeaValue(int unused,
A RGUMENTS
value (out)
Value.
type type of value to return
0 tap position
1 operation mode
2 tap changer command
3 tap operation mode
4 tap operation mode command
useTranslationTable
Only supported if type=0 (tap step), if 1 (default) returned value will be translated
according to given table. If 0 is passed, the raw value will be returned.
R ETURNS
0 on success
1 on error, e.g. unsupported type
Returns 1 on erroReturn value has no meaning. It is always 0.
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExttap-
int StaExttapmea.GetStatuts()
R ETURNS
218
GetStatusTmp
bitfield. See StaExttapmea.SetStatus() for details on the status bits.
int StaExttapmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExttapmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExttapmea.SetStatus() for details
on the status bits.
int StaExttapmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExttap-
int StaExttapmea.IsStatusBitSetTmp(int mask)
R ETURNS
ResetStatusBit
Resets specific bits in the status bitfield. See StaExttapmea.SetStatus() for details on the status
bits.
None StaExttapmea.ResetStatusBit(int mask, int dbSync)
219
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExttapmea.SetStatus()
None StaExttapmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExttapmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus



220

bit29 0x20000000 Read
None StaExttapmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExttapmea.SetStatus() for details on the status
bits.
None StaExttapmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExttapmea.SetStatus()
None StaExttapmea.SetStatusBitTmp(int mask)
A RGUMENTS
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExttapmea.SetStatus() for details on
the status bits.
None StaExttapmea.SetStatusTmp(int status)
221
A RGUMENTS
UpdateControl
afterwards.
int StaExttapmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExttapmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
222
5.3.14 StaExtv3mea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtv3mea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for voltage currently stored in the measurement object.
[int error,
float value] StaExtv3mea.GetMeaValue(int unused,
A RGUMENTS
value (out)
Value for voltage, optionally multiplied by configured multiplicator
phase Index of desired phase. Index must be 0, 1 or 2.
applyMultiplicator
R ETURNS
0 on success
1 on error, e.g. phase index does not exist
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtv3mea.SetStatus()
int StaExtv3mea.GetStatuts()
223
R ETURNS
GetStatusTmp
bitfield. See StaExtv3mea.SetStatus() for details on the status bits.
int StaExtv3mea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtv3mea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtv3mea.SetStatus() for details
on the status bits.
int StaExtv3mea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtv3mea.SetStatus()
int StaExtv3mea.IsStatusBitSetTmp(int mask)
R ETURNS
224
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtv3mea.SetStatus() for details on the status
bits.
None StaExtv3mea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtv3mea.SetStatus()
None StaExtv3mea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtv3mea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

225

bit29 0x20000000 Read

None StaExtv3mea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtv3mea.SetStatus() for details on the status
bits.
None StaExtv3mea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtv3mea.SetStatus() for
None StaExtv3mea.SetStatusBitTmp(int mask)
A RGUMENTS
226
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtv3mea.SetStatus() for details on
the status bits.
None StaExtv3mea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtv3mea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtv3mea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
227
5.3.15 StaExtvmea
Overview
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
None StaExtvmea.CopyExtMeaStatusToStatusTmp()
GetMeaValue
Returns the value for voltage currently stored in the measurement object.
[int error,
float value] StaExtvmea.GetMeaValue(int unused,
A RGUMENTS
value (out)
Value for voltage, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
R ETURNS
GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtvmea.SetStatus()
int StaExtvmea.GetStatuts()
228
R ETURNS
GetStatusTmp
bitfield. See StaExtvmea.SetStatus() for details on the status bits.
int StaExtvmea.GetStatusTmp()
R ETURNS
InitTmp
loop is executed.
None StaExtvmea.InitTmp()
IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See StaExtvmea.SetStatus() for details on
the status bits.
int StaExtvmea.IsStatusBitSet(int mask)
R ETURNS
IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtvmea.SetStatus()
int StaExtvmea.IsStatusBitSetTmp(int mask)
R ETURNS
229
ResetStatusBit
Resets specific bits in the status bitfield. See StaExtvmea.SetStatus() for details on the status
bits.
None StaExtvmea.ResetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtvmea.SetStatus()
None StaExtvmea.ResetStatusBitTmp(int mask)
A RGUMENTS
SetMeaValue
int StaExtvmea.SetMeaValue(float value)
A RGUMENTS
value New value.
R ETURNS
SetStatus

230

bit29 0x20000000 Read

None StaExtvmea.SetStatus(int status, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBit
Sets specific bits in the status bitfield. See StaExtvmea.SetStatus() for details on the status
bits.
None StaExtvmea.SetStatusBit(int mask, int dbSync)
A RGUMENTS
dbSync (optional)
SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtvmea.SetStatus() for
None StaExtvmea.SetStatusBitTmp(int mask)
A RGUMENTS
231
SetStatusTmp
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtvmea.SetStatus() for details on
the status bits.
None StaExtvmea.SetStatusTmp(int status)
A RGUMENTS
UpdateControl
afterwards.
int StaExtvmea.UpdateControl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
UpdateCtrl
cuted afterwards.
int StaExtvmea.UpdateCtrl(int dbSync)
A RGUMENTS
dbSync (optional)
R ETURNS
0 on success
232
5.3.16 StaSwitch
Overview
Close
IsClosed
IsOpen
Open
Close
Closes the switch by changing its status to ’close’. This action will fail if the status is currently
int StaSwitch.Close()
R ETURNS
0 On success
6= 0 On error
S EE ALSO
StaSwitch.Open()
IsClosed
int StaSwitch.IsClosed()
R ETURNS
1 switch is closed
0 switch is open
S EE ALSO
StaSwitch.IsOpen()
IsOpen
int StaSwitch.IsOpen()
R ETURNS
1 switch is open
0 switch is closed
S EE ALSO
StaSwitch.IsClosed()
233
5.4. COMMANDS CHAPTER 5. OBJECT METHODS
Open
Opens the switch by changing its status to ’open’. This action will fail if the status is currently
int StaSwitch.Open()
R ETURNS
0 On success
6= 0 On error
S EE ALSO
StaSwitch.Close()
5.4 Commands
Overview
Execute
Execute
Executes the command.
int Com*.Execute()
5.4.1 ComAddlabel
Overview
Execute
Execute
This function executes the Add Statistic Labels command itself for a given plot and curve.
int ComAddlabel.Execute(DataObject plot, int curveIndex)
A RGUMENTS
plot The plot to modify.
curveIndex
The index of the curve inside the plot’s table. The index is zero based, therefore
the index of the first curve is 0.
R ETURNS
0 The function executed without any errors.
1 The plot is visible on a single line graphic only.
2 The parameter plot is None.
3 The parameter plot is not a virtual instrument (classname should start with Vis).
4 The object plot was found in any open graphic.
234
5 The object plot is not a diagram.

6 An internal error occured (plot is incomplete).
5.4.2 ComAddon
Overview
CreateModule
DefineDouble
DefineDoubleMatrix
DefineDoublePerConnection
DefineDoubleVector
DefineDoubleVectorPerConnection
DefineInteger
DefineIntegerPerConnection
DefineIntegerVector
DefineIntegerVectorPerConnection
DefineObject
DefineObjectPerConnection
DefineObjectVector
DefineObjectVectorPerConnection
DefineString
DefineStringPerConnection
DeleteModule
FinaliseModule
GetActiveModule
ModuleExists
SetActiveModule
CreateModule
Creates the calculation module of this AddOn. Volatile object parameters are created for all
variable definitions stored inside this command. They are accessible like any other built in
object parameter.
int ComAddon.CreateModule()
R ETURNS
0 Ok, module was created.
S EE ALSO
ComAddon.FinaliseModule() ComAddon.DeleteModule()
DefineDouble
Creates a new floating-point-number parameter for the given type of objects.
int ComAddon.DefineDouble(str class,
str name,
str desc,
str unit,
float initial)
235
A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description
unit Parameter’s unit
initial Default value of new parameter
R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.
S EE ALSO
ComAddon.DefineDoublePerConnection()
DefineDoubleMatrix
Creates a new floating-point-matrix parameter for the given type of objects.
int ComAddon.DefineDoubleMatrix(string class,
str name,
str desc,
str unit,
float initial,
int rows,
int columns)
A RGUMENTS
the line.
name Name of the new parameter.
desc Parameter description.
unit Parameter’s unit.
initial Default value for all entries of new parameter.
rows Number of initial rows. Number of rows will be 0 if a value smaller than 0 is given.
columns Number of initial columns. Number of columns will be 0 if a value smaller than 0
is given.
R ETURNS
236
DefineDoublePerConnection
Creates a new floating-point-number parameter for every connection for the given type of ob-
jects.
int ComAddon.DefineDoublePerConnection(str class,
str name,
str desc,
str unit,
float initial)
A RGUMENTS
the line.
R ETURNS
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineDouble shall be used instead.
S EE ALSO
ComAddon.DefineDouble()
DefineDoubleVector
Creates a new floating-point-number vector parameter for the given type of objects.
int ComAddon.DefineDoubleVector(str class,
str name,
str desc,
str unit,
float initial,
int size)
A RGUMENTS
the line.
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.
237
R ETURNS
S EE ALSO
ComAddon.DefineDouble() ComAddon.DefineDoublePerConnection()
DefineDoubleVectorPerConnection
Creates a new floating-point-number vector parameter for the given type of objects for every
connection of the object.
int ComAddon.DefineDoubleVectorPerConnection(str class,
str name,
str desc,
str unit,
float initial,
int size)
A RGUMENTS
the line.

R ETURNS
nection count. DefineDoubleVector shall be used instead.
S EE ALSO
ComAddon.DefineDoubleVector()
DefineInteger
Creates a new integer parameter for the given type of objects.
238
int ComAddon.DefineInteger(str class,

str name,
str desc,
str unit,
int initial)
A RGUMENTS
the line.
R ETURNS
S EE ALSO
ComAddon.DefineIntegerPerConnection()
DefineIntegerPerConnection
Creates a new integer parameter for every connection for the given type of objects.
int ComAddon.DefineIntegerPerConnection(str class,
str name,
str desc,
str unit,
int initial)
A RGUMENTS
the line.
R ETURNS
nection count. DefineInteger shall be used instead.
239
S EE ALSO
ComAddon.DefineInteger()
DefineIntegerVector
Creates a new integer vector parameter for the given type of objects.
int ComAddon.DefineIntegerVector(str class,
str name,
str desc,
str unit,
int initial,
int size)
A RGUMENTS
the line.
R ETURNS
S EE ALSO
ComAddon.DefineInteger() ComAddon.DefineIntegerPerConnection()
DefineIntegerVectorPerConnection
Creates a new integer vector parameter for the given type of objects for every connection of the
object.
int ComAddon.DefineIntegerVectorPerConnection(str class,
str name,
str desc,
str unit,
int initial,
int size)
A RGUMENTS
the line.
240

R ETURNS
nection count. DefineIntegerVector shall be used instead.
S EE ALSO
ComAddon.DefineIntegerVector()
DefineObject
Creates a new object parameter for the given type of objects.
int ComAddon.DefineObject(str class,
str name,
str desc,
DataObject initial)
A RGUMENTS
the line.
initial Default object of new parameter
R ETURNS
S EE ALSO
ComAddon.DefineObjectPerConnection()
241
DefineObjectPerConnection
Creates a new object parameter for every connection for the given type of objects.
int ComAddon.DefineObjectPerConnection(str class,
str name,
str desc,
DataObject initial)
A RGUMENTS
the line.
R ETURNS
nection count. DefineObject shall be used instead.
S EE ALSO
ComAddon.DefineObject()
DefineObjectVector
Creates a new object vector parameter for the given type of objects.
int ComAddon.DefineObjectVector(str class,
str name,
str desc,
DataObject initial,
int size)
A RGUMENTS
the line.

initial Default value of new parameter.
242
R ETURNS
S EE ALSO
ComAddon.DefineObject() ComAddon.DefineObjectPerConnection()
DefineObjectVectorPerConnection
Creates a new object vector parameter for the given type of objects for every connection of the
object.
int ComAddon.DefineObjectVectorPerConnection(str class,
str name,
str desc,
DataObject initial,
int size)
A RGUMENTS
the line.
initial Default value of new parameter.
R ETURNS
nection count. DefineObjectVector shall be used instead.
S EE ALSO
ComAddon.DefineObjectVector()
DefineString
Creates a new text parameter for the given type of objects.
int ComAddon.DefineString(str class,
str name,
str desc,
str unit,
str initial)
243
A RGUMENTS
the line.

R ETURNS
S EE ALSO
ComAddon.DefineStringPerConnection()
DefineStringPerConnection
Creates a new text parameter for every connection for the given type of objects.
int ComAddon.DefineStringPerConnection(str class,
str name,
str desc,
str unit,
str initial)
A RGUMENTS
the line.

R ETURNS
nection count. DefineString shall be used instead.
244
S EE ALSO
ComAddon.DefineString()
DeleteModule
Deletes the module of this add on.
int ComAddon.DeleteModule()
0 Success. The module is deleted completely.
1 Failure. The module does not exist and can therefore not be deleted.
S EE ALSO
ComAddon.CreateModule()
FinaliseModule
Finalises a user defined module which was created using the mthod CreateModule. All user
defined variables defined for this module are read-only after the call of finalise module. The
module is the one being used in the flexible data, single line graphic text boxes and colouring.
It can be reset like any other built-in calculation using the reset button.
int ComAddon.FinaliseModule()
R ETURNS
0 Ok, module was finalised.
1 An error occurred, this command is not the one being currently active.
S EE ALSO
ComAddon.CreateModule()
GetActiveModule
Gets the key of the module being currently active. An empty string is returned if there is no
active module.
str ComAddon.GetActiveModule()
R ETURNS
The key of the active module. an empty string is returned if there is no active module.
S EE ALSO
ComAddon.SetActiveModule()
ModuleExists
Checks if the module for this add-on was already created using the method CreateModule.
int ComAddon.ModuleExists()
245
R ETURNS
0 The module was not created yet.
1 The module was already created.
S EE ALSO
ComAddon.CreateModule() ComAddon.FinaliseModule() ComAddon.DeleteModule()
SetActiveModule
Set this module as active module. This method is required only if several modules are created
concurrently. In case that only one module is being used, there is no need to use this method,
because CreateModule sets the created module automatically as active module.
int ComAddon.SetActiveModule()
R ETURNS
0 Success. This command is set as active module.
1 Failure. This command is already the active module.
S EE ALSO
ComAddon.CreateModule() ComAddon.FinaliseModule() ComAddon.DeleteModule()
5.4.3 ComAmpacity
Overview
ExecuteAmpacityCalc
ExecuteAmpacityCalc
The function executes ampacity calculation with or without the tabular report at the end.
int ComAmpacity.ExecuteAmpacityCalc([int ireport = 1])
A RGUMENTS
ireport (optional)
Show report or not, default = 1.
5.4.4 ComAuditlog
Overview
Check
Check
Checks integrity of Audit Log.
int ComAuditlog.Check()
246
R ETURNS
number of errors
5.4.5 ComBoundary
Overview
GetCreatedBoundaries
GetCreatedBoundaries
Gets created boundaries after the command has been executed.
list ComBoundary.GetCreatedBoundaries()
R ETURNS
Container of created boundaries.
5.4.6 ComCapo
Overview
ConnectShuntToBus
LossCostAtBusTech
TotalLossCost
ConnectShuntToBus
Connects the equivalent shunt in the specified terminal and executes the load flow command.
The shunt is not physically added in the database, just the susceptance is added for the
calculation.
int ComCapo.ConnectShuntToBus(DataObject terminal,
float phtech,
float Q
)
A RGUMENTS
terminal The terminal to which the shunt will be connected
phtech Phase technology. Possible values are
0 three-phase
1 ph-ph a-b
2 ph-ph b-c
3 ph-ph a-c
4 ph-e a
5 ph-e b
6 ph-e c
Note: In balanced load flow, the technology will always be three-phase.
Q Reactive power value in Mvar
247
R ETURNS
0 On success.
1 An error occurred during load flow execution.
LossCostAtBusTech
Returns the losses cost of the selected terminal and configuration calculated during the sensi-
tivity analysis or the optimization.
float ComCapo.LossCostAtBusTech(DataObject terminal,
float phtech
)
A RGUMENTS
terminal Specified bus
phtech Phase technology. Possible values are
0 three-phase
1 ph-ph a-b
2 ph-ph b-c
3 ph-ph a-c
4 ph-e a
5 ph-e b
6 ph-e c
R ETURNS
Returns the losses cost
TotalLossCost
Returns the total cost calculated after the sensitivity analysis or the optimization.
float ComCapo.TotalLossCost([int iopt])
A RGUMENTS
iopt (optional)
Type of cost. Possible values are
0 Losses in MW (default)
1 Cost of losses
2 Cost of voltage violations
3 Cost of shunts
R ETURNS
Returns losses in MW or cost value.
248
5.4.7 ComCimdbexp
Overview
Execute
Execute
Executes the export. In case of a validation error the export is not performed.
int ComCimdbexp.Execute([int validate])
A RGUMENTS
validate (optional)
Option to execute CIM Data Validation before export. If not provided, the validation
is executed. Possible values are
0 Do not validate
1 Validate
R ETURNS
0 OK
1 Error: export failed
5.4.8 ComCimdbimp
Overview
Execute
ImportAndConvert
Execute
Executes the import.
int ComCimdbimp.Execute([int validate])
A RGUMENTS
validate (optional)
Option to execute CIM Data Validation after import. If not provided, the validation
0 Do not validate
1 Validate
R ETURNS
0 OK
1 Error: import failed
249
ImportAndConvert
Imports CIM data from file path provided in the ’CIM Data Import’ command without storing
CIM data into database, and converts CIM to Grid using the ’CIM to Grid Conversion’ command
object provided in the function call as template. The CIM to Grid Conversion will be executed
with default settings if the command object is not provided in the function call.
int ComCimdbimp.ImportAndConvert([int validate],
[DataObject cimToGrid])
A RGUMENTS
validate (optional)
Option to execute CIM Data Validation after import. If not provided, the validation
0 Do not validate
1 Validate
cimToGrid (optional)
ComCimtogrid object with preconfigured settings for converting imported CIM
data. If not provided, the default CIM to Grid Conversion settings will be used.
R ETURNS
0 OK
1 Error: import failed
2 Error: conversion failed
5.4.9 ComCimvalidate
Overview
Execute
GetClassType
GetDescriptionText
GetInputObject
GetModel
GetModelId
GetNumberOfValidationMessages
GetObject
GetObjectId
GetProfile
GetSeverity
GetType
Execute
Executes the validation. Creates no validation report if no errors, or warnings were found.
int ComCimvalidate.Execute([int openReport])
A RGUMENTS
openReport (optional)
Option to open report after validation. If not provided, the report is opened.
Possible values are
250
0 Do not open report

1 Open report
R ETURNS
0 OK
1 Error: validation failed
GetClassType
Returns the object class type from the selected validation message.
str ComCimvalidate.GetClassType(int messageIndex)
A RGUMENTS
messageIndex
Index of the validation message.
R ETURNS
Object class type.
GetDescriptionText
Returns the description from the selected validation message.
str ComCimvalidate.GetDescriptionText(int messageIndex)
A RGUMENTS
messageIndex
R ETURNS
Message description.
GetInputObject
Returns the object selected for validation.
DataObject ComCimvalidate.GetInputObject()
R ETURNS
Pointer to CimArchive, CimModel, or SetSelect.
GetModel
Returns the CimModel object from the selected validation message.
DataObject ComCimvalidate.GetModel(int messageIndex)
A RGUMENTS
messageIndex
251
R ETURNS
Pointer to CimModel.
GetModelId
Returns the model ID from the selected validation message.
str ComCimvalidate.GetModelId(int messageIndex)
A RGUMENTS
messageIndex
R ETURNS
Model ID.
GetNumberOfValidationMessages
Returns the number of validation messages generated.
int ComCimvalidate.GetNumberOfValidationMessages()
R ETURNS
Number of validation messages.
GetObject
Returns the CimObject object from the selected validation message.
DataObject ComCimvalidate.GetObject(int messageIndex)
A RGUMENTS
messageIndex
R ETURNS
Pointer to CimObject.
GetObjectId
Returns the object ID from the selected validation message.
str ComCimvalidate.GetObjectId(int messageIndex)
A RGUMENTS
messageIndex
252
R ETURNS
Object ID.
GetProfile
Returns the model profile from the selected validation message.
str ComCimvalidate.GetProfile(int messageIndex)
A RGUMENTS
messageIndex
R ETURNS
Model profile.
GetSeverity
Returns the severity of the selected validation message.
str ComCimvalidate.GetSeverity(int messageIndex)
A RGUMENTS
messageIndex
R ETURNS
Message severity.
GetType
Returns the type of the selected validation message.
str ComCimvalidate.GetType(int messageIndex)
A RGUMENTS
messageIndex
R ETURNS
Message type.
5.4.10 ComConreq
Overview
Execute
253
Execute
Performs a Connection Request Assessment according to the selected method. Results are
provided for connection request elements in the single line graphic, and are summarised in a
report in the output window.
int ComConreq.Execute()
R ETURNS
0 OK
1 Error: calculation function
2 Error: settings/initialisation/load flow
5.4.11 ComContingency
Overview
ContinueTrace
CreateRecoveryInformation
GetGeneratorEvent
GetInterruptedPowerAndCustomersForStage
GetInterruptedPowerAndCustomersForTimeStep
GetLoadEvent
GetNumberOfGeneratorEventsForTimeStep
GetNumberOfLoadEventsForTimeStep
GetNumberOfSwitchEventsForTimeStep
GetNumberOfTimeSteps
GetObj
GetSwitchEvent
GetTimeOfStepInSeconds
GetTotalInterruptedPower
JumpToLastStep
RemoveEvents
StartTrace
StopTrace
ContinueTrace
Continues trace execution for this contingency.
int ComContingency.ContinueTrace()
R ETURNS
0 On success.
1 On error.
CreateRecoveryInformation
Creates recovery information for a contingency. The recovery information can later be retrieved
e.g. via ComContingency.GetInterruptedPowerAndCustomersForStage().
Can only save one contingency at the same time.
int ComContingency.CreateRecoveryInformation(DataObject resultFileInput)
254
A RGUMENTS
resultFileInput
Read from this result file.
R ETURNS
0 On success.
1 On error.
GetGeneratorEvent
Gets generator event of a certain time step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ DataObject generator,
float changedP,
float changedQ ) ]
ComContingency.GetGeneratorEvent(int currentTimeStep,
int loadEvent)
A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()
switchEvent
Input: Number of generator events for a certain time step are get via ComContin-
gency.GetNumberOfSwitchEventsForTimeStep()
generator (out)
Output: Generator that dispatched
changedP (out)
Output: Changed active power
changedQ (out)
Output: Changed reactive power
GetInterruptedPowerAndCustomersForStage
Gets recovery information of a contingency.
[ int error,
float interruptedPower,
float newInterruptedPower,
float interruptedCustomers,
float newInterruptedCustomers ]
ComContingency.GetInterruptedPowerAndCustomersForStage(float timeOfStageInMinutes)
A RGUMENTS
timeOfStageInMinutes
Input: Get Information for this time.
interruptedPower (out)
Output: Interrupted Power at this time.
255
newInterruptedPower (out)
Output: New interrupted Power at this time.
interruptedCustomers (out)
Output: Interrupted Customers at this time.
newInterruptedCustomers (out)
Output: New interrupted Customers at this time.
R ETURNS
0 On success.
1 On error.
GetInterruptedPowerAndCustomersForTimeStep
Gets recovery information of a contingency.
[ float interruptedPower,
float newInterruptedPower,
float interruptedCustomers,
float newInterruptedCustomers ]
ComContingency.GetInterruptedPowerAndCustomersForTimeStep(int currentTimeStep)
A RGUMENTS
currentTimeStep
interruptedPower (out)
Output: Interrupted Power at this time.
newInterruptedPower (out)
Output: New interrupted Power at this time.
interruptedCustomers (out)
Output: Interrupted Customers at this time.
newInterruptedCustomers (out)
Output: New interrupted Customers at this time.
GetLoadEvent
Gets load event of a certain time step during recovery.
[ DataObject load,
float changedP,
float changedQ,
int isTransfer ) ]
ComContingency.GetLoadEvent(int currentTimeStep,
int loadEvent)
256
A RGUMENTS
currentTimeStep
switchEvent
Input: Number of load events for a certain time step are get via ComContin-
load (out) Output: Load that is shed or transfered
changedP (out)
Output: Changed active power
changedQ (out)
Output: Changed reactive power
isTransfer (out)
Output: = 0 : is load shedding event. >0 is load transfer event.
GetNumberOfGeneratorEventsForTimeStep
Returns the number of generator events of a certain step during recovery.
int ComContingency.GetNumberOfGeneratorEventsForTimeStep([int currentTimeStep])
A RGUMENTS
currentTimeStep
GetNumberOfLoadEventsForTimeStep
Returns the number of load events of a certain step during recovery.
int ComContingency.GetNumberOfLoadEventsForTimeStep([int currentTimeStep])
A RGUMENTS
currentTimeStep
GetNumberOfSwitchEventsForTimeStep
Returns the number of switch events of a certain step during recovery.
int ComContingency.GetNumberOfSwitchEventsForTimeStep([int currentTimeStep])
257
A RGUMENTS
currentTimeStep
GetNumberOfTimeSteps
Returns the number of time steps during recovery.
int ComContingency.GetNumberOfTimeSteps()
GetObj
Gets interrupted element by index (zero based).
DataObject ComContingency.GetObj(int index)
A RGUMENTS
index Element order index, 0 for the first object.
R ETURNS
object Interupted element for given index.
None Index out of range.
GetSwitchEvent
Gets switch event of a certain time step during recovery.
[ DataObject switchToBeActuated,
int isClosed,
int sectionalizingStep ) ]
ComContingency.GetSwitchEvent(int currentTimeStep,
int switchEvent)
A RGUMENTS
currentTimeStep
switchEvent
Input: Number of switch event for a certain time step are get via ComContin-
switchToBeActuated (out)
Output: Switch to be actuated
isClosed (out)
Output: > 0 if switch is closed
sectionalizingStep (out)
Output: sectionalizing step when this switch is actuated
258
GetTimeOfStepInSeconds
Returns the time of the current step during recovery.
int ComContingency.GetTimeOfStepInSeconds(int currentTimeStep)
A RGUMENTS
currentTimeStep
GetTotalInterruptedPower
Gets the total interrupted power (in kW) during restoration. ComContingency.CreateRecoveryInformation()
has to be called beforehand to collect the data.
float ComContingency.GetTotalInterruptedPower()
JumpToLastStep
Gets the last trace execution for this contingency.
int ComContingency.JumpToLastStep([int timeDelay])
A RGUMENTS
timeDelay (optional)
time delay in seconds between trace steps
R ETURNS
0 On success.
1 On error.
RemoveEvents
Removes events from this contingency.
None ComContingency.RemoveEvents([float emitMessage])
None ComContingency.RemoveEvents(str whichEvents)
None ComContingency.RemoveEvents(float emitMessage,
str whichEvents
)
None ComContingency.RemoveEvents(str whichEvents,
float emitMessage
)
A RGUMENTS
emitMessage(optional)
0: no info message shall be issued after event removal
whichEvents(optional)
’lod’ removed load events, ’gen’ removes generator events, ’switch’ removes switch-
ing events
259
StartTrace
Starts trace execution for this contingency.
int ComContingency.StartTrace()
R ETURNS
0 On success.
1 Error, e.g. Contingency is not in trace.
2 On error.
StopTrace
Stops trace execution for this contingency.
int ComContingency.StopTrace([int emitMessage])
A RGUMENTS
emitMessage (optional)
= 0: no trace-stop info messages shall be issued
R ETURNS
0 On Success.
1 Contingency is not in Trace.
5.4.12 ComCoordreport
Overview
DevicesToReport
HasResultsForDirectionalBackup
HasResultsForNonDirectionalBackup
HasResultsForOverreach
HasResultsForZone
MaxZoneNumberFor
ResultForDirectionalBackupVariable
ResultForNonDirectionalBackupVariable
ResultForOverreachVariable
ResultForZoneVariable
TopologyForDirectionalBackupVariable
TopologyForNonDirectionalBackupVariable
TopologyForOverreachVariable
TopologyForZoneVariable
TransferDirectionalBackupResultsTo
TransferNonDirectionalBackupResultsTo
TransferOverreachResultsTo
TransferResultsTo
TransferZoneResultsTo
260
DevicesToReport
Returns the devices with stored results, i.e. which can be reported.
list ComCoordreport.DevicesToReport()
R ETURNS
Container with reportable devices.
HasResultsForDirectionalBackup
Checks whether there is a stored directional backup result for the given device.
int ComCoordreport.HasResultsForDirectionalBackup(DataObject device)
A RGUMENTS
device Device for which to check.
R ETURNS
1 A directional backup result is stored for this device.
0 The device has no stored results or no result for the directional backup.
S EE ALSO
ComCoordreport.HasResultsForZone(), ComCoordreport.HasResultsForOverreach(), Com-

Coordreport.HasResultsForNonDirectionalBackup()
HasResultsForNonDirectionalBackup
Checks whether there is a stored non-directional backup result for the given device.
int ComCoordreport.HasResultsForNonDirectionalBackup(object device)
A RGUMENTS
R ETURNS
1 A non-directional backup result is stored for this device.
0 The device has no stored results or no result for the non-directional backup.
S EE ALSO
ComCoordreport.HasResultsForZone(), ComCoordreport.HasResultsForOverreach(), Com-

Coordreport.HasResultsForDirectionalBackup()
HasResultsForOverreach
Checks whether there is a stored overreach zone result for the given device.
int ComCoordreport.HasResultsForOverreach(DataObject device)
A RGUMENTS
261
R ETURNS
1 An overreach zone result is stored for this device.
0 The device has no stored results or no result for the overreach zone.
S EE ALSO
ComCoordreport.HasResultsForZone(), ComCoordreport.HasResultsForDirectionalBackup(),
ComCoordreport.HasResultsForNonDirectionalBackup()
HasResultsForZone
Checks whether there is a stored result for the given device and zone number.
int ComCoordreport.HasResultsForZone(DataObject device,
int zoneNumber)
A RGUMENTS
zoneNumber
Zone number to check (1-4).
R ETURNS
1 A result is stored for this device and zone number.
0 The device has no stored results or no result for this zone number.
S EE ALSO
ComCoordreport.HasResultsForOverreach(), ComCoordreport.HasResultsForDirectionalBackup(),
ComCoordreport.HasResultsForNonDirectionalBackup()
MaxZoneNumberFor
Returns the highest zone number in the stored results for the given device.
int ComCoordreport.MaxZoneNumberFor(DataObject device)
A RGUMENTS
device Device for which to retrieve the zone number.
R ETURNS
Highest zone number in the stored results.
ResultForDirectionalBackupVariable
Provides access to the directional backup result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForDirectionalBackupVariable(DataObject device,
str variable)
262
A RGUMENTS
device Device for which to retrieve the result.
variable Variable for which to retrieve the result:
dir Tripping direction
Tp Polygonal delay
Tc Circular delay
result (out)
Value of the stored result.
R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
2 The corresponding topological search failed.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
S EE ALSO
ComCoordreport.ResultForZoneVariable(), ComCoordreport.ResultForOverreachVariable(),
ComCoordreport.ResultForNonDirectionalBackupVariable()
ResultForNonDirectionalBackupVariable
Provides access to the non-directional backup result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForNonDirectionalBackupVariable(DataObject device,
str variable)
A RGUMENTS

Tp Polygonal delay
Tc Circular delay
result (out)
R ETURNS
reached).
263
S EE ALSO
ComCoordreport.ResultForZoneVariable(), ComCoordreport.ResultForOverreachVariable(),
ComCoordreport.ResultForDirectionalBackupVariable()
ResultForOverreachVariable
Provides access to the overreach result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForOverreachVariable(DataObject device,
str variable)
A RGUMENTS

X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
Tp Polygonal delay
Tc Circular delay
result (out)
R ETURNS
reached).
S EE ALSO
ComCoordreport.ResultForZoneVariable(), ComCoordreport.ResultForDirectionalBackupVariable(),
ResultForZoneVariable
Provides access to the result for a given device, zone number and variable.
[ int error,
float result ] ComCoordreport.ResultForZoneVariable(DataObject device,
int zoneNumber,
str variable)
264
A RGUMENTS
zoneNumber
Zone number for which to retrieve the result (1-4).
phi Circular angle
Tp Polygonal delay
Tc Circular delay
result (out)
R ETURNS
reached).
S EE ALSO
ComCoordreport.ResultForOverreachVariable(), ComCoordreport.ResultForDirectionalBackupVariable(),
TopologyForDirectionalBackupVariable
Returns the associated directional backup topology for a given device and variable.
list ComCoordreport.TopologyForDirectionalBackupVariable(DataObject device,
str variable)
A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Tp Polygonal delay
Tc Circular delay
R ETURNS
Elements traversed by the topological search determining this variables result.
S EE ALSO
ComCoordreport.TopologyForZoneVariable(), ComCoordreport.TopologyForOverreachVariable(),
ComCoordreport.TopologyForNonDirectionalBackupVariable()
265
TopologyForNonDirectionalBackupVariable
Returns the associated non-directional backup topology for a given device and variable.
list ComCoordreport.TopologyForNonDirectionalBackupVariable(DataObject device,
str variable)
A RGUMENTS
Tp Polygonal delay
Tc Circular delay
R ETURNS
S EE ALSO
ComCoordreport.TopologyForZoneVariable(), ComCoordreport.TopologyForOverreachVariable(),
ComCoordreport.TopologyForDirectionalBackupVariable()
TopologyForOverreachVariable
Returns the associated overreach zone topology for a given device and variable.
list ComCoordreport.TopologyForOverreachVariable(DataObject device,
str variable)
A RGUMENTS
phi Circular angle
Tp Polygonal delay
Tc Circular delay
R ETURNS
S EE ALSO
ComCoordreport.TopologyForZoneVariable(), ComCoordreport.TopologyForDirectionalBackupVariable(),
TopologyForZoneVariable
Returns the associated topology for a given device, zone number and variable.
list ComCoordreport.TopologyForZoneVariable(DataObject device,
int zoneNumber,
str variable)
266
A RGUMENTS
zoneNumber
Zone number for which to retrieve the topology (1-4).
phi Circular angle
Tp Polygonal delay
Tc Circular delay
R ETURNS
S EE ALSO
ComCoordreport.TopologyForOverreachVariable(), ComCoordreport.TopologyForDirectionalBackupVariable(),
TransferDirectionalBackupResultsTo
Transfers the results of the directional backup for the given variables to the device.
int ComCoordreport.TransferDirectionalBackupResultsTo(DataObject device,
str variables)
A RGUMENTS
device Device to transfer the results to.
variable Variables to transfer as semi-colon separated string:
Tp Polygonal delay
Tc Circular delay
R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.
S EE ALSO
ComCoordreport.TransferZoneResultsTo(), ComCoordreport.TransferOverreachResultsTo(),
ComCoordreport.TransferNonDirectionalBackupResultsTo()
TransferNonDirectionalBackupResultsTo
Transfers the results of the non-directional backup for the given variables to the device.
int ComCoordreport.TransferNonDirectionalBackupResultsTo(DataObject device,
str variables)
267
A RGUMENTS
Tp Polygonal delay
Tc Circular delay
R ETURNS
S EE ALSO
ComCoordreport.TransferZoneResultsTo(), ComCoordreport.TransferOverreachResultsTo(),
ComCoordreport.TransferDirectionalBackupResultsTo()
TransferOverreachResultsTo
Transfers the results of the overreach zone for the given variables to the device.
int ComCoordreport.TransferOverreachResultsTo(DataObject device,
str variables)
A RGUMENTS
phi Circular angle
Tp Polygonal delay
Tc Circular delay
R ETURNS
S EE ALSO
ComCoordreport.TransferZoneResultsTo(), ComCoordreport.TransferDirectionalBackupResultsTo(),
268
TransferResultsTo
Transfers the results for the given variables to one or more devices.
int ComCoordreport.TransferResultsTo(DataObject device,
str variables)
int ComCoordreport.TransferResultsTo(list devices,

str variables)
A RGUMENTS
devices Devices to transfer the results to.
phi Circular angle
Tp Polygonal delay
Tc Circular delay
R ETURNS
0 At least one transfer did non succeed.
TransferZoneResultsTo
Transfers the results of a particular zone for the given variables to the device.
int ComCoordreport.TransferZoneResultsTo(DataObject device,
int zoneNumber,
str variables)
A RGUMENTS
zoneNumber
Zone number for which to to transfer the results (1-4).
phi Circular angle
Tp Polygonal delay
Tc Circular delay
269
R ETURNS
S EE ALSO
ComCoordreport.TransferOverreachResultsTo(), ComCoordreport.TransferDirectionalBackupResultsTo(),
5.4.13 ComDllmanager
Overview
Report
Report
Prints a status report of currently available external user-defined dlls (e.g. dpl, exdyn) to the
output window. (Same as pressing the ’Report’ button in the dialog.)
None ComDllmanager.Report()
5.4.14 ComDpl
Overview
CheckSyntax
Encrypt
Execute
GetExternalObject
GetInputParameterDouble
GetInputParameterInt
GetInputParameterString
IsEncrypted
ResetThirdPartyModule
SetExternalObject
SetInputParameterDouble
SetInputParameterInt
SetInputParameterString
SetThirdPartyModule
CheckSyntax
Checks the syntax and input parameter of the DPL script and all its subscripts.
int ComDpl.CheckSyntax()
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.Execute()
270
Encrypt
Encrypts a script and all its subscripts. An encrypted script can be executed without password
but decrypted only with password. If no password is given a ’Choose Password’ dialog appears.
int ComDpl.Encrypt([str password = ""],
[int removeObjectHistory = 1],
[int masterCode = 0])
A RGUMENTS
password (optional)
Password for decryption. If no password is given a ’Choose Password’ dialog
appears.
removeObjectHistory (optional)
Handling of unencrypted object history in database, e.g. used by project versions
or by undo:
0 Do not remove.
1 Do remove (default).
2 Show dialog and ask.
masterCode (optional)
Used for re-selling scripts. 3rd party licence codes already set in the script will be
overwritten by this value (default = 0).
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.IsEncrypted()
Execute
Executes the DPL script as subscript.
int ComDpl.Execute([input parameter])
A RGUMENTS
input parameter (optional)
All input parameter from the ’Basic Options’ page of the ’Edit’ dialog can be given
as arguments. If a parameter is not given then the value from the dialog is used.
The values from the dialog itself are not modified. These can be modified via
• ComDpl.SetInputParameterInt()
• ComDpl.SetInputParameterDouble()
• ComDpl.SetInputParameterString().
The arguments are not given by reference. Thus when a subscript changes the
value of a variable then the value from the main script is not changed.
271
R ETURNS
For scripts without the use of Application.exit() the following values are returned:
0 On a successful execution.
6 User hit the break button.
S EE ALSO
ComDpl.CheckSyntax()
GetExternalObject
Gets the external object defined in the ComDpl edit dialog.
[int error,
DataObject value] ComDpl.GetExternalObject(str name)
A RGUMENTS
name Name of the external object parameter.
value (out)
The external object.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.SetExternalObject(), ComDpl.GetInputParameterInt(), ComDpl.GetInputParameterDouble(),

ComDpl.GetInputParameterString()
Gets the double input parameter value defined in the ComDpl edit dialog.
[int error,
float value] ComDpl.GetInputParameterDouble(str name)
A RGUMENTS
name Name of the double input parameter.
value (out)
Value of the double input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.SetInputParameterDouble(), ComDpl.GetInputParameterInt(), ComDpl.GetInputParameterString(),

ComDpl.GetExternalObject()
272
Gets the integer input parameter value defined in the ComDpl edit dialog.
[int error,
int value ] ComDpl.GetInputParameterInt(str name)
A RGUMENTS
name Name of the integer input parameter.
value (out)
Value of the integer input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.SetInputParameterInt(), ComDpl.GetInputParameterDouble(), ComDpl.GetInputParameterString(),

Gets the string input parameter value defined in the ComDpl edit dialog.
[int error,
str value ] ComDpl.GetInputParameterString(str name)
A RGUMENTS
name Name of the string input parameter.
value (out)
Value of the string input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.SetInputParameterString(), ComDpl.GetInputParameterInt(), ComDpl.GetInputParameterDouble(),

IsEncrypted
Returns the encryption state of the script.
int ComDpl.IsEncrypted()
R ETURNS
1 Script is encrypted.
0 Script is not encrypted.
273
S EE ALSO
ComDpl.Encrypt()
Resets the third party licence. Only possible for non-encrypted scripts. Requires masterkey
licence for third party module currently set.
int ComDpl.ResetThirdPartyModule()
R ETURNS
0 On success.
1 On error.
SetExternalObject
Sets the external object defined in the ComDpl edit dialog.
int ComDpl.SetExternalObject(str name,
DataObject value
)
A RGUMENTS
value The external object.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.GetExternalObject(), ComDpl.SetInputParameterInt(), ComDpl.SetInputParameterDouble(),

ComDpl.SetInputParameterString()
Sets the double input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterDouble(str name,
float value
)
A RGUMENTS
value Value of the double input parameter.
R ETURNS
0 On success.
1 On error.
274
S EE ALSO
ComDpl.GetInputParameterDouble(), ComDpl.SetInputParameterInt(), ComDpl.SetInputParameterString(),

ComDpl.SetExternalObject()
Sets the integer input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterInt(str name,
int value
)
A RGUMENTS
value Value of the integer input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.GetInputParameterInt(), ComDpl.SetInputParameterDouble(), ComDpl.SetInputParameterString(),

Sets the string input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterString(str name,
str value
)
A RGUMENTS
value Value of the string input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComDpl.GetInputParameterString(), ComDpl.SetInputParameterInt(), ComDpl.SetInputParameterDouble(),

SetThirdPartyModule
Sets the third party licence to a specific value. Only possible for non-encrypted scripts with no
third party licence set so far. Requires masterkey licence for third party module to be set.
int ComDpl.SetThirdPartyModule(str companyCode,
str moduleCode
)
275
A RGUMENTS
companyCode
D isplay name or numeric value of company code.
moduleCode
D isplay name or numeric value of third party module.
R ETURNS
0 On success.
1 On error.
5.4.15 ComFlickermeter
Overview
Execute
Execute
Calculates the short- and long-term flicker according to IEC 61000-4-15.
int ComFlickermeter.Execute()
R ETURNS
0 OK
1 Error: column not found in file; other internal errors
2 Error: empty input file
3 Error: cannot open file
4 Internal error: matrix empty
5.4.16 ComGenrelinc
Overview
GetCurrentIteration
GetMaxNumIterations
GetCurrentIteration
The command returns the current iteration number of the ’Run Generation Adequacy’ command
(ComGenrel).
int ComGenrelinc.GetCurrentIteration()
R ETURNS
Returns the current iteration number.
276
GetMaxNumIterations
The command returns the maximume number of iterations specified in the ’Run Generation
Adequacy’ command (ComGenrel).
int ComGenrelinc.GetMaxNumIterations()
R ETURNS
Returns the maximum number of iterations.
5.4.17 ComGridtocim
Overview
ConvertAndExport
SetAuthorityUri
SetBoundaries
SetGridsToExport
ConvertAndExport
Convert Grid to CIM and export CIM data to given file path without storing into database. If
no file path is provided, the file path from the corresponding CIM Data Export command in the
study will be used. In case of a validation error the export is not performed.
int ComGridtocim.ConvertAndExport([int validate])
int ComGridtocim.ConvertAndExport(str filePath,
[int validate])
A RGUMENTS
filePath File path for CIM data.
validate (optional)
Option to execute CIM Data Validation before export. If not provided, the validation
0 Do not validate
1 Validate
R ETURNS
0 OK
1 Error: conversion failed
2 Error: export failed
SetAuthorityUri
Sets the authority uri for a specific grid.
None ComGridtocim.SetAuthorityUri(DataObject grid,
str uri)
277
A RGUMENTS
grid Grid to set the URI for.
uri Model authority URI to be set.
SetBoundaries
Sets the grids as ”Boundary Grid” and clears any previous setting.
None ComGridtocim.SetBoundaries(list grids)
A RGUMENTS
grids The grids to be considered as boundaries.
SetGridsToExport
Sets the grids as ”Selected” and clears any previous setting.
None ComGridtocim.SetGridsToExport(list grids)
A RGUMENTS
grids The grids to be selected.
5.4.18 ComHostcap
Overview
CalcMaxHostedPower
CalcMaxHostedPower
The function executes predefined hosting capacty analysis command and returns the max.
hosted power (P, Q) at the given terminal. In addition, object where the violation has occured is
returned.
[int returnValue,
float P,
float Q,
violatedElement ] ComHostcap.CalcMaxHostedPower(DataObject terminal)
A RGUMENTS
terminal Hosting site.
P (out) Max. active power.
Q (out) Max. reactive power.

violatedElement (out)
Element where the limiting violation occurs.
278
R ETURNS
-1 Selected object is not a terminal.
0 No violations. Calculation OK.
1 Calculation failed.
2 Thermal violation.
3 Voltage violation.
4 Protection violation.
5 Power quality violation.
5.4.19 ComImport
Overview
GetCreatedObjects
GetModifiedObjects
GetCreatedObjects
Returns the newly created objects after execution of a DGS import.
list ComImport.GetCreatedObjects()
R ETURNS
Collection of objects that have been created during DGS import.
GetModifiedObjects
Returns the modified objects after execution of a DGS import.
list ComImport.GetModifiedObjects()
R ETURNS
Collection of objects that have been modified during DGS import.
5.4.20 ComInc
Overview
ZeroDerivative
ZeroDerivative
This function returns 1 if the state variable derivatives are less than the tolerance for the initial
conditions, provided that the Simulation method is set to RMS values and the Verify initial
conditions option is selected in the Calculation of initial conditions command. The tolerance
is defined on the Solver options page in the Maximum error for dynamic model equations field.
The function returns 0 if the aforementioned conditions are not met, or if at least one state
variable has a derivative larger than the tolerance.
int ComInc.ZeroDerivative()
279
R ETURNS
0 At least one state variable has a derivative larger than the tolerance, or the re-
quired command options have not been set.
1 All state variable derivatives are less than the tolerance.
5.4.21 ComLdf
Overview
CheckControllers
DoNotResetCalc
EstimateOutage
Execute
IsAC
IsBalanced
IsDC
PrintCheckResults
SetOldDistributeLoadMode
CheckControllers
Check the conditions of all controllers based on available load flow results. The report will be
printed out in output window.
int ComLdf.CheckControllers()
R ETURNS
Always return 1.
DoNotResetCalc
The load flow results will not be reset even the load flow calculation fails.
int ComLdf.DoNotResetCalc(int doNotReset)
A RGUMENTS
doNotReset
Specifies whether the results shall be reset or not.
0 Reset load flow results if load flow fails.
1 Load flow results will remain even load flow fails.
R ETURNS
Always return 0.
EstimateOutage
Estimate the loading of all branches with outages of given set of branch elements.
int ComLdf.EstimateOutage(list branches,
int init
)
280
A RGUMENTS
branches The branch elements to be in outage.
init Initialisation of sensitivities.
0 No need to calculate sensitivities; it assumes that sensitivities have
been calculated before hand.
1 Sensitivities will be newly calculated.
R ETURNS
0 On success.
1 On error.
Execute
Performs a load flow analysis on a network. Results are displayed in the single line graphic and
available in relevant elements.
int ComLdf.Execute()
R ETURNS
0 OK
1 Load flow failed due to divergence of inner loops.
2 Load flow failed due to divergence of outer loops.
IsAC
Check whether this load flow is configured as AC method or not.
int ComLdf.IsAC()
R ETURNS
0 Is a DC method.
1 Is an AC method.
IsBalanced
Check whether this load flow command is configured as balanced or unbalanced.
int ComLdf.IsBalanced()
R ETURNS
Returns true if the load flow is balanced.
IsDC
Check whether this load flow is configured as DC method or not.
int ComLdf.IsDC()
281
R ETURNS
0 Is an AC method.
1 Is a DC method.
PrintCheckResults
Shows the verification report in the output window.
int ComLdf.PrintCheckResults()
R ETURNS
Always return 1.
SetOldDistributeLoadMode
Set the old scaling mode in case of Distributed Slack by loads.
None ComLdf.SetOldDistributeLoadMode(int iOldMode)
A RGUMENTS
iOldMode The flag showing if the old model is used.
0 Use standard mode.
1 Use old mode.
5.4.22 ComLink
Overview
LoadMicroSCADAFile
ReceiveData
SendData
SentDataStatus
SetOPCReceiveQuality
SetSwitchShcEventMode
LoadMicroSCADAFile
Reads in a MicroSCADA snapshot file.
int ComLink.LoadMicroSCADAFile(str filename,
[int populate]
)
A RGUMENTS
filename name of the file to read
populate (optional)
determines whether new values should be populated to the network elements
(0=no, 1=yes)
282
R ETURNS
0 On success.
1 On error.
ReceiveData
Reads and processes values for all (in PowerFactory configured) items from OPC server (OPC
only).
int ComLink.ReceiveData([int force])
A RGUMENTS
force (optional)
0 (default) Processes changed values (asynchronously) received by Pow-
erFactory via callback
1 Forces (synchronous) reading and processing of all values (independet
of value changes)
R ETURNS
Number of read items
SendData
Sends values from configured measurement objects to OPC server (OPC only).
int ComLink.SendData([int force])
A RGUMENTS
force (optional)
0 (default) Send only data that have been changed and difference be-
tween old and new value is greater than configured deadband
1 Forces writing of all values (independet of previous value)
R ETURNS
Number of written items
SentDataStatus
Outputs status of all items marked for sending to output window.
int ComLink.SentDataStatus()
R ETURNS
Number of items configured for sending.
SetOPCReceiveQuality
Allows to override the actual OPC receive quality by this value. (Can be used for testing.)
int ComLink.SetOPCReceiveQuality(int quality)
283
A RGUMENTS
quality new receive quality (bitmask)
R ETURNS
0 On success.
1 On error.
SetSwitchShcEventMode
Configures whether value changes for switches are directly transferred to the object itself of
whether shc switch events shall be created instead.
None ComLink.SetSwitchShcEventMode(int enabled)
A RGUMENTS
enabled
0 Values are directly written to switches
1 For each value change a switch event will be created
5.4.23 ComMerge
Overview
CheckAssignments
Compare
CompareActive
ExecuteRecording
ExecuteWithActiveProject
GetCorrespondingObject
GetModification
GetModificationResult
GetModifiedObjects
Merge
PrintComparisonReport
PrintModifications
Reset
SetAutoAssignmentForAll
SetObjectsToCompare
ShowBrowser
WereModificationsFound
CheckAssignments
Checks if all assignments are correct and merge can be done.
int ComMerge.CheckAssignments()
R ETURNS
0 On success.
1 Cancelled by user.
284
2 Missing assignments found.

3 Conflicts found.
4 On other errors.
Compare
Starts a comparison according to the settings in this ComMerge object. The merge browser is
not shown.
int ComMerge.Compare()
CompareActive
Starts a comparison according to the settings in this ComMerge object. The merge browser is
not shown. Can compare with the active project.
int ComMerge.CompareActive()
ExecuteRecording
Starts a comparison according to the settings in this ComMerge object and shows the merge
browser. Records modifications in the active scenario and/or expansion stage of the target
project.
int ComMerge.ExecuteRecording()
ExecuteWithActiveProject
Starts a comparison according to the settings in this ComMerge object and shows the merge
browser. Can compare with the active project.
None ComMerge.ExecuteWithActiveProject()
GetCorrespondingObject
Searches corresponding object for given object.
DataObject ComMerge.GetCorrespondingObject(DataObject sourceObj,
[int target]
)
A RGUMENTS
sourceObj
Object for which corresponding object is searched.
target
0 Get corresponding object from “Base” (default)
1 Get corresponding object from “1st”
2 Get corresponding object from “2nd”
285
R ETURNS
object Corresponding object.
None Corresponding object not found.
GetModification
Gets kind of modification between corresponding objects of “Base” and “1st” or “2nd”.
int ComMerge.GetModification(DataObject sourceObj,
[int taget]
)
A RGUMENTS
sourceObj
Object from any source for which modification is searched.
target
1 Get modification from “Base” to “1st” (default)
2 Get modification from “Base” to “2nd”
R ETURNS
0 On error.
1 No modifications (equal).
2 Modified.
3 Added in “1st”/“2nd”.
4 Removed in “1st”/“2nd”.
GetModificationResult
Gets kind of modifications between compared objects in “1st” and “2nd”.
int ComMerge.GetModificationResult(DataObject obj)
A RGUMENTS
obj Object from any source for which modification is searched.
R ETURNS
0 On error.
1 No modifications (equal).
2 Same modifications in “1st” and “2nd” (no conflict).
3 Different modifications in “1st” and “2nd” (conflict).
GetModifiedObjects
Gets all objects with a certain kind of modification.
list ComMerge.GetModifiedObjects(int modType,
[int modSource]
)
286
A RGUMENTS
modType
1 get unmodified objects
2 get modified objects
3 get added objects
4 get removed obejcts
modSource
1 consider modification between “Base” and “1st” (default)
2 consider modification between “Base” and “2nd”
R ETURNS
Set with matching objects.
Unmodified, modified and added objects are always from given “modSource”, removed ob-
jects are always from “Base” .
Merge
Checks assignments, merges modifications according to assignments into target and prints
merge report to output window.
None ComMerge.Merge(int printReport)
A RGUMENTS
printReport
1 print merge report (default)
0 do not print merge report
always set to 0 in paste and split mode
PrintComparisonReport
Prints the modifications of all compared objects as a report to the output window.
None ComMerge.PrintComparisonReport(int mode)
A RGUMENTS
mode
0 no report
1 only modified compare objects
2 all compare objects
PrintModifications
Prints modifications of given objects (if any) to the output window.
int ComMerge.PrintModifications(list objs)
int ComMerge.PrintModifications(DataObject obj)
287
A RGUMENTS
objs Set of objects for which the modifications are printed.
obj Object for which the modifications are printed.
R ETURNS
0 On error: object(s) not found in comparison.
1 On success: modifications were printed.
Reset
Resets/clears and deletes all temp. object sets, created internally for the comparison.
None ComMerge.Reset()
SetAutoAssignmentForAll
Sets the assignment of all compared objects automatically.
None ComMerge.SetAutoAssignmentForAll(int conflictVal)
A RGUMENTS
conflictVal
Assignment of compared objects with undefined automatic values (e.g. conflicts)
0 no assignment
1 assign from “Base”
2 assign from 1st
3 assign from 2nd
SetObjectsToCompare
Sets top level objects for comparison.
None ComMerge.SetObjectsToCompare(DataObject base,
[DataObject first,]
[DataObject second]
)
A RGUMENTS
base Top level object to be set as “Base”
first Top level object to be set as “1st”
second Top level object to be set as “2nd”
ShowBrowser
Shows merge browser with initialized settings and all compared objects. Can only be called
after a comparison was executed.
int ComMerge.ShowBrowser()
288
R ETURNS
0 The browser was left with ok button.
1 The browser was left with cancel button.
2 On error.
WereModificationsFound
Checks, if modifications were found in comparison.
int ComMerge.WereModificationsFound()
R ETURNS
0 All objects in comparison are equal.
1 Modifications found in comparison.
5.4.24 ComMot
Overview
GetMotorConnections
GetMotorSwitch
GetMotorTerminal
GetMotorConnections
Finds the cables connecting the motor to the switch.
list ComMot.GetMotorConnections(DataObject motor)
A RGUMENTS
motor The motor element
R ETURNS
Returns the set of cables connecting the motor to the switch.
GetMotorSwitch
Finds the switch which will connect the motor to the network.
DataObject ComMot.GetMotorSwitch(DataObject motor)
A RGUMENTS
R ETURNS
Returns the switch element.
289
GetMotorTerminal
Finds the terminal to which the motor will be connected.
DataObject ComMot.GetMotorTerminal(DataObject motor)
A RGUMENTS
R ETURNS
Returns the terminal element.
5.4.25 ComNmink
Overview
AddRef
Clear
GenerateContingenciesForAnalysis
GetAll
AddRef
Adds shortcuts to the objects to the existing selection.
None ComNmink.AddRef(DataObject O)
None ComNmink.AddRef(list S)
A RGUMENTS
O(optional)
an object
S(optional)
a Set of objects
Clear
Delete all contents, i.e. to empty the selection.
None ComNmink.Clear()
GenerateContingenciesForAnalysis
Generates Contingencies for Contingency Analysis. Similar to calling ’Execute’ but does not
pop-up the contingency command.
R ETURNS
0 On success.
1 On error.
290
GetAll
Returns all objects which are of the class 'ClassName'.
list ComNmink.GetAll(str className)
A RGUMENTS
className
The object class name.
R ETURNS
The set of objects
5.4.26 ComOmr
Overview
GetFeeders
GetOMR
GetRegionCount
GetFeeders
Get all feeders for which optimal manual switches have been determined. This function can be
used after execution of an Optimal Manual Restoration command only.
list ComOmr.GetFeeders()
R ETURNS
The set of all feeders used for optimisation.
GetOMR
Get terminal and connected optimal manual switches determined by the optimisation for the
given feeder and its region(pocket) of the given index. For a detailed description of a pocket,
please consult the manual. This function can be used after execution of an Optimal Manual
Restoration command only.
list ComOmr.GetOMR(DataObject arg0,
int arg1
)
A RGUMENTS
arg0 The feeder to derive the resulting optimal terminal with its connected (optimal)
manual switches for.
arg1 The index of the region(pocket) inside the given feeder to derive the resulting
optimal terminal with its connected (optimal) manual switches for.
R ETURNS
The resulting optimal terminal with its connected (optimal) manual switches for the region in
the feeder.
291
GetRegionCount
Get total number of regions(pockets) separated by infeeding point, feeder ends and certain
switches for the provided feeder. For a detailed description of a pocket, please consult the
manual. This function can be used after execution of an Optimal Manual Restoration command
only.
int ComOmr.GetRegionCount(DataObject feeder)
A RGUMENTS
feeder Feeder to derive number of regions(pockets) for.
R ETURNS
Number of regions(pockets) for the feeder.
5.4.27 ComOpc
Overview
ReceiveData
SendData
ReceiveData
Reads and processes values for all (in PowerFactory configured) items from OPC server (OPC
only).
int ComOpc.ReceiveData([int force])
A RGUMENTS
force (optional)
1 Forces (synchronous) reading and processing of all values (independet
of value changes)
R ETURNS
1 if successfully received data -1 if an error occurred -2 if the link is not connected
SendData
Sends values from configured measurement objects to OPC server (OPC only).
int ComOpc.SendData([int force])
A RGUMENTS
force (optional)
0 (default) Send only data that have been changed and difference be-
tween old and new value is greater than configured deadband
1 Forces writing of all values (independet of previous value)
R ETURNS
1 if successfully received data -1 if an error occurred -2 if the link is not connected
292
5.4.28 ComOutage
Overview
ContinueTrace
ExecuteTime
GetObject
RemoveEvents
SetObjs
StartTrace
StopTrace
ContinueTrace
Continue the next step of the trace.
int ComOutage.ContinueTrace()
R ETURNS
0 On success.
6= 0 On error.
ExecuteTime
Execute contingency (with multiple time phase) for the given time.
int ComOutage.ExecuteTime(float time)
A RGUMENTS
time the given time to be executed.
R ETURNS
=0 On success.
6= 0 On error.
GetObject
Get the element stored in line number “line” in the table of ComOutage. The line index starts
with 0.
DataObject ComOutage.GetObject(int line)
A RGUMENTS
line line index, if index exceeds the range None is returned
R ETURNS
the element of line “line” in the table.
293
RemoveEvents
Remove all events defined in this contingency.
None ComOutage.RemoveEvents ([int info])
None ComOutage.RemoveEvents (str type)
None ComOutage.RemoveEvents (int info, str type)
None ComOutage.RemoveEvents (str type, int info)
A RGUMENTS
type
none Hidden objects are ignored and not added to the set
'Lod' remove all EvtLod
'Gen' remove all EvtGen
'Switch' remove all EvtSwitch
info(optional)
1 show info message in output window (default)
0 do not show info message
SetObjs
To fill up the ”interrupted components” with given elements.
Sets the list of objects according to S.
int ComOutage.SetObjs(list S)
A RGUMENTS
S the set of objects
R ETURNS
0 On success.
1 On error.
StartTrace
Start trace all post fault events of this contingency.
int ComOutage.StartTrace()
R ETURNS
=0 On success.
6= 0 On error.
StopTrace
To stop the trace.
int ComOutage.StopTrace([int msg])
294
A RGUMENTS
msg (optional)
Emit messages or not.
0 Suppress messages.
1 Emit messages.
R ETURNS
=0 On success.
6= 0 On error.
5.4.29 ComPfdimport
Overview
GetImportedObjects
GetImportedObjects
Returns the imported objects of last execution of command.
list ComPfdimport.GetImportedObjects()
R ETURNS
Returns the imported objects of the last execution of the command.
5.4.30 ComPrjconnector
Overview
GetSuccesfullyConnectedItems
GetUnsuccesfullyConnectedItems
GetSuccesfullyConnectedItems
Returns a list of elements which were correctly processed in the last run of the command
list ComPrjconnector.GetSuccesfullyConnectedItems()
GetUnsuccesfullyConnectedItems
Returns a list of elements which were not correctly processed in the last run of the command
list ComPrjconnector.GetUnsuccesfullyConnectedItems()
295
5.4.31 ComProtgraphic
Overview
AddToUpdatePages
ClearUpdatePages
AddToUpdatePages
Adds pages (*.SetVipage) to the user-defined selection of plot pages to update.
None ComProtgraphic.AddToUpdatePages(list pages)
ClearUpdatePages
Clears the user-defined selection of plot pages to update.
None ComProtgraphic.ClearUpdatePages()
5.4.32 ComPvcurves
Overview
FindCriticalBus
FindCriticalBus
Returns the critical bus for a given PV-Curve result file. The critical bus is the one with the
highest gradient at the last iteration. If a bus is found, whose voltage drop is twice as high, as
the one with the highest gradient, the bus with the higher voltage drop is the critical one.
DataObject ComPvcurves.FindCriticalBus(DataObject resultfile)
5.4.33 ComPython
Overview
GetExternalObject
SetExternalObject
GetExternalObject
Gets the external object defined in the ComPython edit dialog.
[int error,
DataObject value] ComPython.GetExternalObject(str name)
296
A RGUMENTS
value (out)
The external object.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComPython.SetExternalObject(), ComPython.GetInputParameterInt(),
ComPython.GetInputParameterDouble(), ComPython.GetInputParameterString()
Gets the double input parameter value defined in the ComPython edit dialog.
[int error,
float value] ComPython.GetInputParameterDouble(str name)
A RGUMENTS
value (out)
Value of the double input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComPython.SetInputParameterDouble(), ComPython.GetInputParameterInt(),
ComPython.GetInputParameterString(), ComPython.GetExternalObject()
Gets the integer input parameter value defined in the ComPython edit dialog.
[int error,
int value ] ComPython.GetInputParameterInt(str name)
A RGUMENTS
value (out)
Value of the integer input parameter.
R ETURNS
0 On success.
1 On error.
297
S EE ALSO
ComPython.SetInputParameterInt(), ComPython.GetInputParameterDouble(),
ComPython.GetInputParameterString(), ComPython.GetExternalObject()
Gets the string input parameter value defined in the ComPython edit dialog.
[int error,
str value ] ComPython.GetInputParameterString(str name)
A RGUMENTS
value (out)
Value of the string input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComPython.SetInputParameterString(), ComPython.GetInputParameterInt(),
ComPython.GetInputParameterDouble(), ComPython.GetExternalObject()
SetExternalObject
Sets the external object defined in the ComPython edit dialog.
int ComPython.SetExternalObject(str name,
DataObject value
)
A RGUMENTS
value The external object.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComPython.GetExternalObject(), ComPython.SetInputParameterInt(),
ComPython.SetInputParameterDouble(), ComPython.SetInputParameterString()
Sets the double input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterDouble(str name,
float value
)
298
A RGUMENTS
value Value of the double input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComPython.GetInputParameterDouble(), ComPython.SetInputParameterInt(),
ComPython.SetInputParameterString(), ComPython.SetExternalObject()
Sets the integer input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterInt(str name,
int value
)
A RGUMENTS
value Value of the integer input parameter.
R ETURNS
0 On success.
1 On error.
S EE ALSO
ComPython.GetInputParameterInt(), ComPython.SetInputParameterDouble(),
ComPython.SetInputParameterString(), ComPython.SetExternalObject()
Sets the string input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterString(str name,
str value
)
A RGUMENTS
value Value of the string input parameter.
R ETURNS
0 On success.
1 On error.
299
S EE ALSO
ComPython.GetInputParameterString(), ComPython.SetInputParameterInt(),
ComPython.SetInputParameterDouble(), ComPython.SetExternalObject()
5.4.34 ComRed
Overview
ReductionInMemory
ResetReductionInMemory
ReductionInMemory
Execute network reduction in memory, no change to database. Note: afterwards, the function
ResetReductionInMemory() must be called to revert the reduction.
int ComRed.ReductionInMemory()
R ETURNS
Returns 0 if successfully executed.
ResetReductionInMemory
Restore the network back to original after reduction in memory.
void ComRed.ResetReductionInMemory()
5.4.35 ComRel3
Overview
AnalyseElmRes
ExeEvt
OvlAlleviate
RemoveEvents
RemoveOutages
ValidateConstraints
AnalyseElmRes
Evaluate the results object created by the last calculation. Performs exactly the same as
pressing the button 'Perform Evaluation of Result File' in the dialogue box of the command.
int ComRel3.AnalyseElmRes([int error])
A RGUMENTS
error (optional)
0 do not display an error message (default)
1 display error messages in case of errors
R ETURNS
=0 On success.
300
6= 0 On error.
ExeEvt
Executes a given event.
None ComRel3.ExeEvt([DataObject event])
A RGUMENTS
event The event that shall be executed.
OvlAlleviate
Performs an overload alleviation for given events.
int ComRel3.OvlAlleviate([list preCalcEvents])
A RGUMENTS
preCalcEvents (optional)
The events which will be executed before the calculation.
R ETURNS
0 On success.
1 Failure in load flow.
2 No overloading detected.
>2 On error.
RemoveEvents
Removes all events stored in all contingencies (*.ComContingency) inside the reliability com-
mand.
None ComRel3.RemoveEvents()
RemoveOutages
Removes all contingency definitions (*.ComContingencies) stored inside the reliability com-
mand.
None ComRel3.RemoveOutages([int msg])
A RGUMENTS
msg( optional)
1 Show info message in output window (default value).
0 Do not emit messages.
301
ValidateConstraints
Checks if the restoration of a contingency violates any constraint according to the current
settings of the reliability calculation. These do not necessarily have to be the settings used
during calculation. Of course the selected calculation method of ComRel3 has to be ’Load flow
analysis’ to check for constraint violations.
int ComRel3.ValidateConstraints(DataObject contingency)
A RGUMENTS
contingency
The contingency which will be checked for constraint violations.
R ETURNS
0 No constraint violations, or all constraint violations could be solved.
1 Constraints are violated.
−1 Contingency not valid.
5.4.36 ComRelpost
Overview
CalcContributions
GetContributionOfComponent
CalcContributions
Calculates the contributions to load interruptions of the loads that are passed to this function.
The loads can be e.g. inside a feeder or a zone as well. If nothing is passed as input all loads
will be analysed.
int ComRelpost.CalcContributions([list elements])
A RGUMENTS
elements (optional)
Elements (Loads) for which the contributions shall be calculated (default: all loads,
if no argument is passed).
R ETURNS
0 Calculation successful.
1 On error.
Gets the contributions of a component to a certain reliability indice.
float ComRelpost.GetContributionOfComponent(int componentNr,
str indice)
A RGUMENTS
componentNr 1. Lines
2. Cables
302
3. Transformers
4. Busbars
5. Generators
6. Common Modes
7. Double Earth Faults
indice Avalaible indices are: ’SAIFI’, ’SAIDI’, ’ASIFI’, ’ASIDI’, ’ENS’, ’EIC’
R ETURNS
The contribution of this component to this reliability indice.
5.4.37 ComRelreport
Overview
GetContingencies
GetContingencies
Gets all contingencies of reliability for reporting.
list ComRelpost.GetContingencies()
R ETURNS
All contingencies of reliability for reporting.
Is described in ComRelpost.GetContributionOfComponent().
float ComRelreport.GetContributionOfComponent(int componentNr,
str indice)
5.4.38 ComRes
Overview
ExportFullRange
FileNmResNm
ExportFullRange
Executes the export command for the whole data range.
None ComRes.ExportFullRange()
303
FileNmResNm
Sets the filename for the data export to the name of the result object being exported (classes:
ElmRes, IntComtrade)
None ComRes.FileNmResNm()
5.4.39 ComShc
Overview
ExecuteRXSweep
GetFaultType
GetOverLoadedBranches
GetOverLoadedBuses
ExecuteRXSweep
Calculates RX Sweep. If no impedance passed, the value from the command shall be used. If
argument passed then the impedance changes are stored to the command (Rf, Xf).
int ComShc.ExecuteRXSweep()
int ComShc.ExecuteRXSweep(float Zr,
float Zi
)
A RGUMENTS
Zr Impedance real part
Zi Impedance imaginary part
R ETURNS
=0 On success.
6= 0 On error.
GetFaultType
Returns the short-circuit fault type.
int ComShc.GetFaultType()
R ETURNS
0 three phase fault
1 single phase to ground
2 two phase fault
3 two phase to ground fault
4 three phase unbalanced fault
5 single phase to neutral fault
6 single phase, neutral to ground fault
7 two phase to neutral fault
8 two phase, neutral to ground fault
304
9 three phase to neutral fault

10 three phase, neutral to ground fault
20 DC fault
GetOverLoadedBranches
Get overloaded branches after a short-circuit calculation.
[int error,
list branches] ComShc.GetOverLoadedBranches(float ip,
float ith)
A RGUMENTS
ip Max. peak-current loading, in %
ith Max. thermal loading, in %
branches (out)
Set of branches which are checked
R ETURNS
=0 On error or 0 branches found.
6= 0 Number of branches.
E XAMPLE
GetOverLoadedBuses
Get overloaded buses after a short-circuit calculation.
[int error,
list buses] ComShc.GetOverLoadedBuses(float ip,
float ith)
A RGUMENTS
ip Max. peak-current loading, in %
ith Max. thermal loading, in %
buses (optional, out)

Set of buses which are checked
R ETURNS
=0 On error or 0 buses found.
6= 0 Number of buses.
E XAMPLE
305
5.4.40 ComShctrace
Overview
BlockSwitch
ExecuteAllSteps
ExecuteInitialStep
ExecuteNextStep
GetBlockedSwitches
GetCurrentTimeStep
GetDeviceSwitches
GetDeviceTime
GetNonStartedDevices
GetStartedDevices
GetSwitchTime
GetTrippedDevices
NextStepAvailable
BlockSwitch
Blocks a switch from operating for the remainder of the trace.
int ComShctrace.BlockSwitch(DataObject switchDevice)
A RGUMENTS
switchDevice
Switch device to block.
R ETURNS
0 Switch can not be blocked (e.g. because it already operated).
1 Switch is blocked.
ExecuteAllSteps
Executes all steps of the short circuit trace. This function requires the trace to be already
running
int ComShctrace.ExecuteAllSteps()
R ETURNS
0 No error occurred, trace is complete.
!=0 An error occurred, calculation was reset.
S EE ALSO
ComShctrce.ExecuteInitialStep()
ExecuteInitialStep
Executes the first step of the short circuit trace.
int ComShctrace.ExecuteInitialStep()
306
R ETURNS
0 No error occurred, the short-circuit trace is now running.
ExecuteNextStep
Executes the next step of the short circuit trace. This function requires the trace to be already
running
int ComShctrace.ExecuteNextStep()
R ETURNS
0 No error occurred, step was executed .
S EE ALSO
ComShctrce.ExecuteInitialStep()
GetBlockedSwitches
Returns all switches which are currently blocked.
list ComShctrace.GetBlockedSwitches()
R ETURNS
All blocked switches.
GetCurrentTimeStep
Returns the current time step of the trace in seconds.
int ComShctrace.GetCurrentTimeStep()
R ETURNS
The current time step in [s].
GetDeviceSwitches
Returns all switches operated by a protection device.
list ComShctrace.GetDeviceSwitches(DataObject device)
A RGUMENTS
device Protection device to get the switches for.
R ETURNS
All switches devices operated by the protection device.
307
GetDeviceTime
Returns the time a protection device operated or will operate at.
int ComShctrace.GetDeviceTime(DataObject device)
A RGUMENTS
device Protection device to get the time for.
R ETURNS
The tripping time of the device itself, if the device already tripped, or the prospective tripping
time.
GetNonStartedDevices
Returns all protection devices which are not started.
list ComShctrace.GetNonStartedDevices()
R ETURNS
All protection devices which are not started.
GetStartedDevices
Returns all started but not yet tripped protection devices.
list ComShctrace.GetStartedDevices()
R ETURNS
All started but not yet tripped protection devices.
GetSwitchTime
Returns the time a switch device operated or will operate at.
int ComShctrace.GetSwitchTime(DataObject device,
DataObject switchDevice
)
A RGUMENTS
device Reference protection device for the switch.
device Switch device to get the time for.
R ETURNS
The tripping time of the switch device, based on the tripping time of the reference protection
device. If the switch already operated, the time of operation will be returned.
GetTrippedDevices
Returns all protection devices already tripped.
list ComShctrace.GetTrippedDevices()
308
R ETURNS
All protection devices already tripped.
NextStepAvailable
Indicates whether or not a next time step can be executed.
int ComShctrace.NextStepAvailable()
R ETURNS
0 Next step is not available, the trace is completed.
1 A next step is available.
5.4.41 ComSim
Overview
GetSimulationTime
GetTotalWarnA
GetTotalWarnB
GetTotalWarnC
GetViolatedScanModules
LoadSnapshot
SaveSnapshot
GetSimulationTime
Get the actual simulation time if the initial conditions are calculated.
int ComSim.GetSimulationTime()
R ETURNS
Returns the simulation time in seconds. If the initial conditions are not calculated, then the
function returns ’nan’.
GetTotalWarnA
Returns the total number of type-A (serious) warnings related to the time-domain simulation.
int ComSim.GetTotalWarnA()
R ETURNS
Returns the total number of type-A (serious) warnings.
GetTotalWarnB
Returns the total number of type-B (moderate) warnings related to the time-domain simulation.
int ComSim.GetTotalWarnB()
309
R ETURNS
Returns the total number of type-B (moderate) warnings.
GetTotalWarnC
Returns the total number of type-C (minor) warnings related to the time-domain simulation.
int ComSim.GetTotalWarnC()
R ETURNS
Returns the total number of type-C (minor) warnings.
GetViolatedScanModules
Returns a set of scan modules of which each have at least one violation.
list ComSim.GetViolatedScanModules()
R ETURNS
Returns a set of scan modules of which each have at least one violation.
LoadSnapshot
Load the state of a dynamic simulation from a file.
int ComSim.LoadSnapshot([string snapshotFilePath], [int suppressUserMessage])
D EPRECATED N AMES
LoadSimulationState
A RGUMENTS
snapshotFilePath (optional)
The snapshot file to load. If no file is specified, the last snapshot stored in the
memory is used. (default = ”)
suppressUserMessage (optional)
The pop-up window asking for data overwrite is not displayed if this value is set to
1. (default = 0)
R ETURNS
0 Saved simulation state has been loaded.
1 Saved simulation state cannot be loaded.
2 Saved simulation state does not match actual model. Calculation will be reset.
SaveSnapshot
Save the state of a dynamic simulation to memory and to a file.
int ComSim.SaveSnapshot(string snapshotFilePath, [int suppressUserMessage])
310
D EPRECATED N AMES
SaveSimulationState
A RGUMENTS
snapshotFilePath (optional)
The snapshot file to save. If no file is specified, the last snapshot is saved in the
non-persistent memory slot. (default = ”)
suppressUserMessage (optional)
The pop-up window asking for file overwriting is not displayed if this value is set to
1. (default = 0)
R ETURNS
0 OK
1 Error
5.4.42 ComSimoutage
Overview
AddCntcy
AddContingencies
AddRas
ClearCont
CreateFaultCase
Execute
ExecuteAndCheck
GetNTopLoadedElms
MarkRegions
RemoveAllRas
RemoveContingencies
RemoveRas
Reset
SetLimits
Update
AddCntcy
Executes an (additional) ComOutage, without resetting results. The results of the outage
analysis will be added to the intermediate results. Object “O” must be a ComOutage object.
If the outage definition has already been analyzed, it will be ignored. The ComOutage will be
renamed to “name” when “name” is given.
int ComSimoutage.AddCntcy(DataObject O,
[str name]
)
A RGUMENTS
O The ComOutage object
name A name for the outage
R ETURNS
0 On success.
311
1 On error.
AddContingencies
Adds contingencies for fault cases/groups selected by the user to the command. Shows a modal
window with the list of available fault cases and groups. Functionality as “Add Cases/Groups”
button in dialog.
None ComSimoutage.AddContingencies()
AddRas
Adds a reference to a given IntRas to the ComSimoutage.
int ComSimoutage.AddRas(DataObject ras)
A RGUMENTS
ras The IntRas object
R ETURNS
0 If the reference to the IntRas has been added.
1 If the reference to the IntRas has already been there or on error.
ClearCont
Reset existing contingency analysis results and delete existing contingency cases.
int ComSimoutage.ClearCont()
R ETURNS
0 On success.
1 On error.
CreateFaultCase
Create fault cases from the given elements.
int ComSimoutage.CreateFaultCase(list elms,
int mode,
[int createEvt],
[DataObject folder]
)
A RGUMENTS
elms Selected elements to create fault cases.
mode How the fault cases are created:
0 Single fault case containing all elements.
312
3 Collecting coupling elements and create fault cases for line couplings.
createEvt (optional)
Switch event:
0 Do NOT create switch events.
1 Create switch events.
folder (optional)
Folder in which the fault case is stored.
R ETURNS
0 On success.
1 On error.
Execute
Execute contingency analysis.
int ComSimoutage.Execute()
R ETURNS
0 On success.
1 On error.
ExecuteAndCheck
Executes contingency analysis and checks the violated constraints. The constraints are defined
in models, such as maximum and minimum voltage of buses, maximum loading of lines etc.
On the first occured constraint violation, the further contingency execution will be terminated,
making the calculation faster, but with less information.
int ComSimoutage.ExecuteAndCheck([int workMode,]
[int initMode,]
[int considerOPFflags,]
[int considerVstep]
)
A RGUMENTS
workMode (optional)
the mode how the contingency analysis is executed; default is 0
0 Normal execution (doesn’t check limits, write results file)
1 Check constraints (thermal loading, bus voltage range) and terminate
execution if violates any limit, writes result file
2 Check constraints (thermal loading, bus voltage range) and terminate
execution if violates any limit, does not write result file
3 Check thermal loading only and terminate execution if violates any
limit, writes result file
4 Check thermal loading only and terminate execution if violates any
limit, does not write result file
5 Check voltage limits only and terminate execution if violates any limit,
writes result file
313
6 Check voltage limits only and terminate execution if violates any limit,
does not write result file
7 Neither loading nor voltage limits are checked and terminate execution
if any contingency fails, writes result file
8 Neither loading nor voltage limits are checked and terminate execution
if any contingency fails, does not write result file
initMode (optional)
the mode how the contingency analysis is initialised; default is 0
0 full initialisation, new topology rebuild, and update all contingencies
1 new topology rebuild, but skip updating all contingencies
2 no topology rebuild, and no contingency update, which is the fastest
mode
considerOPFflags (optional)
whether the voltage limit settings on OPF page will be considered or not; default
is 1
0 the settings on OPF page are not considered.
1 the voltage limits are considered only when the check boxes on OPF
page are ticked.
considerVstep (optional)
whether the voltage step limits will be considered or not; default is 1
0 the voltage step limits are not considered.

1 the voltage step limits are considered.
R ETURNS
0 contingencies successfully executed without any violation
1 calculation was interrupted by the user
2 error occurred during contingency analysis
3 initialisation failed, such as base case laod flow diverged
4 for AC/DC combined method, base case is already critical and calculation stopped
5 any loading constraint violated
6 any contingency cannot be analysed, non-convergent case
7 any voltage constraint violated
8 any constraint violated already in the base case
GetNTopLoadedElms
To get certain number of top loaded components (most close to its limit).
list ComSimoutage.GetNTopLoadedElms(int number)
A RGUMENTS
number The number of elements to be found.
elements (out)
The top loaded elements.
314
MarkRegions
To execute Region marker for certain system status (like prefault, post fault etc.), which will
indentifies energizing mode for each element.
int ComSimoutage.MarkRegions(int stage)
A RGUMENTS
stage which system stage to be analyzed, 0¡=stage¡=2
R ETURNS
0 On success.
1 On error.
RemoveAllRas
Removes all IntRas from to the ComSimoutage. Only deletes the references not the IntRas
itself.
None ComSimoutage.RemoveAllRas()
RemoveContingencies
Removes all contingencies from the command. Functionality as ”Remove All” button in dialog.
None ComSimoutage.RemoveContingencies()
RemoveRas
Removes the reference to a given IntRas from the ComSimoutage.
int ComSimoutage.RemoveRas(DataObject ras)
A RGUMENTS
ras The IntRas object
R ETURNS
0 If the reference to the IntRas has been successfully removed.
1 If the reference to the IntRas has not been in the container or on error.
Reset
Resets the intermediate results of the outage simulation.
int ComSimoutage.Reset()
R ETURNS
0 On success.
1 On error.
315
SetLimits
Sets the recording limits for the Contingency Analysis.
None ComSimoutage.SetLimits(float vlmin,
float vlmax,
float ldmax)
A RGUMENTS
vlmin The minimum voltage
vlmax The maximum voltage
ldmax The maximum loading
Update
To update contingency cases via topology search. It will find interrupted elements, required
switch actions for each contingency.
int ComSimoutage.Update()
R ETURNS
0 On success.
1 On error.
5.4.43 ComSvgexport
Overview
SetFileName
SetObject
SetObjects
SetFileName
Sets SVG file for export.
None ComSvgexport.SetFileName(str path)
A RGUMENTS
path Path of target SVG file
SetObject
Sets annotation layer or group for export.
None ComSvgexport.SetObject(DataObject obj)
A RGUMENTS
obj Annotation layer (IntGrflayer) or group (IntGrfgroup) to be exported
316
SetObjects
Sets annotation layers and groups for export.
None ComSvgexport.SetObjects(set objs)
A RGUMENTS
objs Set of annotation layers (IntGrflayer) and/or groups (IntGrfgroup) to be exported
5.4.44 ComSvgimport
Overview
SetFileName
SetObject
SetFileName
Sets source SVG file for import.
None ComSvgimport.SetFileName(str path)
A RGUMENTS
path Path of SVG file to be imported
SetObject
Sets target annotation layer or group for import.
None ComSvgimport.SetObject(DataObject obj)
A RGUMENTS
obj Target annotation layer (IntGrflayer) or group (IntGrfgroup)
5.4.45 ComTasks
Overview
AppendCommand
AppendStudyCase
GetCommandsForStudyCase
GetNumberOfCommandsForStudyCase
GetNumberOfStudyCases
GetStudyCases
IsAdditionalResultsFlagSetForCommand
IsCommandIgnored
IsStudyCaseIgnored
RemoveCmdsForStudyCaseRow
RemoveCommand
RemoveStudyCase
RemoveStudyCases
317
SetAdditionalResultsFlagForCommand
SetIgnoreFlagForCommand
SetIgnoreFlagForStudyCase
SetResultsFolder
AppendCommand
Appends a command for calculation.
int ComTasks.AppendCommand(DataObject command,
[int studyCaseRow]
)
R ETURNS
0 Command could not be added for calculation.
1 Command has been successfully added for calculation.
A RGUMENTS
command
Command to add for calculation.
studyCaseRow
≤0 Command is added to the list of commands for its study case.
>0 Optionally, the row in the study case table containing the study case
for which this command shall be added can be passed. This is helpful,
e.g., if a study case has been added multiple times for calculation with
different command lists.
AppendStudyCase
Appends a study case to the list of study cases for calculation.
int ComTasks.AppendStudyCase(DataObject studyCase)
R ETURNS
0 Study case could not be added for calculation.
1 Study case has been successfully added for calculation.
A RGUMENTS
studyCase
Study case to add for calculation.
GetCommandsForStudyCase
Get all selected commands to be processed for a study case from the Task Automation com-
mand.
list ComTasks.GetCommandsForStudyCase(DataObject studyCase,
[int studyCaseRow])
R ETURNS
Returns ordered set of all selected commands to be processed for a study case.
318
A RGUMENTS
studyCase
Study case to get all selected commands to be processed from.
studyCaseRow
≤0 Commands for the first matching study case found will be returned.
for which commands shall be returned can be passed. This is helpful,
GetNumberOfCommandsForStudyCase
Get number of all selected commands to be processed for a study case from the Task Automa-
tion command.
int ComTasks.GetNumberOfCommandsForStudyCase(DataObject studyCase,
[int studyCaseRow])
R ETURNS
Returns number of all selected commands to be processed for a study case.
A RGUMENTS
studyCase
Study case to get number of selected commands to be processed from.
studyCaseRow
≤0 Number of commands for the first matching study case found will be
returned.
for which number of commands shall be returned can be passed. This
is helpful, e.g., if a study case has been added multiple times for
calculation with different command lists.
GetNumberOfStudyCases
Get number of selected study cases from the Task Automation command.
int ComTasks.GetNumberOfStudyCases()
R ETURNS
Returns number of selected study cases from the Task Automation command.
GetStudyCases
Get all selected study cases from the Task Automation command.
list ComTasks.GetStudyCases()
319
R ETURNS
Returns ordered set of all selected study cases from the Task Automation command, set is
empty on failure.
IsAdditionalResultsFlagSetForCommand
Returns whether additional results flag of a command is set or not (using study case row and
task row / using a command directly).
int ComTasks.IsAdditionalResultsFlagSetForCommand(int studyCaseRow,
int taskRow)
int ComTasks.IsAdditionalResultsFlagSetForCommand(DataObject command)
A RGUMENTS
studyCaseRow ≤ 0
The row in the study cases table of the command’s study case for which the
additional results flag shall be derived.
taskRow > 0
The row in the commands table for which the additional results flag shall be
derived.
command
The command to get the additional results flag for.
R ETURNS
0 Additional results flag of command is not set.
1 Additional results flag of command is set.
-1 Additional results flag was not found for provided study case row and task row /
provided command.
IsCommandIgnored
Returns whether the processing of a command will be ignored or not (using study case row and
task row / using provided command).
int ComTasks.IsCommandIgnored(int studyCaseRow,
int taskRow)
int ComTasks.IsCommandIgnored(DataObject command)
A RGUMENTS
studyCaseRow ≤ 0
The row in the study cases table of the command’s study case for which the ignore
flag shall be derived.
taskRow > 0
The row in the commands table for which the ignore flag shall be derived.
command
The command to get the ignore-flag for.
320
R ETURNS
0 Processing of command will be done.
1 Processing of command will be ignored.
-1 Command was not found (for provided study case row and task row / at all).
IsStudyCaseIgnored
Returns whether the command processing for a study case will be ignored or not.
int ComTasks.IsStudyCaseIgnored(DataObject studyCase,
[int studyCaseRow])
R ETURNS
0 Command processing for study case will be done.
1 Command processing for study case will be ignored.
-1 study case or row was not found.
A RGUMENTS
studyCase
Study case to get ignore-flag from.
studyCaseRow
≤0 Ignore flag for the first matching study case found will be returned.
for which ignore-flag shall be returned can be passed. This is helpful,
RemoveCmdsForStudyCaseRow
Removes all commands selected for calculation for a given row in the study case table.
int ComTasks.RemoveCmdsForStudyCaseRow(int studyCaseRow)
R ETURNS
0 Commands could not be removed from calculation.
1 All commands of study case row were successfully removed from calculation.
A RGUMENTS
studyCaseRow> 0
The row in the study case table containing the study case for which all commands
shall be removed.
RemoveCommand
Remove a command from the calculation (for study case row and task row / for all appear-
ances).
int ComTasks.RemoveCommand(int studyCaseRow,
int taskRow
)
int ComTasks.RemoveCommand(DataObject command)
321
A RGUMENTS
studyCaseRow> 0
The row in the study cases table of the command’s study case for which the
command shall be removed.
taskRow> 0
The row in the commands table for which the command shall be removed.
command
Command to remove.
R ETURNS
0 Command could not be removed.
1 Command has been successfully removed.
RemoveStudyCase
Removes a study case from the study cases table.
int ComTasks.RemoveStudyCase(DataObject studyCase,
[int studyCaseRow]
)
R ETURNS
0 Study case could not be removed.
1 Study case has been successfully removed.
A RGUMENTS
studyCase
Study case which shall be removed.
studyCaseRow
≤0 Study case is removed for all entries in the study cases table matching
the provided study case.
which shall be removed can be passed. This is helpful, e.g., if a
study case has been added multiple times for calculation with different
command lists.
RemoveStudyCases
Removes all study cases from calculation.
None ComTasks.RemoveStudyCases()
SetAdditionalResultsFlagForCommand
Set the flag whether to record an additional result file for a command of the calculation (using
study case row and task row / using command).
322
int ComTasks.SetAdditionalResultsFlagForCommand(int studyCaseRow,

int taskRow,
int addResVal
)
int ComTasks.SetAdditionalResultsFlagForCommand(DataObject command,
int addResVal
)
A RGUMENTS
studyCaseRow> 0
The row in the study cases table of the command’s study case for which the flag
to record additional results shall be set.
taskRow> 0
The row in the commands table for which the flag to record additional results shall
be set.
command
The command for which the flag to record additional results shall be set.
addResVal
1 Will set the command to record additional results for the calculation.
0 Will set the command to avoid recording of results for calculation.
R ETURNS
0 Flag to record (or not record) additional results could not be set.
1 Flag to record (or not record) additional results has been successfully set.
SetIgnoreFlagForCommand
Set the flag whether to ignore a command for the calculation (using study case row and task
row / using command).
int ComTasks.SetIgnoreFlagForCommand(int studyCaseRow,
int taskRow,
int ignoreVal
)
int ComTasks.SetIgnoreFlagForCommand(DataObject command,
int ignoreVal
)
A RGUMENTS
studyCaseRow> 0
The row in the study cases table of the command’s study case for which the ignore
flag shall be set.
taskRow> 0
The row in the commands table for which the ignore flag shall be set.
command
Command for which the ignore flag shall be set.
ignoreVal
1 Will set the command to be ignored for calculation.
0 Will set the command to be processed for calculation.
323
R ETURNS
0 Ignore flag could not be set.
1 Ignore flag has been successfully set.
SetIgnoreFlagForStudyCase
Set the flag whether to ignore the processing of commands of a study case for the calculation.
int ComTasks.SetIgnoreFlagForStudyCase(DataObject studyCase,
int ignoreVal,
[int studyCaseRow]
)
R ETURNS
0 Ignore flag could not be set.
1 Ignore flag has been successfully set.
A RGUMENTS
studyCase
Study case for which the ignore flag shall be set.
ignoreVal
1 Will set the flag to ignore the processing of commands of a study case.
0 Will set the flag to process the commands of a study case.
studyCaseRow
≤0 Ignore flag is set for all entries in the study cases table matching the
provided study case.
for which the ignore-flag shall be set can be passed. This is helpful,
SetResultsFolder
Set a folder to store results for a given row in the study case table.
int ComTasks.SetResultsFolder(DataObject folder, int studyCaseRow)
R ETURNS
0 New folder could not be set as results folder for the given row in the study case
table.
1 Folder was successfully set as resuls folder for given row in the study case table.
A RGUMENTS
folder The new folder to store results in.
studyCaseRow
The row in the study case table containing the study case for which results folder
shall be set.
324
5.4.46 ComTececo
Overview
UpdateTablesByCalcPeriod
UpdateTablesByCalcPeriod
Update all calculation points with respect to a new start- and end year
int ComTececo.UpdateTablesByCalcPeriod(float start,
float end
)
A RGUMENTS
start Start year of the study period
end End year of the study period
R ETURNS
0 Calculation points have been successfully set.
1 Invalid input data: end year of study period must be greater or equal to start year.
5.4.47 ComTransfer
Overview
GetTransferCalcData
IsLastIterationFeasible
GetTransferCalcData
The function returns the calculated transfer capacity and the total number of iteration after the
transfer capacity command has been executed.
[float transferCapacity,
int totalIterations ] ComTransfer.GetTransferCalcData()
A RGUMENTS
transferCapacity (out)
Transfer capacity value at the last feasible iteration.
totalIterations (out)
Total iteration number.
IsLastIterationFeasible
The function verifies if the last transfer calculation iteration resulted in a feasible solution or not.
int ComTransfer.IsLastIterationFeasible()
325
R ETURNS
1 Last transfer calculation iteration resulted in a feasible solution.
0 Last transfer calculation iteration did not result in a feasible solution.
5.4.48 ComUcte
Overview
SetBatchMode
SetBatchMode
The batch mode allows to suppress all messages except error and warnings. This can be useful
when used in scripts where additional output might be confusing.
None ComUcte.SetBatchMode(int enabled)
A RGUMENTS
enabled
0 disables batch mode, all messages are printed to output window (de-
fault).
1 enables batch mode, only error and warning messages are printed to
output window.
5.4.49 ComUcteexp
Overview
BuildNodeNames
DeleteCompleteQuickAccess
ExportAndInitQuickAccess
GetConnectedBranches
GetFromToNodeNames
GetOrderCode
GetUcteNodeName
InitQuickAccess
QuickAccessAvailable
ResetQuickAccess
SetGridSelection
BuildNodeNames
Builds the node names as used in UCTE export and makes them accessible via :UcteNode-
Name attribute. The node names will only be available as long as topology has not been
changed. They must be re-build after any topology relevant modification.
Furthermore, the method fills the quick access cache given by the cache index for node names
and branch topologies as used in UCTE export. The quick access cache endures also topology
changes. The cache index is optional. If no cache index is given the default quick access cache
is used.
int ComUcteexp.BuildNodeNames([int cacheIndex])
326
A RGUMENTS
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)
R ETURNS
0 On success.
1 0n error (e.g. load flow calculation failed).
DeleteCompleteQuickAccess
Deletes all quick access caches.
None ComUcteexp.DeleteCompleteQuickAccess()
ExportAndInitQuickAccess
Performs an UCTE export and fills the quick access cache given by the cache index.
None ComUcteexp.ExportAndInitQuickAccess(int cacheIndex)
A RGUMENTS
cacheIndex
GetConnectedBranches
Determines the connected branches for the given terminal from the quick access cache given
by the optional cache index. If no cache index is given the default quick access cache is used.
list ComUcteexp.GetConnectedBranches(DataObject terminal,
[int cacheIndex])
A RGUMENTS
terminal Terminal to determine the connected branches from
connectedBranches (out)
Connected branches for the given terminal
GetFromToNodeNames
Determines the UCTE node names of the branch ends from the quick access cache given by
the optional cache index. If no cache index is given the default quick access cache is used.
[str nodeNameFrom,
str nodeNameTo ] ComUcteexp.GetFromToNodeNames(DataObject branch,
[int cacheIndex])
327
A RGUMENTS
branch Branch to find the UCTE node names from
nodeNameFrom (out)
UCTE node name of start node
nodeNameTo (out)
UCTE node name of end node
GetOrderCode
Determines the order code of the given branch element as used for UCTE export from the quick
access cache given by the optional cache index. If no cache index is given the default quick
access cache is used.
str ComUcteexp.GetOrderCode(DataObject branch,
[int cacheIndex])
A RGUMENTS
branch Branch element to get the UCTE order code from
orderCode (out)
Order code of the given branch element
GetUcteNodeName
Determines the node name of the given terminal as used for UCTE export from the quick access
cache given by the optional cache index. If no cache index is given the default quick access
cache is used.
None ComUcteexp.GetOrderCode(DataObject terminal,
[int cacheIndex])
A RGUMENTS
terminal Terminal to get the UCTE node name from
ucteNodeName (out)
UCTE node name of the given terminal
InitQuickAccess
Initializes the quick access cache given by the optional cache index. The quick acess cache
contains node names and branch topologies as used in UCTE export and endures topology
changes. InitQuickAccess() requires a successful executed UCTE export as pre-condition. The
cache index is optional. If no cache index is given the default quick access cache is used.
None ComUcteexp.InitQuickAccess([int cacheIndex])
328
A RGUMENTS
QuickAccessAvailable
Checks if the quick access cache given by the optional cache index is available. If no cache
index is given the default quick access cache is checked for availability.
int ComUcteexp.QuickAccessAvailable([int cacheIndex])
A RGUMENTS
R ETURNS
0 on success and 1 on error.
ResetQuickAccess
Resets the given quick access cache for node names and branch topologies as used in UCTE
export. The cache index is optional. If no cache index is given the default quick access cache
is reset.
None ComUcteexp.ResetQuickAccess([int cacheIndex])
A RGUMENTS
SetGridSelection
Configures the selected grids in the UCTE export command.
None ComUcteexp.SetGridSelection(list gridsToExport)
A RGUMENTS
gridsToExport
Grids (instances of class ElmNet) to be selected for export. All not contained grids
will be de-selected.
5.4.50 ComWktimp
Overview
GetCreatedObjects
GetModifiedObjects
329
5.5. SETTINGS CHAPTER 5. OBJECT METHODS
GetCreatedObjects
Returns the newly created objects after execution of a WKT import.
list ComWktimp.GetCreatedObjects()
R ETURNS
Collection of objects that have been created during WKT import.
GetModifiedObjects
Returns the modified objects after execution of a WKT import.
list ComWktimp.GetModifiedObjects()
R ETURNS
Collection of objects that have been modified during WKT import.
5.5 Settings
5.5.1 SetCluster
Overview
CalcCluster
GetNumberOfClusters
CalcCluster
Performs a load flow calculation for the cluster index passed to the function. To execute properly
this function requires that a valid load flow result is already calculated before calling it.
int SetCluster.CalcCluster(int clusterIndex,
[int messageOn]
)
A RGUMENTS
clusterIndex
The cluster index. Zero based value, the first cluster has index 0.
messageOn (optional)
Possible values:
0 Do not emit a message in the output window.
1 Emit a message in the output window in case that the function does
not execute properly.
R ETURNS
0 On success.
1 There are no clusters, the number of clusters is 0.
2 The cluster index exceeds the number of clusters.
3 There is no load flow in memory before running CalcCluster.
330
GetNumberOfClusters
Get the number of clusters.
int SetCluster.GetNumberOfClusters()
R ETURNS
The number of clusters.
5.5.2 SetColscheme
Overview
CreateFilter
SetColouring
SetFilter
CreateFilter
Creates filter used to determine objects to be colored.
int SetColscheme.CreateFilter([int pageNr])
A RGUMENTS
pageNr empty Create filter for currently valid calculation
set Dialog page number for which filter is created (see table below)
331
Table 5.5.3
Dialog Page Name ”pageNr” value

Basic Data 101
Load Flow 102
AC Load Flow Sensitivities 120
AC Contingency Analysis 121
AC Quasi-dynamic Simulation 137
DC Load Flow 122
DC Load Flow Sensitivities 123
DC Contingency Analysis 124
DC Quasi-dynamic Simulation 138
VDE/IEC Short-Circuit 103
Complete Short-Circuit 111
ANSI Short-Circuit 112
IEC 61363 114
DC Short-Circuit 117
RMS-Simulation 104
Modal Analysis 128
EMT-Simulation 105
Harmonics/Power Quality 106
Frequency Sweep 127
D-A-CH-CZ Connection Request 139
BDEW/VDE Connection Request 142
Optimal Power Flow 108
DC Optimal Power Flow 130
DC OPF with Contingencies 135
State Estimation 113
Reliability 109
General Adequacy 115
Tie Open Point Opt. 116
Motor Starting Calculation 133
Arc Flash Calculation 129
Optimal Capacitor Placement 126
Voltage Profile Optimisation 125
Backbone Calculation 131
Optimal RCS Placement 132
Optimal Manual Restoration 136
Phase Balance Optimisation 141
User defined calculation 142
R ETURNS
0 On success.
1 On error.
SetColouring
Sets colouring for given or currently valid calculation.
int SetColscheme.SetColouring(str page,
int energizing,
[int alarm,]
[int normal]
)
332
A RGUMENTS
page
empty set for currentlx valid calculation
set page for which modes are set (see table below)
energizing
Colouring for Energizing Status
-2 enable (set to previously selected mode),
-1 do not change
0 disable
>0 set to this mode (see table below)
alarm Colouring for Alarm
-1 do not change (default)
0 disable
normal Other Colouring
-1 do not change (default)
0 disable
333
Table 5.5.4
Dialog Page Name ”page” value

Basic Data basic
Load Flow ldf
AC Load Flow Sensitivities acsens
AC Contingency Analysis accont
AC Quasi-dynamic Simulation acldfsweep
DC Load Flow dcldf
DC Load Flow Sensitivities dcsens
DC Contingency Analysis dccont
DC Quasi-dynamic Simulation dcldfsweep
VDE/IEC Short-Circuit shc
Complete Short-Circuit shcfull
ANSI Short-Circuit shcansi
IEC 61363 shc61363
DC Short-Circuit shcdc
RMS-Simulation rms
Modal Analysis modal
EMT-Simulation emt
Harmonics/Power Quality harm
Frequency Sweep fsweep
D-A-CH-CZ Connection Request dachcz
BDEW/VDE Connection Request bdewvde
Optimal Power Flow opf
DC Optimal Power Flow dcopf
DC OPF with Contingencies dccontopf
State Estimation est
Reliability rel
General Adequacy genrel
Tie Open Point Opt. topo
Motor Starting Calculation motstart
Arc Flash Calculation arcflash
Optimal Capacitor Placement optcapo
Voltage Profile Optimisation mvplan
Backbone Calculation backbone
Optimal RCS Placement optrcs
Optimal Manual Restoration omr
Phase Balance Optimisation balance
Hosting Capacity Analysis hostcap
User defined calculation usercalc
Table 5.5.5
Energizing State Name ”energizing” value

De-energized 33
Out of Calculation 37
De-energised, Planned Outage 61
334
Table 5.5.6
Alarm Name ”alarm” value

Voltage Violations / Overloading 29
Outages 31
Overloading of Thermal / Peak Short Circuit Current 32
Feeder Radiality Check 38
335
Table 5.5.7
Other Colouring Name Group ”normal” value

Voltages / Loading Results 1
Voltage Levels Topology 2
Individual Individual 4
Connected Grid Components Topology 5
According to Filter User-defined see notes below table
Grids Groupings 7
Modifications in Variations / System Stages Variations / System Stages 8
Loading of Thermal / Peak Short-Circuit Current Results 9
Paths Groupings 10
System Type AC/DC and Phases Topology 11
Relays, Current and Voltage Transformers Secondary Equipment 12
Fault Clearing Times Results 13
Feeders Topology 14
Switches, Type of Usage Secondary Equipment 15
Measurement Locations Secondary Equipment 16
Missing graphical connections Topology 17
Zones Groupings 18
State Estimation Results 19
Boundaries (Interior Region) Topology 20
Station Connectivity Topology 21
Outage Check Topology 22
Energizing Status Topology 23
Modifications in Recording Expansion Stage Variations / System Stages 24
Areas Groupings 25
Owners Groupings 26
Routes Groupings 27
Operators Groupings 28
Original Locations Variations / System Stages 30
Boundaries (Definition) Topology 34
Meteo Stations Groupings 35
Station Connectivity (Beach Balls only) Topology 36
Power Restoration Secondary Equipment 43
Connected Components Topology 39
Connected Components, Voltage Level Topology 40
Year of Construction Primary Equipment 41
Cross Section Primary Equipment 42
Forced Outage Rate Primary Equipment 44
Forced Outage Duration Primary Equipment 45
Loads: Yearly interruption frequency Results 46
Loads: Yearly interruption time Results 47
Loads: Average Interruption Duration Results 48
Loads: Load Point Energy Not Supplied Results 49
Supplied by Substation Topology 50
Supplied by Secondary Substation Topology 51
Incident Energy Results 52
PPE-Category Results 53
Optimal Manual Restoration Results 54
Connection Request: Approval Status Results 55
Voltage Angle Results 56
Contributions to SAIDI Results 57
Contributions to SAIFI Results 58
Contributions to ENS Results 59
Contributions to EIC Results 60
336
Note: User-defined filters can be set with a “normal” value of 1000 or higher. The first filter in
the list has the value 1000, the next one has 1001 and so on.
R ETURNS
0 error (at least one of the given colourings cannot be set, e.g. not available for
given page). Nothing is changed.
1 ok
SetFilter
Sets filter for given or currently valid calculation.
int SetColscheme.SetFilter(int filter,
[int page]
)
int SetColscheme.SetFilter(DataObject obj,
[int page]
)
A RGUMENTS
filter number of filter to be set
obj user-defined filter to be set
page (optional)
Dialog page number for which filter is set (for numbers see table listed in Set-
Colscheme.CreateFilter())
R ETURNS
0 ok
1 error (filter or page not found)
S EE ALSO
SetColscheme.CreateFilter()
5.5.3 SetDataext
Overview
AddConfiguration
GetConfiguration
GetConfigurations
RemoveAllConfigurations
RemoveConfiguration
AddConfiguration
Adds a new IntAddonvars configuration object for the given classFilter with the descriptiveName
as object name. For the classFilter expressions like Elm* or ElmTr? are possible. If there
already is an object matching classFilter and descriptiveName exactly, this object is returned
instead.
DataObject SetDataext.AddConfiguration(str classFilter, str descriptiveName)
337
A RGUMENTS
classFilter
The class filter of the IntAddonvars object
descriptiveName
The object name of the IntAddonvars object
R ETURNS
The IntAddonvars object which exactly matches the classFilter and descriptive name or a
newly created one.
S EE ALSO
IntAddonvars.AddDouble(), IntAddonvars.AddDoubleMatrix(), IntAddonvars.AddDoubleVector(),

IntAddonvars.AddInteger(), IntAddonvars.AddIntegerVector(), IntAddonvars.AddObject(), In-
tAddonvars.AddObjectVector(), IntAddonvars.AddString(), IntAddonvars.RemoveParameter()
GetConfiguration
Returns the IntAddonvars object which exactly matches the classFilter and descriptiveName, if
the latter is specified. If there are multiple matches the first object will be returned. Otherwise
nothing is returned.
DataObject SetDataext.GetConfiguration(str classFilter, [str descriptiveName])
A RGUMENTS
classFilter
descriptiveName (optional)
R ETURNS
The IntAddonvars object which exactly matches the classFilter and optionally the descriptive-
Name or nothing.
S EE ALSO

GetConfigurations
Returns all IntAddonvars objects by a given classFilter.
list SetDataext.GetConfigurations(str classFilter)
list SetDataext.GetConfigurations()
A RGUMENTS
classFilter
The class filter for the IntAddonvars object
R ETURNS
A list of IntAddonvars objects matching the classFilter exactly. If no filter is specified all
IntAddonvars are returned.
338
S EE ALSO

RemoveAllConfigurations
Removes all IntAddonvars objects effectively removing all Data Extensions.
None SetDataext.RemoveAllConfigurations()
RemoveConfiguration
Removes the IntAddonvars object exactly matching classFilter and descriptive name.
None SetDataext.RemoveConfiguration(str classFilter, [str descriptiveName])
A RGUMENTS
classFilter
descriptiveName (optional)
5.5.4 SetDeskpage
Overview
Close
Show
Close
Closes the graphic page, if currently shown in the graphics board.
int SetDeskpage.Close()
R ETURNS
0 On success, no error occurred.
1 Otherwise
Show
Displays the diagram page in the graphics board.
int SetDeskpage.Show()
R ETURNS
1 Otherwise
339
5.5.5 SetDesktop
Overview
AddPage
Close
DoAutoScaleX
Freeze
GetActivePage
GetCanvasSize
GetPage
IsFrozen
IsOpened
RemovePage
SetAdaptX
SetAutoScaleX
SetResults
SetScaleX
SetXVar
Show
Unfreeze
WriteWMF
ZoomAll
AddPage
Adds an existing page to a graphics and activates it
• Opens the graphics board if not already open.

• Adds the page if it is not already part of the graphics board.
DataObject SetDesktop.AddPage(DataObject page2add)
A RGUMENTS
page2add
The page to add to the desktop.
• Page is a plot page (GrpPage or SetVipage): A copy of the page is added.
• Page is an IntGrfnet (Single line graphic, block diagram): The graphic is
added.
R ETURNS
The page displayed or None if the desktop was not changed.
Close
Closes the graphics board, if it is currently shown.
int SetDesktop.Close()
R ETURNS
0 on success
1 on error
340
DoAutoScaleX
Scales the x-axes of all plots in the graphics board which use the x-axis scale defined in the
graphics board.
None SetDesktop.DoAutoScaleX()
Freeze
Enables the graphical freeze mode, preventing changes to open diagrams.
int SetDesktop.Freeze()
R ETURNS
0 on success
1 on error
GetActivePage
Returns the page object of the currently shown page.
DataObject SetDesktop.GetActivePage()
R ETURNS
Page object of the active page, or 0 if no page is active.
GetCanvasSize
Returns the pixel dimensions of the currently active (top-most) graphic page.
[int valid
int width,
int height] SetDesktop.GetCanvasSize()
A RGUMENTS
width (out)
Pixel width of the canvas. -1 if no graphics page is open.
height (out)
Pixel height of the canvas. -1 if no graphics page is open.
R ETURNS
0 on success: canvas size could be determined
1 on error: no graphics page is open
GetPage
Searches, activates and returns a graphics page in the currently open graphics board. If “create”
is true, then a new page will be created and added to the graphics board if no page with name
was found.
341
DataObject SetDesktop.GetPage(str name,

[int create,]
[str class]
)
A RGUMENTS
name Name of the page.
create (optional)
Possible values:
0 do not create new plot page
1 create plot page if it does not exist already
class (optional)
Classname of the plot page object to create: either 'GrpPage' or 'SetVipage'. If
not specified, a 'GrpPage' will be created if the new plot framework is enabled in
the project settings, otherwise a 'SetVipage' will be created.
R ETURNS
Plot page (GrpPage or SetVipage), or network graphic page (SetDeskpage)
IsFrozen
Returns whether the graphical freeze mode is currently enabled.
int SetDesktop.IsFrozen()
R ETURNS
0 freeze mode is disabled, or the graphics board is not open
1 graphics board is open and freeze mode is enabled
IsOpened
Returns whether the graphics board is currently shown.
int SetDesktop.IsOpened()
R ETURNS
1 if graphics board is shown
0 otherwise
RemovePage
Removes a graphic page. The page to be removed can be identified either by its name or by its
page object.
int SetDesktop.RemovePage(str pageName)
int SetDesktop.RemovePage(DataObject pageObject)
342
A RGUMENTS
pageName
Name of graphics page.
pageObject
A graphics page object.
R ETURNS
0 on success
1 on error
SetAdaptX
Sets the Adapt Scale option of the x-scale.
None SetDesktop.SetAdaptX(int mode,
[float trigger]
)
A RGUMENTS
mode Possible values:
0 off
1 on
trigger (optional)
Trigger value, unused if mode is off or empty
SetAutoScaleX
Sets automatic scaling mode of the x-scale. A warning is issued if an invalid mode is passed to
the function.
None SetDesktop.SetAutoScaleX(int mode)
A RGUMENTS
0 never
1 after simulation
2 during simulation
SetResults
Sets default results object of graphics board.
None SetDesktop.SetResults(DataObject res)
343
A RGUMENTS
res Result object to set or None to reset. Valid result object is any of class ElmRes,
IntComtrade and IntComtradeset.
SetScaleX
Sets x-axis scale. A function call without arguments sets the Auto Scale setting to On without
changing the scale itself.
None SetDesktop.SetScaleX()
None SetDesktop.SetScaleX(float min,
float max,
[int log]
)
A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.
log (optional)
Possible values:
0 linear
1 logarithmic
SetXVar
Sets x-axis variable. If The default x-axis variable (time) is set if no argument is passed.
None SetDesktop.SetXVar()
None SetDesktop.SetXVar(DataObject obj,]
str varname
)
A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj
Show
Shows the virtual instrument panel with the same name as 'pageObject' or the page with
name 'pageName' in the graphics board. The object 'pageObject' is typically a object of class
'SetVipage' (virtual instrument panel) but, as only its name is used, it may be any other type of
object. Calling the function without an argument opens the graphics board.
int SetDesktop.Show()
int SetDesktop.Show(str pageName)
int SetDesktop.Show(DataObject pageObject)
344
A RGUMENTS
pageName (optional)
Name of graphics page.
pageObject (optional)
A graphics page oject.
R ETURNS
0 on success
1 on error
Unfreeze
Disables the graphical freeze mode, allowing changes to open diagrams.
int SetDesktop.Unfreeze()
R ETURNS
0 on success
1 on error
WriteWMF
Writes the currently open graphic to a windows metafile file (*.wmf).
Please use the Save File command (ComWr) for writing to other formats like *.pdf, *.png, *.svg,
*.emf or *.bmp.
int SetDesktop.WriteWMF(str filename)
A RGUMENTS
filename Filename without extension.
R ETURNS
0 On error.
1 On success.
ZoomAll
Adjusts the zoom level of the currently active (top-most) graphic page such that the entire
diagram is shown.
int SetDesktop.ZoomAll()
R ETURNS
0 on success
1 on error
345
5.5.6 SetDistrstate
Overview
CalcCluster
CalcCluster
Calculates a load flow with a given load distribution state applied.
list(int, ...) SetDistrstate.CalcCluster(int clusterIndex,
[int messageOn]
)
A RGUMENTS
clusterIndex
The cluster index. Zero based value, the first cluster has index 0.
messageOn (optional)
Possible values:
0 Do not emit a message in the output window.
1 Emit a message in the output window in case that the function does
not execute properly.
R ETURNS
0 if ok. -1 if load flow of cluster did not converge.
5.5.7 SetFilt
Overview
Get
Get
Returns a container with the filtered objects.
list SetFilt.Get()
R ETURNS
The set of filtered objects.
5.5.8 SetLevelvis
Overview
AdaptWidth
Align
ChangeFont
ChangeFrameAndWidth
ChangeLayer
346
ChangeRefPoints
ChangeWidthVisibilityAndColour
Mark
Reset
AdaptWidth
This function resizes the in the object specified group of text boxes regarding their text contents.
None SetLevelvis.AdaptWidth()
Align
This function aligns the text within a text box.
None SetLevelvis.Align(int iPos)
A RGUMENTS
iPos Alignment position
0 left
1 middle
2 right
ChangeFont
This function sets the font number for the specified group of text boxes.
None SetLevelvis.ChangeFont(int iFont)
A RGUMENTS
iFont Font number (default fonts range from 0 to 13)
ChangeFrameAndWidth
This method is not available anymore. Please use SetLevelvis.ChangeWidthVisibilityAndColour()
instead.
list(None, ...) SetLevelvis.ChangeFrameAndWidth([int iFrame,]
[int iWidth,]
[int iVisibility,]
[int iColour]
)
ChangeLayer
This function sets the specified group of text boxes to a given layer.
None SetLevelvis.ChangeLayer(str sLayer)
347
A RGUMENTS
sLayer Layer name (e.g. 'Object Names', 'Results', 'Invisible Objects',..)
ChangeRefPoints
This function sets the reference points between a text box (second parameter) and its parent
object (first parameter), e.g. if the result box of a busbar shall be shown on top of a drawn
bar instead of below the bar the values change from (6,4) to (4,6). The first number specifies
the reference number of the text box. The integer values describe the position of the reference
points within a rectangle (0=centre, 1=middle right, 2=top right,..):
432
501
678
None SetLevelvis.ChangeRefPoints(int iParRef,

int iTBRef
)
A RGUMENTS
iParRef Defines the reference point on the parent object (e.g. busbar)
iTBRef Defines the reference point on the text box
ChangeWidthVisibilityAndColour
This function sets the visibility of the frame, the width (in number of letters), the visibility and the
colour of text boxes.
None SetLevelvis.ChangeWidthVisibilityAndColour([int iWidth,]
[int iVisibility,]
[int iColour]
)
A RGUMENTS
iWidth Sets the width in number of letters
0..n width
iVisibility Sets the visibility
0 not visible
1 visible
iColour Sets the colour
0..255 colour
Mark
Marks the specified group of text boxes in the currently shown diagram.
None SetLevelvis.Mark()
348
Reset
This function resets the individually modified text box settings.
None SetLevelvis.Reset(int iMode)
A RGUMENTS
iMode
0 Reset to default (changed reference points are not reset)
1 Only font
2 Shift to original layer (result boxes to layer 'Results', object names to
layer 'Object Names')
5.5.9 SetParalman
Overview
GetNumSlave
SetNumSlave
SetTransfType
GetNumSlave
To get the number of slaves which is currently configured.
int SetParalman.GetNumSlave()
R ETURNS
the number of slaves which is currently configured.
SetNumSlave
To configue the number of slaves to be used for parallel computing.
int SetParalman.SetNumSlave(int numSlaves)
A RGUMENTS
numSlaves
Number of slaves to be used for parallel computing
−1 All cores available will be used.

>0 The number of slaves to be used.
R ETURNS
Always return 0.
SetTransfType
To change the data transfer type: via file or via socket communication.
int SetParalman.SetTransfType(int viaFile)
349
A RGUMENTS
viaFile
0 The data will be transferred via socket communication.
1 The data will be transferred via file.
R ETURNS
0 the data will be transferred via socket communication.
1 the data will be transferred via file.
5.5.10 SetPath
Overview
AllBreakers
AllClosedBreakers
AllOpenBreakers
AllProtectionDevices
Create
GetAll
GetBranches
GetBuses
GetPathFolder
AllBreakers
Returns all breakers in the path definition.
list SetPath.AllBreakers()
R ETURNS
The set of breakers.
AllClosedBreakers
Returns all closed breakers in the path definition.
list SetPath.AllClosedBreakers()
R ETURNS
The set of closed breakers.
AllOpenBreakers
Returns all open breakers in the path definition.
list SetPath.AllOpenBreakers()
R ETURNS
The set of open breakers.
350
AllProtectionDevices
Returns all protection devices in the path definition for a given direction.
list SetPath.AllProtectionDevices(int reverse)
A RGUMENTS
reverse
0 Return devices in forward direction.
1 Return devices in reverse direction.
R ETURNS
The set of protection devices.
Create
Creates or extends the path with the elements provided.
DataObject SetPath.Create(list elements)
A RGUMENTS
elements Elements the path shall be created or extended with.
R ETURNS
DataObject Modification was successful.
None Modification failed. (e.g. elements form an incomplete path)
GetAll
Returns all objects in the path definition.
list SetPath.GetAll()
R ETURNS
The set of objects.
GetBranches
Returns all breanches in the path definition.
list SetPath.GetBranches([int reverse])
A RGUMENTS
reverse (optional)
0 Sort the branches in forward direction.
1 Sort the branches in reverse direction.
R ETURNS
The set of branches.
351
GetBuses
Returns all busbars and terminals in the path definition.
list SetPath.GetBuses()
R ETURNS
The set of busbars and terminals.
GetPathFolder
Returns the default folder for storing path objects.
DataObject SetPath.GetPathFolder([int create])
A RGUMENTS
create (optional)
0 Return only if the folder exists.
1 Create the folder if it does not exist.
R ETURNS
DataObject Default folder for storing path.
None Default folder does not exist or could not be created.
5.5.11 SetSelect
Overview
AddRef
All
AllAsm
AllBars
AllBreakers
AllClosedBreakers
AllElm
AllLines
AllLoads
AllOpenBreakers
AllSym
AllTypLne
Clear
GetAll
AddRef
Adds a reference to the objects to the existing selection.
None SetSelect.AddRef(DataObject O)
None SetSelect.AddRef(list S)
A RGUMENTS
O An object.
352
S A set of objects.
All
Returns all objects in the selection.
list SetSelect.All()
R ETURNS
The set of objects
AllAsm
Returns all asynchronous machines in the selection.
list SetSelect.AllAsm()
R ETURNS
The set of objects
AllBars
Returns all busbars and terminals in the selection.
list SetSelect.AllBars()
R ETURNS
The set of objects
AllBreakers
Returns all breakers in the selection.
list SetSelect.AllBreakers()
R ETURNS
The set of objects
AllClosedBreakers
Returns all closed breakers in the selection.
list SetSelect.AllClosedBreakers()
R ETURNS
The set of objects
353
AllElm
Returns all elements (Elm*) in the selection.
list SetSelect.AllElm()
R ETURNS
The set of containing objects
AllLines
Returns all lines and line routes in the selection.
list SetSelect.AllLines()
R ETURNS
The set of objects
AllLoads
Returns all loads in the selection.
list SetSelect.AllLoads()
R ETURNS
The set of objects
AllOpenBreakers
Returns all open breakers in the selection.
list SetSelect.AllOpenBreakers()
R ETURNS
The set of objects
AllSym
Returns all synchronous machines in the selection.
list SetSelect.AllSym()
R ETURNS
The set of objects
AllTypLne
Returns all line types in the selection.
list SetSelect.AllTypLne()
354
R ETURNS
The set of objects
Clear
Clears (deletes) the selection.
None SetSelect.Clear()
GetAll
Returns all objects in the selection which are of the class 'ClassName'.
list SetSelect.GetAll(str ClassName)
A RGUMENTS
ClassName
The object class name.
R ETURNS
The set of objects
5.5.12 SetTboxconfig
Overview
Check
GetAvailableButtons
GetDisplayedButtons
Purge
SetDisplayedButtons
Check
Checks buttons to be displayed for invalid or duplicate ids and prints error messages.
int SetTboxconfig.Check()
R ETURNS
0 No errors found.
1 Errors found.
GetAvailableButtons
Gets buttons available for selected tool bar.
str SetTboxconfig.GetAvailableButtons()
R ETURNS
String ids of all buttons available for selected tool bar; ids are separated by '\n'.
355
GetDisplayedButtons
Gets buttons configured to be displayed in selected tool bar.
str SetTboxconfig.GetDisplayedButtons()
R ETURNS
String ids of all buttons configured to be displayed in selected tool bar; ids are separated by
'\n'.
Purge
Purges buttons to be displayed from invalid or duplicate ids.
int SetTboxconfig.Purge()
R ETURNS
0 No problems found.
1 Configuration was adapted.
SetDisplayedButtons
Sets buttons to be displayed in selected tool bar. Purges given buttons from invalid or duplicate
buttons (duplicate separators or breaks are kept).
int SetTboxconfig.SetDisplayedButtons(str buttonIds)
A RGUMENTS
buttonIds String ids of all buttons to be set as displayed buttons; ids have to be separated
by '\n'
R ETURNS
0 Given buttons were stored without modification.
1 Given buttons were purged from invalid or duplicate ids.
5.5.13 SetTime
Overview
Date
SetTime
SetTimeUTC
Time
Date
Sets date component to current system date.
None SetTime.Date()
S EE ALSO
SetTime.Time(), SetTime.SetTimeUTC()
356
SetTime
Sets the time in the current year. There is no restriction to the values for H, M and S, except
for the fact that negative values are interpreted as zero. Values higher than 24 or 60 will be
processed normally by adding the hours, minutes and seconds into an absolute time, from
which a new hour-of-year, hour-of-day, minutes and seconds are calculated.
None SetTime.SetTime(float H,
[float M,]
[float S]
)
A RGUMENTS
H The hours
M (optional)
The minutes
S (optional)
The seconds
SetTimeUTC
Sets date and time to given time. The time must be given in UTC format as seconds since
01.01.1970 00:00 GMT.
None SetTime.SetTimeUTC(int time)
A RGUMENTS
time UTC time in seconds since 01.01.1970 00:00 GMT
S EE ALSO
SetTime.Date(), SetTime.Time()
Time
Sets time component to current system time.
None SetTime.Time()
S EE ALSO
SetTime.Date(), SetTime.SetTimeUTC()
5.5.14 SetUser
Overview
GetNumProcesses
357
GetNumProcesses
This function returns the actual number of processes for parallel computation.
int SetUser.GetNumProcesses()
R ETURNS
The actual number of processes for parallel computation.
5.5.15 SetVipage
Overview
Close
DoAutoScaleX
DoAutoScaleY
GetOrInsertPlot
InsertPlot
MigratePage
SetAdaptX
SetAutoScaleX
SetResults
SetScaleX
SetStyle
SetTile
SetXVar
Show
Close
Closes the graphic page, if currently shown, and deletes it from the database.
int SetVipage.Close()
R ETURNS
1 Otherwise
DoAutoScaleX
Scales the x-axes of all plots on the virtual instrument panel automatically.
None SetVipage.DoAutoScaleX()
DoAutoScaleY
Scales the y-axes of all plots on the virtual instrument panel automatically.
None SetVipage.DoAutoScaleY()
358
GetOrInsertPlot
Get or create a virtual instrument of the virtual instrument panel.
DataObject SetVipage.GetOrInsertPlot (str name,
[str class,]
[int create]
)
D EPRECATED N AMES
GetVI
A RGUMENTS
name Name of virtual instrument
class='VisPlot' (optional)
classname of virtual instrument.
create (optional)
Possible values:
0 do not create new virtual instrument
1 create virtual instrument if it does not exist already
R ETURNS
Virtual instrument
InsertPlot
Creates a copy of the virtual instrument passed and displays the copy on this panel.
DataObject SetVipage.InsertPlot(DataObject vi)
D EPRECATED N AMES
CreateVI
A RGUMENTS
vi The virtual instrument which will be copied. Only virtual instruments are allowed
(classname 'Vis*').
R ETURNS
Returns the created virtual instrument.
MigratePage
Converts this SetVipage to the new plot framework introduced in PowerFactory 2021, creating
a GrpPage:
• The original SetVipage will remain unchanged

• The created GrpPage will initially be hidden. Use GrpPage.Show() to make it visible.
Please note that currently (PowerFactory 2021) only plots of type VisPlot, VisPlot2, and VisXy-
plot can be migrated. All other plot types will be missing in the migrated GrpPage.
None SetVipage.MigratePage()
359
R ETURNS
The migrated plot page (GrpPage)
SetAdaptX
None SetVipage.SetAdaptX(int mode,
[float trigger]
)
A RGUMENTS
0 off
1 on
trigger (optional)
SetAutoScaleX
Sets automatic scaling mode of the x-scale. A warning is issued if an invalid mode is passed to
the function.
None SetVipage.SetAutoScaleX(int mode)
A RGUMENTS
0 never
1 after simulation
2 during simulation
SetResults
Sets default results object of virtual instrument panel.
None SetVipage.SetResults(DataObject res)
A RGUMENTS
SetScaleX
Sets x-axis scale. A function call without arguments sets the Auto Scale setting to On without
changing the scale itself.
360
None SetVipage.SetScaleX()
None SetVipage.SetScaleX(float min,
float max,
[int log]
)
A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.
log (optional)
Possible values:
0 linear
1 logarithmic
SetStyle
Sets style of virtual instrument panel. A warning message is issued in the case that a style with
the given name does not exist.
None SetVipage.SetStyle(str name)
A RGUMENTS
name Style Name
SetTile
Rearranges the virtual instrument on the panel.
None SetVipage.SetTile([int tile])
A RGUMENTS
tile=1 (optional) tile =0 arrange virtual instruments automatically (like tiles)
tile=1 arrange them horizontally
SetXVar
Sets x-axis variable. If The default x-axis variable (time) is set if no argument is passed.
None SetVipage.SetXVar()
None SetVipage.SetXVar(DataObject obj,
str varname
)
361
5.6. OTHERS CHAPTER 5. OBJECT METHODS
A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj
Show
Displays the plot page in the graphics board.
int SetVipage.Show()
R ETURNS
1 Otherwise
5.6 Others
5.6.1 BlkDef
Overview
Compile
Encrypt
GetCheckSum
Pack
PackAsMacro
SetThirdPartyModule
Compile
Compiles the model to a DLL. Can be called on an already compiled model. A study case of a
project has to be active.
None BlkDef.Compile([string modelPath])
A RGUMENTS
modelPath (optional)
Full path to a location where the model should be stored. Leave empty to use
default.
Encrypt
Encrypts this block definition. It has to be packed as macro before.
int BlkDef.Encrypt([int removeObjectHistory])
362
A RGUMENTS
H andling of unencrypted object history in database, e.g. used by project versions
or by undo:
0 Do not remove.
R ETURNS
0 On success.
1 On error.
S EE ALSO
BlkDef.PackAsMacro()
GetCheckSum
str BlkDef.GetCheckSum()
D EPRECATED N AMES
CalculateCheckSum
R ETURNS
The checksum of the block definition (0000-0000-0000-0000 for frames).
Pack
Copies all used macros (i.e. referenced BlkDef) to this block.
int BlkDef.Pack()
R ETURNS
0 On success.
1 On error.
PackAsMacro
Collects all equations, stores them to this model and deletes block diagram and all macro
references.
int BlkDef.PackAsMacro()
R ETURNS
0 On success.
1 On error.
S EE ALSO
BlkDef.Encrypt()
363
Resets the third party licence. Only possible for non-encrypted, non-compiled blocks. Requires
masterkey licence for third party module currently set.
int BlkDef.ResetThirdPartyModule()
R ETURNS
0 On success.
1 On error.
SetThirdPartyModule
Sets the third party licence to a specific value. Only possible for non-encrypted, non-compiled
blocks with no third party licence set so far. Requires masterkey licence for third party module
to be set.
int BlkDef.SetThirdPartyModule(str companyCode,
str moduleCode
)
A RGUMENTS
companyCode
moduleCode
R ETURNS
0 On success.
1 On error.
5.6.2 BlkSig
Overview
GetFromSigName
GetToSigName
GetFromSigName
str BlkSig.GetFromSigName()
R ETURNS
The name of the output from which the signal is connected. In cases of no connection, an
empty string.
364
GetToSigName
str BlkSig.GetToSigName()
R ETURNS
The name of the input to which the signal is connected. In cases of no connection, an empty
string.
5.6.3 ChaVecfile
Overview
Update
Update
Reloads the file from disk. Same behaviour like button update.
int ChaVecfile.Update([int msgOn = 0])
A RGUMENTS
msgOn (optional)
Reporting of errors:
0 No error message is shown in case that the file can not be loaded
(default).
1 Emit an error message in case that the file can not be loaded.
R ETURNS
The number of samples (rows) read from the file.
5.6.4 CimModel
Overview
DeleteParameterAtIndex
GetAttributeEnumerationType
GetModelsReferencingThis
GetParameterCount
GetParameterNamespace
GetParameterValue
HasParameter
RemoveParameter
SetAssociationValue
SetAssociationValue
SetAttributeEnumeration
SetAttributeValue
SetAttributeValue
365
Removes the parameter (attribute, or association) value at the given index.
None CimModel.DeleteParameterAtIndex(str parameter, int index)
A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.profile”)
index Index of the parameter
Returns the enumeration type of the attribute.
str CimModel.GetAttributeEnumerationType(str attribute)
A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”GeneratingUnit.genControlSource”)
GetModelsReferencingThis
Returns all CIM models (CimModel) that reference the calling model.
list CimModel.GetModelsReferencingThis()
R ETURNS
CIM models that reference the calling model. The order of the set is undefined.
GetParameterCount
Returns the number of parameters (attribute, or association) of given type.
int CimModel.GetParameterCount(str parameter)
A RGUMENTS
parameter
Returns the namesace of the parameter (attribute, or association).
str CimModel.GetParameterNamespace(str parameter)
A RGUMENTS
parameter
366
GetParameterValue
Returns the value of the parameter (attribute, or association) at the given index if available. If the
parameter (attribute, or association) is not available, or the index is out of bounds the function
returns an empty string.
str CimModel.GetParameterValue(str parameter, [int index])
A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.modelingAuthoritySet”)
index Index of the parameter:

0 Default index
HasParameter
Checks whether the CimModel has the parameter (attribute, or association) specified.
int CimModel.HasParameter(str parameter)
A RGUMENTS
parameter
R ETURNS
1 if parameter is specified
0 if parameter is not specified
RemoveParameter
Removes all occurrences of the parameter (attribute, or association).
None CimModel.RemoveParameter(str parameter)
A RGUMENTS
parameter
SetAssociationValue
Adds the association if not available yet, and sets its value at the given index. If the association
is already added, the function sets a new value at the given index only.
None CimModel.SetAssociationValue(str association,
str value,
[int index])
367
A RGUMENTS
association
Full-name specifier of the association (e.g. ”Model.DependentOn”)
value Value of the association
index Index of the association:
0 Default index
SetAssociationValue
Adds the association if not available yet, and sets its namespace and value. If the association
is already added, the function sets its namespace and value only.
None CimModel.SetAssociationValue(str association,
str value,
str nspace)
A RGUMENTS
attribute Full-name specifier of the association (e.g. ”Model.DependentOn”)

nspace Namespace of the association (e.g. ”md”)
Adds the attribute if not available yet, and sets its enumeration type and value. If the attribute is
already added, the function sets its enumeration type and value only.
None CimModel.SetAttributeEnumeration(str attribute,
str enumerationType,
str value)
A RGUMENTS
enumerationType
Enumeration type of the attribute (e.g. ”GeneratorControlSource”)
value Value of the enumeration (e.g. ”offAGC”)
Adds the attribute if not available yet, and sets its namespace, enumeration type and value.
If the attribute is already added, the function sets its namespace, enumeration type and value
only.
None CimModel.SetAttributeEnumeration(str attribute,
str value,
str nspace)
368
A RGUMENTS
enumerationType
value Value of the attribute (e.g. ”offAGC”)
nspace Namespace of the attribute (e.g. ”cim”)
SetAttributeValue
Adds the attribute if not available yet, and sets its value at the given index. If the attribute is
already added, the function sets a new value at the given index only.
None CimModel.SetAttributeValue(str attribute,
str value,
[int index])
A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”Model.modelingAuthoritySet”)
value Value of the attribute

index Index of the attribute:
0 Default index
SetAttributeValue
Adds the attribute if not available yet, and sets its namespace and value. If the attribute is
already added, the function sets its namespace and value only.
None CimModel.SetAttributeValue(str attribute,
str value,
str nspace)
A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”Model.modelingAuthoritySet”)
nspace Namespace of the attribute (e.g. ”md”)
369
5.6.5 CimObject
Overview
GetObjectsReferencingThis
GetObjectsWithSameId
GetParameterCount
GetParameterValue
GetPfObjects
HasParameter
RemoveParameter
SetAssociationValue
SetAssociationValue
SetAttributeValue
SetAttributeValue
Removes the parameter (attribute, or association) value at the given index.
None CimObject.DeleteParameterAtIndex(str parameter, int index)
A RGUMENTS
parameter
index Index of the parameter
Returns the enumeration type of the attribute.
str CimObject.GetAttributeEnumerationType(str attribute)
A RGUMENTS
GetObjectsReferencingThis
Returns all CIM objects (CimObject) that reference the calling object. The set of objects returned
is also determined by the DependentOn and Supersedes references set in parent CIM model
objects. In order for a CIM object to reference another CIM object, the parent CIM model of the
former object has to hold a reference to the parent CIM model of the later object.
list CimObject.GetObjectsReferencingThis()
370
R ETURNS
CIM objects that reference the calling object. The order of the set is undefined.
GetObjectsWithSameId
Returns all CIM objects (CimObject) that have the same Resource ID as this object.
list CimObject.GetObjectsWithSameId()
R ETURNS
CIM objects that have the same Resource ID as this object.
GetParameterCount
Returns the number of parameters (attribute, or association) of given type.
int CimObject.GetParameterCount(str parameter)
A RGUMENTS
parameter
Returns the namesace of the parameter (attribute, or association).
str CimObject.GetParameterNamespace(str parameter)
A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”IdentifiedObject.name”)
GetParameterValue
Returns the value of the parameter (attribute, or association) at the given index if available. If the
parameter (attribute, or association) is not available, or the index is out of bounds the function
returns an empty string.
str CimObject.GetParameterValue(str parameter, [int index])
A RGUMENTS
parameter
index Index of the parameter:

0 Default index
371
GetPfObjects
Returns all PF objects that have the same Resource ID as this CIM object.
list CimObject.GetPfObjects()
R ETURNS
PF objects that have the same Resource ID as this CIM object.
HasParameter
Checks whether the CimObject has the parameter (attribute, or association) specified.
int CimObject.HasParameter(str parameter)
A RGUMENTS
parameter
R ETURNS
1 if parameter is specified
0 if parameter is not specified
RemoveParameter
Removes all occurrences of the parameter (attribute, or association).
None CimObject.RemoveParameter(str parameter)
A RGUMENTS
parameter
SetAssociationValue
Adds the association if not available yet, and sets its value at the given index. If the association
is already added, the function sets a new value at the given index only.
None CimObject.SetAssociationValue(str association,
str value,
[int index])
A RGUMENTS
association
Full-name specifier of the association (e.g. ”Equipment.EquipmentContainer”)
index Index of the association:

0 Default index
372
SetAssociationValue
Adds the association if not available yet, and sets its namespace and value. If the association
is already added, the function sets its namespace and value only.
None CimObject.SetAssociationValue(str association,
str value,
str nspace)
A RGUMENTS
attribute Full-name specifier of the association (e.g. ”Equipment.EquipmentContainer”)
nspace Namespace of the association (e.g. ”cim”)
Adds the attribute if not available yet, and sets its enumeration type and value. If the attribute is
already added, the function sets its enumeration type and value only.
None CimObject.SetAttributeEnumeration(str attribute,
str value)
A RGUMENTS
enumerationType
value Value of the enumeration (e.g. ”offAGC”)
Adds the attribute if not available yet, and sets its namespace, enumeration type and value.
If the attribute is already added, the function sets its namespace, enumeration type and value
only.
None CimObject.SetAttributeEnumeration(str attribute,
str value,
str nspace)
A RGUMENTS
enumerationType
value Value of the attribute (e.g. ”offAGC”)
373
SetAttributeValue
Adds the attribute if not available yet, and sets its value at the given index. If the attribute is
already added, the function sets a new value at the given index only.
None CimObject.SetAttributeValue(str attribute,
str value,
[int index])
A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”IdentifiedObject.name”)
index Index of the attribute:

0 Default index
SetAttributeValue
Adds the attribute if not available yet, and sets its namespace and value. If the attribute is
already added, the function sets its namespace and value only.
None CimObject.SetAttributeValue(str attribute,
str value,
str nspace)
A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”IdentifiedObject.name”)

5.6.6 GrpPage
Overview
DoAutoScale
DoAutoScaleX
DoAutoScaleY
GetOrInsertCurvePlot
GetOrInsertDiscreteBarPlot
GetOrInsertXYPlot
GetPlot
RemovePage
SetAutoScaleModeX
SetAutoScaleModeY
SetLayoutMode
SetResults
SetScaleTypeX
SetScaleTypeY
SetScaleX
SetScaleY
Show
374
DoAutoScale
Adapts axis ranges of all plots on the page such that they show the entire data range.
None GrpPage.DoAutoScale([int axisDimension])
A RGUMENTS
axisDimension (optional)
Limits auto-scaling to one dimension. Possible values:
0 scale only x-axes
1 scale only y-axes
DoAutoScaleX
Adapts x-axis ranges of all plots on the page such that they show the entire data range.
None GrpPage.DoAutoScaleX()
DoAutoScaleY
Adapts y-axis ranges of all plots on the page such that they show the entire data range.
None GrpPage.DoAutoScaleY()
GetOrInsertCurvePlot
Finds a curve plot by name, or creates it if not found.
DataObject GrpPage.GetOrInsertCurvePlot(str name,
[int create]
)
A RGUMENTS
name Name of plot
create=1 (optional)
Possible values:
0 do not create new plot
1 create plot if it does not exist already
R ETURNS
PltLinebarplot object
GetOrInsertDiscreteBarPlot
Finds a discrete bar plot by name, or creates it if not found. A discrete bar plot is a PltLinebarplot
whose x-axis mode is set to 'Discrete', i.e., it shows net elements on the x-axis.
DataObject GrpPage.GetOrInsertDiscreteBarPlot(str name,
[int create]
)
375
A RGUMENTS
name Name of plot
create=1 (optional)
Possible values:
R ETURNS
GetOrInsertXYPlot
Finds a XY plot by name, or creates it if not found. A XY plot is a PltLinebarplot whose x-axis
mode is set to 'XY'.
DataObject GrpPage.GetOrInsertXYPlot(str name,
[int create]
)
A RGUMENTS
name Name of plot
create=1 (optional)
Possible values:
R ETURNS
GetPlot
Returns the plot on this page with the given name.
DataObject GrpPage.GetPlot(str name)
A RGUMENTS
name Name of the plot to look for
R ETURNS
Plot object if found, or NULL otherwise
RemovePage
Closes the graphic page, if currently shown, and deletes it from the database.
int GrpPage.RemovePage()
376
SetAutoScaleModeX
Defines whether the x-axes on the page should automatically adapt their range on data changes.
None GrpPage.SetAutoScaleModeX(int mode)
A RGUMENTS
0 off (do not react to data changes)
1 adapt scale after calculation has finished
2 adapt scale during live plotting
SetAutoScaleModeY
Defines whether the y-axes on the page should automatically adapt their range on data changes.
None GrpPage.SetAutoScaleModeY(int mode)
A RGUMENTS
SetLayoutMode
Defines the automatic arrangement of plots on the page.
None GrpPage.SetLayoutMode(int mode)
A RGUMENTS
0 off (do not arrange plots automatically)
1 arrange plots vertically
2 arrange plots on grid
SetResults
Sets the default results object of page.
None GrpPage.SetResults(DataObject res)
A RGUMENTS
377
SetScaleTypeX
Sets the scale type (linear, logarithmic) of all x-axes on the page.
None GrpPage.SetScaleTypeX(int scaleType)
A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic
SetScaleTypeY
Set the scale type (linear, logarithmic, dB) of all y-axes on the page.
None GrpPage.SetScaleTypeY(int scaleType)
A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic
2 dB
SetScaleX
Sets the scale of all x-axes on the page.
None GrpPage.SetScaleX(float min,
float max
)
A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.
SetScaleY
Sets the scale of all y-axes on the page.
None GrpPage.SetScaleY(float min,
float max
)
A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.
378
Show
Displays the diagram page in the graphics board.
int GrpPage.Show()
R ETURNS
1 Otherwise
5.6.7 IntAddonvars
Overview
AddDouble
AddDoubleMatrix
AddDoubleVector
AddInteger
AddIntegerVector
AddObject
AddObjectVector
AddString
RemoveParameter
AddDouble
Adds a new double parameter to the Date Extension configuration object.
int IntAddonvars.AddDouble(str parameterName,
str desc,
str unitText,
float initialValue
)
A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
unitText The unit of the new parameter
initialValue
The initial value of the new parameter
R ETURNS
Zero if attribute was successfully added. One based row number if there already is a param-
eter with the same name.
AddDoubleMatrix
Adds a new double vector parameter to the Date Extension configuration object.
int IntAddonvars.AddDoubleMatrix(str parameterName,
str desc,
379
int initialRows,
int initialColumns,
str unitText,
float initialValue)
A RGUMENTS
parameterName
initialRows
The initial number of rows for the matrix
initialColumns
The initial number of columns for the matrix
initialValue
The initial value for the elements
R ETURNS
AddDoubleVector
Adds a new double vector parameter to the Date Extension configuration object.
int IntAddonvars.AddDoubleVector(str parameterName,
str desc,
int initialSize,
str unitText,
float initialValue
)
A RGUMENTS
parameterName
initialSize The initial size of the vector
initialValue
R ETURNS
380
AddInteger
Adds a new integer parameter to the Date Extension configuration object.
int IntAddonvars.AddInteger(str parameterName,
str desc,
str unitText,
int initialValue
)
A RGUMENTS
parameterName
initialValue
R ETURNS
AddIntegerVector
Adds a new integer vector parameter to the Date Extension configuration object.
int IntAddonvars.AddIntegerVector(str parameterName,
str desc,
int initialSize,
str unitText,
int initialValue)
A RGUMENTS
parameterName

initialValue
R ETURNS
AddObject
Adds a new string parameter to the Date Extension configuration object.
381
int IntAddonvars.AddObject(str parameterName,

str desc,
str classFilter
)
A RGUMENTS
parameterName
classFilter
The filter for the objects which are allowed for selection
R ETURNS
AddObjectVector
Adds a new object vector parameter to the Date Extension configuration object.
int IntAddonvars.AddObjectVector(str parameterName,
str desc,
int initialSize,
str classFilter
)
A RGUMENTS
parameterName
classFilter
The filter for the objects which are allowed for selection
R ETURNS
AddString
Adds a new string parameter to the Date Extension configuration object.
int IntAddonvars.AddString(str parameterName,
str desc,
str unitText,
str initialValue
)
382
A RGUMENTS
parameterName
initialValue
R ETURNS
RemoveParameter
Removes the given parameter from the Data Extension configuration.
None IntAddonvars.RemoveParameter(str parameterName)
A RGUMENTS
parameterName
The name of the parameter to be removed
5.6.8 IntCase
Overview
Activate
ApplyNetworkState
ApplyStudyTime
Consolidate
Deactivate
SetStudyTime
Activate
Activates the study case. Deactivates other study cases first.
int IntCase.Activate()
R ETURNS
0 on success
1 on error
ApplyNetworkState
For a study case in a combined project, copy the network state from another case.
Copies the active grids, scenarios and network variations configuration to the current case. The
data will be added to any already existing configuration.
383
int IntCase.ApplyNetworkState(DataObject other)
A RGUMENTS
other The source Study Case to copy data from
R ETURNS
0 On success
1 Source object is not an IntCase object
2 Case where function is called on is not the active case
3 Source case is not from active project
4 Source Study Case is not from a source project in a combined project
5 Other error. Details are given in an error message
ApplyStudyTime
For a study case in a combined project, apply the study time from another study case.
int IntCase.ApplyStudyTime(DataObject other)
A RGUMENTS
other The source study case to copy study time from
R ETURNS
0 On success
1 Source object is not an IntCase object
2 Study case where function is called on is not the active case
3 Source case is not from active project
4 Source case is not from a project part of a combined project
Consolidate
Changes that are recorded in a project’s active Variations are permanently applied to the Net-
work Data folder (like right mouse button Consolidate Network Variation)
Note: Modified scenarios are not saved!
Works only:
• For active study cases

• If a network variation is active
int IntCase.Consolidate()
R ETURNS
0 On success
1 If an error has occured
S EE ALSO
IntScheme.Consolidate()
384
Deactivate
De-activates the study case.
int IntCase.Deactivate()
R ETURNS
0 on success
1 on error
SetStudyTime
Sets the current Study Case time to seconds since 01.01.1970 00:00:00. Use IntCase:iStudyTime
for getting current Study Case time.
None IntCase.SetStudyTime(int dateTime)
A RGUMENTS
dateTime Seconds since 01.01.1970 00:00:00.
5.6.9 IntComtrade
Overview
ConvertToASCIIFormat
ConvertToBinaryFormat
FindColumn
FindMaxInColumn
FindMinInColumn
GetAnalogueDescriptions
GetDescription
GetDigitalDescriptions
GetNumberOfAnalogueSignalDescriptions
GetNumberOfColumns
GetNumberOfDigitalSignalDescriptions
GetNumberOfRows
GetObjectValue
GetSignalHeader
GetUnit
GetValue
GetVariable
Load
Release
ConvertToASCIIFormat
Creates new comtrade configuration and data files in ASCII format in the file system directory of
the original files. The new configuration file is linked automatically to a new IntComtrade object
created in the same PowerFactory folder like this object. An existing IntComtrade object is
already in ASCII format when its parameter ’Binary’ is set to 0.
int IntComtrade.ConvertToASCIIFormat()
385
R ETURNS
0 File successfully converted.
1 Error occurred, e.g. file is already in ASCII format.
ConvertToBinaryFormat
Creates new comtrade configuration and data files in binary format in the file system directory of
the original files. The new configuration file is linked automatically to a new IntComtrade object
created in the same PowerFactory folder like this object. An existing IntComtrade object is
already in binary format when its parameter ’Binary’ is set to 1.
int IntComtrade.ConvertToBinaryFormat()
R ETURNS
0 File successfully converted.
1 Error occurred, e.g. file is already in binary format.
FindColumn
Returns the first column matching the variable name.
int IntComtrade.FindColumn(str variable,
[int startCol]
)
A RGUMENTS
variable The variable name to look for.
startCol (optional)
The index of the column at which to start the search.
R ETURNS
≥0 The column index found.
<0 The column with name variable was not found.
FindMaxInColumn
[int row,
float value] IntComtrade.FindMaxInColumn(int column)
A RGUMENTS

not found.
386
R ETURNS
FindMinInColumn
[int row,
float value] IntComtrade.FindMinInColumn(int column)
A RGUMENTS
not found.
R ETURNS
Get the descriptions of the analogue channel Please note that the comtrade info file contains
proprietary data from PFM. Info files not written by DIgSILENT PFM are not supported.
str IntComtrade.GetAnalogueDescriptions(int index)
A RGUMENTS
index) Digital channel index
R ETURNS
Descriptions for analogue channel in the comtrade info file.
GetDescription
str IntComtrade.GetDescription([int column],
[int short]
)
A RGUMENTS
column (optional)
short (optional)
1 short description
387
R ETURNS
Get the descriptions of the digital channel Please note that the comtrade info file contains
str IntComtrade.GetDigitalDescriptions(int index)
A RGUMENTS
index Digital channel index
R ETURNS
Descriptions for digital channel in the comtrade info file.
Gets the number of descriptions for analogue channels in the comtrade info file. Please note that
the comtrade info file contains proprietary data from PFM. Info files not written by DIgSILENT
PFM are not supported.
int IntComtrade.GetNumberOfAnalogueSignalDescriptions()
R ETURNS
Number of descriptions for analogue channels in the comtrade info file.
GetNumberOfColumns
int IntComtrade.GetNumberOfColumns()
R ETURNS
Get the number of descriptions for digital channels in the comtrade info file. Please note that
int IntComtrade.GetNumberOfDigitalSignalDescriptions()
R ETURNS
Number of descriptions for digital channels in the comtrade info file.
388
GetNumberOfRows
int IntComtrade.GetNumberOfRows()
R ETURNS
GetObjectValue
[int error,
DataObject o ] IntComtrade.GetObjectValue(int iX,
[int col])
A RGUMENTS
iX The row.
col (optional)
R ETURNS
0 when ok
GetSignalHeader
Get the headline of the channel section in the comtrade info file. Please note that the comtrade
info file contains proprietary data from PFM. Info files not written by DIgSILENT PFM are not
supported.
str IntComtrade.GetSignalHeader()
R ETURNS
Headline of signal descriptions
GetUnit
str IntComtrade.GetUnit([int column])
389
A RGUMENTS
column (optional)
R ETURNS
GetValue
[int error,
float d ] IntComtrade.GetValue(int iX,
[int col])
A RGUMENTS
iX The row.
col (optional)
R ETURNS
0 when ok
GetVariable
str IntComtrade.GetVariable([int column])
A RGUMENTS
column (optional)
R ETURNS
data.
390
Load
Loads the data of a result object (IntComtrade) in memory for reading.
None IntComtrade.Load()
Release
None IntComtrade.Release()
Sorts all rows in the data loaded according to the given column. The IntComtrade itself remains
unchanged.
int IntComtrade.SortAccordingToColumn(int column)
A RGUMENTS
R ETURNS
given column.
5.6.10 IntComtradeset
Overview
FindColumn
FindMaxInColumn
FindMinInColumn
GetDescription
GetNumberOfColumns
GetNumberOfRows
GetObjectValue
GetSignalHeader
GetUnit
GetValue
GetVariable
Load
Release
391
FindColumn
Returns the first column matching the variable name.
int IntComtradeset.FindColumn(str variable,
[int startCol]
)
A RGUMENTS
variable The variable name to look for.
startCol (optional)
The index of the column at which to start the search.
R ETURNS
≥0 The column index found.
<0 The column with name variable was not found.
FindMaxInColumn
[int row,
float value] IntComtradeset.FindMaxInColumn(int column)
A RGUMENTS
not found.
R ETURNS
FindMinInColumn
[int row,
float value] IntComtradeset.FindMinInColumn(int column)
A RGUMENTS
not found.
R ETURNS
392
Get the descriptions of the analogue channel Please note that the comtrade info file contains
str IntComtradeset.GetAnalogueDescriptions(int index)
A RGUMENTS
index) Digital channel index
R ETURNS
Descriptions for analogue channel in the comtrade info file.
GetDescription
str IntComtradeset.GetDescription([int column],
[int short]
)
A RGUMENTS
column (optional)
short (optional)
1 short description
R ETURNS
Get the descriptions of the digital channel Please note that the comtrade info file contains
str IntComtradeset.GetDigitalDescriptions(int index)
A RGUMENTS
index Digital channel index
R ETURNS
Descriptions for digital channel in the comtrade info file.
Gets the number of descriptions for analogue channels in the comtrade info file. Please note that
int IntComtradeset.GetNumberOfAnalogueSignalDescriptions()
393
R ETURNS
Number of descriptions for analogue channels in the comtrade info file.
GetNumberOfColumns
int IntComtradeset.GetNumberOfColumns()
R ETURNS
Get the number of descriptions for digital channels in the comtrade info file. Please note that
int IntComtradeset.GetNumberOfDigitalSignalDescriptions()
R ETURNS
Number of descriptions for digital channels in the comtrade info file.
GetNumberOfRows
int IntComtradeset.GetNumberOfRows()
R ETURNS
GetObjectValue
[int error,
DataObject o ] IntComtradeset.GetObjectValue(int iX,
[int col])
A RGUMENTS
iX The row.
col (optional)
394
R ETURNS
0 when ok
GetSignalHeader
Get the headline of the channel section in the comtrade info file. Please note that the comtrade
info file contains proprietary data from PFM. Info files not written by DIgSILENT PFM are not
supported.
str IntComtradeset.GetSignalHeader()
R ETURNS
Headline of signal descriptions
GetUnit
str IntComtradeset.GetUnit([int column])
A RGUMENTS
column (optional)
R ETURNS
GetValue
[int error,
float d ] IntComtradeset.GetValue(int iX,
[int col])
A RGUMENTS
iX The row.
col (optional)
395
R ETURNS
0 when ok
GetVariable
str IntComtradeset.GetVariable([int column])
A RGUMENTS
column (optional)
R ETURNS
data.
Load
Loads the data of a result object (IntComtradeset) in memory for reading.
None IntComtradeset.Load()
Release
None IntComtradeset.Release()
Sorts all rows in the data loaded according to the given column. The IntComtradeset itself
remains unchanged.
int IntComtradeset.SortAccordingToColumn(int column)
A RGUMENTS
396
R ETURNS
given column.
5.6.11 IntDataset
Overview
AddRef
All
Clear
GetAll
AddRef
Adds new reference(s) for passed object(s) as children to the dataset object. Nothing happens
if there exists already a reference for the passed object.
None IntDataset.AddRef(DataObject object)
None IntDataset.AddRef(list objects)
A RGUMENTS
obj/objects
Object(s) for which references should be created and added to the dataset object
All
Returns all children of the dataset object.
list IntDataset.All()
R ETURNS
All objects contained in dataset object.
Clear
Deletes all children of the dataset object.
None IntDataset.Clear()
GetAll
Returns all children of the dataset filtered according to given class name.
list IntDataset.GetAll(str className)
A RGUMENTS
className
class name filter, e.g. ElmTerm
397
R ETURNS
All objects of given class stored in dataset object.
5.6.12 IntDocument
Overview
Export
Import
Reset
View
Export
Exports the embedded data as new file on disk. The embedded data remains unmodified. If
desired it can be removed by calling the Reset() function afterwards
int IntDocument.Export(str filename)
A RGUMENTS
filename Name of export file on disk
R ETURNS
0 On success.
1 On error.
S EE ALSO
IntDocument.Import()
Import
Imports the content of selected file into the PowerFactory object. The data is afterwards em-
bedded in the PowerFactory database.
int IntDocument.Import()
R ETURNS
0 On success.
1 On error.
S EE ALSO
IntDocument.Export()
Reset
Resets embedded data and reference to an external file.
int IntDocument.Reset()
398
View
Views the file in external application. If the file is embedded, it’s extracted into a temporary file
that is opened afterwards. Please note, the action is only executed if access to given file (type)
is enabled in the 'External Access' configuration of PowerFactory (IntExtaccess).
int IntDocument.View()
R ETURNS
0 Success, file was opened
1 Error, file not opened (because of invalid address or security reasons)
S EE ALSO
IntUrl.View()
5.6.13 IntDplmap
Overview
Clear
Contains
First
GetValue
Insert
Next
Remove
Size
Update
Clear
Removes all key/value pairs from the container and resets type information.
None IntDplmap.Clear()
Contains
Checks if a key/value pair with given key is contained in the container.
int IntDplmap.Contains(int | float | str | DataObject | list key)
A RGUMENTS
key Key of the associated pair in the container
R ETURNS
1 if an entry of same key is contained, otherwise 0.
First
Outputs the first key/value pair stored in the container.
Note:
399
• The sequence of the returned pairs is determined by internal criteria and cannot be
changed.
• It is not allowed to modify a container while iterating over it. If doing so, the next call of the
Next command will return a value of 1.
Exception: Update() does not invalidate current position.
[int end,
int | float | str | DataObject | list key
int | float | str | DataObject | list value] IntDplmap.First()
A RGUMENTS
key (out) Key of the associated pair in the container
value (out)
Value of the associated pair in the container
R ETURNS
1 if no next entry is available in the container (e.g. end is reached), otherwise 0.
GetValue
Returns the associated value for given key.
[int|float|str|DataObject|list value,
int error] IntDplmap.GetValue(int|float|str|DataObject|list key)
A RGUMENTS
key Key of the associated pair in the container to find.
error (optional, out)
1 Key was not found in container.
0 Key was found in the container.
R ETURNS
The value which is associated to the given key or an undefined value if key is not associated
with any value.
Insert
Inserts given key and value as an associated pair into the container.
On the first insertion, the container is (automatically) typed by given data types of key and value.
From now on, only keys and values of that types are accepted. (This type information is removed
when IntDplmap.Clear() is called.)
If given key already exists in the container, its associated value will be overwritten. (Each key
can only be contained once in a map (no multi-map support).)
Note:
• Type of key and value can be different, of course.

• Sets are always inserted by value, not by reference!
None IntDplmap.Insert (int | float | str | DataObject | list key,

int | float | str | DataObject | list value)
400
A RGUMENTS
key Key of the associated pair in the container.
value Value of the associated pair in the container.
Next
Outputs the next key/value pair relative to the last key/value pair in the container.
Note:
• The sequence of the returned pairs is determined by internal criteria and cannot be
changed.
• It is not allowed to modify a container while iterating over it. If doing so, the next call of the
Next command will return a value of 1.
Exception: Update() does not invalidate current position.
[int end,
int | float | str | DataObject | list key
int | float | str | DataObject | list value] IntDplmap.Next()
A RGUMENTS
key (out) Key of the associated pair in the container.
value (out)
Value of the associated pair in the container.
R ETURNS
1 if no next entry is available in the container (e.g. end is reached), otherwise 0.
Remove
Removes the key/value pair for given key from the container. No error will occur, if the key is not
contained in the container.
None IntDplmap.Remove (int | float | str | DataObject | list key)
A RGUMENTS
Size
Returns the number of key/value pairs stored in the container.
int IntDplmap.Size()
R ETURNS
Number of key-value pairs stored in the container.
401
Update
Is a special insert function that can be used for updating key/value pairs in the map. It can only
be used if the key is already contained in the map.
None IntDplmap.Update(int | float | str | DataObject | list key,
int | float | str | DataObject | list value)
A RGUMENTS
value Value of the associated pair in the container
5.6.14 IntDplvec
Overview
Clear
Get
IndexOf
Insert
Remove
Size
Sort
Clear
Removes all elements from the container and resets the typ information.
None IntDplvec.Clear()
Get
Returns the element stored at given position in the container.
int|float|str|DataObject|list IntDplvec.Get(int position)
A RGUMENTS
position Position in the container. It is zero-based and must always be lesser than the
container’s size.
R ETURNS
Element stored at given position in the container.
IndexOf
Returns the position where the given element is stored in the container.
int IntDplvec.IndexOf(int|float|str|DataObject|list element,
[int startPosition]
)
402
A RGUMENTS
element Element for which the position will be searched.
startPosition
Start position from which the next occurrence greater or equal to this position is
searched.
R ETURNS
Position of the the given element in the container. The returned position is zero-based. If no
occurrence was found, -1 is returned.
Insert
Inserts an element at given position into the container. If no position is given then the element
is appended to the back. Inserting an element to an empty container fixes the type of elements
which can be hold by itself. Clearing the container resets this type information.
None IntDplvec.Insert(int|float|str|DataObject|list element)
None IntDplvec.Insert(int position,
int|float|str|DataObject|list element
)
A RGUMENTS
element Element to be inserted.
position Position (zero-based) to insert the element at. Any old entry at that position will
be overwritten. Note: The size of the vector is automatically increased if given
position is greater than current size.
Remove
Removes the element stored at given position from the container.
None IntDplvec.Remove(int position)
A RGUMENTS
position Given position (zero-based) at which the element is to be removed.
Size
Returns the number of elements stored in the container.
int IntDplvec.Size()
R ETURNS
Number of elements stored in the container.
Sort
Sorts the elements of the vector depending on the type of elements stored inside the vector:
403
string lexically
double/int
according to value
object according to full name (path + name) or given attribute
None IntDplvec.Sort([int descending,]

[str attribute]
)
A RGUMENTS
descending (optional)
1 Descending sorting order
0 Ascending sorting order (default)
attribute (optional)
For objects only: Attribute according to which the sorting is done (default is full
name)
5.6.15 IntEvt
Overview
CreateCBEvents
RemoveSwitchEvents
CreateCBEvents
Create boundary breaker events for all shc locations which occur simultaneously in this fault
case.
None IntEvt.CreateCBEvents([int iRemoveExisting])
A RGUMENTS
iRemoveExisting (optional)
-1 Query user if circuit breaker events exist.
0 Do not create circuit breaker events if circuit breaker events are already
defined events exist (default)
1 Remove existing circuit breaker events.
RemoveSwitchEvents
Remove all switch events of this fault case.
None IntEvt.RemoveSwitchEvents([int onlyContingency])
A RGUMENTS
onlyContingency (optional)
Condition to remove.
0 Remove all switch events regardless of the calculation type.
404
1 Remove all switch events only when this fault case is used for contin-
gency analysis.
5.6.16 IntExtaccess
Overview
CheckUrl
CheckUrl
Checks whether access to given url will be granted or not according to the security settings.
See also IntUrl.View() for accessing that url.
int IntExtaccess.CheckUrl(str url)
A RGUMENTS
url url to check
R ETURNS
0 access granted
1 access denied
5.6.17 IntGate
Overview
AddTrigger
AddTrigger
Adds either a condition or a gate to the gate.
list IntGate.AddTrigger(DataObject newTrigger)
A RGUMENTS
newTrigger
The condition or gate that shall be added.
5.6.18 IntGrf
Overview
MoveToLayer
405
MoveToLayer
Moves an annotation element stored as (obsolete) IntGrf object to an annotation layer (IntGr-
flayer ) or group (IntGrfgroup).
None IntGrf.MoveToLayer(DataObject layer)
A RGUMENTS
layer Target IntGrflayer or IntGrfgroup object.
5.6.19 IntGrfgroup
Overview
ClearData
Export
Import
ClearData
Removes all annotation elements from this group.
None IntGrfgroup.ClearData()
Export
Exports all objects of a group into svg-file.
None IntGrfgroup.Export(str path,
[int OpenDialog])
A RGUMENTS
path Full export file path
OpenDialog (optional)
Prompt for export path in dialog
0 Export directly and do not show any dialog (default)

1 Show dialog with path before exporting
Import
Imports svg-file into group object.
None IntGrfgroup.Import(str path)
A RGUMENTS
path Path of file to be imported.
406
5.6.20 IntGrflayer
Overview
ClearData
Export
ExportToVec
Import
ImportFromVec
ClearData
Removes all annotation elements on this layer (keeps contained groups and annotation ele-
ments).
None IntGrflayer.ClearData()
Export
Exports all objects of a layer into svg-file, inclusive annotation objects of contained group
objects.
None IntGrflayer.Export(str path,
[int OpenDialog])
A RGUMENTS
path Full export file path
OpenDialog (optional)
Prompt for export path in dialog
0 Export directly and do not show any dialog (default)
1 Show dialog with path before exporting
ExportToVec
Fills string description of annotation elements of this layer into an IntDplvec. Clears IntDplvec
before filling it.
A RGUMENTS
intDplVec IntDplvec object to be filled.
Import
Imports svg file into layer.
None IntGrflayer.Import(str path)
A RGUMENTS
path Path of file to be imported.
407
ImportFromVec
Fills this layer with the string description of annotation elements from an IntDplvec. Clears layer
before filling it.
A RGUMENTS
intDplVec IntDplvec containg description of annotation elements.
5.6.21 IntGrfnet
Overview
Close
SetLayerVisibility
SetSymbolComponentVisibility
Show
Close
Closes the graphic page that displays this diagram.
int IntGrfnet.Close()
R ETURNS
1 Otherwise
SetLayerVisibility
Sets a layer visible or invisible.
None IntGrfnet.SetLayerVisibility(str sLayer,
int iVis)
A RGUMENTS
sLayer Layer to be modified.
iVis Visibility
0 Make layer invisible.

1 Make layer visible.
SetSymbolComponentVisibility
Determines which parts of net element symbols are shown in the diagram.
None IntGrfnet.SetSymbolComponentVisibility(int componentID,
int visible)
408
A RGUMENTS
componentID
Component to be modified.
5 Connection points
7 Tap positions
8 Vector groups
9 Load flow arrows
11 Phases
13 Line sections and loads
14 Connection arrows
21 Connection numbers (block diagrams only)
22 Connection names (block diagrams only)
33 Remotely controlled substation markers
38 Tie open point markers
39 Open standby switch markers
40 Normally open switch markers
visible Visibility
0 Make component invisible.
1 Make component visible.
Show
Opens a diagram.
int IntGrfnet.Show()
R ETURNS
1 Otherwise
5.6.22 IntIcon
Overview
Export
Import
Export
Exports current icon as a bitmap file.
int IntIcon.Export(str filename)
A RGUMENTS
filename Name of export image on disk. Extension needs to be ’.bmp’
409
R ETURNS
0 On success.
1 On error.
S EE ALSO
IntIcon.Import()
Import
Imports icon from a bitmap file.
int IntIcon.Import(str filename)
A RGUMENTS
filename Name of bitmap file on disk. Extension and format needs to be ’.bmp’
R ETURNS
0 On success.
1 On error.
S EE ALSO
IntIcon.Export()
5.6.23 IntLibrary
Overview
Activate
Deactivate
Activate
Activates this library. If another library is already activated it will be deactivated first.
int IntLibrary.Activate()
R ETURNS
1 if successful
0 otherwise
Deactivate
Deactivates this library.
int IntLibrary.Deactivate()
R ETURNS
1 if successful
0 otherwise
410
5.6.24 IntMat
Overview
ColLbl
Get
GetColumnLabel
GetColumnLabelIndex
GetNumberOfColumns
GetNumberOfRows
GetRowLabel
GetRowLabelIndex
Init
Invert
Multiply
Resize
RowLbl
Save
Set
SetColumnLabel
SetRowLabel
SortToColumn
ColLbl
Deprecated function to get or set the label of the given column. Please use IntMat.GetColumnLabel()
or IntMat.SetColumnLabel() instead.
str IntMat.ColLbl(int column)
str IntMat.ColLbl(str label,
int column
)
Get
Returns the value at the position (row, column) of the matrix. A run-time error will occur when
'row' or 'column' is out of range.
float IntMat.Get(int row,
int column
)
A RGUMENTS
row Row in matrix: 1 ... GetNumberOfRows().
column column in matrix: 1 ... GetNumberOfColumn()
R ETURNS
Value in matrix.
S EE ALSO
IntMat.Set()
411
GetColumnLabel
Returns the label of a column.
str IntMat.GetColumnLabel(int column)
A RGUMENTS
column Column index (first column has index 1).
R ETURNS
Column label of given column.
D EPRECATED N AMES
ColLbl
S EE ALSO
IntMat.SetColumnLabel(), IntMat.GetColumnLabelIndex(), IntMat.GetRowLabel()
GetColumnLabelIndex
Gets the index of a label in all column labels.
int IntMat.GetColumnLabelIndex(str label)
A RGUMENTS
label Label to search.
R ETURNS
≥1 The index in the column labels, if label was found.
0 Otherwise
S EE ALSO
IntMat.GetColumnLabel()
GetNumberOfColumns
Returns the number of columns in the matrix.
int IntMat.GetNumberOfColumns()
R ETURNS
The number of columns of the matrix.
D EPRECATED N AMES
NCol, SizeY
S EE ALSO
IntMat.GetNumberOfRows()
412
GetNumberOfRows
Returns the number of rows in the matrix.
int IntMat.GetNumberOfRows()
R ETURNS
The number of rows.
D EPRECATED N AMES
NRow, SizeX
S EE ALSO
IntMat.GetNumberOfColumns()
GetRowLabel
Returns the label of a row.
str IntMat.GetRowLabel(int row)
A RGUMENTS
row Row index (first row has index 1).
R ETURNS
Row label of given row.
D EPRECATED N AMES
RowLbl
S EE ALSO
IntMat.SetRowLabel(), IntMat.GetRowLabelIndex(), IntMat.GetColumnLabel()
GetRowLabelIndex
Gets the index of a label in all row labels.
int IntMat.GetRowLabelIndex(str label)
A RGUMENTS
label Label to search.
R ETURNS
≥1 The index in the row labels, if it was found.
0 Otherwise
S EE ALSO
IntMat.GetRowLabel()
413
Init
Initializes the matrix with given size and values, regardless of the previous size and data.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
int IntMat.Init(int numberOfRows,
int numberOfColumns,
[float initialValue = 0.0]
)
A RGUMENTS
numberOfRows
The number of rows.
numberOfColumns
The number of columns.
initialValue (optional)
Initial values: All matrix entries are initialised with this value. Matrix is initialized
with 0 if ommitted.
R ETURNS
S EE ALSO
IntMat.Resize()
Invert
Inverts the matrix.
database.
int IntMat.Invert()
R ETURNS
0 Success, the matrix is replaced by its inversion.
1 Error, inversion not possible. Original matrix was not changed.
Multiply
Multiplies 2 matrixes and stores the result in this matrix.
database.
int IntMat.Multiply(DataObject M1,
DataObject M2
)
A RGUMENTS
object M1
Matrix 1 to be multiplied.
414
object M2
Matrix 2 to be multiplied.
R ETURNS
Resize
Resizes the matrix to a given size. Existing values will not be changed. Added values will be
set to the optional value, otherwise to 0.
database.
int IntMat.Resize(int numberOfRows,
int numberOfColumns,
[float initialValue = 0.0]
)
A RGUMENTS
numberOfRows
The number of rows.
numberOfColumns
The number of columns.
initialValue (optional)
Initial values: Additional matrix entries are initialised with this value. Additional
values are initialized with 0. if ommitted.
R ETURNS
S EE ALSO
IntMat.Init()
RowLbl
Deprecated function to get or set the label of the given row. Please use IntMat.GetRowLabel()
or IntMat.SetRowLabel() instead.
str IntMat.RowLbl(int row)
str IntMat.RowLbl(str label,
int row
)
Save
Saves the current state of this matrix to database.
None IntMat.Save()
415
Set
Sets a value at the position (row, column) of the matrix. The matrix is resized automatically if
the given coordinates exceed the size.
database.
int IntMat.Set(int row,
int column,
float value
)
A RGUMENTS
row Row index, 1 based. The first row has index 1. Invalid index (leq0) leads to
scripting error.
column Column index, 1 based. The first column has index 1. Invalid index (leq0) leads to
scripting error.
value Value to assign.
R ETURNS
S EE ALSO
IntMat.Get()
SetColumnLabel
Sets the label of a column.
database.
None IntMat.SetColumnLabel(int column,
str label
)
A RGUMENTS
column Column index (first column has index 1).
label Label to set.
S EE ALSO
IntMat.GetColumnLabel(), IntMat.GetColumnLabelIndex(), IntMat.SetRowLabel()
SetRowLabel
Sets the label of a row.
database.
str IntMat.SetRowLabel(int row,
str label
)
416
A RGUMENTS
row Row index (first row has index 1).
label Label to set.
S EE ALSO
IntMat.GetRowLabel(), IntMat.GetRowLabelIndex(), IntMat.SetColumnLabel()
SortToColumn
Sorts the matrix alphanumerically according to a column, which is specified by the input param-
eter. The row labels are sorted accordingly (if input parameter storeInDB is 1).
int IntMat.SortToColumn(int columnIndex,
[float epsilon = 0.0],
[int storeInDB = 1])
D EPRECATED N AMES
SortToColum
A RGUMENTS
columnIndex
The column index, 1 based. The first column has index 1.
epsilon (optional)
Accuracy for comparing equal values. Values which differ less than epsilon are
treated as being equal. Default value is 0.
storeInDb (optional)
Possible Values:
0 Non-persistent change. Values are not stored in database.

1 Values are stored in database. (default)
R ETURNS
0 On success.
1 Error. Original matrix was not changed.
5.6.25 IntMon
Overview
AddVar
AddVars
ClearVars
GetVar
NVars
PrintAllVal
PrintVal
RemoveVar
417
AddVar
Appends the variable “name” to the list of selected variable names.
None IntMon.AddVar(str name)
A RGUMENTS
name The variable name to add.
AddVars
Appends the filtered variables to the list of selected variables.
None IntMon.AddVars(str varFilter)
A RGUMENTS
varFilter The filter for variables to add. For example: ’e:*’ to add all parameters of element
to variable selection.
ClearVars
Clears the list of selected variable names.
None IntMon.ClearVars()
GetVar
Returns the variable name on the given row of the variable selection text on the second page of
the IntMon dialogue, which should contain one variable name per line.
str IntMon.GetVar(int row)
A RGUMENTS
row Given row
R ETURNS
The variable name in line row.
NVars
Returns the number of selected variables or, more exact, the number of lines in the variable
selection text on the second page of the IntMon dialogue, which usually contains one variable
name per line.
int IntMon.NVars()
R ETURNS
The number of variables selected.
418
PrintAllVal
Writes all calculation results of the object assigned in obj id to the output window. The output
includes the variable name followed by the value, its unit and the description.
It should be noted that the variable set itself is modified by this method.
None IntMon.PrintAllVal()
PrintVal
Prints the values of the selected variables to the output window.
None IntMon.PrintVal()
RemoveVar
Removes the variable “name” from the list of selected variable names.
int IntMon.RemoveVar(str name)
A RGUMENTS
name The variable name.
R ETURNS
0 If variable with name was found and removed.
1 If the variable name was not found.
5.6.26 IntOutage
Overview
Apply
ApplyAll
Check
CheckAll
IsInStudyTime
ResetAll
Apply
None IntOutage.Apply([int reportSwitches])
Applies the outage object. The functionality corresponds to pressing the ’Apply’ button in edit
dialog with the difference that the scripting function can also be used without an active scenario.
A RGUMENTS
reportSwitches (optional)
Flag to enable the reporting of changed switches to the output window.
0 No output (default)
1 Print switches to output window
419
ApplyAll
None IntOutage.ApplyAll([int reportSwitches])
Applies all currently relevant (=in study time and not out-of-service) outage objects of current
project. The functionality corresponds to pressing the ’ApplyAll’ button in edit dialog with the
difference that the scripting function can also be used without an active scenario. It applies all
relevant outages independent of the one it was called on.
A RGUMENTS
Check
int IntOutage.Check([int outputMessage])
This function checks if the outage is correctly reflected by the network elements.
A RGUMENTS
outputMessage (optional)
Flag to enable detailed output to the output window.
1 Detailed report of mismatch to output window
R ETURNS
0 Ok, outage is correctly reflected
1 Not ok, status of network elements does not reflect outage
CheckAll
This function checks if all outages are correctly reflected by the network components for current
study time. It checks all outages independent of the one it was called on.
[list notOutaged,
list wronglyOutaged] IntOutage.CheckAll([int emitMsg,]
[DataObject gridfilter,])
A RGUMENTS
int emitMsg (optional)
whether to report inconistencies to the output window
-1 No output
0 (Default) print inconsistencies but without start / end message
1 Full output, including start / end message
gridfilter (optional)
Possibility to restrict checking for accidentally outaged elements to given object
(e.g. grid) and its children (by default, all elements for all active grids are checked).
420
notOutaged (optional, out)(optional)

If given, all network components that should be outaged but are not are filled into
this set.
wronglyOutaged (optional, out)(optional)
If given, all network components that should be outaged but are not are filled into
this set.
IsInStudyTime
int IntOutage.IsInStudyTime()
Checks if outage is relevant for current study time, i.e. the study time lies within the outage’s
validity period.
R ETURNS
0 Outage is not relevant for current study time (outside validity period)
1 Outage is relevant for current study time (inside validity period)
D EPRECATED N AMES
IsInStudytime
ResetAll
None IntOutage.ResetAll([int reportSwitches])
Resets all currently relevant (=in study time and not out-of-service) outage objects of current
project. The functionality corresponds to pressing the ’Reset’ button in all outage objects with
difference that the scripting function can also be used without an active scenario. It resets all
relevant outages independent of the one it was called on.
A RGUMENTS
5.6.27 IntPlannedout
Overview
SetRecurrence
SetRecurrence
Copies the settings of a Recurrence Pattern object to the planned outage object and enables
the flag Recurrent.
int IntPlannedout.SetRecurrence(DataObject recurrencePattern)
421
A RGUMENTS
recurrencePattern
Recurrence pattern object, classname IntRecurrence
R ETURNS
0 Ok, settings copied successful
1 Failed, passed object is NULL or not of class IntRecurrence
5.6.28 IntPlot
Overview
SetAdaptY
SetAutoScaleY
SetScaleY
SetAdaptY
None IntPlot.SetAdaptY(int mode,
[float offset]
)
A RGUMENTS
0 off
1 on
offset (optional)
Offset, unused if mode is off or empty
SetAutoScaleY
Sets automatic scaling mode of the y-scale. A warning is issued if an invalid mode is passed to
the function.
None IntPlot.SetAutoScaleY(int mode)
A RGUMENTS
0 never
1 after simulation
2 during simulation
422
SetScaleY
Sets y-axis scale limits. A function call without arguments sets the Auto Scale setting to On
without changing the scale itself.
None IntPlot.SetScaleY()
None IntPlot.SetScaleY(float min,
float max,
[int log]
)
A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.
log (optional)
Possible values:
0 linear
1 logarithmic
5.6.29 IntPrj
Overview
Activate
AddProjectToCombined
AddProjectToRemoteDatabase
Archive
BeginDataExtensionModification
CanAddProjectToRemoteDatabase
CanSubscribeProjectReadOnly
CanSubscribeProjectReadWrite
ClearInvalidReferences
CopyDataExtensionFrom
CreateVersion
Deactivate
EndDataExtensionModification
GetDerivedProjects
GetExternalReferences
GetGeoCoordinateSystem
GetLatestVersion
GetVersions
HasExternalReferences
LoadData
MergeToBaseProject
Migrate
NormaliseCombined
PackExternalReferences
Purge
RemoveProjectFromCombined
Restore
SetGeoCoordinateSystem
423
SubscribeProjectReadOnly
SubscribeProjectReadWrite
TransformGeoCoordinates
UnsubscribeProject
UpdateStatistics
UpdateToDefaultStructure
UpdateToMostRecentBaseVersion
Activate
Activates the project. If another project is already activated it will be deactivated first.
int IntPrj.Activate()
R ETURNS
0 on success
1 on error
AddProjectToCombined
Adds a project to this using the Project Combination logic. The passed object must be an
IntVersion. The receiving project must be activated but not have a Study Case active, otherwise
this method will fail.
int IntPrj.AddProjectToCombined(object projectVersion)
A RGUMENTS
projectVersion
The verson of a project to add
R ETURNS
0 operation was successful
1 an error occurred
AddProjectToRemoteDatabase
Adds a project to the online database if possible.
Can only be used if the database driver is set to Offline Mode.
int IntPrj.AddProjectToRemoteDatabase()
Archive
Archives the project if the functionality is configured and activated. Does nothing otherwise.
int IntPrj.Archive()
R ETURNS
0 project has been archived
1 project has not been archived
424
BeginDataExtensionModification
Signals the start of a Data Extension modification.
Must be terminated with EndDataExtensionModification, otherwise all changes will be discarded.
Data Extensions can only be modified when the project is active.
DataObject IntPrj.BeginDataExtensionModification()
R ETURNS
The SetDataext configuration object in the settings folder for further processing.
S EE ALSO
IntPrj.EndDataExtensionModification(), SetDataext.AddConfiguration(), SetDataext.GetConfiguration(),

SetDataext.GetConfigurations(), SetDataext.RemoveAllConfigurations(), SetDataext.RemoveConfiguration()
CanAddProjectToRemoteDatabase
Checks if the project can be pushed to the remote database.
The project must be subscribable as read and write and it must be unsubscribed. Can only be
used if the database driver is set to Offline Mode.
int IntPrj.CanAddProjectToRemoteDatabase()
R ETURNS
0 project cannot be added to the remote database
1 project can be added to the remote database
CanSubscribeProjectReadOnly
Checks if a project can be subscribed read-only by the user executing the script.
int IntPrj.CanSubscribeProjectReadOnly()
R ETURNS
0 no permission to subscribe project
1 project can be subscribed
CanSubscribeProjectReadWrite
Checks if a project can be subscribed read-write by the user executing the script.
int IntPrj.CanSubscribeProjectReadWrite()
R ETURNS
0 no permission to subscribe project
1 project can be subscribed
425
ClearInvalidReferences
Removes all references from the project which can no longer be resolved due to target objects
being deleted or projects no longer being available in the database, i.e. project stubs and non-
migrated projects.
int IntPrj.ClearInvalidReferences(int type)
A RGUMENTS
type
0 Remove references to deleted objects
1 Remove references to project stubs and non-migrated projects
2 Remove both
R ETURNS
Number of references cleared.
CopyDataExtensionFrom
Copies the Data Extension configuration from another project into this project. The configuration
is applied immediately. The target project must be active.
int IntPrj.CopyDataExtensionFrom(object other)
A RGUMENTS
other Project to copy the Data Extension configuration from.
R ETURNS
0 Copied successfully
1 Target project is not active
2 Source object is not a project
3 Error during copying, see Output Window
CreateVersion
Creates a new version of project it was called on.
Optionally allows to pass the version name, the timestamp, a bool for user notification, a bool to
enforce project approval and a description.
DataObject IntPrj.CreateVersion([str name = "",]
[int timestamp = 0,]
[int notifyUsers = 0,]
[int approvalRequired = 0,]
[str description = ""]
)
DataObject IntPrj.CreateVersion(int notifyUsersAndApprovalRequired,
[str name = "",]
[float timestamp = 0,]
[str description = ""]
)
426
A RGUMENTS
name Version name. The default version name e.g. ’Project Version’ is used on an
empty string. (default: empty string)
timestamp
Seconds since 01.01.1970 00:00:00. On zero the current date and time is used.
(default: 0)
notifyUsers
User notifications activated:
0 Create version and do not notify users (default).
1 Notify users.
approvalRequired
Project approval required:
0 Create version without approval (default).
1 Require approval.
notifyUsersAndApprovalRequired
Project approval required and user notifications activated:
0 Create version without approval and do not notify users (default).
1 Require approval and notify users.
description
Version description. (default: empty string)
R ETURNS
DataObject Newly created IntVersion object.
None On failure e.g. missing permission rights.
Deactivate
De-activates the project if it is active. Does nothing otherwise.
int IntPrj.Deactivate()
R ETURNS
0 on success
1 on error
EndDataExtensionModification
Terminates a Data Extension modification previously initiated with BeginDataExtensionModifi-
cation.
This will deactivate the Study Case if the new Data Extension configuration can be applied. In
case of errors the project will be deactivated and rolled back. Omitting the call to EndDataEx-
tensionModification and exiting from the script will discard all changes to the Data Extension
configuration.
None IntPrj.EndDataExtensionModification()
427
S EE ALSO
IntPrj.BeginDataExtensionModification()
GetDerivedProjects
Return a set holding all versions created in the project.
list IntPrj.GetDerivedProjects()
R ETURNS
Set holding all versions of a project.
GetExternalReferences
Fills the given map with objects from this project mapping to its external references.
int IntPrj.GetExternalReferences(DataObject resultMap,
[DataObject externalReferencesSettings])
A RGUMENTS
resultMap
DPL map (IntDplmap) which will contain objects mapping to its external refer-
ences. Objects without external references are not mapped.
externalReferencesSettings (optional)
External References settings object (SetExtref). Defines the properties for objects
being external references. The External References settings object from current
user is used if ommitted.
R ETURNS
0 Getting external references succeeded.
1 Getting external references cancelled in dialogue or failed e.g project inactive or
not migrated.
S EE ALSO
IntPrj.HasExternalReferences(), IntPrj.PackExternalReferences()
GetGeoCoordinateSystem
Returns the EPSG code of the geographic coordinate system in which the geo coordinates of
the project’s net elements are stored.
int IntPrj.GetGeoCoordinateSystem()
R ETURNS
EPSG code of the project’s geographic coordinate system, or 0 if the coordinate system is
not known.
428
GetLatestVersion
Returns the most recent version available in the project which has the notify users option set.
Optionally allows to consider all versions, regardless of notify users option.
DataObject IntPrj.GetLatestVersion([int onlyregular])
A RGUMENTS
onlyregular (optional)
1 consider only regular version (default)
0 consider all versions
R ETURNS
Latest version of the project
GetVersions
Returns a set containing all versions of the project.
list IntPrj.GetVersions()
R ETURNS
Set that contains all versions of the project
HasExternalReferences
Checks if any object inside the project references external non-system objects and prints a
report to the Output Window.
int IntPrj.HasExternalReferences([int considerGlobal = 1,]
[int considerRemoteVariants = 0]
)
int IntPrj.HasExternalReferences(DataObject externalReferencesSettings])
A RGUMENTS
considerGlobal (optional)
0 References to global (non-system) objects are not considered as ex-
ternal references.
1 References to global (non-system) objects are considered as external
references (default).
considerRemoteVariants (optional)
0 References to remote variants are not considered as external refer-
ences (default).
1 References to remote variants are considered as external references.
being external references.
R ETURNS
0 No external reference was found.
1 An external reference was found.
429
S EE ALSO
IntPrj.PackExternalReferences(), IntPrj.GetExternalReferences()
LoadData
Loads all objects of the project from the data base. Does nothing when called on an active
project.
This function is useful to optimise searches which would traverse deep into an inactive project.
None IntPrj.LoadData()
MergeToBaseProject
Merges the modifications of a derived project to the base project.
int IntPrj.MergeToBaseProject(int conflictMode)
A RGUMENTS
conflictMode
Assignment in case of modification conflict:
0 Favour none. Diff browser is shown in case of conflicts.

1 Favour base version.
2 Favour derived project.
3 Favour base project.
R ETURNS
0 Merge finished sucessfully.

1 Merge failed (no further information).
2 Merge failed due to failing assignment check.
3 Merge failed due to invalid projects (e.g. no derived project).
4 Merge was canceled by user.
5 Merge completed with errors (see output window).
Migrate
Migrates a project from version V13 to V14. Migration is only executed if project has been
created in build 400 or earlier (and is not yet migrated).
None IntPrj.Migrate([int createCopy])
A RGUMENTS
createCopy (optional)
1 Creates a copy of current project (original copy is maintained) (default)
0 Does an ”in-place” migration of the project (original is overwritten)
430
NormaliseCombined
Normalises a combined project so it appears to be a regular project. This will remove all
intermediate folders which were added when creating the combined project. This might lead
to naming duplications which will be resolved by the normal logic of numbering duplicates.
int IntPrj.NormaliseCombined()
R ETURNS
1 operation was cancelled because the project is active
PackExternalReferences
Packs external references of this project and prints a report to the Output Window.
int IntPrj.PackExternalReferences([DataObject externalReferencesSettings])
A RGUMENTS
being external references. The External References settings object from current
user is used if ommitted.
R ETURNS
0 Packing external references succeeded.
1 Packing external references cancelled in dialogue or failed e.g project inactive or
not migrated.
S EE ALSO
IntPrj.HasExternalReferences(), IntPrj.GetExternalReferences()
Purge
Purges project storage and updates storage statistics.
Requires write access to the project; the functions does nothing when the project is locked by
another user.
None IntPrj.Purge()
RemoveProjectFromCombined
Removes a project from a combined project. For the removal the mapping key must be specified.
Mapping keys are stored in the project, parameter project mapped. The project this method is
called on must be activated but not have a Study Case active, otherwise this method will fail.
int IntPrj.RemoveProjectFromCombined(str mappingKey)
A RGUMENTS
mappingKey
The mapping key for the project that should be removed
431
R ETURNS
1 an unknown error occurred
2 an error occurred and is documented in the output window
Restore
Restores an archived project so it can be used again. Does nothing if the project is not an
archived one.
int IntPrj.Restore()
R ETURNS
0 project has not been restored
1 project has been restored
SetGeoCoordinateSystem
Defines the the geographic coordinate system in which the geo coordinates of the project’s net
elements are stored.
None IntPrj.SetGeoCoordinateSystem(int epsgCode)
A RGUMENTS
epsgCode
EPSG code of the geographic coordinate system to be used for this project. A
value of 0 denotes an unknown coordinate system.
SubscribeProjectReadOnly
Subscribes a project read only if the permission is granted.
None IntPrj.SubscribeProjectReadOnly()
SubscribeProjectReadWrite
Subscribes a project read/write if the permission is granted.
None IntPrj.SubscribeProjectReadWrite()
TransformGeoCoordinates
Transforms geographic coordinates from a source coordinate system to a destination coordinate
system. Geodetic coordinates (longitude/latitude) are specified in decimal degrees. Projected
coordinates are specified in meters.
432
[int error,
float xOut,
float yOut] IntPrj.TransformGeoCoordinates(float xIn, float yIn,
int sourceEpsg, int destEpsg
)
A RGUMENTS
xIn horizontal component of the input location: x position or longitude, resp.
yIn vertical component of the input location: y position or latitude, resp.
xOut (out)
horizontal component of the output location: x position or longitude, resp.
yOut (out)
vertical component of the output location: y position or latitude, resp.
sourceEpsg
EPSG code of the source coordinate system
destEpsg EPSG code of the destination coordinate system
R ETURNS
1 an error occurred
UnsubscribeProject
Unsubscribes a project.
None IntPrj.UnsubscribeProject()
UpdateStatistics
Updates the storage statistics for a project. The statistics are displayed on the page Storage of
a project.
Note: This function requires write access to the project otherwise the update is not executed
and an error message is printed to the output window.
None IntPrj.UpdateStatistics()
UpdateToDefaultStructure
Updates folder structure of currently active project to that of the default project (used for creation
of new projects). Existing folders will be moved to a new location within the project. Folders that
have no correspondence in the default project will remain untouched.
NB: Folders might get moved or additional ones might be created, but no folder is deleted by
this routine.
int IntPrj.UpdateToDefaultStructure(int createMissingFolders, int updateForeignKeys)
433
A RGUMENTS
createMissingFolders (optional)
0 Missing folders will not be created. Only existing ones will be moved to
new locations, if required.
1 Missing folders will be created (default).
updateForeignKeys (optional)
0 Foreign-keys of folders will not be updated.
1 Foreign-keys of folders will be updated (default).
R ETURNS
1 operation was not successful, e.g. project not active
UpdateToMostRecentBaseVersion
Updates a derived project to the most recent version of the base project. This is done by creating
a new derived project from the new version and (optionally) merging the modifications from the
existing derived project into it.
int IntPrj.UpdateToMostRecentBaseVersion(DataObject newDerivedProject,
int versionWithNotification,
int discardOwnModifications,
[int conflictMode = 0]
)
A RGUMENTS
newDerivedProject (out)
New derived project if no error occured.
versionWithNotification
0 Update to the most recent version independent of the ”Notify users”
setting.
1 Update to the most recent version with ”Notify users” enabled.
discardOwnModifications
0 Merge modifications of new version and derived project.
1 Discard modifications of dervived project. The Compare and Merge
Tool is not used at all.
conflictMode (optional)
Assignment in case of modification conflict (only used if not discarding derived
modifications):
0 Favour none. Diff browser is shown in case of conflicts. (default)

1 Favour new base version.
2 Favour derived project.
434
R ETURNS
0 Merge finished sucessfully.
1 Merge failed (no further information).
2 Merge failed due to failing assignment check.
3 Merge failed due to invalid projects (e.g. no derived project).
4 Merge was canceled by user.
5 Merge completed with errors (see output window).
5.6.30 IntPrjfolder
Overview
GetProjectFolderType
IsProjectFolderType
GetProjectFolderType
Returns the type of the project folder stored in attribute “iopt type”.
The following types are currently available (language independent):
• blk - User Defined Models

• cbrat - CB Ratings
• chars - Characteristics
• cstgen - Generator Cost Curves
• effgen - Generator Efficiency Curves
• rnd - Probabilistic Assessment
• cim - CIM Model
• common - Common Mode Failures
• demand - Demand Transfers
• dia - Diagrams
• equip - Equipment Type Library
• fault - Faults
• ras - Remedial Action Schemes
• gen - Generic
• lib - Library
• mvar - Mvar Limit Curves
• netdat - Network Data
• netmod - Network Model
• oplib - Operational Library
• outage - Outages
435
• qpc - QP-Curves
• ra - Running Arrangements
• report - Table Reports
• scen - Operation Scenarios
• scheme - Variations
• script - Scripts
• study - Study Cases
• sw - StationWare
• tariff - Tariffs
• templ - Templates
• therm - Thermal Ratings
• ucc - V-Control-Curves
str IntPrjfolder.GetProjectFolderType()
R ETURNS
The type of the project folder as string. For possible return values see list above.
S EE ALSO
Application.GetProjectFolder()
IsProjectFolderType
This function checks if a project folder is of given type.
int IntPrjfolder.IsProjectFolderType(str type)
A RGUMENTS
type Folder type; for possible type values see IntPrjfolder.GetProjectFolderType()
R ETURNS
1 true, is of given type
0 false, is not of given type
S EE ALSO
Application.GetProjectFolder(), IntPrjfolder.GetProjectFolderType()
5.6.31 IntQlim
Overview
GetQlim
436
GetQlim
Returns either the current maximum or the minimum reactive power limit, given the specified
active power and voltage.
The active power must be given in the same units as the input mode definition of the capability
curve object (parameter ”inputmod” is 0 for MW/Mvar and 1 for p.u.).
float IntQlim.GetQlim(float p,
float v,
[float minmax]
)
A RGUMENTS
p the current value of active power in MW or p.u.
v the current value of voltage in p.u.
minmax (optional)
Returns either the maximum or minimum value. Possible values are:
-1 minimum value
1 maximum value. This is the default value
R ETURNS
Returns the minimum/maximum limit. The units might be Mvar or p.u., depending on the
input mode of the capability curve. Also, the limits are calculated for a single machine.
5.6.32 IntRas
Overview
AddEvent
AddTrigger
IsValid
AddEvent
Adds an event to the Remedial Action Scheme.
list IntRas.AddEvent(DataObject newEvent)
A RGUMENTS
newEvent
The event that shall be added.
AddTrigger
Adds either a condition or a gate to the Remedial Action Scheme.
list IntRas.AddTrigger(DataObject newTrigger)
A RGUMENTS
newTrigger
The condition or gate that shall be added.
437
IsValid
Checks if the Remedial Action Scheme is valid.
int IntRas.IsValid(int emitMessage = 0)
A RGUMENTS
emitMessage
Emit messages if not equal to zero.
R ETURNS
0 If invalid.
1 If valid.
5.6.33 IntRunarrange
Overview
GetSwitchStatus
GetSwitchStatus
Determines the status of the given switch in the running arrangement, without assigning or
applying the running arrangement.
int IntRunarrange.GetSwitchStatus(DataObject switch)
A RGUMENTS
switch ElmCoup or StaSwitch from which to get the status stored in running arrange-
ment
R ETURNS
Status of the switch in the running arrangement. Possible values are
-1 Switch is not part of the running arrangement

0 Switch is open
1 Switch is closed
5.6.34 IntScenario
Overview
Activate
Apply
ApplySelective
Deactivate
DiscardChanges
GetObjects
GetOperationValue
ReleaseMemory
Save
SetOperationValue
438
Activate
Activates a scenario. If there is currently another scenario active that one will be deactivated
automatically.
int IntScenario.Activate()
R ETURNS
0 successfully activated
1 error, e.g. already activate, no project and study case active
Apply
Copies the values stored in a scenario to the corresponding network elements. The value
transfer is identical to scenario activation, however, the scenario will not be activated. In case of
having an active variation or another scenario, the values will be recorded there.
int IntScenario.Apply([int requestUserConfirmation])
int IntScenario.Apply(int requestUserConfirmation,
DataObject parentfilter
)
A RGUMENTS
requestUserConfirmation(optional)
0 silent, just apply the data without further confirmation requests
1 request a user confirmation first (default)
parentfilter (optional)
If given, scenario data is only applied for given object and all of its children (hier-
archical filter)
R ETURNS
0 on success
ApplySelective
Similar to function Apply() but copies only the set of attributes listed in the given apply configu-
ration. An apply configuration is a folder consisting of variable selection objects (IntMon), one
per class. For each class the attributes to be copied can be selected.
int IntScenario.ApplySelective(DataObject configuration)
int IntScenario.ApplySelective(int requestUserConfirmation,
DataObject applyConfiguration
)
A RGUMENTS
applyConfiguration
folder containing variable selection objects
439
R ETURNS
0 on succes
Deactivate
Deactivates the currently active scenario.
int IntScenario.Deactivate([int saveOrUndo])
A RGUMENTS
saveOrUndo(optional)
Determines whether changes in active scenario will be saved or discarded before
the scenario is deactivated. If this argument is omitted, the user will be asked.
0 discard changes
1 save changes
R ETURNS
0 on success
DiscardChanges
Discards all unsaved changes made to a scenario.
int IntScenario.DiscardChanges()
R ETURNS
0 on success
1 error, scenario was not modified or not active
GetObjects
Returns a set of all objects for which operational data are stored in scenario.
list IntScenario.GetObjects()
R ETURNS
Set of all objects for which operational data are stored in scenario
GetOperationValue
This function offers read access to the operation data values stored in the scenario.
[int error,
int|float|str|DataObject value] IntScenario.GetOperationValue(DataObject obj,
str attribute,
[int fromObject])
440
A RGUMENTS
value (out)
variable that holds the value after call
obj object for which the operation to be retrieved
attribute name of the operation data attribute
fromObject
only if current scenario is active:
0 value is taken from scenario (as stored on db)
1 (default), value is taken from object (reflects un-saved modifications)
R ETURNS
0 on success
ReleaseMemory
Releases the memory used by a scenario. Any further access to the scenario will reload the
data from database. The function can be called on inactive scenarios only. Use this function
with care!
int IntScenario.ReleaseMemory()
R ETURNS
0 on success
1 error, scenario is active
Save
Saves the current active value of all operational attributes for all active network elements to
database.
int IntScenario.Save()
R ETURNS
0 successfully saved
1 error, scenario was not modified or not active
SetOperationValue
Offers write access to operational data stored in a scenario.
int IntScenario.SetOperationData(int|float|str|DataObject newvalue,
DataObject obj,
str attribute,
[int toObject = 1]
)
441
A RGUMENTS
newvalue New value to store in the scenario.
obj Object for which the operation data to store.
attribute Name of the operation data attribute.
toObject Only if current scenario is active:

0 Value is only stored to scenario on db.
1 As 0 but value is also updated on object in memory. (default)
R ETURNS
0 on success, otherwise 1.
5.6.35 IntScensched
Overview
Activate
Deactivate
DeleteRow
GetScenario
GetStartEndTime
SearchScenario
Activate
Activates a scenario scheduler.
int IntScensched.Activate()
R ETURNS
Deactivate
Deactivates a scenario scheduler.
int IntScensched.Deactivate()
R ETURNS
0 successfully deactivated
1 error, e.g. already deactivates, no project and study case active
DeleteRow
Delete row(s) of the scenario scheduler.
None IntScensched.DeleteRow(int row, [int numberOfRows])
442
A RGUMENTS
row row number (begin with 0)
numberOfRows (optional)
number of rows to delete (default = 1)
GetScenario
Get the scenario for corresponding time 'iTime'.
DataObject IntScensched.GetScenario(int iTime)
A RGUMENTS
iTime Time (UCTE) to get the corresponding scenario.
R ETURNS
None No scenario at time 'iTime'defined
IntScenario Scenario will be activated at time 'iTime'
GetStartEndTime
Get start and end time of the corresponding scenario.
[int error
int startTime,
int endTime ] IntScensched.GetStartEndTime(DataObject scenario)
A RGUMENTS
scenario A scenario (IntScenario).
startTime (out)
Start time (time when the scenario is activated)).
endTime (out)
End time (time until the scenario is still activated).
R ETURNS
−1 Scenario not found (not part of scenario scheduler)
≥0 Vector index (index of scenario)
SearchScenario
Search at which table index (row) the corresponding scenario is defined in the scheduler.
int IntScensched.SearchScenario(DataObject scenarioObject)
A RGUMENTS
scenarioObject
scenario object
443
R ETURNS
−1 Scenario not found (not part of scenario scheduler).
≥0 Vector index (row, index of scenario).
5.6.36 IntScheme
Overview
Activate
Consolidate
Deactivate
GetActiveScheduler
NewStage
Activate
Activates a variation and inserts a variation reference in a 'Variation Configuration Folder'stored
in the study case.
int IntScheme.Activate()
R ETURNS
Consolidate
Changes that are recorded in this variation will be permanently applied to the original location.
Note: Modified scenarios are not saved.
Works only:
• for non network variation e.g. used for Mvar Limit Curves, Thermal Ratings ...
• and the variation must be activated.
int IntScheme.Consolidate()
R ETURNS
0 On success.
1 If an error has occured.
Deactivate
Deactivates a variation and removes the variation reference in the 'Variation Configuration
Folder'stored in the study case.
int IntScheme.Deactivate()
444
R ETURNS
0 successfully deactivated
1 error, e.g. already deactivated, no project and study case active
GetActiveScheduler
Returns the corresponding active variation scheduler or None if no scheduler is active for this
variation (IntScheme).
DataObject IntScheme.GetActiveScheduler()
NewStage
Adds a new expansion stage into the variation (name = sname).
int IntScheme.NewStage(str name,
int activationTime,
int activate
)
A RGUMENTS
name Name of the new expansion stage.
activationTime
Activation time of the new expansion stage in seconds since 01.01.1970 00:00:00.
activate
1 The actual study time is changed to the parameter iUTCtime and the
varation will be activated. If the variation is a network variation, the
new created expansion stage is used as 'recording 'expansion stage.
If the variation (this) is not active, the variation will be automatically
activated.
0 Expansion stage and/or variation will not be activated.
5.6.37 IntSscheduler
Overview
Activate
Deactivate
Update
Activate
Activates a variation scheduler. An already activated scheduler for same variation will be
deactivated automatically.
int IntSscheduler.Activate()
R ETURNS
=0 On success
445
6= 0 If an error has occurred
Deactivate
Deactivates a variation scheduler.
int IntSscheduler.Deactivate()
R ETURNS
=0 on success
6= 0 If an error has occurred especially if scheduler was not active (to be consistent
with scenario scheduler deactivate()).
Update
Update variation scheduler (updates internal reference stages).
int IntSscheduler.Update()
R ETURNS
=0 On success
6= 0 If an error has occurred
5.6.38 IntSstage
Overview
Activate
CreateStageObject
EnableDiffMode
GetVariation
IsExcluded
PrintModifications
ReadValue
WriteValue
Activate
Activates the expansion stage and sets the 'recording' expansion stage. The study time will be
automatically set to the correponsing time of the stage.
int IntSstage.Activate([int iQueryOption])
A RGUMENTS
iQueryOption
0 (default) The user must confirm the query.
1 The “Yes” button is automatically applied.
2 The “No” button is automatically applied.
R ETURNS
0 Successfully activated.
446
1 Error, e.g. scheme is not active.
CreateStageObject
Creates a stage object (delta or delete object) inside corresponding IntSstage.
DataObject IntSstage.CreateStageObject(int type,
DataObject rootObject
)
A RGUMENTS
type Kind of object to create
1 Delete object
2 Delta object
rootObject
(Original) object for which the stage object should be created.
R ETURNS
Stage object on success.
EnableDiffMode
Enables the comparison mode for the variation management system. If the mode is enabled a
DELTA object is only created when the object is different.
None IntSstage.EnableDiffMode(int enable)
A RGUMENTS
enable
0 disables the difference/comparison mode
1 enables the difference/comparison mode
GetVariation
Returns variation of expansion stage.
DataObject IntSstage.GetVariation()
R ETURNS
Variation object corresponding to stage.
D EPRECATED N AMES
GetScheme
IsExcluded
Returns if expansion stage flag 'Exclude from Activation' is switched on (return value = 1) or not
(return value = 0). The function checks also if the stage is excluded regarding the restricted
validity period of the corresponding variation and considers also the settings of an variation
scheduler when defined.
447
float IntSstage.IsExcluded()
R ETURNS
1 if stage is excluded
0 if stage is considered
PrintModifications
Reports in the the output window the modification of the corresponding expansion stage. Works
only if the expansion stage is the active 'recording 'expansion stage.
int IntSstage.PrintModifications([int onlyNetworkData,]
[str ignoredParameter]
)
A RGUMENTS
onlyNetworkData (optional)
1 (default) Show only network data modifications. Graphical modifica-
tions are not report when the diagrams folder are recored.
0 Show all modifications
ignoredParameter (optional)
Comma separated list of parameters which are ignored for reporting.
R ETURNS
0 on success
1 if the actual expansion stage is not the 'recording 'expansion stage.
ReadValue
Get the value for an attribute of an ADD or DELTA object which modifies “rootObj” (root object).
[int error,
float|str|DataObject value] IntSstage.ReadValue(DataObject rootObj,
str attributeName)
R ETURNS
=0 On success.
6= 0 Error e.g. wrong data type.
WriteValue
Writes a value for an attribute to an ADD or DELTA object which modifies rootObj (root object).
int IntSstage.WriteValue(float|str|DataObject value,
DataObject rootObj,
str attributeName)
448
R ETURNS
=0 On success.
6= 0 Error e.g. wrong data type.
5.6.39 IntSubset
Overview
Apply
ApplySelective
Clear
GetConfiguration
GetObjects
Apply
Copies the values stored in a scenario to the corresponding network elements. The value
transfer is identical to scenario activation, however, the scenario will not be activated. In case of
having an active variation or another scenario, the values will be recorded there.
int IntSubset.Apply([int requestUserConfirmation])
A RGUMENTS
R ETURNS
0 on success
ApplySelective
Similar to function Apply() but copies only the set of attributes listed in the given apply configu-
ration. An apply configuration is a folder consisting of variable selection objects (IntMon), one
per class. For each class the attributes to be copied can be selected.
int IntSubset.ApplySelective(DataObject applyConfiguration)
int IntSubset.ApplySelective(int requestUserConfirmation,
DataObject applyConfiguration
)
A RGUMENTS
applyConfiguration
folder containing variable selection objects
R ETURNS
0 on succes
449
Clear
Clears all values stored in the subset.
Please note that this function can only be called on subsets of currently in-active scenarios.
int IntSubset.Clear()
R ETURNS
0 On success.
1 On error, e.g. subset belongs to a currently active scenario.
GetConfiguration
Returns class and attribute configuration for the subset.
str IntSubset.GetConfiguration(str subset)
A RGUMENTS
subset
R ETURNS
Returns a list of classes and attributes for which operational data are stored in subset.
GetObjects
Returns a set of all objects for which operational data are stored in the subset.
list IntSubset.GetObjects()
R ETURNS
Set of all objects for which operational data are stored in the subset
5.6.40 IntThrating
Overview
GetCriticalTimePhase
GetRating
GetCriticalTimePhase
This function returns the smallest duration (time-phase) for which the power flow is beyond the
rating.
float IntThrating.GetCriticalTimePhase(float Flow,
float Loading
)
A RGUMENTS
Flow Power from the load flow calculation, in MVA.
Loading Element loading, in %.
450
R ETURNS
>0 Smallest time-phase for which the flow is beyond the rating.
-1 In case that no rating is violated.
GetRating
This function returns the rating in MVA according to the thermal rating table, considering element
overloading and its duration (time-phase).
float IntThrating.GetRating(float Loading,
float Duration
)
A RGUMENTS
Loading Element loading, in %.
Duration Duration or time phase for which the loading is considered, in minutes
R ETURNS
Rating in MVA or 0 if not found.
5.6.41 IntUrl
Overview
View
View
Requests the operating system to open given URL for viewing. The performed action depends
on the default action configured in the system. For example, by default 'http://www.google.com'
would be opened in standard browser.
Please note, the action is only executed if access to given URL is enabled in the 'External
Access' configuration of PowerFactory (IntExtaccess).
int IntUrl.View()
R ETURNS
The returned value reports the success of the operation:
0 Success, URL was opened

1 Error, URL was not opened (because of invalid address or security reasons)
5.6.42 IntUser
Overview
Purge
SetPassword
TerminateSession
451
Purge
Purges project storage and updates storage statistics for all projects of the user.
Requires write access to the project; the functions does nothing when the project is locked by
another user.
None IntUser.Purge()
SetPassword
Sets the password for the user the function is called on.
Note: Only the administrator user is allowed to use this function. He can (re-)set the password
for every user.
int IntUser.SetPassword(str newpassword)
A RGUMENTS
newpassword
Case sensitive user password to set
R ETURNS
Returns whether or not the password has successfully been set. Possible values are:
0 error
1 password set successfully
TerminateSession
Allows the Administrator to log out another user. Prints an error if the current user is not the
Administrator.
None IntUser.TerminateSession()
5.6.43 IntUserman
Overview
CreateGroup
CreateUser
GetGroups
GetUsers
UpdateGroups
CreateGroup
Creates a new user group of given name. If a group with given name already exists the existing
one is returned instead.
Note: Only Administrator user is allowed to call this function.
DataObject IntUserman.CreateGroup(str name)
452
A RGUMENTS
name Given name of the user group
R ETURNS
Created user group (IntGroup)
CreateUser
Creates a new user with given name. If the user already exists the existing one is returned
instead.
Note: Only Administrator user is allowed to call this function.
DataObject IntUserman.CreateUser(str name)
A RGUMENTS
name Given name of the user
R ETURNS
Created user (IntUser)
GetGroups
Returns a container with all user groups.
Note: Only the administrator user is allowed to call this function.
list IntUserman.GetGroups()
R ETURNS
Set of all available users
GetUsers
Returns a container with all users as they are currently visible in the Data Manager tree.
Note: Only the administrator user is allowed to call this function.
list IntUserman.GetUsers()
R ETURNS
Set of all available users
UpdateGroups
Updates the Everybody group so it contains all currently existing users and cleans it of removed
users.
None IntUserman.UpdateGroups()
453
5.6.44 IntVec
Overview
Get
Init
Max
Mean
Min
Resize
Save
Set
Size
Sort
Get
Get the value in row index. Index is one based, therefore the index of the first entry is 1.
float IntVec.Get(int index)
A RGUMENTS
index Index in vector, one based.
S EE ALSO
IntVec.Set()
Init
Initializes the vector. Resizes the vector and initializes all values to 0.
This operation is performed in memory only. Use IntVec.Save() to save the modified vector to
database.
None IntVec.Init(int size)
A RGUMENTS
size The new size of the vector.
Max
Gets the maximum value stored in the vector.
float IntVec.Max()
R ETURNS
The maximum value stored in the vector. Empty vectors return 0 as maximum value.
Mean
Calculates the average value of the vector.
float IntVec.Mean()
454
R ETURNS
The average value of the vector. A value of 0. is returned for empty vectors.
Min
Gets the minimum value stored in the vector.
float IntVec.Min()
R ETURNS
The minimum value stored in the vector. Empty vectors return 0 as minimum value.
Resize
Resizes the vector. Inserted values are initialized to 0.
database.
None IntVec.Resize(int size)
A RGUMENTS
size The new size.
Save
Saves the current state of this vector to database.
None IntVec.Save()
Set
Set the value in row index. Index is one based, therefore the index of the first entry is 1.
The vector is resized automatically to size index in case that the index exceeds the current
vector size. Values inserted are automatically initialized to a value of 0.
database.
None IntVec.Set(int index,
float value)
A RGUMENTS
index Index in vector.
value Value to assign in row index.
S EE ALSO
IntVec.Get()
455
Size
Returns the size of the vector.
int IntVec.Size()
R ETURNS
The size of the vector.
Sort
Sorts the vector.
database.
None IntVec.Sort([int ascending = 0])
A RGUMENTS
ascending
Sort order:
0 Highest value first (descending, default).

1 Smallest value first (ascending).
5.6.45 IntVecobj
Overview
Get
Resize
Save
Search
Set
Size
Get
Get the object in row index. Index is one based, therefore the index of the first entry is 1.
DataObject IntVecobj.Get(int index)
A RGUMENTS
index Index in vector, one based.
S EE ALSO
IntVecobj.Set()
Resize
Resizes the vector. Inserted new entries are initialized to None.
This operation is performed in memory only. Use IntVecobj.Save() to save the modified vector
to database.
456
None IntVecobj.Resize(int size)
A RGUMENTS
size The new size.
Save
Saves the current state of this vector to database.
None IntVecobj.Save()
Search
Search if the object (obj) is part of the vecor and returns the corresponding index of the vector
(one based).
int IntVecobj.Search(DataObject obj)
R ETURNS
1 ... size object found, located at index
0 object not part of vector
Set
Set the object (obj) in row index. Index is one based, therefore the index of the first entry is 1.
The vector is resized automatically to size index in case that the index exceeds the current
vector size. Object inserted are automatically initialized to a value of None.
This operation is performed in memory only. Use IntVecobj.Save() to save the modified vector
to database.
None IntVecobj.Set(int index,
DataObject obj)
A RGUMENTS
index Index in vector.
obj Object to assign in row index.
S EE ALSO
IntVecobj.Get()
Size
Returns the size of the vector.
int IntVecobj.Size()
457
R ETURNS
The size of the vector.
5.6.46 IntVersion
Overview
CreateDerivedProject
GetDerivedProjects
GetHistoricalProject
Rollback
CreateDerivedProject
Creates a derived project from the version.
DataObject IntVersion.CreateDerivedProject(str name,
[DataObject parent]
)
A RGUMENTS
name The name of the project which will be created.
parent(optional)
The parent of the project which will be created. Default is the current user.
R ETURNS
Returns the created project.
GetDerivedProjects
list of projects derived from this version
list IntVersion.GetDerivedProjects()
R ETURNS
list of derived projects
GetHistoricalProject
Returns historic project within version
DataObject IntVersion.GetHistoricalProject()
R ETURNS
Returns the historic project object
Rollback
Roll backs the project to this version. No project have to be active. Furthermore no script from
the project of the version have to be running.
int IntVersion.Rollback()
458
R ETURNS
0 on success
1 otherwise
5.6.47 IntViewbookmark
Overview
JumpTo
UpdateFromCurrentView
JumpTo
Opens the referenced diagram (if not already open) and sets the viewing area.
None IntViewbookmark.JumpTo()
UpdateFromCurrentView
Updates the bookmark’s diagram and view area from the current drawing window.
None IntViewbookmark.UpdateFromCurrentView()
5.6.48 PltDataseries
Overview
AddCurve
AddXYCurve
ClearCurves
GetDataSource
GetIntCalcres
AddCurve
Appends a curve to the plot.
None PltDataseries.AddCurve(DataObject element,
str varname,
[DataObject datasource]
)
A RGUMENTS
element Element to display
varname Name of the element variable to display
datasource (optional)
Data source to assign to the curve (ElmRes or IntComtrade). If not specified, the
plot’s default result file will be used for the curve.
459
AddXYCurve
Appends a curve to a XY plot.
None PltDataseries.AddXYCurve(DataObject elementX,
str varnameX,
DataObject elementY,
str varnameY,
[DataObject datasource]
)
A RGUMENTS
elementX Element to display on x-axis
varnameX
Name of the element variable to display on x-axis
elementY Element to display on y-axis
varnameY
Name of the element variable to display on y-axis
datasource (optional)
Data source to assign to the curve (ElmRes or IntComtrade). If not specified, the
plot’s default result file will be used for the curve.
ClearCurves
Removes all curves from the plot.
None PltDataseries.ClearCurves()
GetDataSource
Returns the data source that is used for the curve with given index.
DataObject PltDataseries.GetDataSource(int curveIndex)
A RGUMENTS
int curveIndex
curve index in table, must be ≥ 0
R ETURNS
DataObject Data source
None No data source found
GetIntCalcres
Gets all user Calculated Result objects (IntCalcres) stored inside the data series.
list PltDataseries.GetIntCalcres()
460
R ETURNS
All Calculated Result objects (IntCalcres) stored inside the data series.
5.6.49 PltLinebarplot
Overview
DoAutoScale
GetAxisX
GetAxisY
GetDataSeries
GetLegend
GetTitleObject
SetAutoScaleModeX
SetAutoScaleModeY
SetAxisSharingLevelX
SetAxisSharingLevelY
SetScaleTypeX
SetScaleTypeY
SetScaleX
SetScaleY
DoAutoScale
Adapts the plot’s axes ranges such that they show the entire data range.
None PltLinebarplot.DoAutoScale([int axisDimension])
A RGUMENTS
axisDimension (optional)
Limits auto-scaling to one dimension. Possible values:
0 scale only x-axes
1 scale only y-axes
GetAxisX
Returns one of the plot’s x-axes.
DataObject PltLinebarplot.GetAxisX([int axisIndex])
A RGUMENTS
axisIndex=0 (optional)
Determines which x-axis should be returned:
0 main x-axis
1 second x-axis (will be created if not yet present)
R ETURNS
PltAxis object
461
GetAxisY
Returns one of the plot’s y-axes.
DataObject PltLinebarplot.GetAxisY([int axisIndex])
A RGUMENTS
axisIndex=0 (optional)
Determines which y-axis should be returned:
0 main y-axis
1 second y-axis (will be created if not yet present)
R ETURNS
PltAxis object
GetDataSeries
Returns the plot’s data series object (PltDataseries).
DataObject PltLinebarplot.GetDataSeries()
R ETURNS
Data series object (PltDataseries)
GetLegend
Returns the plot’s legend object (PltLegend).
DataObject PltLinebarplot.GetLegend()
R ETURNS
Legend object (PltLegend)
GetTitleObject
Returns the plot’s title object (PltTitle).
DataObject PltLinebarplot.GetTitleObject()
R ETURNS
Title object (PltTitle)
SetAutoScaleModeX
Defines whether the plot should automatically adapt its main x-axis range on data changes.
None PltLinebarplot.SetAutoScaleModeX(int mode)
462
A RGUMENTS
SetAutoScaleModeY
Defines whether the plot should automatically adapt its main y-axis range on data changes.
None PltLinebarplot.SetAutoScaleModeY(int mode)
A RGUMENTS
SetAxisSharingLevelX
Defines whether the plot has its own x-axis or should share its x-axis across the page or the
entire graphics board.
None PltLinebarplot.SetAxisSharingLevelX(int level)
A RGUMENTS
level Possible values:
0 local (do not share x-axis)
1 use x-axis from page
2 use x-axis from graphics board
SetAxisSharingLevelY
Defines whether the plot has its own y-axis or should share its y-axis across the page or the
entire graphics board.
None PltLinebarplot.SetAxisSharingLevelY(int level)
A RGUMENTS
level Possible values:
0 local (do not share y-axis)

1 use y-axis from page
2 use y-axis from graphics board
463
SetScaleTypeX
Sets the scale type of the plot’s main x-axis.
None PltLinebarplot.SetScaleTypeX(int scaleType)
A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic
SetScaleTypeY
Set the scale type of the plot’s main y-axis.
None PltLinebarplot.SetScaleTypeY(int scaleType)
A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic
2 dB
SetScaleX
Sets the scale of the plot’s main x-axis.
None PltLinebarplot.SetScaleX(float min,
float max
)
A RGUMENTS
SetScaleY
Sets the scale of the plot’s main y-axis.
None PltLinebarplot.SetScaleY(float min,
float max
)
464
A RGUMENTS
5.6.50 RelZpol
Overview
AssumeCompensationFactor
AssumeReRl
AssumeXeXl
AssumeCompensationFactor
Triggers a calculation of the complex compensation factor and stores the result.
int RelZpol.AssumeCompensationFactor()
R ETURNS
0 The compensation factor was successfully calculated.
1 An error occurred (e.g. conencted branch was not found).
AssumeReRl
Triggers a calculation of the real part of the decoupled compensation factor and stores the
result.
int RelZpol.AssumeReRl()
R ETURNS
AssumeXeXl
Triggers a calculation of the imaginary part of the decoupled compensation factor and stores
the result.
int RelZpol.AssumeXeXl()
R ETURNS
465
5.6.51 ScnFreq
Overview
GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime
GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float ScnFreq.GetLimit(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
The limit value (in p.u.) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.
Returns the number of violations.
int ScnFreq.GetNumberOfViolations()
R ETURNS
The number of violations.
GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float ScnFreq.GetValue(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
The ith value (in p.u.), given by vIdx, which causes the violation. If vIdx is negative, zero or
greater than the number of violations, then the function returns ’nan’.
GetVariable
Returns the name of the variable of the ith violation, given by vIdx.
str ScnFreq.GetVariable(int vIdx)
466
A RGUMENTS
vIdx vIdx > 0
R ETURNS
The name of the variable of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ”NoVariable”.
GetViolatedElement
Returns the element of the ith violation, given by vIdx.
DataObject ScnFreq.GetViolatedElement(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
The element of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns None.
GetViolationTime
Returns the time (in seconds) of the ith violation, given by vIdx.
float ScnFreq.GetViolationTime(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
The time (in seconds) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
5.6.52 ScnFrt
Overview
GetLimit
GetValue
GetVariable
GetViolatedElement
GetViolationTime
GetLimit
Returns the limit value of the ith violation, given by vIdx.
float ScnFrt.GetLimit(int vIdx)
467
A RGUMENTS
vIdx vIdx > 0
R ETURNS
The limit value of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns ’nan’.
int ScnFrt.GetNumberOfViolations()
R ETURNS
GetValue
Returns the ith value, given by vIdx, which causes the violation.
float ScnFrt.GetValue(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
The ith value, given by vIdx, which causes the violation. If vIdx is negative, zero or greater
GetVariable
str ScnFrt.GetVariable(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetViolatedElement
DataObject ScnFrt.GetViolatedElement(int vIdx)
A RGUMENTS
vIdx vIdx > 0
468
R ETURNS
GetViolationTime
float ScnFrt.GetViolationTime(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
5.6.53 ScnSpeed
Overview
GetLimit
GetValue
GetVariable
GetViolatedElement
GetViolationTime
GetLimit
float ScnSpeed.GetLimit(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
int ScnSpeed.GetNumberOfViolations()
R ETURNS
469
GetValue
float ScnSpeed.GetValue(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetVariable
str ScnSpeed.GetVariable(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetViolatedElement
DataObject ScnSpeed.GetViolatedElement(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetViolationTime
float ScnSpeed.GetViolationTime(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
470
5.6.54 ScnSync
Overview
GetLimit
GetValue
GetVariable
GetViolatedElement
GetViolationTime
GetLimit
float ScnSync.GetLimit(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
int ScnSync.GetNumberOfViolations()
R ETURNS
GetValue
float ScnSync.GetValue(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetVariable
str ScnSync.GetVariable(int vIdx)
471
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetViolatedElement
DataObject ScnSync.GetViolatedElement(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetViolationTime
float ScnSync.GetViolationTime(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
5.6.55 ScnVar
Overview
GetLimit
GetValue
GetVariable
GetViolatedElement
GetViolationTime
GetLimit
float ScnVar.GetLimit(int vIdx)
472
A RGUMENTS
vIdx vIdx > 0
R ETURNS
int ScnVar.GetNumberOfViolations()
R ETURNS
GetValue
float ScnVar.GetValue(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetVariable
str ScnVar.GetVariable(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetViolatedElement
DataObject ScnVar.GetViolatedElement(int vIdx)
A RGUMENTS
vIdx vIdx > 0
473
R ETURNS
GetViolationTime
float ScnVar.GetViolationTime(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
5.6.56 ScnVolt
Overview
GetLimit
GetValue
GetVariable
GetViolatedElement
GetViolationTime
GetLimit
float ScnVolt.GetLimit(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
int ScnVolt.GetNumberOfViolations()
R ETURNS
474
GetValue
float ScnVolt.GetValue(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetVariable
str ScnVolt.GetVariable(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetViolatedElement
DataObject ScnVolt.GetViolatedElement(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
GetViolationTime
float ScnVolt.GetViolationTime(int vIdx)
A RGUMENTS
vIdx vIdx > 0
R ETURNS
475
5.6.57 StoMaint
Overview
SetElms
SetElms
Sets the maintenance elements.
None StoMaint.SetElms(DataObject singleElement)
None StoMaint.SetElms(list multipleElements)
A RGUMENTS
singleElement
single Element for Maintenance
multipleElements
multiple Elements for Maintenance
5.6.58 TypAsmo
Overview
CalcElParams
CalcElParams
Function calculates the electrical parameters from the input data. Behaves identically as the cal-
culate button on the basic data page was pressed. Shall be applied only if the ’Slip-Torque/Current
Characteristic’ chosen.
int TypAsmo.CalcElParams()
R ETURNS
0 Calculated successfully.
1 Error.
5.6.59 TypCtcore
Overview
AddRatio
RemoveRatio
RemoveRatioByIndex
AddRatio
Adds the given ratio to the core. The ratio is added so that the sorting remains in ascending
order. The accuracy parameters will be copied from the previous row. If the new ratio is to be
the first ratio, the accuracy parameters will be copied from the next row instead.
int TypCtcore.AddRatio(float ratio)
476
A RGUMENTS
ratio New ratio to add.
R ETURNS
0 New ratio was added.
RemoveRatio
Removes the given ratio from the core. The last remaining ratio can never be removed.
int TypCtcore.RemoveRatio(float ratio)
A RGUMENTS
ratio Ratio to remove.
R ETURNS
0 Ratio was removed.
RemoveRatioByIndex
Removes the ratio with the given index from the core. The index is zero based. The last
remaining ratio can never be removed.
int TypCtcore.RemoveRatio(int index)
A RGUMENTS
index Index to remove.
R ETURNS
0 Index was removed.
5.6.60 TypLne
Overview
IsCable
IsCable
Checks if the line type is a cable type.
int TypLne.IsCable()
R ETURNS
1 Type is a cable
0 Type is not a cable
477
5.6.61 TypQdsl
Overview
Encrypt
IsEncrypted
SetThirdPartyModule
Encrypt
Encrypts a type. An encrypted type can be used without password but decrypted only with
password. If no password is given a ’Choose Password’ dialog appears.
int TypQdsl.Encrypt([str password = ""],
[int removeObjectHistory = 1],
[int masterCode = 0])
A RGUMENTS
password (optional)
Password for decryption. If no password is given a ’Choose Password’ dialog
appears.
Handling of unencrypted object history in database, e.g. used by project versions
or by undo:
0 Do not remove.
masterCode (optional)
Used for re-selling types. Third party licence codes already set in the type will be
overwritten by this value (default = 0).
R ETURNS
0 On success.
1 On error.
S EE ALSO
TypQdsl.IsEncrypted()
IsEncrypted
Returns the encryption state of the type.
int TypQdsl.IsEncrypted()
R ETURNS
1 Type is encrypted.
0 Type is not encrypted.
478
S EE ALSO
TypQdsl.Encrypt()
Resets the third party licence. Only possible for non-encrypted models. Requires masterkey
licence for third party module currently set.
int TypQdsl.ResetThirdPartyModule()
R ETURNS
0 On success.
1 On error.
SetThirdPartyModule
Sets the third party licence to a specific value. Only possible for non-encrypted models with no
third party licence set so far. Requires masterkey licence for third party module to be set.
int TypQdsl.SetThirdPartyModule(str companyCode,
str moduleCode
)
A RGUMENTS
companyCode
moduleCode
R ETURNS
0 On success.
1 On error.
5.6.62 TypTr2
Overview
GetZeroSequenceHVLVT
GetZeroSequenceHVLVT
Returns the calculated star equivalent of the zero sequence impedances.
[int error,
float hvReal,
float hvImag,
float lvReal,
float lvImag,
float tReal ,
float tImag ] TypTr2.GetZeroSequenceHVLVT()
479
A RGUMENTS
hvReal (out)
Real part of the HV impedance in %.
hvImag (out)
Imaginary part of the HV impedance in %.
lvReal (out)
Real part of the LV impedance in %.
lvImag (out)
Imaginary part of the LV impedance in %.
tReal (out)
Real part of the tertiary (delta) impedance in %.
tImag (out)
Imaginary part of the tertiary (delta) impedance in %.
R ETURNS
1 An error occurred; the values are invalid.
5.6.63 VisBdia
Overview
AddObjs
AddResObjs
Clear
SetScaleY
SetXVariable
SetYVariable
AddObjs
Adds objects to elements column in table 'Bars'.
None VisBdia.AddObjs(list elements)
A RGUMENTS
elements Elements to add in table.
AddResObjs
Adds objects to elements column in table 'Bars' (similar to AddObjs). Additionally a result file is
assigned to all rows added in the 'Result File' column.
None VisBdia.AddResObjs(DataObject resultFileObj,
list elements
)
480
A RGUMENTS
resultFileObj
The result file to assign. Must be an object of class ElmRes.
elements Elements to add in table.
Clear
Removes all elements from plot by erasing all rows from the table named 'Bars'.
None VisBdia.Clear()
SetScaleY
Sets y-axis scale limits.
None VisBdia.SetScaleY(float min,
float max,
[int log]
)
A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.
log (optional)
Possible values:
0 linear
1 logarithmic
SetXVariable
Set the x-axis Variable of the Distortion Analysis Diagram
int VisBdia.SetXVariable(str variable)
A RGUMENTS
variable x-axis variable to set.Length of variable must not exceed 37 characters.
R ETURNS
0 if ok, 1 if variable length exceeds 37 characters,
SetYVariable
Set the y-axis variable of the Distortion Analysis Diagram
int VisBdia.SetYVariable(str variable)
481
A RGUMENTS
variable y-axis variable to set.Length of variable must not exceed 37 characters.
R ETURNS
0 if ok, 1 if variable length exceeds 37 characters,
5.6.64 VisDraw
Overview
AddRelay
AddRelays
CentreOrigin
Clear
DoAutoScaleOnAll
DoAutoScaleOnCharacteristics
DoAutoScaleOnImpedances
DoAutoScaleX
DoAutoScaleY
AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None VisDraw.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])
A RGUMENTS
relay The protection device to be added.
colour (optional)
The colour to be used.
style (optional)
The line style to be used.
width (optional)
The line width to be used.
AddRelays
Adds relays to the plot.
None VisDraw.AddRelays(list relays)
A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.
482
CentreOrigin
Centre the origin of the plot
None VisDraw.CentreOrigin()
Clear
Removes all protection devices from the plot.
None VisDraw.Clear()
DoAutoScaleOnAll
Scales the plot automatically under consideration of relay characteristics, simulation curves and
short circuit arrows. The function works for local scales only.
int VisDraw.DoAutoScaleOnAll()
R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.
DoAutoScaleOnCharacteristics
Scales the plot automatically under consideration of relay characteristics. Same as button
named Characteristics. The function works for local scales only.
int VisDraw.DoAutoScaleOnCharacteristics()
R ETURNS
DoAutoScaleOnImpedances
Scales the plot automatically under consideration of branch impedances. Same as button
named Impedances. The function works for local scales only.
int VisDraw.DoAutoScaleOnImpedances()
R ETURNS
DoAutoScaleX
Scales the x-axis of the plot automatically. The function works for local x-scales only. If the
x-scale is not local a warning is shown in the output window and 1 is returned by the function.
int VisDraw.DoAutoScaleX()
483
R ETURNS
DoAutoScaleY
Scales the y-axis of the plot automatically. The function works for local y-scales only. If the
int VisDraw.DoAutoScaleY()
R ETURNS
5.6.65 VisHrm
Overview
Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
GetScaleObjX
GetScaleObjY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc
SetDefScaleX
SetDefScaleY
Clear
Removes all curves by clearing table named 'Curves'.
None VisHrm.Clear()
DoAutoScaleX
Scales x-axis automatically.
int VisHrm.DoAutoScaleX()
R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scale is not local
DoAutoScaleY
Scales y-axis automatically.
484
int VisHrm.DoAutoScaleY()
R ETURNS
0 Ok, call to DoAutoScaleY() was successfull
1 Failed, because the y-scale is not local
GetDataSource
Get data source for curve with index
DataObject VisHrm.GetDataSource(int curveIndex)
A RGUMENTS
int curveIndex
Possible values:
<0 invalid
≥0 curve index in table
R ETURNS
GetScaleObjX
Gets the object used for scaling the x-axis.
DataObject VisHrm.GetScaleObjX()
R ETURNS
this object In case that 'Use local Axis' is set to 'Local'.
the virtual instrument panel In case that 'Use local axis' is set to 'Current Page'.
the graphics board In case that 'Use local axis' is set to 'Graphics Board'.
GetScaleObjY
Gets the object used for scaling the y-axis.
DataObject VisHrm.GetScaleObjY()
R ETURNS
this object In case that 'Use local Axis' is enabled.
the plot type In case that 'Use local axis' is disabled.
SetAutoScaleX
Sets Auto Scale setting of the x-scale. The scale is automatic set to local, in case that the
waveform plot is using the scale of the graphics board or the virtual instrument panel.
None VisHrm.SetAutoScaleX(int mode)
485
A RGUMENTS
0 never
1 after simulation
SetAutoScaleY
Sets Auto Scale setting of the y-scale. The scale is automatic set to local, in case that the
waveform plot is using the scale of the plot type.
None VisHrm.SetAutoScaleY(int mode)
A RGUMENTS
0 never
1 after simulation
SetCrvDesc
Sets the user defined description of a curve.
None VisHrm.SetCrvDesc(int curveIndex, str curveDescription)
A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set
SetDefScaleX
Sets the x-scale to be used to the graphics board.
None VisHrm.SetDefScaleX()
SetDefScaleY
Sets the y-scale to be used to the plot type.
None VisHrm.SetDefScaleY()
5.6.66 VisMagndiffplt
486
Overview
AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY
Refresh
AddRelay
None VisMagndiffplt.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])
A RGUMENTS
colour (optional)
style (optional)
width (optional)
AddRelays
None VisMagndiffplt.AddRelays(list relays)
A RGUMENTS
Clear
None VisMagndiffplt.Clear()
DoAutoScaleX
int VisMagndiffplt.DoAutoScaleX()
487
R ETURNS
DoAutoScaleY
int VisMagndiffplt.DoAutoScaleY()
R ETURNS
Refresh
Refreshes the plot by attempting to automatically scale both axes.
None VisMagndiffplt.Refresh()
5.6.67 VisOcplot
Overview
AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY
Refresh
AddRelay
None VisOcplot.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])
A RGUMENTS
colour (optional)
style (optional)
width (optional)
488
AddRelays
None VisOcplot.AddRelays(list relays)
A RGUMENTS
Clear
None VisOcplot.Clear()
DoAutoScaleX
int VisOcplot.DoAutoScaleX()
R ETURNS
DoAutoScaleY
int VisOcplot.DoAutoScaleY()
R ETURNS
Refresh
Refreshes the plot by attempting to automatically scale both axes.
None VisOcplot.Refresh()
489
5.6.68 VisPath
Overview
Clear
DoAutoScaleX
DoAutoScaleY
SetAdaptX
SetAdaptY
SetScaleX
SetScaleY
Clear
Removes all curves by clearing table named 'Variables' on page 'Curves'.
None VisPath.Clear()
DoAutoScaleX
int VisPath.DoAutoScaleX()
R ETURNS
Always 0
DoAutoScaleY
int VisPath.DoAutoScaleY()
R ETURNS
Always 0
SetAdaptX
None VisPath.SetAdaptX(int mode)
A RGUMENTS
0 off
1 on
SetAdaptY
None VisPath.SetAdaptY(int mode)
490
A RGUMENTS
0 off
1 on
SetScaleX
Sets x-axis scale.
None VisPath.SetScaleX(float min,
float max
)
A RGUMENTS
SetScaleY
Sets y-axis scale limits.
None VisPath.SetScaleY(float min,
float max,
[int log]
)
A RGUMENTS

log (optional)
Possible values:
0 linear
1 logarithmic
5.6.69 VisPcompdiffplt
Overview
AddRelay
AddRelays
CentreOrigin
Clear
DoAutoScaleX
DoAutoScaleY
491
AddRelay
None VisPcompdiffplt.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])
A RGUMENTS
colour (optional)
style (optional)
width (optional)
AddRelays
None VisPcompdiffplt.AddRelays(list relays)
A RGUMENTS
CentreOrigin
None VisPcompdiffplt.CentreOrigin()
Clear
None VisPcompdiffplt.Clear()
DoAutoScaleX
int VisPcompdiffplt.DoAutoScaleX()
R ETURNS
492
DoAutoScaleY
int VisPcompdiffplt.DoAutoScaleY()
R ETURNS
5.6.70 VisPlot
Overview
AddResVars
AddVars
Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
GetIntCalcres
GetScaleObjX
GetScaleObjY
SetAdaptX
SetAdaptY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc
SetDefScaleX
SetDefScaleY
SetScaleX
SetScaleY
SetXVar
AddResVars
Appends variables to the plot. Variables which are already in the plot are not added.
None VisPlot.AddResVars(DataObject elmRes,
DataObject element,
str varname
)
A RGUMENTS
elmRes Result object, classname ElmRes.
elememt Element to add.
varname Variable name.
AddVars
493
None VisPlot.AddVars(DataObject element,

str varname
)
A RGUMENTS
elememt Element to add.
varname Variable name.
Clear
Removes all curves from plot.
None VisPlot.Clear()
DoAutoScaleX
int VisPlot.DoAutoScaleX()
R ETURNS
DoAutoScaleY
int VisPlot.DoAutoScaleY()
R ETURNS
GetDataSource
DataObject VisPlot.GetDataSource(int curveIndex)
A RGUMENTS
int curveIndex
Possible values:
<0 invalid
494
R ETURNS
GetIntCalcres
Gets all user Calculated Result objects (IntCalcres) stored inside plot
list VisPlot.GetIntCalcres()
R ETURNS
All Calculated Result objects (IntCalcres) stored inside plot.
GetScaleObjX
DataObject VisPlot.GetScaleObjX()
R ETURNS
GetScaleObjY
Gets the object used for scaling the y-axis.
DataObject VisPlot.GetScaleObjY()
R ETURNS
SetAdaptX
Sets the Adapt Scale option of the local x-scale.
None VisPlot.SetAdaptX(int mode,
[float trigger]
)
A RGUMENTS
0 off
1 on
trigger (optional)
495
SetAdaptY
Sets the Adapt Scale option of the local y-scale.
None VisPlot.SetAdaptY(int mode,
[float offset]
)
A RGUMENTS
0 off
1 on
offset (optional)
Offset value, unused if mode is off or empty
SetAutoScaleX
Sets Auto Scale setting of the x-scale. The scale is automatic set to local, in case that the plot
is using the scale of the graphics board or the virtual instrument panel.
None VisPlot.SetAutoScaleX(int mode)
A RGUMENTS
0 never
1 after simulation
2 during simulation
SetAutoScaleY
Sets Auto Scale setting of the y-scale. The scale is automatic set to local, in case that the plot
is using the scale of the plot type.
None VisPlot.SetAutoScaleY(int mode)
A RGUMENTS
0 never
1 after simulation
2 during simulation
SetCrvDesc
None VisPlot.SetCrvDesc(int curveIndex,
str curveDescription
)
496
A RGUMENTS
curveIndex
curveDescription
Description to set.
SetDefScaleX
None VisPlot.SetDefScaleX()
SetDefScaleY
None VisPlot.SetDefScaleY()
SetScaleX
Sets the local x-axis scale. A function call without arguments sets the Auto Scale setting to On
None VisPlot.SetScaleX()
None VisPlot.SetScaleX(float min,
float max,
[int log]
)
A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.
log (optional)
Possible values:
0 linear
1 logarithmic
SetScaleY
Sets the local y-axis scale. A function call without arguments sets the Auto Scale setting to On
None VisPlot.SetScaleY()
None VisPlot.SetScaleY(float min,
float max,
[int log]
)
497
A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.
log (optional)
Possible values:
0 linear
1 logarithmic
SetXVar
Sets the local x-axis variable. If The default x-axis variable (time) is set if no argument is
passed.
None VisPlot.SetXVar()
None VisPlot.SetXVar(DataObject obj,]
str varname
)
A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj
5.6.71 VisPlot2
Overview
AddResVars
AddVars
Clear
DoAutoScaleX
DoAutoScaleY
DoAutoScaleY2
GetDataSource
GetScaleObjX
GetScaleObjY
SetAdaptX
SetAdaptY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc
SetDefScaleX
SetDefScaleY
SetScaleX
SetScaleY
SetXVar
ShowY2
498
AddResVars
None VisPlot2.AddResVars(DataObject elmRes
DataObject element,
str varname,
[int y2]
)
A RGUMENTS
elmRes Result object, classanme ElmRes
elememt Element to add
varname Variable name
y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis
AddVars
None VisPlot2.AddVars(DataObject element,
str varname,
[int y2]
)
A RGUMENTS
elememt Element to add
varname Variable name
y2 (optional)
Possible values:
2 y2 axis
Clear
Removes variables from plot
None VisPlot2.Clear([int y2])
A RGUMENTS
y2 (optional)
Possible values:
2 y2 axis
499
DoAutoScaleX
int VisPlot2.DoAutoScaleX()
R ETURNS
DoAutoScaleY
Scales y1-axis automatically.
int VisPlot2.DoAutoScaleY()
R ETURNS
DoAutoScaleY2
Scales y2-axis automatically.
int VisPlot2.DoAutoScaleY2()
R ETURNS
GetDataSource
DataObject VisPlot2.GetDataSource(int curveIndex, int yaxis)
A RGUMENTS
int curveIndex
Possible values:
<0 invalid
int yaxis Possible values:
1 y1 axis
2 y2 axis
R ETURNS
500
GetScaleObjX
DataObject VisPlot2.GetScaleObjX()
R ETURNS
GetScaleObjY
Returns used object defining y-scale. The returned object is either the plot itself or the plot type
(IntPlot).
DataObject VisPlot2.GetScaleObjY ([int y2])
R ETURNS
SetAdaptX
Sets the Adapt Scale option of the local x-scale.
None VisPlot2.SetAdaptX(int mode,
[float trigger]
)
A RGUMENTS
0 off
1 on
trigger (optional)
SetAdaptY
Sets the Adapt Scale option of the local y-scale.
None VisPlot2.SetAdaptY(int mode,
[float offset,]
[int y2]
)
A RGUMENTS
0 off
1 on
501
offset (optional)
Offset value, unused if mode is off or empty
y2 (optional)
Possible values:
2 y2 axis
SetAutoScaleX
Sets Auto Scale setting of the x-scale. The scale is automatic set to local, in case that the plot
is using the scale of the graphics board or the virtual instrument panel.
None VisPlot2.SetAutoScaleX(int mode)
A RGUMENTS
0 never
1 after simulation
2 during simulation
SetAutoScaleY
Sets automatic scaling mode of the y-scale. The axis given in the second argument is automat-
ically set to local.
None VisPlot2.SetAutoScaleY (int mode,
[int y2]
)
A RGUMENTS
0 never
1 after simulation
2 during simulation
y2 (optional)
Possible values:
2 y2 axis
SetCrvDesc
None VisPlot2.SetCrvDesc(int curveIndex, str curveDescription)
502
A RGUMENTS
curveIndex
curveDescription
Description to set
SetDefScaleX
None VisPlot2.SetDefScaleX()
SetDefScaleY
None VisPlot2.SetDefScaleY([int y2])
A RGUMENTS
y2 (optional)
Possible values:
2 y2 axis
SetScaleX
Sets the local x-axis scale. A function call without arguments sets the Auto Scale setting to On
None VisPlot.SetScaleX()
None VisPlot.SetScaleX(float min,
float max,
[int log]
)
A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.
log (optional)
Possible values:
0 linear
1 logarithmic
503
SetScaleY
Sets scale of y-axis. Calling the function without any argument sets the Auto Scale option for
the y axis (both share the same setting) to On.
None VisPlot2.SetScaleY()
None VisPlot2.SetScaleY(float min,
float max,
[int log,]
[int Y2]
)
A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.
log (optional)
Possible values:
0 linear
1 logarithmic
y2 (optional)
Possible values:
2 y2 axis
SetXVar
Sets the local x-axis variable. If The default x-axis variable (time) is set if no argument is
passed.
None VisPlot.SetXVar()
None VisPlot.SetXVar(DataObject obj,]
str varname
)
A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj
ShowY2
Enables or disables the y2 axis.
None VisPlot2.ShowY2([int show])
504
A RGUMENTS
show (optional)
Possible values:
0 hide y2 axis
1 show y2 axis (default)
5.6.72 VisPlottz
Overview
AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY
AddRelay
None VisPlottz.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])
A RGUMENTS
colour (optional)
style (optional)
width (optional)
AddRelays
None VisPlottz.AddRelays(list relays)
A RGUMENTS
Clear
None VisPlottz.Clear()
505
DoAutoScaleX
int VisPlottz.DoAutoScaleX()
R ETURNS
DoAutoScaleY
int VisPlottz.DoAutoScaleY()
R ETURNS
5.6.73 VisVec
Overview
CentreOrigin
CentreOrigin
None VisVec.CentreOrigin()
5.6.74 VisVecres
Overview
CentreOrigin
CentreOrigin
None VisVecres.CentreOrigin()
506
5.6.75 VisXyplot
Overview
Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
SetCrvDescX
SetCrvDescY
Clear
Removes all curves from plot.
None VisXyplot.Clear()
DoAutoScaleX
Scales all used x-axes automatically.
int VisXyplot.DoAutoScaleX()
R ETURNS
1 Failed, because the x-scales are not local
DoAutoScaleY
Scales all used y-axes automatically.
int VisXyplot.DoAutoScaleY()
R ETURNS
1 Failed, because the x-scales are not local
GetDataSource
DataObject VisPlot.GetDataSource(int curveIndex)
A RGUMENTS
int curveIndex
Possible values:
<0 invalid
507
R ETURNS
SetCrvDescX
Sets the user defined description of a curve for the x-variable.
None VisXyplot.SetCrvDescX(int curveIndex, str curveDescription)
A RGUMENTS
curveIndex
curveDescription
Description to set
SetCrvDescY
Sets the user defined description of a curve for the y-variable.
None VisXyplot.SetCrvDescY(int curveIndex, str curveDescription)
A RGUMENTS
curveIndex
curveDescription
Description to set
508
Index
version AddObjs
Module Functions, 2 VisBdia, 480
AddPage
Activate SetDesktop, 340
ElmNet, 105 AddProjectToCombined
IntCase, 383 IntPrj, 424
IntLibrary, 410 AddProjectToRemoteDatabase
IntPrj, 424 IntPrj, 424
IntScenario, 439 AddRas
IntScensched, 442 ComSimoutage, 312
IntScheme, 444 AddRatio
IntSscheduler, 445 TypCtcore, 476
IntSstage, 446 AddRef
ActivateProject ComNmink, 290
Application Methods, 5 IntDataset, 397
AdaptWidth SetSelect, 352
SetLevelvis, 347 AddRelay
AddCntcy VisDraw, 482
ComSimoutage, 311 VisMagndiffplt, 487
AddConfiguration VisOcplot, 488
SetDataext, 337 VisPcompdiffplt, 492
AddContingencies VisPlottz, 505
ComSimoutage, 312 AddRelays
AddCopy VisDraw, 482
General Object Methods, 49 VisMagndiffplt, 487
AddCubicle VisOcplot, 489
ElmBoundary, 84 VisPcompdiffplt, 492
AddCurve VisPlottz, 505
PltDataseries, 459 AddResObjs
AddDouble VisBdia, 480
IntAddonvars, 379 AddResVars
AddDoubleMatrix VisPlot, 493
IntAddonvars, 379 VisPlot2, 499
AddDoubleVector AddString
IntAddonvars, 380 IntAddonvars, 382
AddEvent AddToUpdatePages
IntRas, 437 ComProtgraphic, 296
AddInteger AddTrigger
IntAddonvars, 381 IntGate, 405
AddIntegerVector IntRas, 437
IntAddonvars, 381 AddVar
AddObject IntMon, 418
IntAddonvars, 381 AddVariable
AddObjectVector ElmRes, 115
IntAddonvars, 382 AddVars
509
INDEX INDEX
ElmRes, 115 GetActiveStages, 9

IntMon, 418 GetActiveStudyCase, 10
VisPlot, 493 GetAllUsers, 10
VisPlot2, 499 GetAttributeDescription, 10
AddXYCurve GetAttributeUnit, 11
PltDataseries, 460 GetBorderCubicles, 11
Align GetBrowserSelection, 11
SetLevelvis, 347 GetCalcRelevantObjects, 12
All GetClassDescription, 12
IntDataset, 397 GetClassId, 13
SetSelect, 353 GetCurrentDiagram, 13
AllAsm GetCurrentScript, 13
SetSelect, 353 GetCurrentSelection, 13
AllBars GetCurrentUser, 14
SetSelect, 353 GetCurrentZoomScaleLevel, 14
AllBreakers GetDataFolder, 14
SetPath, 350 GetDiagramSelection, 15
SetSelect, 353 GetFlowOrientation, 15
AllClosedBreakers GetFromStudyCase, 15
SetPath, 350 GetGlobalLibrary, 16
SetSelect, 353 GetGraphicsBoard, 16
AllElm GetInterfaceVersion, 16
SetSelect, 354 GetLanguage, 16
AllLines GetLocalLibrary, 17
SetSelect, 354 GetMem, 17
AllLoads GetProjectFolder, 17
SetSelect, 354 GetRecordingStage, 18
AllOpenBreakers GetSettings, 18
SetPath, 350 GetSummaryGrid, 18
SetSelect, 354 GetUserManager, 18
AllProtectionDevices Hide, 19
SetPath, 351 ImportDz, 19
AllSym ImportSnapshot, 19
SetSelect, 354 IsAttributeModeInternal, 20
AllTypLne IsLdfValid, 20
SetSelect, 354 IsRmsValid, 20
AnalyseElmRes IsScenarioAttribute, 20
ComRel3, 300 IsShcValid, 21
AppendCommand IsSimValid, 21
ComTasks, 318 IsWriteCacheEnabled, 21
AppendStudyCase LoadProfile, 21
ComTasks, 318 MarkInGraphics, 22
Application Methods, 4 OutputFlexibleData, 22
ActivateProject, 5 PostCommand, 22
ClearRecycleBin, 6 PrepForUntouchedDelete, 23
CommitTransaction, 6 Rebuild, 23
CreateFaultCase, 6 ReloadProfile, 23
CreateProject, 7 ResetCalculation, 23
DefineTransferAttributes, 7 ResGetData, 23
DeleteUntouchedObjects, 7 ResGetDescription, 24
ExecuteCmd, 8 ResGetFirstValidObject, 24
GetActiveCalculationStr, 8 ResGetFirstValidObjectVariable, 24
GetActiveNetworkVariations, 9 ResGetFirstValidVariable, 24
GetActiveProject, 9 ResGetIndex, 24
GetActiveScenario, 9 ResGetMax, 25
GetActiveScenarioScheduler, 9 ResGetMin, 25
510
INDEX INDEX
ResGetNextValidObject, 25 Encrypt, 362

ResGetNextValidObjectVariable, 25 GetCheckSum, 363
ResGetNextValidVariable, 25 Pack, 363
ResGetObject, 25 PackAsMacro, 363
ResGetUnit, 26 ResetThirdPartyModule, 364
ResGetValueCount, 26 SetThirdPartyModule, 364
ResGetVariable, 26 BlkSig, 364
ResGetVariableCount, 26 GetFromSigName, 364
ResLoadData, 26 GetToSigName, 365
ResReleaseData, 26 BlockSwitch
ResSortToVariable, 26 ComShctrace, 306
SaveAsScenario, 27 BuildNodeNames
SearchObjectByForeignKey, 27 ComUcteexp, 326
SelectToolbox, 27
SetAttributeModeInternal, 28 CalcAggrVarsInRadFeed
SetInterfaceVersion, 28 ElmFeeder, 90
SetShowAllUsers, 28 CalcCluster
SetWriteCacheEnabled, 29 SetCluster, 330
Show, 29 SetDistrstate, 346
SplitLine, 29 CalcContributions
StatFileGetXrange, 30 ComRelpost, 302
StatFileResetXrange, 30 CalcEfficiency
StatFileSetXrange, 30 ElmAsm, 76
WriteChangesToDb, 30 ElmGenstat, 94
Apply ElmPvsys, 107
ElmBmu, 83 ElmSym, 135
IntOutage, 419 ElmXnet, 161
IntScenario, 439 CalcElParams
IntSubset, 449 TypAsmo, 476
ApplyAll CalcMaxHostedPower
IntOutage, 420 ComHostcap, 278
ApplyAndResetRA CalcShiftedReversedBoundary
ElmSubstat, 130 ElmBoundary, 84
ApplyNetworkState CalculateCheckSum
IntCase, 383 BlkDef, 363
ApplySelective CalculateInterchangeTo
IntScenario, 439 ElmArea, 75
IntSubset, 449 ElmNet, 106
ApplyStudyTime ElmZone, 162
IntCase, 384 CanAddProjectToRemoteDatabase
Archive IntPrj, 425
IntPrj, 424 CanSubscribeProjectReadOnly
AreDistParamsPossible IntPrj, 425
ElmLne, 99 CanSubscribeProjectReadWrite
AssumeCompensationFactor IntPrj, 425
RelZpol, 465 CentreOrigin
AssumeReRl VisDraw, 483
RelZpol, 465 VisPcompdiffplt, 492
AssumeXeXl VisVec, 506
RelZpol, 465 VisVecres, 506
ChangeFont
BeginDataExtensionModification SetLevelvis, 347
IntPrj, 425 ChangeFrameAndWidth
BlkDef, 362 SetLevelvis, 347
CalculateCheckSum, 363 ChangeLayer
Compile, 362 SetLevelvis, 347
511
INDEX INDEX
ChangeRefPoints IntDplvec, 402

SetLevelvis, 348 IntSubset, 450
ChangeWidthVisibilityAndColour Output Window Methods, 46
SetLevelvis, 348 SetSelect, 355
ChaVecfile, 365 VisBdia, 481
Update, 365 VisDraw, 483
Check VisHrm, 484
ComAuditlog, 246 VisMagndiffplt, 487
IntOutage, 420 VisOcplot, 489
SetTboxconfig, 355 VisPath, 490
CheckAll VisPcompdiffplt, 492
IntOutage, 420 VisPlot, 494
CheckAssignments VisPlot2, 499
ComMerge, 284 VisPlottz, 505
CheckBbPath VisXyplot, 507
ElmBbone, 81 ClearCont
CheckControllers ComSimoutage, 312
ComLdf, 280 ClearCurves
CheckRanges PltDataseries, 460
ElmRelay, 110 ClearData
CheckSyntax IntGrfgroup, 406
ComDpl, 270 IntGrflayer, 407
CheckUrl ClearInvalidReferences
IntExtaccess, 405 IntPrj, 426
CimModel, 365 ClearOutputWindow
DeleteParameterAtIndex, 366 Output Window Functions, 44
GetAttributeEnumerationType, 366 ClearRecycleBin
GetModelsReferencingThis, 366 Application Methods, 6
GetParameterCount, 366 ClearUpdatePages
GetParameterNamespace, 366 ComProtgraphic, 296
GetParameterValue, 367 ClearVars
HasParameter, 367 IntMon, 418
RemoveParameter, 367 Close
SetAssociationValue, 367, 368 ElmCoup, 87
SetAttributeEnumeration, 368 ElmGndswt, 97
SetAttributeValue, 369 ElmRes, 118
CimObject, 370 IntGrfnet, 408
DeleteParameterAtIndex, 370 SetDeskpage, 339
GetAttributeEnumerationType, 370 SetDesktop, 340
GetObjectsReferencingThis, 370 SetVipage, 358
GetObjectsWithSameId, 371 StaSwitch, 233
GetParameterCount, 371 CloseTableReports
GetParameterNamespace, 371 Dialogue Boxes Functions, 32
GetParameterValue, 371 ColLbl
GetPfObjects, 372 IntMat, 411, 412
HasParameter, 372 ComAddlabel, 234
RemoveParameter, 372 Execute, 234
SetAssociationValue, 372, 373 ComAddon, 235
SetAttributeEnumeration, 373 CreateModule, 235
SetAttributeValue, 374 DefineDouble, 235
Clear DefineDoubleMatrix, 236
ComNmink, 290 DefineDoublePerConnection, 237
ElmBoundary, 85 DefineDoubleVector, 237
ElmRes, 116 DefineDoubleVectorPerConnection, 238
IntDataset, 397 DefineInteger, 238
IntDplmap, 399 DefineIntegerPerConnection, 239
512
INDEX INDEX
DefineIntegerVector, 240 GetNumberOfTimeSteps, 258

DefineIntegerVectorPerConnection, 240 GetObj, 258
DefineObject, 241 GetSwitchEvent, 258
DefineObjectPerConnection, 242 GetTimeOfStepInSeconds, 259
DefineObjectVector, 242 GetTotalInterruptedPower, 259
DefineObjectVectorPerConnection, 243 JumpToLastStep, 259
DefineString, 243 RemoveEvents, 259
DefineStringPerConnection, 244 StartTrace, 260
DeleteModule, 245 StopTrace, 260
FinaliseModule, 245 ComCoordreport, 260
GetActiveModule, 245 DevicesToReport, 261
ModuleExists, 245 HasResultsForDirectionalBackup, 261
SetActiveModule, 246 HasResultsForNonDirectionalBackup, 261
ComAmpacity, 246 HasResultsForOverreach, 261
ExecuteAmpacityCalc, 246 HasResultsForZone, 262
ComAuditlog, 246 MaxZoneNumberFor, 262
Check, 246 ResultForDirectionalBackupVariable, 262
ComBoundary, 247 ResultForNonDirectionalBackupVariable, 263
GetCreatedBoundaries, 247 ResultForOverreachVariable, 264
ComCapo, 247 ResultForZoneVariable, 264
ConnectShuntToBus, 247 TopologyForDirectionalBackupVariable, 265
LossCostAtBusTech, 248 TopologyForNonDirectionalBackupVariable,
TotalLossCost, 248 266
ComCimdbexp, 249 TopologyForOverreachVariable, 266
Execute, 249 TopologyForZoneVariable, 266
ComCimdbimp, 249 TransferDirectionalBackupResultsTo, 267
Execute, 249 TransferNonDirectionalBackupResultsTo, 267
ImportAndConvert, 250 TransferOverreachResultsTo, 268
ComCimvalidate, 250 TransferResultsTo, 269
Execute, 250 TransferZoneResultsTo, 269
GetClassType, 251 ComDllmanager, 270
GetDescriptionText, 251 Report, 270
GetInputObject, 251 ComDpl, 270
GetModel, 251 CheckSyntax, 270
GetModelId, 252 Encrypt, 271
GetNumberOfValidationMessages, 252 Execute, 271
GetObject, 252 GetExternalObject, 272
GetObjectId, 252 GetInputParameterDouble, 272
GetProfile, 253 GetInputParameterInt, 273
GetSeverity, 253 GetInputParameterString, 273
GetType, 253 IsEncrypted, 273
ComConreq, 253 ResetThirdPartyModule, 274
Execute, 254 SetExternalObject, 274
ComContingency, 254 SetInputParameterDouble, 274
ContinueTrace, 254 SetInputParameterInt, 275
CreateRecoveryInformation, 254 SetInputParameterString, 275
GetGeneratorEvent, 255 SetThirdPartyModule, 275
GetInterruptedPowerAndCustomersForStage,
ComFlickermeter, 276
255 Execute, 276
GetInterruptedPowerAndCustomersForTimeStep,
ComGenrelinc, 276
256 GetCurrentIteration, 276
GetLoadEvent, 256 GetMaxNumIterations, 277
GetNumberOfGeneratorEventsForTimeStep,ComGridtocim, 277
257 ConvertAndExport, 277
GetNumberOfLoadEventsForTimeStep, 257 SetAuthorityUri, 277
GetNumberOfSwitchEventsForTimeStep, 257 SetBoundaries, 278
513
INDEX INDEX
SetGridsToExport, 278 ComOmr, 291

ComHostcap, 278 GetFeeders, 291
CalcMaxHostedPower, 278 GetOMR, 291
ComImport, 279 GetRegionCount, 292
GetCreatedObjects, 279 ComOpc, 292
GetModifiedObjects, 279 ReceiveData, 292
ComInc, 279 SendData, 292
ZeroDerivative, 279 ComOutage, 293
ComLdf, 280 ContinueTrace, 293
CheckControllers, 280 ExecuteTime, 293
DoNotResetCalc, 280 GetObject, 293
EstimateOutage, 280 RemoveEvents, 294
Execute, 281 SetObjs, 294
IsAC, 281 StartTrace, 294
IsBalanced, 281 StopTrace, 294
IsDC, 281 Compare
PrintCheckResults, 282 ComMerge, 285
SetOldDistributeLoadMode, 282 CompareActive
ComLink, 282 ComMerge, 285
LoadMicroSCADAFile, 282 ComPfdimport, 295
ReceiveData, 283 GetImportedObjects, 295
SendData, 283 Compile
SentDataStatus, 283 BlkDef, 362
SetOPCReceiveQuality, 283 ComPrjconnector, 295
SetSwitchShcEventMode, 284 GetSuccesfullyConnectedItems, 295
Commands Methods, 234 GetUnsuccesfullyConnectedItems, 295
Execute, 234 ComProtgraphic, 296
ComMerge, 284 AddToUpdatePages, 296
CheckAssignments, 284 ClearUpdatePages, 296
Compare, 285 ComPvcurves, 296
CompareActive, 285 FindCriticalBus, 296
ExecuteRecording, 285 ComPython, 296
ExecuteWithActiveProject, 285 GetExternalObject, 296
GetCorrespondingObject, 285 GetInputParameterDouble, 297
GetModification, 286 GetInputParameterInt, 297
GetModificationResult, 286 GetInputParameterString, 298
GetModifiedObjects, 286 SetExternalObject, 298
Merge, 287 SetInputParameterDouble, 298
PrintComparisonReport, 287 SetInputParameterInt, 299
PrintModifications, 287 SetInputParameterString, 299
Reset, 288 ComRed, 300
SetAutoAssignmentForAll, 288 ReductionInMemory, 300
SetObjectsToCompare, 288 ResetReductionInMemory, 300
ShowBrowser, 288 ComRel3, 300
WereModificationsFound, 289 AnalyseElmRes, 300
CommitTransaction ExeEvt, 301
Application Methods, 6 OvlAlleviate, 301
ComMot, 289 RemoveEvents, 301
GetMotorConnections, 289 RemoveOutages, 301
GetMotorSwitch, 289 ValidateConstraints, 302
GetMotorTerminal, 290 ComRelpost, 302
ComNmink, 290 CalcContributions, 302
AddRef, 290 GetContributionOfComponent, 302
Clear, 290 ComRelreport, 303
GenerateContingenciesForAnalysis, 290 GetContingencies, 303
GetAll, 291 GetContributionOfComponent, 303
514
INDEX INDEX
ComRes, 303 AppendCommand, 318

ExportFullRange, 303 AppendStudyCase, 318
FileNmResNm, 304 GetCommandsForStudyCase, 318
ComShc, 304 GetNumberOfCommandsForStudyCase, 319
ExecuteRXSweep, 304 GetNumberOfStudyCases, 319
GetFaultType, 304 GetStudyCases, 319
GetOverLoadedBranches, 305 IsAdditionalResultsFlagSetForCommand, 320
GetOverLoadedBuses, 305 IsCommandIgnored, 320
ComShctrace, 306 IsStudyCaseIgnored, 321
BlockSwitch, 306 RemoveCmdsForStudyCaseRow, 321
ExecuteAllSteps, 306 RemoveCommand, 321
ExecuteInitialStep, 306 RemoveStudyCase, 322
ExecuteNextStep, 307 RemoveStudyCases, 322
GetBlockedSwitches, 307 SetAdditionalResultsFlagForCommand, 322
GetCurrentTimeStep, 307 SetIgnoreFlagForCommand, 323
GetDeviceSwitches, 307 SetIgnoreFlagForStudyCase, 324
GetDeviceTime, 308 SetResultsFolder, 324
GetNonStartedDevices, 308 ComTececo, 325
GetStartedDevices, 308 UpdateTablesByCalcPeriod, 325
GetSwitchTime, 308 ComTransfer, 325
GetTrippedDevices, 308 GetTransferCalcData, 325
NextStepAvailable, 309 IsLastIterationFeasible, 325
ComSim, 309 ComUcte, 326
GetSimulationTime, 309 SetBatchMode, 326
GetTotalWarnA, 309 ComUcteexp, 326
GetTotalWarnB, 309 BuildNodeNames, 326
GetTotalWarnC, 310 DeleteCompleteQuickAccess, 327
GetViolatedScanModules, 310 ExportAndInitQuickAccess, 327
LoadSimulationState, 310 GetConnectedBranches, 327
LoadSnapshot, 310 GetFromToNodeNames, 327
SaveSimulationState, 310 GetOrderCode, 328
SaveSnapshot, 310 GetUcteNodeName, 328
ComSimoutage, 311 InitQuickAccess, 328
AddCntcy, 311 QuickAccessAvailable, 329
AddContingencies, 312 ResetQuickAccess, 329
AddRas, 312 SetGridSelection, 329
ClearCont, 312 ComWktimp, 329
CreateFaultCase, 312 GetCreatedObjects, 330
Execute, 313 GetModifiedObjects, 330
ExecuteAndCheck, 313 ConnectShuntToBus
GetNTopLoadedElms, 314 ComCapo, 247
MarkRegions, 315 Consolidate
RemoveAllRas, 315 IntCase, 384
RemoveContingencies, 315 IntScheme, 444
RemoveRas, 315 Contains
Reset, 315 IntDplmap, 399
SetLimits, 316 ContainsNonAsciiCharacters
Update, 316 General Object Methods, 50
ComSvgexport, 316 ContinueTrace
SetFileName, 316 ComContingency, 254
SetObject, 316 ComOutage, 293
SetObjects, 317 ConvertAndExport
ComSvgimport, 317 ComGridtocim, 277
SetFileName, 317 ConvertToASCIIFormat
SetObject, 317 IntComtrade, 385
ComTasks, 317 ConvertToBinaryFormat
515
INDEX INDEX
IntComtrade, 386 Date/Time Functions, 32

CopyData GetStudyTimeObject, 32
General Object Methods, 50 Date
CopyDataExtensionFrom SetTime, 356
IntPrj, 426 Deactivate
CopyExtMeaStatusToStatusTmp ElmNet, 106
StaExtbrkmea, 168 IntCase, 385
StaExtcmdmea, 173 IntLibrary, 410
StaExtdatmea, 178 IntPrj, 427
StaExtfmea, 183 IntScenario, 440
StaExtfuelmea, 188 IntScensched, 442
StaExtimea, 193 IntScheme, 444
StaExtpfmea, 198 IntSscheduler, 446
StaExtpmea, 203 DefineBoundary
StaExtqmea, 208 ElmArea, 75
StaExtsmea, 213 ElmNet, 106
StaExttapmea, 218 ElmZone, 163
StaExtv3mea, 223 DefineDouble
StaExtvmea, 228 ComAddon, 235
Create DefineDoubleMatrix
SetPath, 351 ComAddon, 236
CreateCBEvents DefineDoublePerConnection
IntEvt, 404 ComAddon, 237
CreateDerivedProject DefineDoubleVector
IntVersion, 458 ComAddon, 237
CreateEvent DefineDoubleVectorPerConnection
ElmTr2, 144 ComAddon, 238
ElmTr3, 147 DefineInteger
ElmTr4, 151 ComAddon, 238
ElmVoltreg, 159 DefineIntegerPerConnection
StaExtdatmea, 178 ComAddon, 239
CreateFaultCase DefineIntegerVector
Application Methods, 6 ComAddon, 240
ComSimoutage, 312 DefineIntegerVectorPerConnection
CreateFeederWithRoutes ComAddon, 240
ElmLne, 100 DefineObject
CreateFilter ComAddon, 241
SetColscheme, 331 DefineObjectPerConnection
CreateGroup ComAddon, 242
IntUserman, 452 DefineObjectVector
CreateModule ComAddon, 242
ComAddon, 235 DefineObjectVectorPerConnection
CreateObject ComAddon, 243
General Object Methods, 50 DefineString
CreateProject ComAddon, 243
Application Methods, 7 DefineStringPerConnection
CreateRecoveryInformation ComAddon, 244
ComContingency, 254 DefineTransferAttributes
CreateStageObject Application Methods, 7
IntSstage, 447 Delete
CreateUser General Object Methods, 51
IntUserman, 453 DeleteCompleteQuickAccess
CreateVersion ComUcteexp, 327
IntPrj, 426 DeleteModule
CreateVI ComAddon, 245
SetVipage, 359 DeleteParameterAtIndex
516
INDEX INDEX
CimModel, 366 VisMagndiffplt, 488

CimObject, 370 VisOcplot, 489
DeleteRow VisPath, 490
IntScensched, 442 VisPcompdiffplt, 493
DeleteUntouchedObjects VisPlot, 494
Application Methods, 7 VisPlot2, 500
Derate VisPlottz, 506
ElmGenstat, 94 VisXyplot, 507
ElmPvsys, 107 DoNotResetCalc
ElmSym, 135 ComLdf, 280
DevicesToReport
ComCoordreport, 261 EchoOff
Dialogue Boxes Functions, 32 Environment Functions, 35
CloseTableReports, 32 EchoOn
GetTableReports, 32 Environment Functions, 35
ShowModalBrowser, 33 ElmArea, 74
ShowModalSelectBrowser, 33 CalculateInterchangeTo, 75
ShowModelessBrowser, 34 DefineBoundary, 75
UpdateTableReports, 34 GetAll, 75
DiscardChanges GetBranches, 75
IntScenario, 440 GetBuses, 76
Disconnect GetObjs, 76
ElmGenstat, 95 ElmAsm, 76
ElmPvsys, 107 CalcEfficiency, 76
ElmSym, 135 GetAvailableGenPower, 76
ElmXnet, 161 GetElecTorque, 77
DoAutoScale GetGroundingImpedance, 78
GrpPage, 375 GetMechTorque, 78
PltLinebarplot, 461 GetMotorStartingFlag, 78
DoAutoScaleOnAll GetStepupTransformer, 79
VisDraw, 483 IsPQ, 79
DoAutoScaleOnCharacteristics ElmAsmsc, 79
VisDraw, 483 GetAvailableGenPower, 79
DoAutoScaleOnImpedances GetGroundingImpedance, 80
VisDraw, 483 GetStepupTransformer, 80
DoAutoScaleX ElmBbone, 81
GrpPage, 375 CheckBbPath, 81
SetDesktop, 341 GetBbOrder, 81
SetVipage, 358 GetCompleteBbPath, 82
VisDraw, 483 GetFOR, 82
VisHrm, 484 GetMeanCs, 82
VisMagndiffplt, 487 GetMinCs, 82
VisOcplot, 489 GetTieOpenPoint, 83
VisPath, 490 GetTotLength, 83
VisPcompdiffplt, 492 HasGnrlMod, 83
VisPlot, 494 ElmBmu, 83
VisPlot2, 500 Apply, 83
VisPlottz, 506 Update, 84
VisXyplot, 507 ElmBoundary, 84
DoAutoScaleY2 AddCubicle, 84
VisPlot2, 500 CalcShiftedReversedBoundary, 84
DoAutoScaleY Clear, 85
GrpPage, 375 GetInterior, 85
SetVipage, 358 IsSplitting, 85
VisDraw, 484 Resize, 85
VisHrm, 484 Update, 86
517
INDEX INDEX
ElmBranch, 86 GetZ1m, 102

Update, 86 GetZmatDist, 103
ElmCabsys, 86 HasRoutes, 103
FitParams, 86 HasRoutesOrSec, 103
GetLineCable, 86 IsCable, 103
Update, 87 IsNetCoupling, 104
ElmComp, 87 MeasureLength, 104
slotupd, 87 SetDetailed, 104
SlotUpdate, 87 ElmLnesec, 104
ElmCoup, 87 IsCable, 105
Close, 87 ElmNec, 105
GetRemoteBreakers, 88 GetGroundingImpedance, 105
IsBreaker, 88 ElmNet, 105
IsClosed, 89 Activate, 105
IsOpen, 89 CalculateInterchangeTo, 106
Open, 89 Deactivate, 106
ElmDsl, 89 DefineBoundary, 106
ExportToClipboard, 89 ElmPvsys, 107
ExportToFile, 90 CalcEfficiency, 107
ElmFeeder, 90 Derate, 107
CalcAggrVarsInRadFeed, 90 Disconnect, 107
GetAll, 91 GetAvailableGenPower, 108
GetBranches, 91 GetGroundingImpedance, 108
GetBuses, 92 IsConnected, 109
GetNodesBranches, 92 Reconnect, 109
GetObjs, 92 ResetDerating, 109
ElmFile, 93 ElmRelay, 109
LoadFile, 93 CheckRanges, 110
SaveFile, 93 GetCalcRX, 110
ElmFilter, 93 GetMaxFdetectCalcI, 110
GetGroundingImpedance, 93 GetSlot, 111
ElmGenstat, 94 GetUnom, 111
CalcEfficiency, 94 IsStarted, 111
Derate, 94 SetImpedance, 112
Disconnect, 95 SetMaxI, 113
GetAvailableGenPower, 95 SetMaxIearth, 113
GetGroundingImpedance, 95 SetMinI, 113
GetStepupTransformer, 96 SetMinIearth, 113
IsConnected, 96 SetOutOfService, 113
Reconnect, 96 SetTime, 114
ResetDerating, 97 slotupd, 114
ElmGndswt, 97 SlotUpdate, 114
Close, 97 ElmRes, 115
GetGroundingImpedance, 97 AddVariable, 115
IsClosed, 98 AddVars, 115
IsOpen, 98 Clear, 116
Open, 98 Close, 118
ElmLne, 99 FindColumn, 116
AreDistParamsPossible, 99 FindMaxInColumn, 116
CreateFeederWithRoutes, 100 FindMaxOfVariableInRow, 117
FitParams, 100 FindMinInColumn, 117
GetIthr, 100 FindMinOfVariableInRow, 117
GetType, 101 FinishWriting, 118
GetY0m, 101 Flush, 118
GetY1m, 101 GetDescription, 118
GetZ0m, 102 GetFirstValidObject, 119
518
INDEX INDEX
GetFirstValidObjectVariable, 120 IsConnected, 137

GetFirstValidVariable, 120 Reconnect, 137
GetNextValidObject, 120 ResetDerating, 137
GetNextValidObjectVariable, 122 ElmTerm, 138
GetNextValidVariable, 122 GetBusType, 138
GetNumberOfColumns, 122 GetCalcRelevantCubicles, 138
GetNumberOfRows, 122 GetConnectedBrkCubicles, 138
GetObj, 123 GetConnectedCubicles, 139
GetObject, 123 GetConnectedMainBuses, 139
GetObjectValue, 123 GetConnectionInfo, 139
GetRelCase, 124 GetEquivalentTerminals, 140
GetSubElmRes, 124 GetMinDistance, 140
GetUnit, 124 GetNextHVBus, 141
GetValue, 125 GetNodeName, 141
GetVariable, 125 GetSepStationAreas, 141
Init, 125 HasCreatedCalBus, 142
InitialiseWriting, 125 IsElectrEquivalent, 142
Load, 126 IsEquivalent, 143
NCol, 122 IsInternalNodeInStation, 143
NRow, 122 UpdateSubstationTerminals, 143
Release, 126 ElmTr2, 144
SetAsDefault, 126 CreateEvent, 144
SetObj, 126 GetGroundingImpedance, 144
SetSubElmResKey, 127 GetSuppliedElements, 145
SizeX, 122 GetTapPhi, 145
SizeY, 122 GetTapRatio, 146
SortAccordingToColumn, 127 GetZ0pu, 146
Write, 127 GetZpu, 146
WriteDraw, 127 IsQuadBooster, 147
ElmShnt, 128 NTap, 147
GetGroundingImpedance, 128 ElmTr3, 147
ElmStactrl, 128 CreateEvent, 147
GetControlledHVNode, 128 GetGroundingImpedance, 148
GetControlledLVNode, 129 GetSuppliedElements, 148
GetStepupTransformer, 129 GetTapPhi, 149
Info, 129 GetTapRatio, 149
ElmSubstat, 130 GetTapZDependentSide, 149
ApplyAndResetRA, 130 GetZ0pu, 150
GetSplit, 130 GetZpu, 150
GetSplitCal, 131 IsQuadBooster, 151
GetSplitIndex, 132 NTap, 151
GetSuppliedElements, 132 ElmTr4, 151
OverwriteRA, 133 CreateEvent, 151
ResetRA, 133 GetGroundingImpedance, 152
SaveAsRA, 133 GetSuppliedElements, 152
SetRA, 133 GetTapPhi, 153
ElmSvs, 134 GetTapRatio, 153
GetStepupTransformer, 134 GetTapZDependentSide, 154
ElmSym, 134 GetZ0pu, 154
CalcEfficiency, 135 GetZpu, 155
Derate, 135 IsQuadBooster, 155
Disconnect, 135 NTap, 155
GetAvailableGenPower, 135 ElmTrfstat, 156
GetGroundingImpedance, 136 GetSplit, 156
GetMotorStartingFlag, 136 GetSplitCal, 157
GetStepupTransformer, 137 GetSplitIndex, 157
519
INDEX INDEX
GetSuppliedElements, 158 Commands Methods, 234

ElmVac, 158 ComSimoutage, 313
GetGroundingImpedance, 159 ExecuteAllSteps
ElmVoltreg, 159 ComShctrace, 306
CreateEvent, 159 ExecuteAmpacityCalc
GetGroundingImpedance, 159 ComAmpacity, 246
GetZpu, 160 ExecuteAndCheck
NTap, 160 ComSimoutage, 313
ElmXnet, 160 ExecuteCmd
CalcEfficiency, 161 Application Methods, 8
Disconnect, 161 ExecuteInitialStep
GetGroundingImpedance, 161 ComShctrace, 306
GetStepupTransformer, 161 ExecuteNextStep
Reconnect, 162 ComShctrace, 307
ElmZone, 162 ExecuteRecording
CalculateInterchangeTo, 162 ComMerge, 285
DefineBoundary, 163 ExecuteRXSweep
GetAll, 163 ComShc, 304
GetBranches, 163 ExecuteTime
GetBuses, 163 ComOutage, 293
GetObjs, 163 ExecuteWithActiveProject
SetLoadScaleAbsolute, 164 ComMerge, 285
EnableDiffMode ExeEvt
IntSstage, 447 ComRel3, 301
Encrypt Export
BlkDef, 362 IntDocument, 398
ComDpl, 271 IntGrfgroup, 406
TypQdsl, 478 IntGrflayer, 407
EndDataExtensionModification IntIcon, 409
IntPrj, 427 ExportAndInitQuickAccess
Energize ComUcteexp, 327
General Object Methods, 51 ExportFullRange
Environment Functions, 34 ComRes, 303
EchoOff, 35 ExportToClipboard
EchoOn, 35 ElmDsl, 89
IsAutomaticCalculationResetEnabled, 35 ExportToFile
IsFinalEchoOnEnabled, 35 ElmDsl, 90
SetAutomaticCalculationResetEnabled, 35 ExportToVec
SetEnableUserBreak, 37 IntGrflayer, 407
SetFinalEchoOnEnabled, 36
SetGraphicUpdate, 36 File System Functions, 31
SetGuiUpdateEnabled, 36 GetInstallationDirectory, 31
SetProgressBarUpdatesEnabled, 37 GetInstallDir, 31
SetRescheduleFlag, 36 GetTempDir, 31
SetUserBreakEnabled, 37 GetTemporaryDirectory, 31
EstimateOutage GetWorkingDir, 31
ComLdf, 280 GetWorkspaceDirectory, 31
Execute FileNmResNm
ComAddlabel, 234 ComRes, 304
ComCimdbexp, 249 FinaliseModule
ComCimdbimp, 249 ComAddon, 245
ComCimvalidate, 250 FindColumn
ComConreq, 254 ElmRes, 116
ComDpl, 271 IntComtrade, 386
ComFlickermeter, 276 IntComtradeset, 392
ComLdf, 281 FindCriticalBus
520
INDEX INDEX
ComPvcurves, 296 GetSupplyingSubstations, 60

FindMaxInColumn GetSupplyingTransformers, 61
ElmRes, 116 GetSupplyingTrfstations, 61
IntComtrade, 386 GetSystemGrounding, 61
IntComtradeset, 392 GetUnom, 62
FindMaxOfVariableInRow GetZeroImpedance, 62
ElmRes, 117 HasAttribute, 62
FindMinInColumn HasResults, 63
ElmRes, 117 IsCalcRelevant, 63
IntComtrade, 387 IsDeleted, 63
IntComtradeset, 392 IsEarthed, 64
FindMinOfVariableInRow IsEnergized, 64
ElmRes, 117 IsHidden, 64
FinishWriting IsInFeeder, 64
ElmRes, 118 IsNetworkDataFolder, 65
First IsNode, 66
IntDplmap, 399 IsObjectActive, 66
FitParams IsObjectModifiedByVariation, 66
ElmCabsys, 86 Isolate, 67
ElmLne, 100 IsOutOfService, 67
Flush IsReducible, 67
ElmRes, 118 IsShortCircuited, 68
Freeze MarkInGraphics, 68
SetDesktop, 341 Move, 68
PasteCopy, 69
General Object Methods, 48 PurgeUnusedObjects, 69
AddCopy, 49 ReplaceNonAsciiCharacters, 70
ContainsNonAsciiCharacters, 50 ReportNonAsciiCharacters, 70
CopyData, 50 ReportUnusedObjects, 70
CreateObject, 50 SearchObject, 70
Delete, 51 SetAttribute, 71
Energize, 51 SetAttributeLength, 71
GetAttribute, 52 SetAttributes, 71
GetAttributeDescription, 52 SetAttributeShape, 72
GetAttributeLength, 52 ShowEditDialog, 72
GetAttributes, 53 ShowModalSelectTree, 72
GetAttributeShape, 53 SwitchOff, 73
GetAttributeType, 53 SwitchOn, 73
GetAttributeUnit, 54 WriteChangesToDb, 74
GetChildren, 54 GenerateContingenciesForAnalysis
GetClassName, 55 ComNmink, 290
GetCombinedProjectSource, 55 Get
GetConnectedElements, 55 IntDplvec, 402
GetConnectionCount, 56 IntMat, 411
GetContents, 56 IntVec, 454
GetControlledNode, 56 IntVecobj, 456
GetCubicle, 57 SetFilt, 346
GetFullName, 57 GetActiveCalculationStr
GetImpedance, 57 Application Methods, 8
GetInom, 58 GetActiveModule
GetNode, 58 ComAddon, 245
GetOperator, 59 GetActiveNetworkVariations
GetOwner, 59 Application Methods, 9
GetParent, 59 GetActivePage
GetReferences, 60 SetDesktop, 341
GetRegion, 60 GetActiveProject
521
INDEX INDEX
Application Methods, 9 GetAxisX

GetActiveScenario PltLinebarplot, 461
Application Methods, 9 GetAxisY
GetActiveScenarioScheduler PltLinebarplot, 462
Application Methods, 9 GetBbOrder
GetActiveScheduler ElmBbone, 81
IntScheme, 445 GetBlockedSwitches
GetActiveStages ComShctrace, 307
Application Methods, 9 GetBorderCubicles
GetActiveStudyCase Application Methods, 11
Application Methods, 10 GetBranch
GetAll StaCubic, 165
ComNmink, 291 GetBranches
ElmArea, 75 ElmArea, 75
ElmFeeder, 91 ElmFeeder, 91
ElmZone, 163 ElmZone, 163
IntDataset, 397 SetPath, 351
SetPath, 351 GetBrowserSelection
SetSelect, 355 Application Methods, 11
StaCubic, 165 GetBuses
GetAllUsers ElmArea, 76
Application Methods, 10 ElmFeeder, 92
GetAnalogueDescriptions ElmZone, 163
IntComtrade, 387 SetPath, 352
IntComtradeset, 393 GetBusType
GetApplication ElmTerm, 138
Module Functions, 2 GetCalcRelevantCubicles
GetApplicationExt ElmTerm, 138
Module Functions, 3 GetCalcRelevantObjects
GetAttribute Application Methods, 12
General Object Methods, 52 GetCalcRX
GetAttributeDescription ElmRelay, 110
Application Methods, 10 GetCanvasSize
General Object Methods, 52 SetDesktop, 341
GetAttributeEnumerationType GetCheckSum
CimModel, 366 BlkDef, 363
CimObject, 370 GetChildren
GetAttributeLength General Object Methods, 54
General Object Methods, 52 GetClassDescription
GetAttributes Application Methods, 12
General Object Methods, 53 GetClassId
GetAttributeShape Application Methods, 13
General Object Methods, 53 GetClassName
GetAttributeType General Object Methods, 55
General Object Methods, 53 GetClassType
GetAttributeUnit ComCimvalidate, 251
Application Methods, 11 GetColumnLabel
General Object Methods, 54 IntMat, 412
GetAvailableButtons GetColumnLabelIndex
SetTboxconfig, 355 IntMat, 412
GetAvailableGenPower GetCombinedProjectSource
ElmAsm, 76 General Object Methods, 55
ElmAsmsc, 79 GetCommandsForStudyCase
ElmGenstat, 95 ComTasks, 318
ElmPvsys, 108 GetCompleteBbPath
ElmSym, 135 ElmBbone, 82
522
INDEX INDEX
GetConfiguration Application Methods, 13

IntSubset, 450 GetCurrentTimeStep
SetDataext, 338 ComShctrace, 307
GetConfigurations GetCurrentUser
SetDataext, 338 Application Methods, 14
GetConnectedBranches GetCurrentZoomScaleLevel
ComUcteexp, 327 Application Methods, 14
GetConnectedBrkCubicles GetDataFolder
ElmTerm, 138 Application Methods, 14
GetConnectedCubicles GetDataSeries
ElmTerm, 139 PltLinebarplot, 462
GetConnectedElements GetDataSource
General Object Methods, 55 PltDataseries, 460
GetConnectedMainBuses VisHrm, 485
ElmTerm, 139 VisPlot, 494
GetConnectedMajorNodes VisPlot2, 500
StaCubic, 165 VisXyplot, 507
GetConnectionCount GetDerivedProjects
General Object Methods, 56 IntPrj, 428
GetConnectionInfo IntVersion, 458
ElmTerm, 139 GetDescription
GetConnections ElmRes, 118
StaCubic, 166 IntComtrade, 387
GetContent IntComtradeset, 393
Output Window Methods, 46 GetDescriptionText
GetContents ComCimvalidate, 251
General Object Methods, 56 GetDeviceSwitches
GetContingencies ComShctrace, 307
ComRelreport, 303 GetDeviceTime
GetContributionOfComponent ComShctrace, 308
ComRelpost, 302 GetDiagramSelection
ComRelreport, 303 Application Methods, 15
GetControlledHVNode GetDigitalDescriptions
ElmStactrl, 128 IntComtrade, 388
GetControlledLVNode IntComtradeset, 393
ElmStactrl, 129 GetDisplayedButtons
GetControlledNode SetTboxconfig, 356
General Object Methods, 56 GetElecTorque
GetCorrespondingObject ElmAsm, 77
ComMerge, 285 GetEquivalentTerminals
GetCreatedBoundaries ElmTerm, 140
ComBoundary, 247 GetExternalObject
GetCreatedObjects ComDpl, 272
ComImport, 279 ComPython, 296
ComWktimp, 330 GetExternalReferences
GetCriticalTimePhase IntPrj, 428
IntThrating, 450 GetFaultType
GetCubicle ComShc, 304
General Object Methods, 57 GetFeeders
GetCurrentDiagram ComOmr, 291
Application Methods, 13 GetFirstValidObject
GetCurrentIteration ElmRes, 119
ComGenrelinc, 276 GetFirstValidObjectVariable
GetCurrentScript ElmRes, 120
Application Methods, 13 GetFirstValidVariable
GetCurrentSelection ElmRes, 120
523
INDEX INDEX
GetFlowOrientation ComPython, 298

Application Methods, 15 GetInstallationDirectory
GetFOR File System Functions, 31
ElmBbone, 82 GetInstallDir
GetFromSigName File System Functions, 31
BlkSig, 364 GetIntCalcres
GetFromStudyCase PltDataseries, 460
Application Methods, 15 VisPlot, 495
GetFromToNodeNames GetInterfaceVersion
GetFullName GetInterior
General Object Methods, 57 ElmBoundary, 85
GetGeneratorEvent GetInterruptedPowerAndCustomersForStage
ComContingency, 255 ComContingency, 255
GetGeoCoordinateSystem GetInterruptedPowerAndCustomersForTimeStep
IntPrj, 428 ComContingency, 256
GetGlobalLibrary GetIthr
Application Methods, 16 ElmLne, 100
GetGraphicsBoard GetLanguage
Application Methods, 16 Application Methods, 16
GetGroundingImpedance GetLatestVersion
ElmAsm, 78 IntPrj, 429
ElmAsmsc, 80 GetLegend
ElmFilter, 93 PltLinebarplot, 462
ElmGenstat, 95 GetLimit
ElmGndswt, 97 ScnFreq, 466
ElmNec, 105 ScnFrt, 467
ElmPvsys, 108 ScnSpeed, 469
ElmShnt, 128 ScnSync, 471
ElmSym, 136 ScnVar, 472
ElmTr2, 144 ScnVolt, 474
ElmTr3, 148 GetLineCable
ElmTr4, 152 ElmCabsys, 86
ElmVac, 159 GetLoadEvent
ElmVoltreg, 159 ComContingency, 256
ElmXnet, 161 GetLocalLibrary
GetGroups Application Methods, 17
IntUserman, 453 GetMaxFdetectCalcI
GetHistoricalProject ElmRelay, 110
IntVersion, 458 GetMaxNumIterations
GetImpedance ComGenrelinc, 277
General Object Methods, 57 GetMeanCs
GetImportedObjects ElmBbone, 82
ComPfdimport, 295 GetMeaValue
GetInom StaExtbrkmea, 168
General Object Methods, 58 StaExtcmdmea, 173
GetInputObject StaExtdatmea, 178
ComCimvalidate, 251 StaExtfmea, 183
GetInputParameterDouble StaExtfuelmea, 188
ComDpl, 272 StaExtimea, 193
ComPython, 297 StaExtpfmea, 198
GetInputParameterInt StaExtpmea, 203
ComDpl, 273 StaExtqmea, 208
ComPython, 297 StaExttapmea, 218
GetInputParameterString StaExtv3mea, 223
ComDpl, 273 StaExtvmea, 228
524
INDEX INDEX
GetMechTorque GetNumberOfColumns
ElmAsm, 78 ElmRes, 122
GetMem IntComtrade, 388
Application Methods, 17 IntComtradeset, 394
GetMinCs IntMat, 412
ElmBbone, 82 GetNumberOfCommandsForStudyCase
GetMinDistance ComTasks, 319
ElmTerm, 140 GetNumberOfDigitalSignalDescriptions
GetModel IntComtrade, 388
ComCimvalidate, 251 IntComtradeset, 394
GetModelId GetNumberOfGeneratorEventsForTimeStep
ComCimvalidate, 252 ComContingency, 257
GetModelsReferencingThis GetNumberOfLoadEventsForTimeStep
CimModel, 366 ComContingency, 257
GetModification GetNumberOfRows
ComMerge, 286 ElmRes, 122
GetModificationResult IntComtrade, 389
ComMerge, 286 IntComtradeset, 394
GetModifiedObjects IntMat, 413
ComImport, 279 GetNumberOfStudyCases
ComMerge, 286 ComTasks, 319
ComWktimp, 330 GetNumberOfSwitchEventsForTimeStep
GetMotorConnections ComContingency, 257
ComMot, 289 GetNumberOfTimeSteps
GetMotorStartingFlag ComContingency, 258
ElmAsm, 78 GetNumberOfValidationMessages
ElmSym, 136 ComCimvalidate, 252
GetMotorSwitch GetNumberOfViolations
ComMot, 289 ScnFreq, 466
GetMotorTerminal ScnFrt, 468
ComMot, 290 ScnSpeed, 469
GetNearestBusbars ScnSync, 471
StaCubic, 166 ScnVar, 473
GetNextHVBus ScnVolt, 474
ElmTerm, 141 GetNumProcesses
GetNextValidObject SetUser, 358
ElmRes, 120 GetNumSlave
GetNextValidObjectVariable SetParalman, 349
ElmRes, 122 GetObj
GetNextValidVariable ComContingency, 258
ElmRes, 122 ElmRes, 123
GetNode GetObject
General Object Methods, 58 ComCimvalidate, 252
GetNodeName ComOutage, 293
ElmTerm, 141 ElmRes, 123
GetNodesBranches GetObjectId
ElmFeeder, 92 ComCimvalidate, 252
GetNonStartedDevices GetObjects
ComShctrace, 308 IntScenario, 440
GetNTopLoadedElms IntSubset, 450
ComSimoutage, 314 GetObjectsReferencingThis
GetNumberOfAnalogueSignalDescriptions CimObject, 370
IntComtrade, 388 GetObjectsWithSameId
IntComtradeset, 393 CimObject, 371
GetNumberOfClusters GetObjectValue
SetCluster, 331 ElmRes, 123
525
INDEX INDEX
IntComtrade, 389 IntPrjfolder, 435

IntComtradeset, 394 GetQlim
GetObjs IntQlim, 437
ElmArea, 76 GetRandomNumber
ElmFeeder, 92 Mathematical Functions, 38
ElmZone, 163 GetRandomNumberEx
GetOMR Mathematical Functions, 38
ComOmr, 291 GetRating
GetOperationValue IntThrating, 451
IntScenario, 440 GetRecordingStage
GetOperator Application Methods, 18
General Object Methods, 59 GetReferences
GetOrderCode General Object Methods, 60
ComUcteexp, 328 GetRegion
GetOrInsertCurvePlot General Object Methods, 60
GrpPage, 375 GetRegionCount
GetOrInsertDiscreteBarPlot ComOmr, 292
GrpPage, 375 GetRelCase
GetOrInsertPlot ElmRes, 124
SetVipage, 359 GetRemoteBreakers
GetOrInsertXYPlot ElmCoup, 88
GrpPage, 376 GetRowLabel
GetOutputWindow IntMat, 413
Output Window Functions, 44 GetRowLabelIndex
GetOverLoadedBranches IntMat, 413
ComShc, 305 GetScaleObjX
GetOverLoadedBuses VisHrm, 485
ComShc, 305 VisPlot, 495
GetOwner VisPlot2, 501
General Object Methods, 59 GetScaleObjY
GetPage VisHrm, 485
SetDesktop, 341 VisPlot, 495
GetParameterCount VisPlot2, 501
CimModel, 366 GetScenario
CimObject, 371 IntScensched, 443
GetParameterNamespace GetScheme
CimModel, 366 IntSstage, 447
CimObject, 371 GetSepStationAreas
GetParameterValue ElmTerm, 141
CimModel, 367 GetSettings
CimObject, 371 Application Methods, 18
GetParent GetSeverity
General Object Methods, 59 ComCimvalidate, 253
GetPathFolder GetSignalHeader
SetPath, 352 IntComtrade, 389
GetPathToNearestBusbar IntComtradeset, 395
StaCubic, 167 GetSimulationTime
GetPfObjects ComSim, 309
CimObject, 372 GetSlot
GetPlot ElmRelay, 111
GrpPage, 376 GetSplit
GetProfile ElmSubstat, 130
ComCimvalidate, 253 ElmTrfstat, 156
GetProjectFolder GetSplitCal
Application Methods, 17 ElmSubstat, 131
GetProjectFolderType ElmTrfstat, 157
526
INDEX INDEX
GetSplitIndex ElmTr3, 148

ElmSubstat, 132 ElmTr4, 152
ElmTrfstat, 157 ElmTrfstat, 158
GetStartedDevices GetSupplyingSubstations
ComShctrace, 308 General Object Methods, 60
GetStartEndTime GetSupplyingTransformers
IntScensched, 443 General Object Methods, 61
GetStatus GetSupplyingTrfstations
StaExtbrkmea, 168 General Object Methods, 61
StaExtcmdmea, 173 GetSwitchEvent
StaExtdatmea, 179 ComContingency, 258
StaExtfmea, 183 GetSwitchStatus
StaExtfuelmea, 188 IntRunarrange, 438
StaExtimea, 193 GetSwitchTime
StaExtpfmea, 198 ComShctrace, 308
StaExtpmea, 203 GetSystemGrounding
StaExtqmea, 208 General Object Methods, 61
StaExtsmea, 213 GetTableReports
StaExttapmea, 218 Dialogue Boxes Functions, 32
StaExtv3mea, 223 GetTapPhi
StaExtvmea, 228 ElmTr2, 145
GetStatusTmp ElmTr3, 149
StaExtbrkmea, 169 ElmTr4, 153
StaExtcmdmea, 174 GetTapRatio
StaExtdatmea, 179 ElmTr2, 146
StaExtfmea, 184 ElmTr3, 149
StaExtfuelmea, 189 ElmTr4, 153
StaExtimea, 194 GetTapZDependentSide
StaExtpfmea, 199 ElmTr3, 149
StaExtpmea, 204 ElmTr4, 154
StaExtqmea, 209 GetTempDir
StaExtsmea, 213 File System Functions, 31
StaExttapmea, 219 GetTemporaryDirectory
StaExtv3mea, 224 File System Functions, 31
StaExtvmea, 229 GetTieOpenPoint
GetStepupTransformer ElmBbone, 83
ElmAsm, 79 GetTimeOfStepInSeconds
ElmAsmsc, 80 ComContingency, 259
ElmGenstat, 96 GetTitleObject
ElmStactrl, 129 PltLinebarplot, 462
ElmSvs, 134 GetToSigName
ElmSym, 137 BlkSig, 365
ElmXnet, 161 GetTotalInterruptedPower
GetStudyCases ComContingency, 259
ComTasks, 319 GetTotalWarnA
GetStudyTimeObject ComSim, 309
Date/Time Functions, 32 GetTotalWarnB
GetSubElmRes ComSim, 309
ElmRes, 124 GetTotalWarnC
GetSuccesfullyConnectedItems ComSim, 310
ComPrjconnector, 295 GetTotLength
GetSummaryGrid ElmBbone, 83
Application Methods, 18 GetTransferCalcData
GetSuppliedElements ComTransfer, 325
ElmSubstat, 132 GetTrippedDevices
ElmTr2, 145 ComShctrace, 308
527
INDEX INDEX
GetType GetViolationTime
ComCimvalidate, 253 ScnFreq, 467
ElmLne, 101 ScnFrt, 469
GetUcteNodeName ScnSpeed, 470
ComUcteexp, 328 ScnSync, 472
GetUnit ScnVar, 474
ElmRes, 124 ScnVolt, 475
IntComtrade, 389 GetWorkingDir
IntComtradeset, 395 File System Functions, 31
GetUnom GetWorkspaceDirectory
ElmRelay, 111 File System Functions, 31
General Object Methods, 62 GetY0m
GetUnsuccesfullyConnectedItems ElmLne, 101
ComPrjconnector, 295 GetY1m
GetUserManager ElmLne, 101
Application Methods, 18 GetZ0m
GetUsers ElmLne, 102
IntUserman, 453 GetZ0pu
GetValue ElmTr2, 146
ElmRes, 125 ElmTr3, 150
IntComtrade, 390 ElmTr4, 154
IntComtradeset, 395 GetZ1m
IntDplmap, 400 ElmLne, 102
ScnFreq, 466 GetZeroImpedance
ScnFrt, 468 General Object Methods, 62
ScnSpeed, 470 GetZeroSequenceHVLVT
ScnSync, 471 TypTr2, 479
ScnVar, 473 GetZmatDist
ScnVolt, 475 ElmLne, 103
GetVar GetZpu
IntMon, 418 ElmTr2, 146
GetVariable ElmTr3, 150
ElmRes, 125 ElmTr4, 155
IntComtrade, 390 ElmVoltreg, 160
IntComtradeset, 396 GrpPage, 374
ScnFreq, 466 DoAutoScale, 375
ScnFrt, 468 DoAutoScaleX, 375
ScnSpeed, 470 DoAutoScaleY, 375
ScnSync, 471 GetOrInsertCurvePlot, 375
ScnVar, 473 GetOrInsertDiscreteBarPlot, 375
ScnVolt, 475 GetOrInsertXYPlot, 376
GetVariation GetPlot, 376
IntSstage, 447 RemovePage, 376
GetVersions SetAutoScaleModeX, 377
IntPrj, 429 SetAutoScaleModeY, 377
GetVI SetLayoutMode, 377
SetVipage, 359 SetResults, 377
GetViolatedElement SetScaleTypeX, 378
ScnFreq, 467 SetScaleTypeY, 378
ScnFrt, 468 SetScaleX, 378
ScnSpeed, 470 SetScaleY, 378
ScnSync, 472 Show, 379
ScnVar, 473
ScnVolt, 475 HasAttribute
GetViolatedScanModules General Object Methods, 62
ComSim, 310 HasCreatedCalBus
528
INDEX INDEX
ElmTerm, 142 StaExtimea, 194

HasExternalReferences StaExtpfmea, 199
IntPrj, 429 StaExtpmea, 204
HasGnrlMod StaExtqmea, 209
ElmBbone, 83 StaExtsmea, 213
HasParameter StaExttapmea, 219
CimModel, 367 StaExtv3mea, 224
CimObject, 372 StaExtvmea, 229
HasResults Insert
General Object Methods, 63 IntDplmap, 400
HasResultsForDirectionalBackup IntDplvec, 403
ComCoordreport, 261 InsertPlot
HasResultsForNonDirectionalBackup SetVipage, 359
ComCoordreport, 261 IntAddonvars, 379
HasResultsForOverreach AddDouble, 379
ComCoordreport, 261 AddDoubleMatrix, 379
HasResultsForZone AddDoubleVector, 380
ComCoordreport, 262 AddInteger, 381
HasRoutes AddIntegerVector, 381
ElmLne, 103 AddObject, 381
HasRoutesOrSec AddObjectVector, 382
ElmLne, 103 AddString, 382
Hide RemoveParameter, 383
Application Methods, 19 IntCase, 383
Activate, 383
Import ApplyNetworkState, 383
IntDocument, 398 ApplyStudyTime, 384
IntGrfgroup, 406 Consolidate, 384
IntGrflayer, 407 Deactivate, 385
IntIcon, 410 SetStudyTime, 385
ImportAndConvert IntComtrade, 385
ComCimdbimp, 250 ConvertToASCIIFormat, 385
ImportDz ConvertToBinaryFormat, 386
Application Methods, 19 FindColumn, 386
ImportFromVec FindMaxInColumn, 386
IntGrflayer, 408 FindMinInColumn, 387
ImportSnapshot GetAnalogueDescriptions, 387
Application Methods, 19 GetDescription, 387
IndexOf GetDigitalDescriptions, 388
IntDplvec, 402 GetNumberOfAnalogueSignalDescriptions,
Info 388
ElmStactrl, 129 GetNumberOfColumns, 388
Init GetNumberOfDigitalSignalDescriptions, 388
ElmRes, 125 GetNumberOfRows, 389
IntMat, 414 GetObjectValue, 389
IntVec, 454 GetSignalHeader, 389
InitialiseWriting GetUnit, 389
ElmRes, 125 GetValue, 390
InitQuickAccess GetVariable, 390
ComUcteexp, 328 Load, 391
InitTmp NCol, 388
StaExtbrkmea, 169 NRow, 389
StaExtcmdmea, 174 Release, 391
StaExtdatmea, 179 SizeX, 389
StaExtfmea, 184 SizeY, 388
StaExtfuelmea, 189 SortAccordingToColumn, 391
529
INDEX INDEX
IntComtradeset, 391 CheckUrl, 405

FindColumn, 392 IntGate, 405
FindMaxInColumn, 392 AddTrigger, 405
FindMinInColumn, 392 IntGrf, 405
GetAnalogueDescriptions, 393 MoveToLayer, 406
GetDescription, 393 IntGrfgroup, 406
GetDigitalDescriptions, 393 ClearData, 406
GetNumberOfAnalogueSignalDescriptions, Export, 406
393 Import, 406
GetNumberOfColumns, 394 IntGrflayer, 407
GetNumberOfDigitalSignalDescriptions, 394 ClearData, 407
GetNumberOfRows, 394 Export, 407
GetObjectValue, 394 ExportToVec, 407
GetSignalHeader, 395 Import, 407
GetUnit, 395 ImportFromVec, 408
GetValue, 395 IntGrfnet, 408
GetVariable, 396 Close, 408
Load, 396 SetLayerVisibility, 408
NCol, 394 SetSymbolComponentVisibility, 408
NRow, 394 Show, 409
Release, 396 IntIcon, 409
SizeX, 394 Export, 409
SizeY, 394 Import, 410
SortAccordingToColumn, 396 IntLibrary, 410
IntDataset, 397 Activate, 410
AddRef, 397 Deactivate, 410
All, 397 IntMat, 411
Clear, 397 ColLbl, 411, 412
GetAll, 397 Get, 411
IntDocument, 398 GetColumnLabel, 412
Export, 398 GetColumnLabelIndex, 412
Import, 398 GetNumberOfColumns, 412
Reset, 398 GetNumberOfRows, 413
View, 399 GetRowLabel, 413
IntDplmap, 399 GetRowLabelIndex, 413
Clear, 399 Init, 414
Contains, 399 Invert, 414
First, 399 Multiply, 414
GetValue, 400 NCol, 412
Insert, 400 NRow, 413
Next, 401 Resize, 415
Remove, 401 RowLbl, 413, 415
Size, 401 Save, 415
Update, 402 Set, 416
IntDplvec, 402 SetColumnLabel, 416
Clear, 402 SetRowLabel, 416
Get, 402 SizeX, 413
IndexOf, 402 SizeY, 412
Insert, 403 SortToColum, 417
Remove, 403 SortToColumn, 417
Size, 403 IntMon, 417
Sort, 403 AddVar, 418
IntEvt, 404 AddVars, 418
CreateCBEvents, 404 ClearVars, 418
RemoveSwitchEvents, 404 GetVar, 418
IntExtaccess, 405 NVars, 418
530
INDEX INDEX
PrintAllVal, 419 IntQlim, 436

PrintVal, 419 GetQlim, 437
RemoveVar, 419 IntRas, 437
IntOutage, 419 AddEvent, 437
Apply, 419 AddTrigger, 437
ApplyAll, 420 IsValid, 438
Check, 420 IntRunarrange, 438
CheckAll, 420 GetSwitchStatus, 438
IsInStudyTime, 421 IntScenario, 438
IsInStudytime, 421 Activate, 439
ResetAll, 421 Apply, 439
IntPlannedout, 421 ApplySelective, 439
SetRecurrence, 421 Deactivate, 440
IntPlot, 422 DiscardChanges, 440
SetAdaptY, 422 GetObjects, 440
SetAutoScaleY, 422 GetOperationValue, 440
SetScaleY, 423 ReleaseMemory, 441
IntPrj, 423 Save, 441
Activate, 424 SetOperationValue, 441
AddProjectToCombined, 424 IntScensched, 442
AddProjectToRemoteDatabase, 424 Activate, 442
Archive, 424 Deactivate, 442
BeginDataExtensionModification, 425 DeleteRow, 442
CanAddProjectToRemoteDatabase, 425 GetScenario, 443
CanSubscribeProjectReadOnly, 425 GetStartEndTime, 443
CanSubscribeProjectReadWrite, 425 SearchScenario, 443
ClearInvalidReferences, 426 IntScheme, 444
CopyDataExtensionFrom, 426 Activate, 444
CreateVersion, 426 Consolidate, 444
Deactivate, 427 Deactivate, 444
EndDataExtensionModification, 427 GetActiveScheduler, 445
GetDerivedProjects, 428 NewStage, 445
GetExternalReferences, 428 IntSscheduler, 445
GetGeoCoordinateSystem, 428 Activate, 445
GetLatestVersion, 429 Deactivate, 446
GetVersions, 429 Update, 446
HasExternalReferences, 429 IntSstage, 446
LoadData, 430 Activate, 446
MergeToBaseProject, 430 CreateStageObject, 447
Migrate, 430 EnableDiffMode, 447
NormaliseCombined, 431 GetScheme, 447
PackExternalReferences, 431 GetVariation, 447
Purge, 431 IsExcluded, 447
RemoveProjectFromCombined, 431 PrintModifications, 448
Restore, 432 ReadValue, 448
SetGeoCoordinateSystem, 432 WriteValue, 448
SubscribeProjectReadOnly, 432 IntSubset, 449
SubscribeProjectReadWrite, 432 Apply, 449
TransformGeoCoordinates, 432 ApplySelective, 449
UnsubscribeProject, 433 Clear, 450
UpdateStatistics, 433 GetConfiguration, 450
UpdateToDefaultStructure, 433 GetObjects, 450
UpdateToMostRecentBaseVersion, 434 IntThrating, 450
IntPrjfolder, 435 GetCriticalTimePhase, 450
GetProjectFolderType, 435 GetRating, 451
IsProjectFolderType, 436 IntUrl, 451
531
INDEX INDEX
View, 451 TypLne, 477

IntUser, 451 IsCalcRelevant
Purge, 452 General Object Methods, 63
SetPassword, 452 IsClosed
TerminateSession, 452 ElmCoup, 89
IntUserman, 452 ElmGndswt, 98
CreateGroup, 452 StaCubic, 167
CreateUser, 453 StaSwitch, 233
GetGroups, 453 IsCommandIgnored
GetUsers, 453 ComTasks, 320
UpdateGroups, 453 IsConnected
IntVec, 454 ElmGenstat, 96
Get, 454 ElmPvsys, 109
Init, 454 ElmSym, 137
Max, 454 StaCubic, 167
Mean, 454 IsDC
Min, 455 ComLdf, 281
Resize, 455 IsDeleted
Save, 455 General Object Methods, 63
Set, 455 IsEarthed
Size, 456 General Object Methods, 64
Sort, 456 IsElectrEquivalent
IntVecobj, 456 ElmTerm, 142
Get, 456 IsEncrypted
Resize, 456 ComDpl, 273
Save, 457 TypQdsl, 478
Search, 457 IsEnergized
Set, 457 General Object Methods, 64
Size, 457 IsEquivalent
IntVersion, 458 ElmTerm, 143
CreateDerivedProject, 458 IsExcluded
GetDerivedProjects, 458 IntSstage, 447
GetHistoricalProject, 458 IsFinalEchoOnEnabled
Rollback, 458 Environment Functions, 35
IntViewbookmark, 459 IsFrozen
JumpTo, 459 SetDesktop, 342
UpdateFromCurrentView, 459 IsHidden
Invert General Object Methods, 64
IntMat, 414 IsInFeeder
InvertMatrix General Object Methods, 64
Mathematical Functions, 39 IsInStudyTime
IsAC IntOutage, 421
ComLdf, 281 IsInStudytime
IsAdditionalResultsFlagSetForCommand IntOutage, 421
ComTasks, 320 IsInternalNodeInStation
IsAttributeModeInternal ElmTerm, 143
Application Methods, 20 IsLastIterationFeasible
IsAutomaticCalculationResetEnabled ComTransfer, 325
Environment Functions, 35 IsLdfValid
IsBalanced Application Methods, 20
ComLdf, 281 IsNetCoupling
IsBreaker ElmLne, 104
ElmCoup, 88 IsNetworkDataFolder
IsCable General Object Methods, 65
ElmLne, 103 IsNode
ElmLnesec, 105 General Object Methods, 66
532
INDEX INDEX
IsObjectActive StaExtfmea, 184

General Object Methods, 66 StaExtfuelmea, 189
IsObjectModifiedByVariation StaExtimea, 194
General Object Methods, 66 StaExtpfmea, 199
Isolate StaExtpmea, 204
General Object Methods, 67 StaExtqmea, 209
IsOpen StaExtsmea, 214
ElmCoup, 89 StaExttapmea, 219
ElmGndswt, 98 StaExtv3mea, 224
StaSwitch, 233 StaExtvmea, 229
IsOpened IsStudyCaseIgnored
SetDesktop, 342 ComTasks, 321
IsOutOfService IsValid
General Object Methods, 67 IntRas, 438
IsPQ IsWriteCacheEnabled
ElmAsm, 79 Application Methods, 21
IsProjectFolderType
IntPrjfolder, 436 JumpTo
IsQuadBooster IntViewbookmark, 459
ElmTr2, 147 JumpToLastStep
ElmTr3, 151 ComContingency, 259
ElmTr4, 155
Load
IsReducible
ElmRes, 126
General Object Methods, 67
IntComtrade, 391
IsRmsValid
IntComtradeset, 396
Application Methods, 20
LoadData
IsScenarioAttribute
IntPrj, 430
LoadFile
IsShcValid
ElmFile, 93
LoadMicroSCADAFile
IsShortCircuited
ComLink, 282
General Object Methods, 68
LoadProfile
IsSimValid
LoadSimulationState
IsSplitting
ComSim, 310
ElmBoundary, 85
LoadSnapshot
IsStarted
ComSim, 310
ElmRelay, 111
LossCostAtBusTech
IsStatusBitSet
ComCapo, 248
StaExtbrkmea, 169
StaExtcmdmea, 174 Mark
StaExtdatmea, 179 SetLevelvis, 348
StaExtfmea, 184 MarkInGraphics
StaExtfuelmea, 189 Application Methods, 22
StaExtimea, 194 General Object Methods, 68
StaExtpfmea, 199 MarkRegions
StaExtpmea, 204 ComSimoutage, 315
StaExtqmea, 209 Mathematical Functions, 38
StaExtsmea, 214 GetRandomNumber, 38
StaExttapmea, 219 GetRandomNumberEx, 38
StaExtv3mea, 224 InvertMatrix, 39
StaExtvmea, 229 RndExp, 40
IsStatusBitSetTmp RndGetMethod, 40
StaExtbrkmea, 169 RndGetSeed, 41
StaExtcmdmea, 174 RndNormal, 41
StaExtdatmea, 179 RndSetup, 41
533
INDEX INDEX
RndUnifInt, 42 ElmTr3, 151

RndUnifReal, 43 ElmTr4, 155
RndWeibull, 43 ElmVoltreg, 160
SetRandomSeed, 43 NVars
Max IntMon, 418
IntVec, 454
MaxZoneNumberFor Object Methods, 48
ComCoordreport, 262 Open
Mean ElmCoup, 89
IntVec, 454 ElmGndswt, 98
MeasureLength StaSwitch, 234
ElmLne, 104 Other Objects Methods, 362
Merge Output Window Functions, 44
ComMerge, 287 ClearOutputWindow, 44
MergeToBaseProject GetOutputWindow, 44
IntPrj, 430 PrintError, 44
Migrate PrintInfo, 44
IntPrj, 430 PrintPlain, 45
MigratePage PrintWarn, 45
SetVipage, 359 SetOutputWindowState, 45
Min Output Window Methods, 46
IntVec, 455 Clear, 46
Module Functions, 2 GetContent, 46
version , 2 Print, 46
GetApplication, 2 Save, 47
GetApplicationExt, 3 SetState, 47
ModuleExists OutputFlexibleData
ComAddon, 245 Application Methods, 22
Move OverwriteRA
General Object Methods, 68 ElmSubstat, 133
MoveToLayer OvlAlleviate
IntGrf, 406 ComRel3, 301
Multiply
IntMat, 414 Pack
BlkDef, 363
NCol PackAsMacro
ElmRes, 122 BlkDef, 363
IntComtrade, 388 PackExternalReferences
IntComtradeset, 394 IntPrj, 431
IntMat, 412 PasteCopy
Network Elements Methods, 74 General Object Methods, 69
NewStage PltDataseries, 459
IntScheme, 445 AddCurve, 459
Next AddXYCurve, 460
IntDplmap, 401 ClearCurves, 460
NextStepAvailable GetDataSource, 460
ComShctrace, 309 GetIntCalcres, 460
NormaliseCombined PltLinebarplot, 461
IntPrj, 431 DoAutoScale, 461
NRow GetAxisX, 461
ElmRes, 122 GetAxisY, 462
IntComtrade, 389 GetDataSeries, 462
IntComtradeset, 394 GetLegend, 462
IntMat, 413 GetTitleObject, 462
NTap SetAutoScaleModeX, 462
ElmTr2, 147 SetAutoScaleModeY, 463
534
INDEX INDEX
SetAxisSharingLevelX, 463 VisMagndiffplt, 488

SetAxisSharingLevelY, 463 VisOcplot, 489
SetScaleTypeX, 464 Release
SetScaleTypeY, 464 ElmRes, 126
SetScaleX, 464 IntComtrade, 391
SetScaleY, 464 IntComtradeset, 396
PostCommand ReleaseMemory
Application Methods, 22 IntScenario, 441
PrepForUntouchedDelete ReloadProfile
Print RelZpol, 465
Output Window Methods, 46 AssumeCompensationFactor, 465
PrintAllVal AssumeReRl, 465
IntMon, 419 AssumeXeXl, 465
PrintCheckResults Remove
ComLdf, 282 IntDplmap, 401
PrintComparisonReport IntDplvec, 403
ComMerge, 287 RemoveAllConfigurations
PrintError SetDataext, 339
Output Window Functions, 44 RemoveAllRas
PrintInfo ComSimoutage, 315
Output Window Functions, 44 RemoveCmdsForStudyCaseRow
PrintModifications ComTasks, 321
ComMerge, 287 RemoveCommand
IntSstage, 448 ComTasks, 321
PrintPlain RemoveConfiguration
Output Window Functions, 45 SetDataext, 339
PrintVal RemoveContingencies
IntMon, 419 ComSimoutage, 315
PrintWarn RemoveEvents
Output Window Functions, 45 ComContingency, 259
Purge ComOutage, 294
IntPrj, 431 ComRel3, 301
IntUser, 452 RemoveOutages
SetTboxconfig, 356 ComRel3, 301
PurgeUnusedObjects RemovePage
General Object Methods, 69 GrpPage, 376
SetDesktop, 342
QuickAccessAvailable RemoveParameter
ComUcteexp, 329 CimModel, 367
CimObject, 372
ReadValue IntAddonvars, 383
IntSstage, 448 RemoveProjectFromCombined
Rebuild IntPrj, 431
Application Methods, 23 RemoveRas
ReceiveData ComSimoutage, 315
ComLink, 283 RemoveRatio
ComOpc, 292 TypCtcore, 477
Reconnect RemoveRatioByIndex
ElmGenstat, 96 TypCtcore, 477
ElmPvsys, 109 RemoveStudyCase
ElmSym, 137 ComTasks, 322
ElmXnet, 162 RemoveStudyCases
ReductionInMemory ComTasks, 322
ComRed, 300 RemoveSwitchEvents
Refresh IntEvt, 404
535
INDEX INDEX
RemoveVar StaExtvmea, 230

IntMon, 419 ResetThirdPartyModule
ReplaceNonAsciiCharacters BlkDef, 364
General Object Methods, 70 ComDpl, 274
Report TypQdsl, 479
ComDllmanager, 270 ResGetData
ReportNonAsciiCharacters Application Methods, 23
General Object Methods, 70 ResGetDescription
ReportUnusedObjects Application Methods, 24
General Object Methods, 70 ResGetFirstValidObject
Reset Application Methods, 24
ComMerge, 288 ResGetFirstValidObjectVariable
ComSimoutage, 315 Application Methods, 24
IntDocument, 398 ResGetFirstValidVariable
SetLevelvis, 349 Application Methods, 24
ResetAll ResGetIndex
IntOutage, 421 Application Methods, 24
ResetCalculation ResGetMax
ResetDerating ResGetMin
ElmGenstat, 97 Application Methods, 25
ElmPvsys, 109 ResGetNextValidObject
ElmSym, 137 Application Methods, 25
ResetQuickAccess ResGetNextValidObjectVariable
ResetRA ResGetNextValidVariable
ElmSubstat, 133 Application Methods, 25
ResetReductionInMemory ResGetObject
ComRed, 300 Application Methods, 25
ResetStatusBit ResGetUnit
StaExtbrkmea, 169 Application Methods, 26
StaExtcmdmea, 175 ResGetValueCount
StaExtdatmea, 180 Application Methods, 26
StaExtfmea, 185 ResGetVariable
StaExtfuelmea, 190 Application Methods, 26
StaExtimea, 195 ResGetVariableCount
StaExtpfmea, 200 Application Methods, 26
StaExtpmea, 205 Resize
StaExtqmea, 210 ElmBoundary, 85
StaExtsmea, 214 IntMat, 415
StaExttapmea, 219 IntVec, 455
StaExtv3mea, 225 IntVecobj, 456
StaExtvmea, 230 ResLoadData
ResetStatusBitTmp Application Methods, 26
StaExtbrkmea, 170 ResReleaseData
StaExtcmdmea, 175 Application Methods, 26
StaExtdatmea, 180 ResSortToVariable
StaExtfmea, 185 Application Methods, 26
StaExtfuelmea, 190 Restore
StaExtimea, 195 IntPrj, 432
StaExtpfmea, 200 ResultForDirectionalBackupVariable
StaExtpmea, 205 ComCoordreport, 262
StaExtqmea, 210 ResultForNonDirectionalBackupVariable
StaExtsmea, 214 ComCoordreport, 263
StaExttapmea, 220 ResultForOverreachVariable
StaExtv3mea, 225 ComCoordreport, 264
536
INDEX INDEX
ResultForZoneVariable GetValue, 470

ComCoordreport, 264 GetVariable, 470
RndExp GetViolatedElement, 470
Mathematical Functions, 40 GetViolationTime, 470
RndGetMethod ScnSync, 471
Mathematical Functions, 40 GetLimit, 471
RndGetSeed GetNumberOfViolations, 471
Mathematical Functions, 41 GetValue, 471
RndNormal GetVariable, 471
Mathematical Functions, 41 GetViolatedElement, 472
RndSetup GetViolationTime, 472
Mathematical Functions, 41 ScnVar, 472
RndUnifInt GetLimit, 472
Mathematical Functions, 42 GetNumberOfViolations, 473
RndUnifReal GetValue, 473
Mathematical Functions, 43 GetVariable, 473
RndWeibull GetViolatedElement, 473
Mathematical Functions, 43 GetViolationTime, 474
Rollback ScnVolt, 474
IntVersion, 458 GetLimit, 474
RowLbl GetNumberOfViolations, 474
IntMat, 413, 415 GetValue, 475
GetVariable, 475
Save GetViolatedElement, 475
IntMat, 415 GetViolationTime, 475
IntScenario, 441 Search
IntVec, 455 IntVecobj, 457
IntVecobj, 457 SearchObject
Output Window Methods, 47 General Object Methods, 70
SaveAsRA SearchObjectByForeignKey
ElmSubstat, 133 Application Methods, 27
SaveAsScenario SearchScenario
Application Methods, 27 IntScensched, 443
SaveFile SelectToolbox
ElmFile, 93 Application Methods, 27
SaveSimulationState SendData
ComSim, 310 ComLink, 283
SaveSnapshot ComOpc, 292
ComSim, 310 SentDataStatus
ScnFreq, 466 ComLink, 283
GetLimit, 466 Set
GetNumberOfViolations, 466 IntMat, 416
GetValue, 466 IntVec, 455
GetVariable, 466 IntVecobj, 457
GetViolatedElement, 467 SetActiveModule
GetViolationTime, 467 ComAddon, 246
ScnFrt, 467 SetAdaptX
GetLimit, 467 SetDesktop, 343
GetNumberOfViolations, 468 SetVipage, 360
GetValue, 468 VisPath, 490
GetVariable, 468 VisPlot, 495
GetViolatedElement, 468 VisPlot2, 501
GetViolationTime, 469 SetAdaptY
ScnSpeed, 469 IntPlot, 422
GetLimit, 469 VisPath, 490
GetNumberOfViolations, 469 VisPlot, 496
537
INDEX INDEX
VisPlot2, 501 CalcCluster, 330

SetAdditionalResultsFlagForCommand GetNumberOfClusters, 331
ComTasks, 322 SetColouring
SetAsDefault SetColscheme, 332
ElmRes, 126 SetColscheme, 331
SetAssociationValue CreateFilter, 331
CimModel, 367, 368 SetColouring, 332
CimObject, 372, 373 SetFilter, 337
SetAttribute SetColumnLabel
General Object Methods, 71 IntMat, 416
SetAttributeEnumeration SetCrvDesc
CimModel, 368 VisHrm, 486
CimObject, 373 VisPlot, 496
SetAttributeLength VisPlot2, 502
General Object Methods, 71 SetCrvDescX
SetAttributeModeInternal VisXyplot, 508
Application Methods, 28 SetCrvDescY
SetAttributes VisXyplot, 508
General Object Methods, 71 SetDataext, 337
SetAttributeShape AddConfiguration, 337
General Object Methods, 72 GetConfiguration, 338
SetAttributeValue GetConfigurations, 338
CimModel, 369 RemoveAllConfigurations, 339
CimObject, 374 RemoveConfiguration, 339
SetAuthorityUri SetDefScaleX
ComGridtocim, 277 VisHrm, 486
SetAutoAssignmentForAll VisPlot, 497
ComMerge, 288 VisPlot2, 503
SetAutomaticCalculationResetEnabled SetDefScaleY
Environment Functions, 35 VisHrm, 486
SetAutoScaleModeX VisPlot, 497
GrpPage, 377 VisPlot2, 503
PltLinebarplot, 462 SetDeskpage, 339
SetAutoScaleModeY Close, 339
GrpPage, 377 Show, 339
PltLinebarplot, 463 SetDesktop, 340
SetAutoScaleX AddPage, 340
SetDesktop, 343 Close, 340
SetVipage, 360 DoAutoScaleX, 341
VisHrm, 485 Freeze, 341
VisPlot, 496 GetActivePage, 341
VisPlot2, 502 GetCanvasSize, 341
SetAutoScaleY GetPage, 341
IntPlot, 422 IsFrozen, 342
VisHrm, 486 IsOpened, 342
VisPlot, 496 RemovePage, 342
VisPlot2, 502 SetAdaptX, 343
SetAxisSharingLevelX SetAutoScaleX, 343
PltLinebarplot, 463 SetResults, 343
SetAxisSharingLevelY SetScaleX, 344
PltLinebarplot, 463 SetXVar, 344
SetBatchMode Show, 344
ComUcte, 326 Unfreeze, 345
SetBoundaries WriteWMF, 345
ComGridtocim, 278 ZoomAll, 345
SetCluster, 330 SetDetailed
538
INDEX INDEX
ElmLne, 104 ChangeFrameAndWidth, 347

SetDisplayedButtons ChangeLayer, 347
SetTboxconfig, 356 ChangeRefPoints, 348
SetDistrstate, 346 ChangeWidthVisibilityAndColour, 348
CalcCluster, 346 Mark, 348
SetElms Reset, 349
StoMaint, 476 SetLimits
SetEnableUserBreak ComSimoutage, 316
Environment Functions, 37 SetLoadScaleAbsolute
SetExternalObject ElmZone, 164
ComDpl, 274 SetMaxI
ComPython, 298 ElmRelay, 113
SetFileName SetMaxIearth
ComSvgexport, 316 ElmRelay, 113
ComSvgimport, 317 SetMeaValue
SetFilt, 346 StaExtbrkmea, 170
Get, 346 StaExtcmdmea, 175
SetFilter StaExtdatmea, 180
SetColscheme, 337 StaExtfmea, 185
SetFinalEchoOnEnabled StaExtfuelmea, 190
Environment Functions, 36 StaExtimea, 195
SetGeoCoordinateSystem StaExtpfmea, 200
IntPrj, 432 StaExtpmea, 205
SetGraphicUpdate StaExtqmea, 210
Environment Functions, 36 StaExtsmea, 215
SetGridSelection StaExttapmea, 220
ComUcteexp, 329 StaExtv3mea, 225
SetGridsToExport StaExtvmea, 230
ComGridtocim, 278 SetMinI
SetGuiUpdateEnabled ElmRelay, 113
Environment Functions, 36 SetMinIearth
SetIgnoreFlagForCommand ElmRelay, 113
ComTasks, 323 SetNumSlave
SetIgnoreFlagForStudyCase SetParalman, 349
ComTasks, 324 SetObj
SetImpedance ElmRes, 126
ElmRelay, 112 SetObject
SetInputParameterDouble ComSvgexport, 316
ComDpl, 274 ComSvgimport, 317
ComPython, 298 SetObjects
SetInputParameterInt ComSvgexport, 317
ComDpl, 275 SetObjectsToCompare
ComPython, 299 ComMerge, 288
SetInputParameterString SetObjs
ComDpl, 275 ComOutage, 294
ComPython, 299 SetOldDistributeLoadMode
SetInterfaceVersion ComLdf, 282
Application Methods, 28 SetOPCReceiveQuality
SetLayerVisibility ComLink, 283
IntGrfnet, 408 SetOperationValue
SetLayoutMode IntScenario, 441
GrpPage, 377 SetOutOfService
SetLevelvis, 346 ElmRelay, 113
AdaptWidth, 347 SetOutputWindowState
Align, 347 Output Window Functions, 45
ChangeFont, 347 SetParalman, 349
539
INDEX INDEX
GetNumSlave, 349 VisPlot2, 504

SetNumSlave, 349 SetSelect, 352
SetTransfType, 349 AddRef, 352
SetPassword All, 353
IntUser, 452 AllAsm, 353
SetPath, 350 AllBars, 353
AllBreakers, 350 AllBreakers, 353
AllClosedBreakers, 350 AllClosedBreakers, 353
AllOpenBreakers, 350 AllElm, 354
AllProtectionDevices, 351 AllLines, 354
Create, 351 AllLoads, 354
GetAll, 351 AllOpenBreakers, 354
GetBranches, 351 AllSym, 354
GetBuses, 352 AllTypLne, 354
GetPathFolder, 352 Clear, 355
SetPrimaryTap GetAll, 355
StaCt, 164 SetShowAllUsers
SetProgressBarUpdatesEnabled Application Methods, 28
Environment Functions, 37 SetState
SetRA Output Window Methods, 47
ElmSubstat, 133 SetStatus
SetRandomSeed StaExtbrkmea, 170
Mathematical Functions, 43 StaExtcmdmea, 175
SetRecurrence StaExtdatmea, 180
IntPlannedout, 421 StaExtfmea, 185
SetRescheduleFlag StaExtfuelmea, 190
Environment Functions, 36 StaExtimea, 195
SetResults StaExtpfmea, 200
GrpPage, 377 StaExtpmea, 205
SetDesktop, 343 StaExtqmea, 210
SetVipage, 360 StaExtsmea, 215
SetResultsFolder StaExttapmea, 220
ComTasks, 324 StaExtv3mea, 225
SetRowLabel StaExtvmea, 230
IntMat, 416 SetStatusBit
SetScaleTypeX StaExtbrkmea, 171
GrpPage, 378 StaExtcmdmea, 176
PltLinebarplot, 464 StaExtdatmea, 181
SetScaleTypeY StaExtfmea, 186
GrpPage, 378 StaExtfuelmea, 191
PltLinebarplot, 464 StaExtimea, 196
SetScaleX StaExtpfmea, 201
GrpPage, 378 StaExtpmea, 206
PltLinebarplot, 464 StaExtqmea, 211
SetDesktop, 344 StaExtsmea, 216
SetVipage, 360 StaExttapmea, 221
VisPath, 491 StaExtv3mea, 226
VisPlot, 497 StaExtvmea, 231
VisPlot2, 503 SetStatusBitTmp
SetScaleY StaExtbrkmea, 171
GrpPage, 378 StaExtcmdmea, 176
IntPlot, 423 StaExtdatmea, 181
PltLinebarplot, 464 StaExtfmea, 186
VisBdia, 481 StaExtfuelmea, 191
VisPath, 491 StaExtimea, 196
VisPlot, 497 StaExtpfmea, 201
540
INDEX INDEX
StaExtpmea, 206 Environment Functions, 37

StaExtqmea, 211 SetVipage, 358
StaExtsmea, 216 Close, 358
StaExttapmea, 221 CreateVI, 359
StaExtv3mea, 226 DoAutoScaleX, 358
StaExtvmea, 231 DoAutoScaleY, 358
SetStatusTmp GetOrInsertPlot, 359
StaExtbrkmea, 172 GetVI, 359
StaExtcmdmea, 177 InsertPlot, 359
StaExtdatmea, 182 MigratePage, 359
StaExtfmea, 187 SetAdaptX, 360
StaExtfuelmea, 192 SetAutoScaleX, 360
StaExtimea, 197 SetResults, 360
StaExtpfmea, 202 SetScaleX, 360
StaExtpmea, 207 SetStyle, 361
StaExtqmea, 212 SetTile, 361
StaExtsmea, 216 SetXVar, 361
StaExttapmea, 221 Show, 362
StaExtv3mea, 227 SetWriteCacheEnabled
StaExtvmea, 232 Application Methods, 29
SetStudyTime SetXVar
IntCase, 385 SetDesktop, 344
SetStyle SetVipage, 361
SetVipage, 361 VisPlot, 498
SetSubElmResKey VisPlot2, 504
ElmRes, 127 SetXVariable
SetSwitchShcEventMode VisBdia, 481
ComLink, 284 SetYVariable
SetSymbolComponentVisibility VisBdia, 481
IntGrfnet, 408 Show
SetTboxconfig, 355 Application Methods, 29
Check, 355 GrpPage, 379
GetAvailableButtons, 355 IntGrfnet, 409
GetDisplayedButtons, 356 SetDeskpage, 339
Purge, 356 SetDesktop, 344
SetDisplayedButtons, 356 SetVipage, 362
SetThirdPartyModule ShowBrowser
BlkDef, 364 ComMerge, 288
ComDpl, 275 ShowEditDialog
TypQdsl, 479 General Object Methods, 72
SetTile ShowModalBrowser
SetVipage, 361 Dialogue Boxes Functions, 33
SetTime, 356 ShowModalSelectBrowser
Date, 356 Dialogue Boxes Functions, 33
ElmRelay, 114 ShowModalSelectTree
SetTime, 357 General Object Methods, 72
SetTimeUTC, 357 ShowModelessBrowser
Time, 357 Dialogue Boxes Functions, 34
SetTimeUTC ShowY2
SetTime, 357 VisPlot2, 504
Settings Methods, 330 Size
SetTransfType IntDplmap, 401
SetParalman, 349 IntDplvec, 403
SetUser, 357 IntVec, 456
GetNumProcesses, 358 IntVecobj, 457
SetUserBreakEnabled SizeX
541
INDEX INDEX
ElmRes, 122 StaExtcmdmea, 173

IntComtrade, 389 CopyExtMeaStatusToStatusTmp, 173
IntComtradeset, 394 GetMeaValue, 173
IntMat, 413 GetStatus, 173
SizeY GetStatusTmp, 174
ElmRes, 122 InitTmp, 174
IntComtrade, 388 IsStatusBitSet, 174
IntComtradeset, 394 IsStatusBitSetTmp, 174
IntMat, 412 ResetStatusBit, 175
slotupd ResetStatusBitTmp, 175
ElmComp, 87 SetMeaValue, 175
ElmRelay, 114 SetStatus, 175
SlotUpdate SetStatusBit, 176
ElmComp, 87 SetStatusBitTmp, 176
ElmRelay, 114 SetStatusTmp, 177
Sort UpdateControl, 177
IntDplvec, 403 UpdateCtrl, 177
IntVec, 456 StaExtdatmea, 178
SortAccordingToColumn CopyExtMeaStatusToStatusTmp, 178
ElmRes, 127 CreateEvent, 178
IntComtrade, 391 GetMeaValue, 178
IntComtradeset, 396 GetStatus, 179
SortToColum GetStatusTmp, 179
IntMat, 417 InitTmp, 179
SortToColumn IsStatusBitSet, 179
IntMat, 417 IsStatusBitSetTmp, 179
SplitLine ResetStatusBit, 180
Application Methods, 29 ResetStatusBitTmp, 180
StaCt, 164 SetMeaValue, 180
SetPrimaryTap, 164 SetStatus, 180
StaCubic, 164 SetStatusBit, 181
GetAll, 165 SetStatusBitTmp, 181
GetBranch, 165 SetStatusTmp, 182
GetConnectedMajorNodes, 165 UpdateControl, 182
GetConnections, 166 UpdateCtrl, 182
GetNearestBusbars, 166 StaExtfmea, 183
GetPathToNearestBusbar, 167 CopyExtMeaStatusToStatusTmp, 183
IsClosed, 167 GetMeaValue, 183
IsConnected, 167 GetStatus, 183
StaExtbrkmea, 168 GetStatusTmp, 184
CopyExtMeaStatusToStatusTmp, 168 InitTmp, 184
GetMeaValue, 168 IsStatusBitSet, 184
GetStatus, 168 IsStatusBitSetTmp, 184
GetStatusTmp, 169 ResetStatusBit, 185
InitTmp, 169 ResetStatusBitTmp, 185
IsStatusBitSet, 169 SetMeaValue, 185
IsStatusBitSetTmp, 169 SetStatus, 185
ResetStatusBit, 169 SetStatusBit, 186
ResetStatusBitTmp, 170 SetStatusBitTmp, 186
SetMeaValue, 170 SetStatusTmp, 187
SetStatus, 170 UpdateControl, 187
SetStatusBit, 171 UpdateCtrl, 187
SetStatusBitTmp, 171 StaExtfuelmea, 188
SetStatusTmp, 172 CopyExtMeaStatusToStatusTmp, 188
UpdateControl, 172 GetMeaValue, 188
UpdateCtrl, 172 GetStatus, 188
542
INDEX INDEX
GetStatusTmp, 189 ResetStatusBitTmp, 205

InitTmp, 189 SetMeaValue, 205
IsStatusBitSet, 189 SetStatus, 205
IsStatusBitSetTmp, 189 SetStatusBit, 206
ResetStatusBit, 190 SetStatusBitTmp, 206
ResetStatusBitTmp, 190 SetStatusTmp, 207
SetMeaValue, 190 UpdateControl, 207
SetStatus, 190 UpdateCtrl, 207
SetStatusBit, 191 StaExtqmea, 208
SetStatusBitTmp, 191 CopyExtMeaStatusToStatusTmp, 208
SetStatusTmp, 192 GetMeaValue, 208
UpdateControl, 192 GetStatus, 208
UpdateCtrl, 192 GetStatusTmp, 209
StaExtimea, 193 InitTmp, 209
CopyExtMeaStatusToStatusTmp, 193 IsStatusBitSet, 209
GetMeaValue, 193 IsStatusBitSetTmp, 209
GetStatus, 193 ResetStatusBit, 210
GetStatusTmp, 194 ResetStatusBitTmp, 210
InitTmp, 194 SetMeaValue, 210
IsStatusBitSet, 194 SetStatus, 210
IsStatusBitSetTmp, 194 SetStatusBit, 211
ResetStatusBit, 195 SetStatusBitTmp, 211
ResetStatusBitTmp, 195 SetStatusTmp, 212
SetMeaValue, 195 UpdateControl, 212
SetStatus, 195 UpdateCtrl, 212
SetStatusBit, 196 StaExtsmea, 213
SetStatusBitTmp, 196 CopyExtMeaStatusToStatusTmp, 213
SetStatusTmp, 197 GetStatus, 213
UpdateControl, 197 GetStatusTmp, 213
UpdateCtrl, 197 InitTmp, 213
StaExtpfmea, 198 IsStatusBitSet, 214
CopyExtMeaStatusToStatusTmp, 198 IsStatusBitSetTmp, 214
GetMeaValue, 198 ResetStatusBit, 214
GetStatus, 198 ResetStatusBitTmp, 214
GetStatusTmp, 199 SetMeaValue, 215
InitTmp, 199 SetStatus, 215
IsStatusBitSet, 199 SetStatusBit, 216
IsStatusBitSetTmp, 199 SetStatusBitTmp, 216
ResetStatusBit, 200 SetStatusTmp, 216
ResetStatusBitTmp, 200 UpdateControl, 217
SetMeaValue, 200 UpdateCtrl, 217
SetStatus, 200 StaExttapmea, 217
SetStatusBit, 201 CopyExtMeaStatusToStatusTmp, 218
SetStatusBitTmp, 201 GetMeaValue, 218
SetStatusTmp, 202 GetStatus, 218
UpdateControl, 202 GetStatusTmp, 219
UpdateCtrl, 202 InitTmp, 219
StaExtpmea, 203 IsStatusBitSet, 219
CopyExtMeaStatusToStatusTmp, 203 IsStatusBitSetTmp, 219
GetMeaValue, 203 ResetStatusBit, 219
GetStatus, 203 ResetStatusBitTmp, 220
GetStatusTmp, 204 SetMeaValue, 220
InitTmp, 204 SetStatus, 220
IsStatusBitSet, 204 SetStatusBit, 221
IsStatusBitSetTmp, 204 SetStatusBitTmp, 221
ResetStatusBit, 205 SetStatusTmp, 221
543
INDEX INDEX
UpdateControl, 222 SubscribeProjectReadOnly

UpdateCtrl, 222 IntPrj, 432
StaExtv3mea, 223 SubscribeProjectReadWrite
CopyExtMeaStatusToStatusTmp, 223 IntPrj, 432
GetMeaValue, 223 SwitchOff
GetStatus, 223 General Object Methods, 73
GetStatusTmp, 224 SwitchOn
InitTmp, 224 General Object Methods, 73
IsStatusBitSet, 224
IsStatusBitSetTmp, 224 TerminateSession
ResetStatusBit, 225 IntUser, 452
ResetStatusBitTmp, 225 Time
SetMeaValue, 225 SetTime, 357
SetStatus, 225 TopologyForDirectionalBackupVariable
SetStatusBit, 226 ComCoordreport, 265
SetStatusBitTmp, 226 TopologyForNonDirectionalBackupVariable
SetStatusTmp, 227 ComCoordreport, 266
UpdateControl, 227 TopologyForOverreachVariable
UpdateCtrl, 227 ComCoordreport, 266
StaExtvmea, 228 TopologyForZoneVariable
CopyExtMeaStatusToStatusTmp, 228 ComCoordreport, 266
GetMeaValue, 228 TotalLossCost
GetStatus, 228 ComCapo, 248
GetStatusTmp, 229 TransferDirectionalBackupResultsTo
InitTmp, 229 ComCoordreport, 267
IsStatusBitSet, 229 TransferNonDirectionalBackupResultsTo
IsStatusBitSetTmp, 229 ComCoordreport, 267
ResetStatusBit, 230 TransferOverreachResultsTo
ResetStatusBitTmp, 230 ComCoordreport, 268
SetMeaValue, 230 TransferResultsTo
SetStatus, 230 ComCoordreport, 269
SetStatusBit, 231 TransferZoneResultsTo
SetStatusBitTmp, 231 ComCoordreport, 269
SetStatusTmp, 232 TransformGeoCoordinates
UpdateControl, 232 IntPrj, 432
UpdateCtrl, 232 TypAsmo, 476
StartTrace CalcElParams, 476
ComContingency, 260 TypCtcore, 476
ComOutage, 294 AddRatio, 476
StaSwitch, 233 RemoveRatio, 477
Close, 233 RemoveRatioByIndex, 477
IsClosed, 233 TypLne, 477
IsOpen, 233 IsCable, 477
Open, 234 TypQdsl, 478
StatFileGetXrange Encrypt, 478
Application Methods, 30 IsEncrypted, 478
StatFileResetXrange ResetThirdPartyModule, 479
Application Methods, 30 SetThirdPartyModule, 479
StatFileSetXrange TypTr2, 479
Application Methods, 30 GetZeroSequenceHVLVT, 479
Station Elements Methods, 164
StoMaint, 476 Unfreeze
SetElms, 476 SetDesktop, 345
StopTrace UnsubscribeProject
ComContingency, 260 IntPrj, 433
ComOutage, 294 Update
544
INDEX INDEX
ChaVecfile, 365 IntDocument, 399

ComSimoutage, 316 IntUrl, 451
ElmBmu, 84 VisBdia, 480
ElmBoundary, 86 AddObjs, 480
ElmBranch, 86 AddResObjs, 480
ElmCabsys, 87 Clear, 481
IntDplmap, 402 SetScaleY, 481
IntSscheduler, 446 SetXVariable, 481
UpdateControl SetYVariable, 481
StaExtbrkmea, 172 VisDraw, 482
StaExtcmdmea, 177 AddRelay, 482
StaExtdatmea, 182 AddRelays, 482
StaExtfmea, 187 CentreOrigin, 483
StaExtfuelmea, 192 Clear, 483
StaExtimea, 197 DoAutoScaleOnAll, 483
StaExtpfmea, 202 DoAutoScaleOnCharacteristics, 483
StaExtpmea, 207 DoAutoScaleOnImpedances, 483
StaExtqmea, 212 DoAutoScaleX, 483
StaExtsmea, 217 DoAutoScaleY, 484
StaExttapmea, 222 VisHrm, 484
StaExtv3mea, 227 Clear, 484
StaExtvmea, 232 DoAutoScaleX, 484
UpdateCtrl DoAutoScaleY, 484
StaExtbrkmea, 172 GetDataSource, 485
StaExtcmdmea, 177 GetScaleObjX, 485
StaExtdatmea, 182 GetScaleObjY, 485
StaExtfmea, 187 SetAutoScaleX, 485
StaExtfuelmea, 192 SetAutoScaleY, 486
StaExtimea, 197 SetCrvDesc, 486
StaExtpfmea, 202 SetDefScaleX, 486
StaExtpmea, 207 SetDefScaleY, 486
StaExtqmea, 212 VisMagndiffplt, 486
StaExtsmea, 217 AddRelay, 487
StaExttapmea, 222 AddRelays, 487
StaExtv3mea, 227 Clear, 487
StaExtvmea, 232 DoAutoScaleX, 487
UpdateFromCurrentView DoAutoScaleY, 488
IntViewbookmark, 459 Refresh, 488
UpdateGroups VisOcplot, 488
IntUserman, 453 AddRelay, 488
UpdateStatistics AddRelays, 489
IntPrj, 433 Clear, 489
UpdateSubstationTerminals DoAutoScaleX, 489
ElmTerm, 143 DoAutoScaleY, 489
UpdateTableReports Refresh, 489
Dialogue Boxes Functions, 34 VisPath, 490
UpdateTablesByCalcPeriod Clear, 490
ComTececo, 325 DoAutoScaleX, 490
UpdateToDefaultStructure DoAutoScaleY, 490
IntPrj, 433 SetAdaptX, 490
UpdateToMostRecentBaseVersion SetAdaptY, 490
IntPrj, 434 SetScaleX, 491
SetScaleY, 491
ValidateConstraints VisPcompdiffplt, 491
ComRel3, 302 AddRelay, 492
View AddRelays, 492
545
INDEX INDEX
CentreOrigin, 492 Clear, 507

Clear, 492 DoAutoScaleX, 507
DoAutoScaleX, 492 DoAutoScaleY, 507
DoAutoScaleY, 493 GetDataSource, 507
VisPlot2, 498 SetCrvDescX, 508
AddResVars, 499 SetCrvDescY, 508
AddVars, 499
Clear, 499 WereModificationsFound
DoAutoScaleX, 500 ComMerge, 289
DoAutoScaleY, 500 Write
DoAutoScaleY2, 500 ElmRes, 127
GetDataSource, 500 WriteChangesToDb
GetScaleObjX, 501 Application Methods, 30
GetScaleObjY, 501 General Object Methods, 74
SetAdaptX, 501 WriteDraw
SetAdaptY, 501 ElmRes, 127
SetAutoScaleX, 502 WriteValue
SetAutoScaleY, 502 IntSstage, 448
SetCrvDesc, 502 WriteWMF
SetDefScaleX, 503 SetDesktop, 345
SetDefScaleY, 503
SetScaleX, 503 ZeroDerivative
SetScaleY, 504 ComInc, 279
SetXVar, 504 ZoomAll
ShowY2, 504 SetDesktop, 345
VisPlot, 493
AddResVars, 493
AddVars, 493
Clear, 494
DoAutoScaleX, 494
DoAutoScaleY, 494
GetDataSource, 494
GetIntCalcres, 495
GetScaleObjX, 495
GetScaleObjY, 495
SetAdaptX, 495
SetAdaptY, 496
SetAutoScaleX, 496
SetAutoScaleY, 496
SetCrvDesc, 496
SetDefScaleX, 497
SetDefScaleY, 497
SetScaleX, 497
SetScaleY, 497
SetXVar, 498
VisPlottz, 505
AddRelay, 505
AddRelays, 505
Clear, 505
DoAutoScaleX, 506
DoAutoScaleY, 506
VisVec, 506
CentreOrigin, 506
VisVecres, 506
CentreOrigin, 506
VisXyplot, 507
546

PythonReference en

Uploaded by

PythonReference en

Uploaded by

PowerFactory 2021

Python Function Reference

POWER SYSTEM SOLUTIONS

Please visit our homepage at:

Copyright © 2021 DIgSILENT GmbH

5.4.1 ComAddlabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

5.4.41 ComSim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

5.6.14 IntDplvec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

5.6.54 ScnSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

0 Single fault case containing all elements.

• and points to an element that sits outside the station

list Application.GetBorderCubicles(DataObject element)

0 Class name invalid.

A value of -1 is returned in case of no open diagram.

0 (default) Do not create switch on first connection side.

0 (default) Do not create switch on second connection side.

max (out) Last point in time considered in statistics.

3.1 File System

3.3 Dialogue Boxes

Closes all open table reports.

Returns all open table reports.

Opens a modal browser window and lists all given objects.

Opens a modeless browser window and lists all given objects.

Updates all open table reports.

Application.EchoOn(), Application.IsFinalEchoOnEnabled(), Application.SetFinalEchoOnEnabled()

Application.EchoOff(), Application.IsFinalEchoOnEnabled(), Application.SetFinalEchoOnEnabled()

Application.SetFinalEchoOnEnabled(), Application.EchoOn(), Application.EchoOff()

None Application.SetFinalEchoOnEnabled(int enabled);

Application.IsFinalEchoOnEnabled(), Application.EchoOn(), Application.EchoOff()

int Application.SetGuiUpdateEnabled(int enabled)

0 GUI updates were disabled before.

0 Progress bar updates were disabled before.

C(i,j) = A(i,j) + j · imaginaryP art(i,j).

int Application.InvertMatrix(DataObject realPart,

0 (default) ’Global random number generator’.

1. Whether to seed automatically or not.

2. The seed, if not automatically seeded.

Supported types of random number generators:

3. Additive Lagged Fibonacci.

0 Mersenne Twister (recommended) (default).

0 (default) ’Global random number generator’.

3.6 Output Window

OutputWindow.MessageType.Plain Normal text.

5.1 General Methods

DataObject.PasteCopy(), DataObject.Move(), Application.Delete()

0 Action was successful.

DataObject.SwitchOn(), DataObject.SwitchOff(), DataObject.Isolate()

short 0 Return long attribute description (default).

DataObject.GetAttributeShape(), DataObject.SetAttributeLength(), DataObject.GetAttributeType()

DataObject.GetAttributeLength(), DataObject.SetAttributeShape(), DataObject.GetAttributeType()

AttributeType DataObject.GetAttributeType(str name)

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(),

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(),

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(),

0 Return the HV-MV impedance.

-1(default) Checks if “c:” quantities exist

• deleted in currently active variation or

IntArea stores ElmArea objects

IntCircuit stores ElmCircuit objects

IntOwner stores ElmOwner objects

IntScales stores Tri* objects

0 Action was successful

DataObject.SwitchOn(), DataObject.SwitchOff(), DataObject.Energize()

DataObject.AddCopy(), DataObject.PasteCopy(), Application.Delete()

DataObject.AddCopy(), DataObject.Move(), Application.Delete()

length New length of the attribute.

DataObject.SetAttributeShape(), DataObject.GetAttributeLength(), DataObject.GetAttributeType()

DataObject.SetAttributeLength(), DataObject.GetAttributeShape(), DataObject.GetAttributeType()

0 Action was successful

DataObject.SwitchOn(), DataObject.Isolate(), DataObject.Energize()

0 Action was successful

DataObject.SwitchOff(), DataObject.Isolate(), DataObject.Energize()

5.2 Network Elements

• No Wind Model: No available power.

For motors, the available power is zero.

-1 in the process of being calculated