PowerFactory 2025

Python Function Reference

F2025

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
[email protected]

Please visit our homepage at:

https://www.digsilent.de

Copyright DIgSILENT GmbH

All rights reserved. No part of this
publication may be reproduced or
distributed in any form without written
permission of DIgSILENT GmbH.

March 12, 2025

r120749
CONTENTS CONTENTS

Contents

1 General Description 1

2 PowerFactory Module 2

3 Application Methods 4
3.1 File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3.2 Date/Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.3 Dialogue Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.4 Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.5 Mathematics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
3.6 Output Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4 Output Window 62

5 Object Methods 64
5.1 General Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
5.2 Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
5.2.1 ElmArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
5.2.2 ElmAsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
5.2.3 ElmAsmsc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
5.2.4 ElmBbone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
5.2.5 ElmBmu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
5.2.6 ElmBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
5.2.7 ElmBranch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
5.2.8 ElmCabsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
5.2.9 ElmComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.2.10 ElmCoup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.2.11 ElmDcu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.2.12 ElmDsl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.2.13 ElmFeeder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
5.2.14 ElmFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
5.2.15 ElmFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

2
CONTENTS CONTENTS

5.2.16 ElmGenstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

5.2.17 ElmGndswt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
5.2.18 ElmLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
5.2.19 ElmLnesec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
5.2.20 ElmMdl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
5.2.21 ElmNec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
5.2.22 ElmNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
5.2.23 ElmPvsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
5.2.24 ElmRecmono . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
5.2.25 ElmRelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
5.2.26 ElmRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
5.2.27 ElmShnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
5.2.28 ElmStactrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
5.2.29 ElmSubstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
5.2.30 ElmSvs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
5.2.31 ElmSym . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
5.2.32 ElmTerm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
5.2.33 ElmTow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
5.2.34 ElmTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
5.2.35 ElmTr3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
5.2.36 ElmTr4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
5.2.37 ElmTrain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
5.2.38 ElmTrb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
5.2.39 ElmTrfstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
5.2.40 ElmTrmult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
5.2.41 ElmVac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
5.2.42 ElmVoltreg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
5.2.43 ElmVscmono . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
5.2.44 ElmXnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
5.2.45 ElmZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
5.3 Station Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
5.3.1 StaCt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
5.3.2 StaCubic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
5.3.3 StaExtbrkmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
5.3.4 StaExtcmdmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.3.5 StaExtdatmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
5.3.6 StaExtfmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
5.3.7 StaExtfuelmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
5.3.8 StaExtimea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
5.3.9 StaExtpfmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

3
CONTENTS CONTENTS

5.3.10 StaExtpmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

5.3.11 StaExtqmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
5.3.12 StaExtsmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
5.3.13 StaExttapmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
5.3.14 StaExtv3mea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
5.3.15 StaExtvmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
5.3.16 StaSwitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
5.4 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
5.4.1 ComAddlabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
5.4.2 ComAddon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.4.3 ComAmpacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
5.4.4 ComArcreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
5.4.5 ComAuditlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
5.4.6 ComBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5.4.7 ComCapo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5.4.8 ComCimdbexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
5.4.9 ComCimdbimp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
5.4.10 ComCimtogrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
5.4.11 ComCimvalidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
5.4.12 ComConreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
5.4.13 ComContingency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.4.14 ComCoordreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
5.4.15 ComCosim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
5.4.16 ComDllmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
5.4.17 ComDpl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
5.4.18 ComFlickermeter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
5.4.19 ComGenrelinc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
5.4.20 ComGridtocim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
5.4.21 ComHostcap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
5.4.22 ComImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
5.4.23 ComInc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
5.4.24 ComLdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
5.4.25 ComLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
5.4.26 ComMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
5.4.27 ComMot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
5.4.28 ComNmink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.4.29 ComOmr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
5.4.30 ComOpc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
5.4.31 ComOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.4.32 ComPfdimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

4
CONTENTS CONTENTS

5.4.33 ComPrjconnector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

5.4.34 ComProtgraphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
5.4.35 ComPvcurves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
5.4.36 ComPython . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
5.4.37 ComRed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
5.4.38 ComRel3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
5.4.39 ComRelpost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
5.4.40 ComRelreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
5.4.41 ComReltabreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
5.4.42 ComReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
5.4.43 ComRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
5.4.44 ComShc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
5.4.45 ComShctrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
5.4.46 ComSim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
5.4.47 ComSimoutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
5.4.48 ComStationware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
5.4.49 ComSvgexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
5.4.50 ComSvgimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
5.4.51 ComTablereport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
5.4.52 ComTasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
5.4.53 ComTececo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
5.4.54 ComTececocmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
5.4.55 ComTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
5.4.56 ComUcte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
5.4.57 ComUcteexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
5.4.58 ComWr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
5.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
5.5.1 SetCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
5.5.2 SetColscheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
5.5.3 SetDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
5.5.4 SetDataext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
5.5.5 SetDeskpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
5.5.6 SetDesktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
5.5.7 SetDistrstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
5.5.8 SetFilt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
5.5.9 SetLevelvis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
5.5.10 SetLvscale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
5.5.11 SetParalman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
5.5.12 SetPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
5.5.13 SetPrj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

5
CONTENTS CONTENTS

5.5.14 SetScenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

5.5.15 SetSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
5.5.16 SetTabgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
5.5.17 SetTboxconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
5.5.18 SetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
5.5.19 SetUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
5.5.20 SetVipage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
5.6 Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
5.6.1 BlkDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
5.6.2 BlkSig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
5.6.3 ChaVecfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
5.6.4 CimArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
5.6.5 CimModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
5.6.6 CimObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
5.6.7 GrpPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
5.6.8 IntAddonvars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
5.6.9 IntCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
5.6.10 IntComtrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
5.6.11 IntComtradeset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
5.6.12 IntDataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
5.6.13 IntDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
5.6.14 IntDplmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
5.6.15 IntDplvec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
5.6.16 IntEvt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
5.6.17 IntExtaccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
5.6.18 IntGate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
5.6.19 IntGrf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
5.6.20 IntGrfgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
5.6.21 IntGrflayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
5.6.22 IntGrfnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
5.6.23 IntIcon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
5.6.24 IntLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
5.6.25 IntMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
5.6.26 IntMon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
5.6.27 IntNndata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
5.6.28 IntNnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
5.6.29 IntOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
5.6.30 IntPlannedout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
5.6.31 IntPrj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
5.6.32 IntPrjfolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531

6
CONTENTS CONTENTS

5.6.33 IntQlim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533

5.6.34 IntRas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
5.6.35 IntReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
5.6.36 IntRunarrange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
5.6.37 IntScenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
5.6.38 IntScensched . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
5.6.39 IntScheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
5.6.40 IntSscheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
5.6.41 IntSstage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
5.6.42 IntSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
5.6.43 IntSym . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
5.6.44 IntThrating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
5.6.45 IntUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
5.6.46 IntUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
5.6.47 IntUserman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
5.6.48 IntVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
5.6.49 IntVecobj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
5.6.50 IntVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
5.6.51 IntViewbookmark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
5.6.52 PltAxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
5.6.53 PltBiasdiff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
5.6.54 PltComplexdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
5.6.55 PltDataseries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
5.6.56 PltImpedancerx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
5.6.57 PltLegend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
5.6.58 PltLinebarplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
5.6.59 PltNetgraphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
5.6.60 PltOvercurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
5.6.61 PltPowerpq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
5.6.62 PltTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
5.6.63 PltVectorplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
5.6.64 RelChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
5.6.65 RelToc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
5.6.66 RelZpol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
5.6.67 ScnFreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
5.6.68 ScnFrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
5.6.69 ScnSpeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
5.6.70 ScnSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
5.6.71 ScnVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
5.6.72 ScnVolt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

7
CONTENTS CONTENTS

5.6.73 StoMaint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599

5.6.74 TypAsmo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
5.6.75 TypCtcore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
5.6.76 TypLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
5.6.77 TypMdl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
5.6.78 TypQdsl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
5.6.79 TypTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
5.6.80 VisPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
5.6.81 VisPcompdiffplt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
5.6.82 VisPlottz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
5.6.83 VisValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610

Index 611

8
 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
This function is deprecated, because PowerFactory will not be closed regularly (so the log file
will not be closed). Please use GetApplicationExt().
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
ConvertGeometryStringToMDL
CreateFaultCase
CreateProject
DecodeColour
DefineTransferAttributes
DeleteUntouchedObjects
EncodeColour
ExecuteCmd
GetActiveCalculationStr
GetActiveNetworkVariations
GetActiveProject
GetActiveScenario
GetActiveScenarioScheduler
GetActiveStages
GetActiveStudyCase
GetAllUsers
GetAttributeDescription
GetAttributeUnit
GetAvailableAttributes
GetAvailableAttributesAsJson
GetBorderCubicles
GetBrowserSelection
GetCalcRelevantObjects
GetCalculationBalancedMode
GetCalculationDescription
GetCalculations
GetCalculationsAsJson
GetClassDescription
GetClassId
GetCurrentDiagram
GetCurrentScript
GetCurrentSelection
GetCurrentUser
GetCurrentZoomScaleLevel
GetDataFolder
GetDesktop
GetDiagramSelection
GetFlowOrientation
GetFromStudyCase

4
 CHAPTER 3. APPLICATION METHODS

GetGlobalLibrary
GetInterfaceVersion
GetLanguage
GetLocalLibrary
GetMem
GetObjectByDbObjectKey
GetProjectFolder
GetRecordingStage
GetSettings
GetSummaryGrid
GetTouchedObjects
GetTouchingExpansionStages
GetTouchingStageObjects
GetTouchingVariations
GetUserManager
GetUserSettings
Hide
ImportDz
ImportSnapshot
IsAttributeModeInternal
IsLdfValid
IsNAN
IsRmsValid
IsScenarioAttribute
IsShcValid
IsSimValid
IsWriteCacheEnabled
LicenceHasModule
LoadProfile
MarkInGraphics
MigrateAllProjects
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

5
 CHAPTER 3. APPLICATION METHODS

SaveAsScenario
SearchObjectByForeignKey
SearchObjectsByCimId
SelectToolbox
SetAttributeInRootAndStageObjects
SetAttributeModeInternal
SetInterfaceVersion
SetShowAllUsers
SetWriteCacheEnabled
Show
SplitLine
StatFileGetXrange
StatFileResetXrange
StatFileSetXrange
WriteChangesToDb

ActivateProject
Activates a project with its name.
int Application.ActivateProject(str name)

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()

ConvertGeometryStringToMDL
Conversion of string geometry used in PowerFactory versions < 23.
str Application.ConvertGeometryStringToMDL(str orgString,
DataObject intGrfOrLayer)

6
 CHAPTER 3. APPLICATION METHODS

A RGUMENTS
orgString String to be converted.
intGrfOrLayer
IntGrf or IntGrflayer which contains the text.

R ETURNS
The converted MDL-string.

CreateFaultCase
Create fault cases from the given elements.
int Application.CreateFaultCase(set elms,
int mode,
[int createEvt = 0],
[DataObject folder = None]
)

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).
2 n-2 (multiple cases).
3 Collecting coupling elements and create fault cases for line couplings.
createEvt (optional)
Switch event:
0 Do NOT create switch events (default).
1 Create switch events.
folder (optional)
Folder in which the fault case is stored.

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. If desired, a new grid can also be created. Returns the newly created
project.
DataObject Application.CreateProject(str projectName,
str gridName,
[DataObject parent = None])
DataObject Application.CreateProject(str projectName,
[DataObject parent = None])

7
 CHAPTER 3. APPLICATION METHODS

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. Use an empty string to open
up the ElmNet dialog and let the user enter a name.
Leave out this argument completely to not create a grid.
parent The parent for the new project. Can be omitted to use the currently logged on user
as default.

DecodeColour
Decodes a colour value stored in PowerFactory’s internal colour representation, and splits it into
its RGBA components.
[int red,
int green,
int blue,
int alpha] Application.DecodeColour(int encodedColour)

A RGUMENTS
encodedColour
Colour value given in PowerFactory’s internal colour representation, as read from
any colour attribute.

red (out) Red colour channel. Range [0,255].

green (out)
Green colour channel. Range [0,255].
blue (out) Blue colour channel. Range [0,255].

alpha (out)
Colour transparency. Range [0,255], with 0 being fully transparent and 255 being
fully opaque.

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.

8
 CHAPTER 3. APPLICATION METHODS

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)

EncodeColour
Encodes an RGBA colour value into PowerFactory’s internal colour representation. The re-
turned value is meant to be assigned to a colour attribute.
int Application.EncodeColour(int red,
int green,
int blue,
[int alpha = 255])

A RGUMENTS
red Red colour channel. Must be in the range [0,255].

green Green colour channel. Must be in the range [0,255].

blue Blue colour channel. Must be in the range [0,255].
alpha(optional)
Colour transparency. Must be in the range [0,255], with 0 being fully transparent
and 255 being fully opaque.

R ETURNS
The encoded colour value. This value can be assigned to any colour attribute.

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

9
 CHAPTER 3. APPLICATION METHODS

GetActiveCalculationStr
Gets the “string ID” of the currently valid calculation.
str Application.GetActiveCalculationStr()

R ETURNS
String ID of the currently valid calculation, see Application.GetCalculations().

S EE ALSO

Application.GetCalculations(), Application.GetCalculationDescription(),
Application.GetCalculationBalancedMode(), Application.GetCalculationsAsJson() (not avail-
able in DPL)

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.

10
 CHAPTER 3. APPLICATION METHODS

GetActiveStages
Returns all active stages currently active for a given folder, e.g. 'Network Data' folder.
list Application.GetActiveStages([DataObject variedFolder = None])

A RGUMENTS
variedFolder (optional)
Folder for which all active stages will be returned; by default, the project folder
'Network Data' is taken.

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.
list Application.GetAllUsers([int forceReload = 0])

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.

GetAttributeDescription
Returns the description of an attribute.
str Application.GetAttributeDescription(str classname,
str name,
int short = 0)

11
 CHAPTER 3. APPLICATION METHODS

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.

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.
name Name of an attribute.

R ETURNS
None For an invalid class or attribute name.
str Attribute unit.

S EE ALSO

Application.GetAttributeDescription()

GetAvailableAttributes
Gets all variables available for a class.
str Application.GetAvailableAttributes(str className,
[str calculation,]
[int balanced,]
[str nameSpace])

A RGUMENTS
className
Name of a PowerFactory class
calculation (optional)
Calculation page value, see Application.GetCalculations()
Empty Attributes for all calculations (default)

12
 CHAPTER 3. APPLICATION METHODS

Set Only attributes for given calculation. Please note that for "basic" you
will get all calculation results that are available for all calculations (names-
pace ’b’). In case you want to get the input attributes, please use the
namespace filter ’e’.
balanced (optional)
Calculation type (only considered if calculation is set).
0 Unbalanced calculation
1 Balanced calculation (default)
nameSpace (optional)
Attribute namespace
Empty Attributes for all namespaces (default)
Set Only attributes of given namespace.

Namespace Attribute group

e Input data (built-in)
p Input data (data extensions)
b Calculation quantities (independent of calculation)
c Calculation quantities (results)
m Calculation quantities (results per connection)
n Calculation quantities (results per bus)
s Calculation quantities (signals and states)
x Calculation quantities (user-defined)

R ETURNS
List of attribute names with one attribute name per line.

GetAvailableAttributesAsJson
Gets attributes available for a class with additional information as string in JSON format.
JSON schema:

{
"$schema": "http://json-schema.org/draft/2019-09/schema",
"title": "Attributes",
"type": "object",
"required": ["class", "attributes"],
"properties": {
"class": {
"type": "string"
},
"attributes": {
"type": ["array", "null"],
"items": {
"type": "object"
},
"required": ["namespace", "name", "instances"],
"properties": {
"namespace": {
"type": "string"
},

13
 CHAPTER 3. APPLICATION METHODS

"name": {
"type": "string"
},
"busses": {
"type": "array",
"items": {
"type": "string"
}
},
"instances": {
"type": "array",
"items": {
"type": "object"
},
"properties": {
"description": {
"type": string
},
"unit": {
"type": "string"
},
"data_type": {
"type": "string"
},
"subindex_dimension": {
"type": "integer
},
"phases": {
"type": "array",
"items": {
"type": "string"
}
},
"functions": {
"type": "array",
"items": {
"type": "string"
}
},
"statistics": {
"type": "array",
"items": {
"type": "string"
}
},
"signal_type": {
"type": "string"
},
"calculations_balanced": {
"type": "array of strings"
},
"calculations_unbalanced": {
"type": "array of strings"
}
}
}

14
 CHAPTER 3. APPLICATION METHODS

}
}
}
}

The resulting JSON could look like (attribute list is elided):

{
"class": "ElmLne",
"attributes": [
{
"namespace": "e",
"name": "loc_name",
"instances": [
{
"description": "Name",
"unit": null,
"data_type": "string",
},
]
},
{
"namespace": "m",
"name": "uinet",
"busses": ["bus1", "bus2],
"instances": [
{
"description":
"Phase Voltage, Imaginary Part, referred to network",
"unit": "p.u.",
"data_type": "double",
"phases": ["A", "B", "C"],
"calculations_balanced": [],
"calculations_unbalanced": ["ldf"],
"model": "BasMon_ldf_rst"
},
{
"description":
"Phase Voltage, Imaginary Part, referred to network",
"unit": "p.u.",
"data_type": "double",
"calculations_balanced":
["ldf", "dcldf", "dccontopf", "optcapo"],
"calculations_unbalanced": [],
"model": "BasMon_ldf_sym"
},
]
},
{
"namespace": "s",
"name": "iL1",
"instances": [
{
"description": "Line-Current (bus1)",
"unit": "",

15
 CHAPTER 3. APPLICATION METHODS

"data_type": "double",
"functions": ["dt"],
"signal_type": "STATE, continuous",
"calculations_balanced": [],
"calculations_unbalanced": ["emt"],
"model": "CalLnedcshc_ins_rst"
}
]
},
...
]
}

str Application.GetAvailableAttributesAsJson(str className,

[str calculation,]
[int balanced,]
[str nameSpace,]
[str properties])

A RGUMENTS
className
Name of a PowerFactory class

calculation (optional)
Calculation page value, see Application.GetCalculations()
Empty Attributes for all calculations (default)
Set Only attributes for given calculation. Please note that for "basic" you
will get all calculation results that are available for all calculations (names-
pace ’b’). In case you want to get the input attributes, please use the
namespace filter ’e’.
balanced (optional)
Calculation type (only considered if calculation is set).

0 Unbalanced calculation
1 Balanced calculation (default)
nameSpace (optional)
Attribute namespace, see Application.GetAvailableAttributes()

Empty Attributes for all namespaces (default)

Set Only attributes of given namespace
properties (optional)
Comma separated list of JSON attribute instance property keys to be serialized,
see JSON schema above.

Empty All available properties (default)

Set Only given properties

R ETURNS
Attribute information in JSON format.

16
 CHAPTER 3. APPLICATION METHODS

E XAMPLE
The following script gets all calculation bus results ("m:*") available for the class ElmLne
in balanced load flow and includes only the properties description and unit in the resulting
JSON:
import powerfactory
app = powerfactory.GetApplicationExt()
attributes = app.GetAvailableAttributesAsJson("ElmLne", "ldf", 1, "m",
"description,unit");

S EE ALSO

Application.GetAvailableAttributes() Application.GetCalculations()

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). In comparison to
Application.GetCurrentSelection() this is independently of how the script is executed.
list Application.GetBrowserSelection()

R ETURNS
Objects marked in the “on top” Data Manager (Browser, right side).

S EE ALSO

Application.GetCurrentSelection(), Application.GetDiagramSelection()

17
 CHAPTER 3. APPLICATION METHODS

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()

GetCalculationBalancedMode
Gets balanced/unbalanced mode for a calculation.
int Application.GetCalculationBalancedMode(str calculationId)

A RGUMENTS
calculationId
Calculation string ID, see Application.GetCalculations().

R ETURNS
0 Calculation is available as balanced and unbalanced
1 Calculation is only available as balanced
2 Calculation is only available as unbalanced

18
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.GetCalculations(), Application.GetActiveCalculationStr(),
Application.GetCalculationDescription(), Application.GetCalculationsAsJson() (not available
in DPL)

GetCalculationDescription
Gets the description text for a calculation as displayed on the pages of the object dialogs.
str Application.GetCalculationDescription(str calculationId)

A RGUMENTS
calculationId
Calculation string ID, see Application.GetCalculations().

R ETURNS
Description text.

S EE ALSO

Application.GetCalculations(), Application.GetActiveCalculationStr(),
Application.GetCalculationBalancedMode(), Application.GetCalculationsAsJson() (not avail-
able in DPL)

GetCalculations
Gets “string IDs” of all calculations available.

String ID Dialog Page Name balanced unbalanced

basic Basic Data X
ldf Load Flow AC X X
dcldf Load Flow DC X
lvldf Low Voltage Load Flow X X
acsens AC Load Flow Sensitivities X X
dcsens DC Load Flow Sensitivities X
shc Short-Circuit VDE/IEC X X
shcfull Short-Circuit Complete X X
shcansi Short-Circuit ANSI X X
shc61363 Short-Circuit IEC61363 X
shcdc Short-Circuit DC X
accont Contingency Analysis AC X
dccont Contingency Analysis DC X
acldfsweep Quasi-dynamic Simulation AC X X
dcldfsweep Quasi-dynamic Simulation DC X
rms RMS-Simulation X X
emt EMT-Simulation X
modal Modal/Eigenvalue Analysis X
prot Protection X X
arcflash Arc Flash Calculation X X
cabsize Cable Sizing: International Standard X X
cabsizerf Cable Sizing: User Defined X X

19
 CHAPTER 3. APPLICATION METHODS

cabsizevf Cable Sizing: Verification X X

cabamp Cable Amplicity X X
harm Power Quality/Harmonics X X
fsweep Frequency Sweep X X
dachcz Connection Request D-A-CH-CZ X
bdew Connection Request BDEW X
vde4100 Connection Request VDE 4100/4105 X
vde4110 Connection Request VDE 4110 X
topo Tie Open Point Opt. X X
mvplan Voltage Profile Optimisation X
balance Phase Balance Optimisation X
optcapo Optimal Capacitor Placement X X
backbone Backbone Calculation X
rel Reliability X
omr Optimal Manual Restoration X
optrcs Optimal RCS Placement X
genrel Generation Adequacy X
cntrest Contingency Restoration Analysis X
hostcap Hosting Capacity Analysis X
powpark Power Park Energy Analysis X
acsto Probabilistic Load Flow AC X X
dcsto Probabilistic Load Flow DC X
acopfsto Probabilistic OPF AC X
dcopfsto Probabilistic OPF DC X
dcopfctsto Probabilistic OPF with Contingencies DC X
opf Optimal Power Flow AC X
dcopf Optimal Power Flow DC X
dccontopf OPF with Contingencies DC X
acuc Unit Commitment AC X
dcuc Unit Commitment DC X
placeopt Optimal Equipment Placement X
est State Estimation X X
motstart Motor Starting Calculation X X
usercalc User defined calculation X
tececo Techno-Economical Calculation X

str Application.GetCalculations()

R ETURNS
List of calculation string IDs with one ID per line.

S EE ALSO

Application.GetActiveCalculationStr(), Application.GetCalculationDescription(),
Application.GetCalculationBalancedMode(), Application.GetCalculationsAsJson() (not avail-
able in DPL)

20
 CHAPTER 3. APPLICATION METHODS

GetCalculationsAsJson
Gets all calculations available including additional information in JSON format.
JSON schema:

{
"$schema": "http://json-schema.org/draft/2019-09/schema",
"title": "Calculation Pages",
"type": "object",
"required": ["calculation_pages"],
"properties":
{
"calculation_pages":
{
"type": "array",
"items":
{
"type": "object"
},
"required":
["id", "description", "balanced", "unbalanced", "group"],
"properties":
{
"id":
{
"type": "string"
},
"description":
{
"type": "string"
},
"balanced":
{
"type": "boolean"
},
"unbalanced":
{
"type": "boolean"
},
"group":
{
"type": "string"
}
}
}
}
}

str Application.GetCalculationsAsJson()

R ETURNS
Calculation information in JSON format.

21
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.GetCalculations(), Application.GetActiveCalculationStr(),
Application.GetCalculationDescription(), Application.GetCalculationBalancedMode()

GetClassDescription
Returns a description for a PowerFactory class.
str Application.GetClassDescription(str name)

A RGUMENTS
name Name of a PowerFactory class

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.

22
 CHAPTER 3. APPLICATION METHODS

GetCurrentSelection
Returns all objects marked in the “on top” Data Manager (Browser, right side) or diagram when
the script is executed via the right-click menu entry ’Execute Script’. When the script is executed
e.g via the edit dialog or via a toolbar button then it always returns an empty selection.
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()

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 = 0])

A RGUMENTS
classname
Classname of the elements:
ElmBmu
ElmArea
ElmZone

23
 CHAPTER 3. APPLICATION METHODS

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 (default).
1 The folder is created if it does not exist. The found or created folder is
returned.

R ETURNS
The network data folder, which is found or created.

S EE ALSO

DataObject.IsNetworkDataFolder()

GetDesktop
Returns the currently active Desktop.
DataObject Application.GetDesktop()

R ETURNS
The desktop object

GetDiagramSelection
Returns all objects marked in the “on top” diagram. In comparison to
Application.GetCurrentSelection() this is independently of how the script is executed.
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()

24
 CHAPTER 3. APPLICATION METHODS

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.

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()

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()

25
 CHAPTER 3. APPLICATION METHODS

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
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 Application.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).

26
 CHAPTER 3. APPLICATION METHODS

R ETURNS
The current working set size or the delta since the last call.

GetObjectByDbObjectKey
Returns the object for an Object Key.
DataObject Application.GetObjectByDbObjectKey(DataObject projectOrLibrary,
str dbObjectKey)

A RGUMENTS
projectOrLibrary
Project or library

dbObjectKey
The Object Key in the database

R ETURNS
DataObject The object in the project/library with that Object Key if existing.
None Otherwise.

S EE ALSO

DataObject.GetDbObjectKey()

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 = 0])

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).

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.

27
 CHAPTER 3. APPLICATION METHODS

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

GetTouchedObjects
Gets all root objects added, modified or deleted in the given variations and expansion stages.
list Application.GetTouchedObjects(object varOrStage)
list Application.GetTouchedObjects(list varsAndStages)

A RGUMENTS
varOrStage
Variation or expansion stage.
varsAndStages
Variations and expansion stages.

R ETURNS
Matching root objects.

28
 CHAPTER 3. APPLICATION METHODS

GetTouchingExpansionStages
Gets all expansion stages in which at least one of the given objects is added, modified or
deleted.
list Application.GetTouchingExpansionStages(object rootObject)
list Application.GetTouchingExpansionStages(list rootObjects)

A RGUMENTS
rootObject
Root object.
rootObjects
Root objects.

R ETURNS
Matching expansion stages.

GetTouchingStageObjects
Gets all stage objects adding, modifying or deleting one of the given objects.
list Application.GetTouchingStageObjects(object rootObject)
list Application.GetTouchingStageObjects(list rootObjects)

A RGUMENTS
rootObject
Root object.
rootObjects
Root objects.

R ETURNS
Matching expansion stages.

GetTouchingVariations
Gets all variations in which at least one of the given objects is added, modified or deleted.
list Application.GetTouchingVariations(object rootObject)
list Application.GetTouchingVariations(list rootObjects)

A RGUMENTS
rootObject
Root objects.
rootObjects
Root objects.

R ETURNS
Matching variations.

29
 CHAPTER 3. APPLICATION METHODS

GetUserManager
Offers access to the user manager object (IntUserman) stored in the configuration folder.
DataObject Application.GetUserManager()

R ETURNS
The user manager object

GetUserSettings
Convient routine to get the settings object (SetUser) of a user.
object Application.GetUserSettings([object user = None])

A RGUMENTS
user (optional)
If current user that executes the function is Administrator, passing a user object
(IntUser) will return the corresponding setting object for that user.
Note: For normal users, the argument is ignored and always the setting object of
current user is returned.

R ETURNS
Returns the settings object (SetUser) for a user.

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.

30
 CHAPTER 3. APPLICATION METHODS

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

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

IsNAN
Checks whether a double value is NAN (not a number).
int Application.IsNAN(float value)

31
 CHAPTER 3. APPLICATION METHODS

A RGUMENTS
value Double value to check.

R ETURNS
Returns 1, if value is NAN, 0 otherwise.

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.

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()

32
 CHAPTER 3. APPLICATION METHODS

R ETURNS
0 if no simulation results are available

IsWriteCacheEnabled
Returns whether or not the cache method for optimizing performances is enabled. For more
informations, see Application.SetWriteCacheEnabled().
int Application.IsWriteCacheEnabled()

R ETURNS
0 Write cache is disabled.
1 Write cache is enabled.

S EE ALSO

Application.SetWriteCacheEnabled(), Application.WriteChangesToDb()

LicenceHasModule
Checks whether the current licence contains a module.
The following licence module abbreviations can be used:

• ai - Artificial Intelligence
• anaredefas - ANAREDE/ANAFAS Export
• arcflash - Arc-Flash Analysis
• c37 - C37 Simulation Interface
• cabOpt - Cable Analysis
• cimEentso - CIM Import/Export (ENTSO-E Profile)
• cimEentsoCorp - CIM Import/Export (ENTSO-E Profile) - corp.
• cimIentso - CIM Import (ENTSO-E Profile)
• conrequest - Connection Request Assessment
• contingency - Contingency Analysis
• cosim - Co-Simulation Interface
• crypt - DPL/DSL/QDSL Encryption
• dist - Distance Protection
• distr - Distribution Network Tools
• econom - Economic Analysis Tools
• fmuexp - FMU Model Export
• harm - Power Quality and Harmonic Analysis
• integral - Integral Export
• masterstation - PFM Master Station

33
 CHAPTER 3. APPLICATION METHODS

• motstart - Motor Starting Functions

• muld - Multi-User Database

• netred - Network Reduction
• opc - OPC Interface
• opfact - OPF (Economic Dispatch)

• opfreact - OPF (Reactive Power Optimisation)

• paramid - System Parameter Identification
• probAnalysis - Probabilistic Analysis
• prot - Time-Overcurrent Protection

• psse - PSS/E Export

• qdynsim - Quasi - Dynamic Simulation
• reli - Reliablity and Restoration Analysis

• script - Scripting and Automation

• smallsig - Small Signal Stability (Eigenvalue Analysis)
• stab - Stability Analysis Functions (RMS)
• stabemt - Electromagnetic Transients (EMT)

• staest - State Estimation

• transmission - Transmission Network Tools
• unitcomm - Unit Commitment and Dispatch Optimisation

int Application.LicenceHasModule(str module)

A RGUMENTS
module Abbreviated name of the licence module, e.g. "prot". See list above.

R ETURNS
1 Module is contained in the current licence. Corresponding functionality can be
used.
0 Module is not contained in the current licence.

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.

34
 CHAPTER 3. APPLICATION METHODS

R ETURNS
0 On error, e.g. profile with given name not found.
1 On success.

S EE ALSO

Application.ReloadProfile()

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.

MigrateAllProjects
Migrates all projects in the database to the current PowerFactory version. In multi-user databases
this function can be run only as Administrator user.
int Application.MigrateAllProjects()

R ETURNS
0 On success.
1 On error.

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 = ''])

35
 CHAPTER 3. APPLICATION METHODS

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 as string to the command pipe of the “input window”. The posted command
string will be executed after the currently running script has finished.
None Application.PostCommand(str commandString)
None Application.PostCommand(DataObject command)

A RGUMENTS
commandString
A command as string e.g ’exit’ for ComExit.
command
A command. Internally the command is converted to a command string including
all its properties.

PrepForUntouchedDelete
Mark (as not modified) all objects stored in the grid (or stored in set). Required for function
Application.DeleteUntouchedObjects().
None Application.PrepForUntouchedDelete(DataObject grid)
None Application.PrepForUntouchedDelete(list grids)

Rebuild
Rebuilds the currently visible single line diagram or plot.
None Application.Rebuild([int iMode = 1])

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()

36
 CHAPTER 3. APPLICATION METHODS

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])

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])

37
 CHAPTER 3. APPLICATION METHODS

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,
[str variableNames])

ResGetIndex
This function is deprecated. Please use ElmRes.FindColumn() or IntComtrade.FindColumn()
instead.
int Application.ResGetIndex(DataObject resultFile,
DataObject obj,
[str varName])
int Application.ResGetIndex(DataObject resultFile,
DataObject obj,
[int colIndex])
int Application.ResGetIndex(DataObject resultFile,
[str varName,]
[int colIndex])

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)

38
 CHAPTER 3. APPLICATION METHODS

ResGetNextValidObject
This function is deprecated. Please use ElmRes.GetNextValidObject() instead.
int Application.ResGetNextValidObject(DataObject resultFile,
[str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[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,
[str variableNames])

ResGetNextValidVariable
This function is deprecated. Please use ElmRes.GetNextValidVariable() instead.
int Application.ResGetNextValidVariable(DataObject resultFile,
[str variableNames])

ResGetObject
This function is deprecated. Please use ElmRes.GetObject() instead.
DataObject Application.ResGetObj(DataObject resultObject,
int col)

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])

39
 CHAPTER 3. APPLICATION METHODS

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)

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).

40
 CHAPTER 3. APPLICATION METHODS

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.

SearchObjectsByCimId
Searches for objects by CIM RDF ID within an active project.
list Application.SearchObjectsByCimId(str cimId)

A RGUMENTS
cimId CIM RDF ID

R ETURNS
Matching objects.

E XAMPLE
The following example shows how to search for objects by CIM RDF ID:
import powerfactory
app = powerfactory.GetApplicationExt()

objects = app.SearchObjectsByCimId("_17086487-56ba-4979-b8de-064025a6b4da")
for object in objects:
app.PrintInfo(object)

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.

41
 CHAPTER 3. APPLICATION METHODS

R ETURNS
0 On error, e.g. no matching tool box found.
1 On success.

SetAttributeInRootAndStageObjects
Sets an attribute value in all occurences of an object, i.e. in the root object and all stage objects
referring to that root object.
int Application.SetAttributeInRootAndStageObjects(DataObject obj,
str attributeName,
str value)
int Application.SetAttributeInRootAndStageObjects(list objs,
str attributeName,
str value)

A RGUMENTS
obj Object to be modified.
objs Objects to be modified.
attributeName
Name of attribute to be modified, including prefix and subindices.
value New attribute value.

R ETURNS
0 OK
1 Error

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)

42
 CHAPTER 3. APPLICATION METHODS

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.

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 Application.WriteChangesToDb() 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
Application.WriteChangesToDb() 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()

43
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.Hide()

SplitLine
Splits the passed line or ElmBranch-object at a given position and inserts a new terminal. With
the optional parameters for specifying the bay end terminals of a substation it is possible to set
the new connection nodes within an already existing substation.
DataObject Application.SplitLine(DataObject Line,
[float percent = 50,]
[int createSwitchSide0 = 0,]
[int createSwitchSide1 = 0,]
[int graphicSplit = 0,]
[DataObject bayEndTerm1 = None,]
[DataObject bayEndTerm2 = None])

A RGUMENTS
double percent (optional)
Position in percent from the first connection side where line shall be split.

int createSwitchSide0 (optional - will be ignored if a substation is inserted)

0 (default) Do not create switch on first connection side. Will be ignored
if a ’bayEndTerm1’ or ’bayEndTerm2’ is set.
1 Create switch on first connection side.
int createSwitchSide1 (optional - will be ignored if a substation is inserted)
0 (default) Do not create switch on second connection side. Will be
ignored if a ’bayEndTerm1’ or ’bayEndTerm2’ is set.
1 Create switch on second connection side.
int graphicSplit (optional)
0 (default) Do not perform line split graphically.
1 Split line also graphically.
object bayEndTerm1 (optional - only needed when connecting into an existing substation)
First (bay end) terminal inside substation.

object bayEndTerm2 (optional - only needed when connecting into an existing substation)
Second (bay end) terminal inside substation.

R ETURNS
Inserted terminal or None on error.

StatFileGetXrange
Gets the x-range for the statistic result file.
[int error,
float min,
float max] Application.StatFileGetXrange()

44
 CHAPTER 3. APPLICATION METHODS

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()

S EE ALSO

Application.SetWriteCacheEnabled(), Application.IsWriteCacheEnabled()

45
3.1. FILE SYSTEM CHAPTER 3. APPLICATION METHODS

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.

D EPRECATED N AMES
GetWorkingDir

46
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS

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
This function is not supported in GUI-less mode.

Closes all open table reports.

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

GetTableReports
This function is not supported in GUI-less mode.

Returns all open table reports.

list Application.GetTableReports()

ShowModalBrowser
This function is not supported in GUI-less mode.

Opens a modal browser window and lists all given objects.

47
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS

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
This function is not supported in GUI-less mode.

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
objects Objects to be listed. The listing is in detailed mode, if only one kind of objects (e.g.
only ElmTerm) is contained.
title (optional)
String for user defined window title. The default window title is shown when no or
an empty string is given.
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)
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.

R ETURNS
Set of selected objects. The set is empty if “cancel” is pressed.

48
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS

ShowModelessBrowser
This function is not supported in GUI-less mode.

Opens a modeless browser window and lists all given objects.

None Application.ShowModelessBrowser(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.

UpdateTableReports
This function is not supported in GUI-less mode.

Updates all open table reports.

None Application.UpdateTableReports()

3.4 Environment
Overview

EchoOff
EchoOn
IsAutomaticCalculationResetEnabled
IsFinalEchoOnEnabled
SetAutomaticCalculationResetEnabled
SetFinalEchoOnEnabled
SetGraphicUpdate
SetGuiUpdateEnabled
SetProgressBarUpdatesEnabled
SetUserBreakEnabled

49
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS

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()

50
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS

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.
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

51
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS

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.
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.

52
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.SetGuiUpdateEnabled(), Application.SetGraphicUpdate()

SetUserBreakEnabled
Enables or disables the “Break” button of the main tool bar. After script execution it is disabled
automatically.
Disabling the “Break” button before executing a lot of Python code e.g a large loop can provide
an immense performance boost. Disabling the “Break” button does not lead to a further perfor-
mance improvement when the GUI updates are already disabled (see
Application.SetGuiUpdateEnabled()).
None Application.SetUserBreakEnabled(int enabled)

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

53
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

GetRandomNumber
This function 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 function is marked as deprecated since PowerFactory 2017. Please use
Application.RndUnifReal(), Application.RndNormal() or Application.RndWeibull() instead.
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

54
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

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])

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 Application.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.

55
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

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 Application.RndGetMethod([int rngNum])

A RGUMENTS
rngNum (optional)
Number of the random number generator of which the method type is returned.
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.

R ETURNS
string Name of the used method

RndGetSeed
Returns the used seed of a random number generator. See the example given in the DPL
description of Application.RndSetup().
int Application.RndGetSeed([int rngNum])

A RGUMENTS
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
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 Application.RndNormal(float mean, float stddev, [int rngNum])

A RGUMENTS
mean Mean of normal distribution.
stddev Standard deviation of normal 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.

56
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

R ETURNS
double Random number

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,
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 Application.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
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.

57
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

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 Application.RndUnifInt(int min, int max, [int rngNum])

A RGUMENTS
min Smallest possible number
max Largest possible number
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
int Random number

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 Application.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)
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

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 Application.RndWeibull(float shape, float scale, [int rngNum])

A RGUMENTS
shape Shape parameter of Weibull distribution.
scale Scale parameter of Weibull 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.

58
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS

R ETURNS
double Random number

SetRandomSeed
This function 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)

A RGUMENTS
seed seed 0..9

3.6 Output Window

Overview

ClearOutputWindow
FlushOutputWindow
GetOutputWindow
PrintError
PrintInfo
PrintPlain
PrintWarn
SetOutputWindowState

ClearOutputWindow
Clears the output window.
None Application.ClearOutputWindow()

FlushOutputWindow
Calling this function ensures that all previously printed and potentially buffered messages are
visible in the output window.
None Application.FlushOutputWindow()

E XAMPLE
import powerfactory
app = powerfactory.GetApplicationExt()
app.PrintInfo('It is not guaranteed that this message is \
shown immediately in the output window as it could be buffered.')
# After this call all previously printed messages
# are guaranteed to be visible in the output window.
app.FlushOutputWindow()

59
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS

GetOutputWindow
Returns the PowerFactory Output Window.
OutputWindow Application.GetOutputWindow()

R ETURNS
An instance of the class OutputWindow.

E XAMPLE
import powerfactory
app = powerfactory.GetApplicationExt()
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)

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)

60
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS

A RGUMENTS
newState
0 Minimized output window.
1 Maximized output window.
-1 Restore previous state.

61
 CHAPTER 4. OUTPUT WINDOW

4 Output Window

Overview

Clear
Flush
GetContent
Print
Save
SetState

Clear
Clears the output window.
None OutputWindow.Clear()

Flush
Calling this function ensures that all previously printed and potentially buffered messages are
visible in the output window.
None OutputWindow.Flush()

GetContent
Returns the content (unfiltered or filtered) of the output window.
[str] OutputWindow.GetContent()
[str] OutputWindow.GetContent(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()

62
 CHAPTER 4. OUTPUT WINDOW

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(MessageType type, str message)

A RGUMENTS
type Type of message to print:
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.GetApplicationExt()
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.

63
 CHAPTER 5. OBJECT METHODS

5 Object Methods

5.1 General Methods

Overview

AddCopy
CopyData
CreateObject
Delete
Energize
GetAttribute
GetAttributeDescription
GetAttributeLength
GetAttributes
GetAttributeShape
GetAttributeType
GetAttributeUnit
GetChildren
GetClassName
GetCombinedProjectSource
GetConnectedElements
GetConnectionCount
GetContents
GetControlledNode
GetCubicle
GetDbObjectId
GetDbObjectKey
GetDbProjectId
GetFullName
GetImpedance
GetInom
GetNode
GetOperator
GetOwner
GetParent
GetReferences
GetRegion
GetSupplyingSubstations
GetSupplyingTransformers
GetSupplyingTrfstations
GetSystemGrounding
GetUnom
GetZeroImpedance
HasAttribute

64
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

HasReferences
HasResults
IsCalcRelevant
IsDeleted
IsEarthed
IsEnergized
IsHidden
IsInFeeder
IsNetworkDataFolder
IsNode
IsObjectActive
IsObjectModifiedByVariation
Isolate
IsOutOfService
IsReducible
IsShortCircuited
MarkInGraphics
Move
PasteCopy
PurgeUnusedObjects
ReportUnusedObjects
SearchObject
SetAttribute
SetAttributeInRootAndStageObjects
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.

65
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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()

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.

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()

66
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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()

GetAttribute
Returns the value of an attribute.
int|float|str|DataObject|list DataObject.GetAttribute(str name)

A RGUMENTS
name Name of an attribute.

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.

67
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

DataObject.SetAttribute(), DataObject.GetAttributeType()

GetAttributeDescription
Returns the description of an attribute.
str DataObject.GetAttributeDescription(str name,
int short = 0)

A RGUMENTS
name Name of an attribute.
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
name Name of an attribute.

R ETURNS
>0 Length of a valid vector or matrix attribute.
0 All other valid attributes.
−1 For invalid attribute names.

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.

68
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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
name Name of an attribute.

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.
AttributeType DataObject.GetAttributeType(str name)

A RGUMENTS
name Name of an attribute.

R ETURNS
The type of an attribute or AttributeType.INVALID for an invalid attribute name.

S EE ALSO

DataObject.GetAttribute(), DataObject.SetAttribute()

69
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

GetAttributeUnit
Returns the unit of an attribute e.g. km, MW. . . .
str DataObject.GetAttributeUnit(str name)

A RGUMENTS
name Name of an attribute.

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.

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()

70
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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.

GetConnectionCount
Returns the number of electrical connections.

A RGUMENTS
includeNeutral (optional)
1, also separate neutral conductor connections are taken into account.

int DataObject.GetConnectionCount([int includeNeutral=0])

R ETURNS
The number of electrical connections.

71
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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.

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)

72
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

A RGUMENTS
side The connection number.

R ETURNS
The cubicle object or None.

GetDbObjectId
Returns the Id for an object (depends to the current database).
int DataObject.GetDbObjectId([int asString])
str DataObject.GetDbObjectId([int asString])

A RGUMENTS
asString Set the return type:
0 Return the id as int (default). If Id is greater than 231 (out of integer
range) then returns a negative number.
1 Return the id as string (required if Id greater than 231 ).

R ETURNS
The Object Id in the current database.

S EE ALSO

DataObject.GetDbObjectKey(), DataObject.GetDbProjectId()

GetDbObjectKey
Returns the Object Key for an object.
str DataObject.GetDbObjectKey()

R ETURNS
The Object Key e.g. "T4108k/RnUyenmjUh7iR0w" if the object has an Object Key. Other-
wise "".

S EE ALSO

Application.GetObjectByDbObjectKey(), DataObject.GetDbObjectId(),
DataObject.GetDbProjectId()

GetDbProjectId
Returns the project Id for an object (depends to the current database).
int DataObject.GetDbProjectId([int asString])
str DataObject.GetDbProjectId([int asString])

A RGUMENTS
asString Set the return type:
0 Return the id as int (default). If Id is greater than 231 (out of integer
range) then returns a negative number.
1 Return the id as string (required if Id greater than 231 ).

73
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
The Project Id of the object in the current database.

S EE ALSO

DataObject.GetDbObjectId(), DataObject.GetDbObjectKey()

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.
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.

74
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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])

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.

75
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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.

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,]
[int includeDataExtensions = 0])

76
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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)
includeDataExtensions (optional)
References from Data Extension parameters are also included. These are nor-
mally not included for performance reasons. (default: 0)

R ETURNS
Set of objects with references to the object the method was called on.

S EE ALSO

DataObject.GetReferences()

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.

S EE ALSO

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements(),
ElmSubstat.GetSuppliedElements(), ElmTrfstat.GetSuppliedElements(),
DataObject.GetSupplyingTransformers(), DataObject.GetSupplyingTrfstations()

77
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements(),
ElmSubstat.GetSuppliedElements(), 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

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements(),
ElmSubstat.GetSuppliedElements(), ElmTrfstat.GetSuppliedElements(),
DataObject.GetSupplyingTransformers(), DataObject.GetSupplyingSubstations()

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

GetUnom
Returns the nominal voltage of the object.
float DataObject.GetUnom([int busIndex = 0])

78
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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
real (out) Real part of the impedance in Ohm.
imag (out)
Imaginary part of the impedance in Ohm.
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.GetImpedance()

HasAttribute
Returns whether the given name is a currently valid attribute name.
int DataObject.HasAttribute(str name)

A RGUMENTS
name Name of an attribute.

R ETURNS
0 Given name is not a currently valid attribute name.
1 Given name is a currently valid attribute name.

79
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

DataObject.GetAttribute(), DataObject.SetAttribute()

HasReferences
Find out whether there are objects with references to the object the method was called on.
int DataObject.HasReferences()

R ETURNS
0 There are no such objects
1 There is one or more such objects

S EE ALSO

DataObject.GetReferences()

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()

80
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

IsDeleted
Returns 1 if the object is deleted.
int DataObject.IsDeleted()

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’

81
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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])

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()

82
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
0 false, object is not a network data folder
1 true, object is a network data folder

S EE ALSO

Application.GetDataFolder()

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

83
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

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
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
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
Information about the success of the action:

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()

84
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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()

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
This function is not supported in GUI-less mode.

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.

85
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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)

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.

86
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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).
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()

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)

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)

87
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

A RGUMENTS
name Name of an attribute.
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()

SetAttributeInRootAndStageObjects
Sets an attribute value in all occurences of an object, i.e. in the root object and all stage objects
referring to that root object.
int DataObject.SetAttributeInRootAndStageObjects(str attributeName,
str value)

A RGUMENTS
attributeName
Name of attribute to be modified, including prefix and subindices.
value New attribute value.

R ETURNS
0 OK
1 Error

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
name Name of an attribute.
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)

88
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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 shape)

A RGUMENTS
name Name of an attribute.
shape New shape of the attribute.

R ETURNS
0 On success.
1 On error.

S EE ALSO

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

ShowEditDialog
This function is not supported in GUI-less mode.

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
This function is not supported in GUI-less mode.

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])

89
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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
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
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
Information about the success of the action:

0 Action was successful

1 Action failed

S EE ALSO

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

90
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

SwitchOn
Performs a “switch on” action on the network element. This action is identical to that in the
context menue.
[int error,
list changedSwitches] DataObject.SwitchOn([int resetRA,]
[int simulateOnly])

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
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:

0 Action was successful

1 Action failed

S EE ALSO

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

WriteChangesToDb
See Application.WriteChangesToDb() for a detailed description.
None DataObject.WriteChangesToDb()

91
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2 Network Elements

5.2.1 ElmArea
Overview

CalculateInterchangeTo
CalculateVoltageLevel
CalculateVoltInterVolt
DefineBoundary
GetAll
GetBranches
GetBuses
GetObjs

CalculateInterchangeTo
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

CalculateVoltageLevel
Internal funciton to calculate per voltage level the corresponding summary results. The values
are stored in current area (values from the previous load flow calculation are overwritten):
int ElmArea.CalculateVoltageLevel(double U)

A RGUMENTS
U for voltage level (in kV)

R ETURNS
<0 error
=0 voltage level not exists in the area
>0 ok

92
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CalculateVoltInterVolt
This function calculates the power flow from voltage level to voltage level. The values are stored
in current area 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 ElmArea.CalculateVoltInterVolt(double Ufrom,

double Uto)

A RGUMENTS
Ufrom from voltage level (in kV)

Uto to voltage level (in kV)

R ETURNS
<0 error
=0 voltage levels not exists in the area, no interchange exists
>0 ok

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()

93
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.

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

94
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.

GetAvailableGenPower
Returns the available power that can be dispatched from the generator, for the particular study
time.
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]
)

95
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.

GetGroundingImpedance
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.

96
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetMotorStartingFlag
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

GetStepupTransformer
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.

97
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.3 ElmAsmsc
Overview

GetAvailableGenPower
GetGroundingImpedance
GetStepupTransformer

GetAvailableGenPower
Returns the available power that can be dispatched from the generator, for the particular study
time.
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 ElmAsmsc.GetAvailableGenPower()

R ETURNS
Available generation power

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmAsmsc.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.

98
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 The values are invalid (e.g. because there is no internal grounding)
1 The values are valid.

GetStepupTransformer
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:
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).

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!)).

99
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

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()

100
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

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].

101
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.
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

102
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.
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.

103
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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’)

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

104
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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)

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 Cable system was updated.
0 Update was not required.

105
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

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)

106
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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-reducible 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.

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
Returns information about current switch state.
int ElmCoup.IsOpen()

107
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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
determined by an active running arrangement.
int ElmCoup.Open()

R ETURNS
0 On success
6= 0 On error

S EE ALSO

ElmCoup.Close()

5.2.11 ElmDcu
Overview

GetGroundingImpedance

GetGroundingImpedance
Returns the impedance of the internal grounding. Voltage source with a setpoint of zero are
considered as grounding devices themselves; i.e. the Ri paramter is used.
[int valid,
float resistance,
float reactance ] ElmDcu.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.

108
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.12 ElmDsl
Overview

ExportToClipboard
ExportToFile

ExportToClipboard
Export the parameter list to clipboard.
None ElmDsl.ExportToClipboard([str colSeparator],
[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).

109
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.13 ElmFeeder
Overview

CalcAggrVarsInRadFeed
GetAll
GetBranches
GetBuses
GetNodesBranches
GetObjs

CalcAggrVarsInRadFeed
Computes all the aggregated variables in radial feeders.
int ElmFeeder.CalcAggrVarsInRadFeed([int lookForRoot,]
[int considerNested])

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.

110
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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)
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 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)
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 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)
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.

111
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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)
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 feeder objects.

5.2.14 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()

112
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
6= 0 On error.

5.2.15 ElmFilter
Overview

GetGroundingImpedance

GetGroundingImpedance
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,
float reactance ] ElmFilter.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.

5.2.16 ElmGenstat
Overview

CalcEfficiency
Derate
Disconnect
GetAvailableGenPower
GetGroundingImpedance
GetStepupTransformer
IsConnected
Reconnect
ResetDerating

113
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float ElmGenstat.CalcEfficiency(float activePowerMW)

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

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

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))

GetAvailableGenPower
Returns the available power that can be dispatched from the generator, for the particular study
time.
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.

114
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

• 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 ElmGenstat.GetAvailableGenPower()

R ETURNS
Available generation power

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmGenstat.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.

GetStepupTransformer
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:

0 consider all switch status
1 ignore breaker status
2 ignore all switch status

115
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns the first collected step-up transformer object. It is empty if not found (e.g. start
terminal already at hvVoltage).

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()

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.17 ElmGndswt
Overview

Close
GetGroundingImpedance
IsClosed
IsOpen
Open

116
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

GetGroundingImpedance
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 or DC.
[int valid,
float resistance,
float reactance ] ElmGndswt.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.

IsClosed
Returns information about current switch state.
int ElmGndswt.IsClosed()

R ETURNS
1 switch is closed
0 switch is open

S EE ALSO

ElmGndswt.IsOpen()

IsOpen
Returns information about current switch state.
int ElmGndswt.IsOpen()

117
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

5.2.18 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()

118
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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])

119
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
isRMSModel

modify

R ETURNS
0 Success
1 Error

GetIthr
Returns the rated short-time current of the line element.
float ElmLne.GetIthr()

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 uS 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

120
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetY1m
The function returns the positive-sequence mutual coupling admittance (G1m, B1m) in uS 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

R ETURNS
0 Success, data obtained
1 Error, e.g. no coupling objects defined

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
0 Success, data obtained
1 Error, e.g. no coupling objects defined

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)

121
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
Lne2 Line element
R1m (out)
Resulting R1m value
X1m (out)
Resulting X1m value

R ETURNS
0 Success, data obtained
1 Error, e.g. no coupling objects defined

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()

122
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

R ETURNS
2 when line contains cable and overhead line sections
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

123
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.19 ElmLnesec
Overview

IsCable

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.20 ElmMdl
Overview

Check
ExportToClipboard
ExportToFile

Check
Checks the Modelica Model.
int ElmMdl.Check()

R ETURNS
0 Modelica Model is correct.
1 Error found.

ExportToClipboard
Export the parameter list to clipboard.
None ElmMdl.ExportToClipboard([str colSeparator],
[int useLocalHeader]
)

124
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ElmMdl.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.21 ElmNec
Overview

GetGroundingImpedance

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmNec.GetGroundingImpedance(int busIdx)

A RGUMENTS
busIdx Bus index where the grounding should be determined.
resistance (out)
Real part of the grounding impedance in Ohm.

125
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.

5.2.22 ElmNet
Overview

Activate
CalculateInterchangeTo
CalculateVoltageLevel
CalculateVoltInterVolt
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()

R ETURNS
0 on success
1 on error

CalculateInterchangeTo
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

126
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
<0 error
=0 grids are not connected, no interchange exists
>0 ok

CalculateVoltageLevel
Internal funciton to calculate per voltage level the corresponding summary results. The values
are stored in current grid (values from the previous load flow calculation are overwritten):
int ElmNet.CalculateVoltageLevel(double U)

A RGUMENTS
U for voltage level (in kV)

R ETURNS
<0 error
=0 voltage level not exists in the grid
>0 ok

CalculateVoltInterVolt
This function calculates the power flow from voltage level to voltage level. 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.CalculateVoltInterVolt(double Ufrom,

double Uto)

A RGUMENTS
Ufrom from voltage level (in kV)
Uto to voltage level (in kV)

R ETURNS
<0 error
=0 voltage levels not exists in the grid, no interchange exists
>0 ok

127
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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)

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
The defined boundary is returned in case of success. Otherwise NULL, if an error appeared
in the definition of the boundary.

5.2.23 ElmPvsys
Overview

CalcEfficiency
Derate
Disconnect
GetAvailableGenPower
GetGroundingImpedance
IsConnected
Reconnect
ResetDerating

CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float ElmPvsys.CalcEfficiency(float activePowerMW)

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

128
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ElmPvsys.Derate(float deratingP)

A RGUMENTS
deratingP Derating value

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()

R ETURNS
0 breaker already open or successfully opened
1 an error occurred (no breaker found, open action not possible (earthing / RA))

GetAvailableGenPower
Returns the available power that can be dispatched from the generator, for the particular study
time.
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 ElmPvsys.GetAvailableGenPower()

129
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Available generation power

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmPvsys.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.

IsConnected
Checks if a PV system is already connected to any busbar.
int ElmPvsys.IsConnected()

R ETURNS
0 false, not connected to a busbar
1 true, generator is connected to a busbar

Reconnect
Connects a PV system 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 ElmPvsys.Reconnect()

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 ElmPvsys.ResetDerating()

130
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.24 ElmRecmono
Overview

GetGroundingImpedance

GetGroundingImpedance
Returns the impedance of the internal grounding. Only thhe DC side is considered to to be
grounded.
[int valid,
float resistance,
float reactance ] ElmRecmono.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.

5.2.25 ElmRelay
Overview

CalculateMaxFaultCurrents
CheckRanges
GetCalcRX
GetMaxFdetectCalcI
GetSlot
GetUnom
IsStarted
SetImpedance
SetMaxI
SetMaxIearth
SetMinI
SetMinIearth
SetOutOfService
SetTime
SlotUpdate

131
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CalculateMaxFaultCurrents
Calculates and stores the “Max. phase fault current” and the “Max. earth fault current”.
None ElmRelay.CalculateMaxFaultCurrents()

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
real (out) Real part of the impedance in Ohm.
imag (out)
Imaginary part of the impedance in Ohm.

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
)

132
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
Iabs (out) The measured current in A
earth
0 Get the phase current.
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()

133
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 No fault was detected.
1 Fault was detected.
-1 An error occurred.

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

134
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.

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.

135
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.

R ETURNS
0 No error occurred.
1 An error occurred or no element was found.

SetTime
Sets the tripping time for elements contained in the relay.
int ElmRelay.SetTime(double 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
0 No error occurred.
1 An error occurred or no element was found.

SlotUpdate
Triggers a slot update of the relay.
None ElmRelay.SlotUpdate()

136
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

D EPRECATED N AMES
slotupd

5.2.26 ElmRes
Overview

AddVariable
Clear
ExecuteLoadingCommand
FindColumn
FindMaxInColumn
FindMaxOfVariableInRow
FindMaxRowsInColumns
FindMinInColumn
FindMinOfVariableInRow
FindMinRowsInColumns
FinishWriting
Flush
GetColumnValues
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

137
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

AddVariable
Adds a variable to the list of monitored variables for the Result object.
int ElmRes.AddVariable(DataObject element,
str varname)

A RGUMENTS
element An object.
varname Variable name for object element.

R ETURNS
0 On success.
1 An error occurred during adding of variables.

D EPRECATED N AMES
AddVars

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.

ExecuteLoadingCommand
Loads results into memory.
int ElmRes.ExecuteLoadingCommand()

R ETURNS
0 Success
1 Failure

FindColumn
Returns the index of the first header column matching the given object and/or variable name.
ElmRes.Load() must be called before using this function.
int ElmRes.FindColumn(DataObject obj,
[str varName]
)
int ElmRes.FindColumn(DataObject obj,
[int startCol]
)
int ElmRes.FindColumn(DataObject obj,
str varName
)

138
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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. ElmRes.Load() must be called
before using this function.
[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.

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. ElmRes.Load() must be called before
using this function.
[int col,
float maxValue] ElmRes.FindMaxOfVariableInRow(str variable,
int row)

A RGUMENTS
variable The variable name

variable The row

maxValue (optional, out)
The corresponding maximum value.

139
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
<0 There is no valid value of the corresponding variable in the row.
≥0 Column index of variable.

FindMaxRowsInColumns
For a given vector of column indices, determines the row indices of the maxima of these
columns. ElmRes.Load() must be called before using this function.
int ElmRes.FindMaxRowsInColumns(DataObject colIndices,
DataObject& rowIndicesOfMaxima)

A RGUMENTS
colIndices
IntDplvec containing the column indices for which the maximum rows are required.
rowIndicesOfMaxima
IntDplvec. Will be resized to the same length as colIndices and filled with the in-
dices of the rows where the corresponding columns have their maximum. Indices
< 0 indicate that the column is empty or does not exist.

R ETURNS
−2 Arguments are of wrong type
−1 Error reading results
0 Success
1 Invalid column indices found

FindMinInColumn
Find the minimum value of the variable in the given column. ElmRes.Load() must be called
before using this function.
[int row,
float value] ElmRes.FindMinInColumn(int column)

A RGUMENTS
column The column index.

value (optional, out)

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.

140
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

FindMinOfVariableInRow
Find the minimum value for the given row and variable. ElmRes.Load() must be called before
using this function.
[int col,
float minValue] ElmRes.FindMinOfVariableInRow(str variable,
int row)

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.

FindMinRowsInColumns
For a given vector of column indices, determines the row indices of the minima of these columns.
ElmRes.Load() must be called before using this function.
int ElmRes.FindMinRowsInColumns(DataObject colIndices,
DataObject& rowIndicesOfMinima)

A RGUMENTS
colIndices
IntDplvec containing the column indices for which the minimum rows are required.
rowIndicesOfMinima
IntDplvec. Will be resized to the same length as colIndices and filled with the
indices of the rows where the corresponding columns have their minimum. Indices
< 0 indicate that the column is empty or does not exist.

R ETURNS
−2 Arguments are of wrong type
−1 Error reading results
0 Success
1 Invalid column indices found

FinishWriting
Finishes the writing of values to a result file.
None ElmRes.FinishWriting()

D EPRECATED N AMES
Close

141
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

GetColumnValues
Get complete column values. ElmRes.Load() must be called before using this function.
int ElmRes.GetColumnValues(DataObject dataVector,
int column)

A RGUMENTS
dataVector
IntVec which will be filled with column values.
column The column index. -1 for default (e.g. time).

R ETURNS
=0 Column values were found.
=1 dataVector is None.
=2 dataVector is not of class IntVec.
=3 Column index is out of range.

GetDescription
Get the description of a column. ElmRes.Load() must be called before using this function.
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

142
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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. ElmRes.Load()
must be called before using this function.
int ElmRes.GetFirstValidObject(int row,
[str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[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,
0 all values are valid (default)
1/-1 valid values must be < limit2
2/-2 valid values must be ≤ limit2

143
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

3/-3 valid values must be > limit2

4/-4 valid values must be ≥ limit2

objects Valid objects

R ETURNS
≥0 column index
<0 no valid column found

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. ElmRes.Load() must be
called before using this function.
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
<0 no valid column found

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. ElmRes.Load()
must be called before using this function.
int ElmRes.GetFirstValidVariable(int row,
[str variableNames]
)

A RGUMENTS
row Result file row.
variableNames (optional)
Comma separated list of valid variable names. The next column with one of
the given variables is searched. If not set all variables are considered as valid
(default).

R ETURNS
≥0 column index
<0 no valid column found

144
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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. ElmRes.Load() must be called
before using this function.
int ElmRes.GetNextValidObject([str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[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:
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,
0 all values are valid (default)
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

145
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
≥0 column index
<0 no valid column found

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.
ElmRes.Load() must be called before using this function.
int ElmRes.GetNextValidObjectVariable([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 not set all variables are considered as valid
(default).

R ETURNS
≥0 column index
<0 no valid column found

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.
ElmRes.Load() must be called before using this function.
int ElmRes.GetNextValidVariable([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 not set all variables are considered as valid
(default).

R ETURNS
≥0 column index
<0 no valid column found

GetNumberOfColumns
Returns the number of variables (columns) in result file excluding the default variable (e.g. time
for time domain simulation). ElmRes.Load() must be called before using this function.
int ElmRes.GetNumberOfColumns()

R ETURNS
Number of variables (columns) in result file.

146
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetNumberOfRows
Returns the number of values per column (rows) stored in result object. ElmRes.Load() must
be called before using this function.
int ElmRes.GetNumberOfRows()

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. ElmRes.Load() must be called before using this function.
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. ElmRes.Load() must be called before using this function.
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. ElmRes.Load() must be called
before using this function.
[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.

147
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 when ok
1 when iX out of bound
2 when col out of bound
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. ElmRes.Load() must be called before using this function.
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.

148
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns the unit which is empty in case that the column index is not part of the data.

GetValue
Returns a value from a result object for row iX of curve col. ElmRes.Load() must be called
before using this function.
[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)
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
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.

GetVariable
Get variable name of column. ElmRes.Load() must be called before using this function.
str ElmRes.GetVariable([int column])

A RGUMENTS
column (optional)
The column index. The variable name of the default variable is returned if the
parameter is nor passed to the function.

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).

149
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

int ElmRes.InitialiseWriting()
int ElmRes.InitialiseWriting(str variableName,
str unit,
str description,
[str shortDescription]
)

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)

150
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
element Element to store in result file

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

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The ElmRes itself remains
unchanged. ElmRes.Load() must be called before using this function.
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()

151
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

WriteDraw
Writes current results to the result objects and updates all plots that display values from the
result object.
int ElmRes.WriteDraw()

R ETURNS
0 on success

5.2.27 ElmShnt
Overview

GetGroundingImpedance

GetGroundingImpedance
Returns the impedance of the internal grounding. Single phase shunts connected to neutral
or R-L type DC shunts 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
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.

5.2.28 ElmStactrl
Overview

GetControlledHVNode
GetControlledLVNode
GetStepupTransformer
Info

152
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.

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

GetStepupTransformer
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

153
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

5.2.29 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.

154
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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
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 connectionCubicles,
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.
connectionCubicles (optional, out)
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.

155
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.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

156
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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)

157
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.30 ElmSvs
Overview

GetStepupTransformer

GetStepupTransformer
Performs a topological search to find the step-up transformer of the static VAR system.
DataObject ElmSvs.GetStepupTransformer(float voltage,
int swStatus
)

A RGUMENTS
voltage voltage level at which the search will stop
swStatus 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).

5.2.31 ElmSym
Overview

CalcEfficiency
Derate
Disconnect
GetAvailableGenPower
GetGroundingImpedance
GetMotorStartingFlag
GetStepupTransformer
IsConnected
Reconnect
ResetDerating

158
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float ElmSym.CalcEfficiency(float activePowerMW)

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

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 ElmSym.Derate(float deratingP)

A RGUMENTS
deratingP Derating value

Disconnect
Disconnects a synchronous machine by opening the first circuit breaker. The topological search
performed to find such a breaker, stops at any busbar.
int ElmSym.Disconnect()

R ETURNS
0 breaker already open or successfully opened
1 an error occurred (no breaker found, open action not possible (earthing / RA))

GetAvailableGenPower
Returns the available power that can be dispatched from the generator, for the particular study
time.
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.

159
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

• 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 ElmSym.GetAvailableGenPower()

R ETURNS
Available generation power

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmSym.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.

GetMotorStartingFlag
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

160
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetStepupTransformer
Performs a topological search to find the step-up transformer of the synchronous machine.
DataObject ElmSym.GetStepupTransformer(float voltage,
int swStatus
)

A RGUMENTS
voltage voltage level at which the search will stop
swStatus 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).

IsConnected
Checks if a synchronous machine is already connected to any busbar.
int ElmSym.IsConnected()

R ETURNS
0 false, not connected to a busbar
1 true, generator is connected to a busbar

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
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 ElmSym.ResetDerating()

161
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.32 ElmTerm
Overview

GetBusType
GetCalcRelevantCubicles
GetConnectedBrkCubicles
GetConnectedCubicles
GetConnectedMainBuses
GetConnectionInfo
GetEquivalentTerminals
GetMinDistance
GetNextHVBus
GetNodeName
GetSepStationAreas
GetShortestPath
GetShortestPathWithIndex
HasCreatedCalBus
InitAllShortestPaths
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).

162
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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
considerSwitches (optional)
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.

163
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

closedAndNonSwitchingDevices
Number of total closed and non-switch devices (closedSwitches + nonSwitch-
ingDevices).
allDevices
Number of total switch and non-switch devices (allSwitches + nonSwitchingDe-
vices).
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& path,]
[list limitToNodes,]
[list elementsToIgnore]
)

A RGUMENTS
term Terminal to which the shortest path is determined.
considerSwitches (optional)
0 Traverse all components, ignore switch states

164
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

1 Do not traverse open switch devices (default)

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

S EE ALSO

ElmTerm.GetShortestPath()

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.

165
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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])

A RGUMENTS
considerSwitches (optional)
Consider switch state (default 1).

R ETURNS
Set of all separate areas in this substation.

GetShortestPath
This function determines the shortest path between the terminal the function was called on
and the terminal that was passed as argument. The shortest path is determined on net-
work topology according to the given settings. If all shortest paths should be returned, use
ElmTerm.InitAllShortestPaths() followed by ElmTerm.GetShortestPathWithIndex().
float ElmTerm.GetShortestPath(DataObject term)
[float minDistance,
list path ] ElmTerm.GetShortestPath(int criterion,
DataObject term,
[int considerSwitches,]
[list& path,]
[list limitToNodes,]
[list elementsToIgnore]
)

A RGUMENTS
criterion
0 According to line length, same as ElmTerm.GetMinDistance()
1 According to node count
2 According to impedance
3 According to resistance
4 According to reactance
term Terminal to which the shortest path is determined.
considerSwitches (optional)
0 Traverse all components, ignore switch states
1 Do not traverse open switch devices (default)
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).

166
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
<0 If there is no path between the two terminals
≥0 Distance of shortest path according to given criterion

S EE ALSO

ElmTerm.GetMinDistance()

GetShortestPathWithIndex
This function returns the shortest path of the given index in the previously cached shortest
paths. Requires function call to ElmTerm.InitAllShortestPaths() beforehand.
list ElmTerm.GetShortestPathWithIndex(int index)

A RGUMENTS
index Index of the path to be retrieved.

R ETURNS
Path at the given index.

E XAMPLE
#assume startTerm and endTerm are objects of class ElmTerm
import powerfactory
app = powerfactory.GetApplicationExt()
script = app.GetCurrentScript()

criterion = 0 #Linelength
number = script.startTerm.InitAllShortestPaths(criterion,endTerm)
app.PrintPlain(number)
for i in range(number):
path = startTerm.GetShortestPathWithIndex(i)
app.PrintPlain(path)

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.

InitAllShortestPaths
This function computes all shortest paths between the terminal the function was called on and
the terminal that was passed as argument. The shortest paths are determined on network
topology according to the given settings. Paths can be retrieved using the function
ElmTerm.GetShortestPathWithIndex().

167
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

int ElmTerm.InitAllShortestPaths(int criterion,

DataObject term,
[int considerSwitches,]
[int pathDifferenceType,]
[list limitToNodes,]
[list elementsToIgnore]
)

A RGUMENTS
criterion
0 According to line length
1 According to node count
2 According to impedance
3 According to resistance
4 According to reactance
term Terminal to which the shortest paths are determined.
considerSwitches (optional)
0 Traverse all components, ignore switch states
1 Do not traverse open switch devices (default)
pathDifferenceType
0 Paths differ in at least one node (default)
1 Paths are edge-disjoint
2 Paths are node-disjoint
limitToNodes(optional)
If given, the shortest paths are searched only within this set of nodes. Please
note, when limiting search to a given set of nodes, the start and end terminals
must be part of this set.
elementsToIgnore(optional)
If given, these objects (e.g. nodes) are ignored in the search and not traversed
(=considered as not existing).

R ETURNS
Number of shortest paths found.

IsElectrEquivalent
Function checks if two terminals are electrically equivalent. Two terminals are said to be
electrically equivalent if they are topologically connected only by

• closed switching devices (ElmCoup, RelFuse) or

• 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
)

168
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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()

IsEquivalent
Function checks if two terminals are topologically connected only by

• closed switching devices (ElmCoup, RelFuse) or

• 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()

169
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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
)

A RGUMENTS
volt Updates nominal voltages (<> 0)
phs Updates phase technology (<> 0)

5.2.33 ElmTow
Overview

Update

Update
Updates line couplings element depending on configuration of the associated tower types or
tower geometries.
None ElmTow.Update()

R ETURNS
1 Line couplings element was updated.
0 Update was not required.

5.2.34 ElmTr2
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetZ0pu
GetZpu
IsQuadBooster
NTap

170
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmTr2.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.

GetSuppliedElements
Returns the network components that are supplied by the transformer.
A transformer is treated as supplying if it is located in a station. Transformers outside stations
are not supplying in this sense.
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.

171
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ElmTr2.GetSuppliedElements([int inclNested])

A RGUMENTS
inclNested (optional)
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)

R ETURNS
Elements supplied by this transformer. The set is empty if the transfomer is located outside
a station or if no element is topologically connected its HV side.

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

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
)

172
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
itappos Tap position
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
itappos Tap position
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)

A RGUMENTS
itappos Tap position
rpu (out) Resistance in p.u.
xpu (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).

173
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.35 ElmTr3
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetTapZDependentSide
GetZ0pu
GetZpu
IsQuadBooster
NTap

CreateEvent
For the corresponding transformer, a Tap Event (EvtTap) is created for the simulation.
None ElmTr3.CreateEvent([int tapAction = 2,]
[int tapPos = 0,]
[int busIdx = 0]
)

A RGUMENTS
tapAction (optional)
0=increase tap; 1=decrease tap; 2=set tap to tapPos; 3=manual; 4=automatic
tapPos (optional)
Position of tap.
busIdx (optional)
Bus index.

174
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmTr3.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.

GetSuppliedElements
Returns the network components that are supplied by the transformer.
A transformer is treated as supplying if it is located in a station. Transformers outside stations
are not supplying in this sense.
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 ElmTr3.GetSuppliedElements([int inclNested])

A RGUMENTS
inclNested (optional)
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)

175
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Elements supplied by this transformer. The set is empty if the transfomer is located outside
a station or if no element is topologically connected its HV side.

S EE ALSO

ElmTr2.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(),
ElmTrfstat.GetSuppliedElements()

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
1 = Includes the vector group phase shift, 0 = consider only the tap phase shift

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
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 and side

GetTapZDependentSide
Get tap side used for the dependent impedance
int ElmTr3.GetTapZDependentSide()

176
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
-1 if no tap dependent impedance is defined
0 for HV tap
1 for MV tap
2 for LV tap

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 ] ElmTr3.GetZ0pu(int itappos,
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
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 ] ElmTr3.GetZpu(int itappos,
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.

177
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

rpu (out) Resistance in p.u.

xpu (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).

IsQuadBooster
Returns whether transformer is a quadbooster or not, i.e. checks phase shift angle modulus
180◦ .
int ElmTr3.IsQuadBooster()

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.36 ElmTr4
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetTapZDependentSide
GetZ0pu
GetZpu
IsQuadBooster
NTap

178
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CreateEvent
For the corresponding transformer, a Tap Event (EvtTap) is created for the simulation.
None ElmTr4.CreateEvent([int tapAction = 2,]
[int tapPos = 0,]
[int busIdx = 0]
)

A RGUMENTS
tapAction (optional)
0=increase tap; 1=decrease tap; 2=set tap to tapPos; 3=manual; 4=automatic
tapPos (optional)
Position of tap.

busIdx (optional)
Bus index.

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmTr4.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.

GetSuppliedElements
Returns the network components that are supplied by the transformer.
A transformer is treated as supplying if it is located in a station. Transformers outside stations
are not supplying in this sense.
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,

179
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

• 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 ElmTr4.GetSuppliedElements([int inclNested])

A RGUMENTS
inclNested (optional)
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)

R ETURNS
Elements supplied by this transformer. The set is empty if the transfomer is located outside
a station or if no element is topologically connected its HV side.

S EE ALSO

ElmTr2.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(),
ElmTrfstat.GetSuppliedElements()

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
1 = Includes the vector group phase shift, 0 = consider only the tap phase shift

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
)

180
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
iSide for tap at side (0=HV, 1=LV1, 2=Lv2, 3=Lv3)
itappos Tap position at corresponding side
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 and side

GetTapZDependentSide
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
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 ] ElmTr4.GetZ0pu(int itappos,
int iSide,
int systembase)

A RGUMENTS
itappos Tap position of the z-dependent tap
iSide
0 Get the HV-LV1 impedance.
1 Get the HV-LV2 impedance.
2 Get the HV-LV3 impedance.
3 Get the LV1-LV2 impedance.
4 Get the LV1-LV3 impedance.
5 Get the LV2-LV3 impedance.
r0pu (out)
Resistance in p.u.
x0pu (out)
Reactance in p.u.

181
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ] ElmTr4.GetZpu(int itappos,
int iSide,
int systembase)

A RGUMENTS
itappos Tap position of the z-dependent tap

iSide
0 Get the HV-LV1 impedance.
1 Get the HV-LV2 impedance.
2 Get the HV-LV3 impedance.
3 Get the LV1-LV2 impedance.
4 Get the LV1-LV3 impedance.
5 Get the LV2-LV3 impedance.
rpu (out) Resistance in p.u.
xpu (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).

IsQuadBooster
Returns whether transformer is a quadbooster or not, i.e. checks phase shift angle modulus
180◦ .
int ElmTr4.IsQuadBooster()

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)

182
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
busIdx 0=HV, 1=MV, 2=LV

R ETURNS
The tap position.

5.2.37 ElmTrain
Overview

SetPosition

SetPosition
Set the position (line and postion in km) of the train
int ElmTrain.SetPosition(DBObject* line, double position)

R ETURNS
1 error, train position cannot be set
0 ok

5.2.38 ElmTrb
Overview

GetGroundingImpedance

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmTrb.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.

183
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.39 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 connectionCubicles,
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.

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
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

ElmTrfstat.GetSplitCal(), ElmTrfstat.GetSplitIndex(),

184
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 connectionCubicles,
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.
connectionCubicles (optional, out)
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
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

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.

R ETURNS
≥0 index of split in which element is contained
-1 given object does not belong to any split of that station

185
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

• 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 ElmTrfstat.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

S EE ALSO

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements()

5.2.40 ElmTrmult
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetZpu
IsQuadBooster
NTap

186
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CreateEvent
For the corresponding transformer, a Tap Event (EvtTap) is created for the simulation.
None ElmTrmult.CreateEvent([int tapAction = 2,]
[int tapPos = 0,]
)

A RGUMENTS
tapAction (optional)
0=increase tap; 1=decrease tap; 2=set tap to tapPos; 3=manual; 4=automatic
tapPos (optional)
Position of tap.

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmTrmult.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.

GetSuppliedElements
Returns the network components that are supplied by the transformer.
A transformer is treated as supplying if it is located in a station. Transformers outside stations
are not supplying in this sense.
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.

187
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ElmTrmult.GetSuppliedElements([int inclNested])

A RGUMENTS
inclNested (optional)
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)

R ETURNS
Elements supplied by this transformer. The set is empty if the transfomer is located outside
a station or if no element is topologically connected its HV side.

S EE ALSO

ElmTr2.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(),
ElmTrfstat.GetSuppliedElements()

GetTapPhi
Gets the tap phase shift in deg of the transformer for given tap position and side.
float ElmTrmult.GetTapPhi(int iSide,
int itappos,
int inclPhaseShift
)

A RGUMENTS
iSide for tap at side iSide

itappos Tap position for corresponding side

inclPhaseShift
1 = Includes the vector group phase shift, 0 = consider only the tap phase shift

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 ElmTrmult.GetTapRatio(int iSide,
int itappos,
int includeNomRatio
)

188
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
iSide for tap at side iSide
itappos Tap position at corresponding side
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 and side

GetZpu
Gets the impedance in p.u. of the transformer between iSide1 and iSide2. The resistance is
that of iSide1 winding.
[float rpu,
float xpu ] ElmTrmult.GetZpu(int iSide1,
int iSide2,
int systembase)

A RGUMENTS
iSide1

iSide2
rpu (out) Resistance in p.u.
xpu (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).

IsQuadBooster
Returns whether transformer is a quadbooster or not, i.e. checks phase shift angle modulus
180◦ .
int ElmTrmult.IsQuadBooster()

R ETURNS
'1' if the transformer phase shift angle modulus 180◦ does not equal 0, else '0'

NTap
Gets the transformer tap position.
int ElmTrmult.NTap()

189
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The tap position.

5.2.41 ElmVac
Overview

GetGroundingImpedance

GetGroundingImpedance
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
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.

5.2.42 ElmVoltreg
Overview

CreateEvent
GetGroundingImpedance
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
tapAction (optional)
0=increase tap; 1=decrease tap; 2=set tap to tapPos; 3=manual; 4=automatic

190
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

tapPos (optional)
Position of tap

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmVoltreg.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.

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
itappos Tap position
rpu (out) Resistance in p.u.
xpu (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).

NTap
Gets the voltage regulator tap position.
int ElmVoltreg.NTap(int tap)

A RGUMENTS
tap 0=Tap 1, 1=Tap 2, 2=Tap 3

191
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The tap position.

5.2.43 ElmVscmono
Overview

GetGroundingImpedance

GetGroundingImpedance
Returns the impedance of the internal grounding. Only thhe DC side is considered to to be
grounded.
[int valid,
float resistance,
float reactance ] ElmVscmono.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.

5.2.44 ElmXnet
Overview

CalcEfficiency
Disconnect
GetGroundingImpedance
GetStepupTransformer
Reconnect

CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float ElmXnet.CalcEfficiency(float activePowerMW)

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

192
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ElmXnet.Disconnect()

R ETURNS
0 breaker already open or successfully opened
1 an error occurred (no breaker found, open action not possible (earthing / RA))

GetGroundingImpedance
Returns the impedance of the internal grounding.
[int valid,
float resistance,
float reactance ] ElmXnet.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.

GetStepupTransformer
Performs a topological search to find the step-up transformer of an external grid
DataObject ElmXnet.GetStepupTransformer(float voltage,
int swStatus
)

A RGUMENTS
voltage voltage level at which the search will stop
swStatus 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).

193
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ElmXnet.Reconnect()

R ETURNS
0 the machine was successfully closed
1 a error occurred and the machine could not be connected to any busbar

5.2.45 ElmZone
Overview

CalculateInterchangeTo
CalculateVoltageLevel
CalculateVoltInterVolt
DefineBoundary
GetAll
GetBranches
GetBuses
GetObjs
SetLoadScaleAbsolute

CalculateInterchangeTo
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

CalculateVoltageLevel
Internal funciton to calculate per voltage level the corresponding summary results. The values
are stored in current zone (values from the previous load flow calculation are overwritten):
int ElmZone.CalculateVoltageLevel(double U)

A RGUMENTS
U for voltage level (in kV)

194
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
<0 error
=0 voltage level not exists in the zone
>0 ok

CalculateVoltInterVolt
This function calculates the power flow from voltage level to voltage level. The values are stored
in current area 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 ElmZone.CalculateVoltInterVolt(double Ufrom,

double Uto)

A RGUMENTS
Ufrom from voltage level (in kV)
Uto to voltage level (in kV)

R ETURNS
<0 error
=0 voltage levels not exists in the area, no interchange exists
>0 ok

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
The defined boundary is returned in case of success. Otherwise NULL, if an error appeared
in the definition of the boundary.

195
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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")

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.

196
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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.

197
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.

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).

198
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 pass-
ing at least one closed switch and stopping at 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.

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.

199
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.

5.3.3 StaExtbrkmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

200
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

CopyExtMeaStatusToStatusTmp
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
0 on success
1 error searching position in mapping table

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtbrkmea.SetStatus() for details on the status bits.
int StaExtbrkmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

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
Status bitfield as an integer value.

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()

201
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
StaExtbrkmea.SetStatus() for details on the status bits.
int StaExtbrkmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

ResetStatusBit
Resets specific bits in the status bitfield. See StaExtbrkmea.SetStatus() for details on the status
bits.
None StaExtbrkmea.ResetStatusBit(int mask, int dbSync)

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
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value for the switch position currently stored in the measurement object.
int StaExtbrkmea.SetMeaValue(int value)

202
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
value New value for switch status.

R ETURNS
Return value has no meaning. It is always 0.

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

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)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBit
Sets specific bits in the status bitfield. See StaExtbrkmea.SetStatus() for details on the status
bits.
None StaExtbrkmea.SetStatusBit(int mask, int dbSync)

203
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtbrkmea.SetStatus()
for details on the status bits.
None StaExtbrkmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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
status Bitfield for status flags, see above

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

204
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.
Note: Calculation results will not be reset by this value transfer.
int StaExtbrkmea.UpdateCtrl(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

5.3.4 StaExtcmdmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtcmdmea.CopyExtMeaStatusToStatusTmp()

205
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
Return value has no meaning. It is always 0.

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtcmdmea.SetStatus() for details on the status bits.
int StaExtcmdmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtcmdmea.SetStatus() for details on the status bits.
int StaExtcmdmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 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)

206
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
StaExtcmdmea.SetStatus() for details on the status bits.
int StaExtcmdmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtcmdmea.SetStatus()
for details on the status bits.
None StaExtcmdmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value stored in the measurement object.
int StaExtcmdmea.SetMeaValue(float value)

A RGUMENTS
value New value.

207
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Return value has no meaning. It is always 0.

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

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 StaExtcmdmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBit
Sets specific bits in the status bitfield. See StaExtcmdmea.SetStatus() for details on the status
bits.
None StaExtcmdmea.SetStatusBit(int mask, int dbSync)

208
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtcmdmea.SetStatus()
for details on the status bits.
None StaExtcmdmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtcmdmea.SetStatus() for details on
the status bits.
None StaExtcmdmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtcmdmea.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

209
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.
Note: Calculation results will not be reset by this value transfer.
int StaExtcmdmea.UpdateCtrl(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

5.3.5 StaExtdatmea
Overview

CopyExtMeaStatusToStatusTmp
CreateEvent
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
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()

210
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 (optional)
Not used.
applyMultiplicator (optional)
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.

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
StaExtdatmea.SetStatus() for details on the status bits.
int StaExtdatmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtdatmea.SetStatus() for details on the status bits.
int StaExtdatmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 StaExtdatmea.InitTmp()

211
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
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
StaExtdatmea.SetStatus() for details on the status bits.
int StaExtdatmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtdatmea.SetStatus()
for details on the status bits.
None StaExtdatmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value stored in the measurement object.
int StaExtdatmea.SetMeaValue(float value)

212
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
value New value.

R ETURNS
Return value has no meaning. It is always 0.

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

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 StaExtdatmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above

dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBit
Sets specific bits in the status bitfield. See StaExtdatmea.SetStatus() for details on the status
bits.
None StaExtdatmea.SetStatusBit(int mask, int dbSync)

213
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtdatmea.SetStatus()
for details on the status bits.
None StaExtdatmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtdatmea.SetStatus() for details on
the status bits.
None StaExtdatmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtdatmea.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

214
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.
Note: Calculation results will not be reset by this value transfer.
int StaExtdatmea.UpdateCtrl(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

5.3.6 StaExtfmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtfmea.CopyExtMeaStatusToStatusTmp()

215
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
Return value has no meaning. It is always 0.

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtfmea.SetStatus() for details on the status bits.
int StaExtfmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtfmea.SetStatus() for details on the status bits.
int StaExtfmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 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)

216
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
StaExtfmea.SetStatus() for details on the status bits.
int StaExtfmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtfmea.SetStatus()
for details on the status bits.
None StaExtfmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value stored in the measurement object.
int StaExtfmea.SetMeaValue(float value)

A RGUMENTS
value New value.

217
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Return value has no meaning. It is always 0.

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

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 StaExtfmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBit
Sets specific bits in the status bitfield. See StaExtfmea.SetStatus() for details on the status bits.
None StaExtfmea.SetStatusBit(int mask, int dbSync)

218
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

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
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtfmea.SetStatus() for details on the
status bits.
None StaExtfmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtfmea.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

219
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.
Note: Calculation results will not be reset by this value transfer.
int StaExtfmea.UpdateCtrl(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

5.3.7 StaExtfuelmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtfuelmea.CopyExtMeaStatusToStatusTmp()

GetMeaValue
Returns the value for fuel currently stored in the measurement object.
[int error,
float value] StaExtfuelmea.GetMeaValue([int unused,]
[int applyMultiplicator])

220
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
value (out)
Value for fuel, optionally multiplied by configured multiplicator
unused (optional)
Not used.
applyMultiplicator (optional)
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
Return value has no meaning. It is always 0.

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtfuelmea.SetStatus() for details on the status bits.
int StaExtfuelmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtfuelmea.SetStatus() for details on the status bits.
int StaExtfuelmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 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)

221
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
StaExtfuelmea.SetStatus() for details on the status bits.
int StaExtfuelmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtfuelmea.SetStatus()
for details on the status bits.
None StaExtfuelmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value stored in the measurement object.
int StaExtfuelmea.SetMeaValue(float value)

A RGUMENTS
value New value.

222
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Return value has no meaning. It is always 0.

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

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 StaExtfuelmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBit
Sets specific bits in the status bitfield. See StaExtfuelmea.SetStatus() for details on the status
bits.
None StaExtfuelmea.SetStatusBit(int mask, int dbSync)

223
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtfuelmea.SetStatus()
for details on the status bits.
None StaExtfuelmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtfuelmea.SetStatus() for details on
the status bits.
None StaExtfuelmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtfuelmea.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

224
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.
Note: Calculation results will not be reset by this value transfer.
int StaExtfuelmea.UpdateCtrl(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

5.3.8 StaExtimea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtimea.CopyExtMeaStatusToStatusTmp()

GetMeaValue
Returns the value for current currently stored in the measurement object.
[int error,
float value] StaExtimea.GetMeaValue([int phase,]
[int applyMultiplicator])

225
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
value (out)
Value for current, optionally multiplied by configured multiplicator
phase (optional)
If measurement is unbalanced specifies which value to get.

0 Current of phase 1 (default)

1 Current of phase 2
2 Current of phase 3
applyMultiplicator (optional)
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
Return value has no meaning. It is always 0.

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtimea.SetStatus() for details on the status bits.
int StaExtimea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtimea.SetStatus() for details on the status bits.
int StaExtimea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 StaExtimea.InitTmp()

226
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
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
StaExtimea.SetStatus() for details on the status bits.
int StaExtimea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtimea.SetStatus()
for details on the status bits.
None StaExtimea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

227
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetMeaValue
Sets the value stored in the measurement object.
int StaExtimea.SetMeaValue(float value,
[int phase,]
[int copyToCtrlObj,]
[int dbSync])

A RGUMENTS
value New value.
phase (optional)
If measurement is unbalanced specifies which value to set.
0 Current of phase 1 (default)
1 Current of phase 2
2 Current of phase 3
copyToCtrlObj (optional)
Only for balanced measurement object. Default 0 (=off), else sets value addition-
ally to variables of controlled object with given “dbSync” mode.

dbSync (optional)
Only relevant if parameter “copyToCtrlObj” is non-zero, see descriptiong there.

R ETURNS
0 on success
1 copying to controlled object was selected but measurement is unbalanced

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

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

228
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None StaExtimea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

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
mask Mask of bits to set to 1. A bit is unchanged if already set before.

dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtimea.SetStatus() for
details on the status bits.
None StaExtimea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtimea.SetStatus() for details on the
status bits.
None StaExtimea.SetStatusTmp(int status)

229
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtimea.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.
Note: Calculation results will not be reset by this value transfer.
int StaExtimea.UpdateCtrl(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

230
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.9 StaExtpfmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtpfmea.CopyExtMeaStatusToStatusTmp()

GetMeaValue
Returns the value for power factor currently stored in the measurement object.
[int error,
float value] StaExtpfmea.GetMeaValue([int unused,]
[int applyMultiplicator])

A RGUMENTS
value (out)
Value for current, optionally multiplied by configured multiplicator
unused (optional)
Not used.
applyMultiplicator (optional)
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
Return value has no meaning. It is always 0.

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtpfmea.SetStatus() for details on the status bits.
int StaExtpfmea.GetStatuts()

231
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtpfmea.SetStatus() for details on the status bits.
int StaExtpfmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 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
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
StaExtpfmea.SetStatus() for details on the status bits.
int StaExtpfmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

232
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
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 StaExtpfmea.SetStatus()
for details on the status bits.
None StaExtpfmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value stored in the measurement object.
int StaExtpfmea.SetMeaValue(float value)

A RGUMENTS
value New value.

R ETURNS
Return value has no meaning. It is always 0.

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

bit1 0x00000002 Tele-Measurement
bit2 0x00000004 Disturbance
bit3 0x00000008 Protection
bit4 0x00000010 Marked suspect
bit5 0x00000020 Violated constraint

233
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 StaExtpfmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

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
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtpfmea.SetStatus() for
details on the status bits.
None StaExtpfmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

234
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 StaExtpfmea.SetStatus() for details on
the status bits.
None StaExtpfmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtpfmea.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.
Note: Calculation results will not be reset by this value transfer.
int StaExtpfmea.UpdateCtrl(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

235
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.10 StaExtpmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtpmea.CopyExtMeaStatusToStatusTmp()

GetMeaValue
Returns the value for active power stored in the measurement object.
[int error,
float value] StaExtpmea.GetMeaValue([int phase,]
[int applyMultiplicator])

A RGUMENTS
value (out)
Value for active power, optionally multiplied by configured multiplicator
phase (optional)
If measurement is unbalanced specifies which value to get.
0 Active power of phase 1 (default)
1 Active power of phase 2
2 active power of phase 3

applyMultiplicator (optional)
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
Return value has no meaning. It is always 0.

236
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtpmea.SetStatus() for details on the status bits.
int StaExtpmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtpmea.SetStatus() for details on the status bits.
int StaExtpmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 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
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
StaExtpmea.SetStatus() for details on the status bits.
int StaExtpmea.IsStatusBitSetTmp(int mask)

237
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtpmea.SetStatus()
for details on the status bits.
None StaExtpmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value stored in the measurement object.
int StaExtpmea.SetMeaValue(float value,
[int phase,]
[int copyToCtrlObj,]
[int dbSync])

A RGUMENTS
value New value.
phase (optional)
If measurement is unbalanced specifies which value to set.
0 Active power of phase 1 (default)
1 Active power of phase 2
2 Active power of phase 3
copyToCtrlObj (optional)
Only for balanced measurement object. Default 0 (=off), else sets value addition-
ally to variables of controlled object with given “dbSync” mode.
dbSync (optional)
Only relevant if parameter “copyToCtrlObj” is non-zero, see descriptiong there.

238
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 on success
1 copying to controlled object was selected but measurement is unbalanced

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

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 StaExtpmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above

dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBit
Sets specific bits in the status bitfield. See StaExtpmea.SetStatus() for details on the status
bits.
None StaExtpmea.SetStatusBit(int mask, int dbSync)

239
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtpmea.SetStatus() for
details on the status bits.
None StaExtpmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtpmea.SetStatus() for details on
the status bits.
None StaExtpmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtpmea.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

240
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.
Note: Calculation results will not be reset by this value transfer.
int StaExtpmea.UpdateCtrl(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

5.3.11 StaExtqmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtqmea.CopyExtMeaStatusToStatusTmp()

GetMeaValue
Returns the value for reactive power currently stored in the measurement object.
[int error,
float value] StaExtqmea.GetMeaValue([int phase,]
[int applyMultiplicator])

241
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
value (out)
Value for reactive power, optionally multiplied by configured multiplicator
phase (optional)
If measurement is unbalanced specifies which value to get.

0 Reactive power of phase 1 (default)

1 Reactive power of phase 2
2 Reactive power of phase 3
applyMultiplicator (optional)
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
Return value has no meaning. It is always 0.

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtqmea.SetStatus() for details on the status bits.
int StaExtqmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtqmea.SetStatus() for details on the status bits.
int StaExtqmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 StaExtqmea.InitTmp()

242
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
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
StaExtqmea.SetStatus() for details on the status bits.
int StaExtqmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtqmea.SetStatus()
for details on the status bits.
None StaExtqmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

243
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetMeaValue
Sets the value stored in the measurement object.
int StaExtqmea.SetMeaValue(float value,
[int phase,]
[int copyToCtrlObj,]
[int dbSync])

A RGUMENTS
value New value.
phase (optional)
If measurement is unbalanced specifies which value to set.
0 Reactive power of phase 1 (default)
1 Reactive power of phase 2
2 Reactive power of phase 3
copyToCtrlObj (optional)
Only for balanced measurement object. Default 0 (=off), else sets value addition-
ally to variables of controlled object with given “dbSync” mode.

dbSync (optional)
Only relevant if parameter “copyToCtrlObj” is non-zero, see descriptiong there.

R ETURNS
0 on success
1 copying to controlled object was selected but measurement is unbalanced

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

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

244
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None StaExtqmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

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
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtqmea.SetStatus() for
details on the status bits.
None StaExtqmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtqmea.SetStatus() for details on
the status bits.
None StaExtqmea.SetStatusTmp(int status)

245
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtqmea.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.
Note: Calculation results will not be reset by this value transfer.
int StaExtqmea.UpdateCtrl(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

246
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.12 StaExtsmea
Overview

CopyExtMeaStatusToStatusTmp
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtsmea.CopyExtMeaStatusToStatusTmp()

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtsmea.SetStatus() for details on the status bits.
int StaExtsmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtsmea.SetStatus() for details on the status bits.
int StaExtsmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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.

247
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

This function should be called once after the link has been established and before the calculation
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
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
StaExtsmea.SetStatus() for details on the status bits.
int StaExtsmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtsmea.SetStatus()
for details on the status bits.
None StaExtsmea.ResetStatusBitTmp(int mask)

248
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

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

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 StaExtsmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBit
Sets specific bits in the status bitfield. See StaExtsmea.SetStatus() for details on the status
bits.
None StaExtsmea.SetStatusBit(int mask, int dbSync)

249
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtsmea.SetStatus() for
details on the status bits.
None StaExtsmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtsmea.SetStatus() for details on
the status bits.
None StaExtsmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtsmea.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

250
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.
Note: Calculation results will not be reset by this value transfer.
int StaExtsmea.UpdateCtrl(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

5.3.13 StaExttapmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
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 type,]
[int useTranslationTable])

251
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
value (out)
Value.
type (optional)
type of value to return
0 tap position (default)
1 operation mode
2 tap changer command
3 tap operation mode
4 tap operation mode command
useTranslationTable (optional)
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

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExttapmea.SetStatus() for details on the status bits.
int StaExttapmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExttapmea.SetStatus() for details on the status bits.
int StaExttapmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 StaExttapmea.InitTmp()

252
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
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
StaExttapmea.SetStatus() for details on the status bits.
int StaExttapmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

ResetStatusBit
Resets specific bits in the status bitfield. See StaExttapmea.SetStatus() for details on the status
bits.
None StaExttapmea.ResetStatusBit(int mask, int dbSync)

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 StaExttapmea.SetStatus()
for details on the status bits.
None StaExttapmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

253
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetMeaValue
Sets the value stored in the measurement object.
int StaExttapmea.SetMeaValue(float value,
[int type],
[int copyToCtrlObj],
[int dbSync])

A RGUMENTS
value New value.
type (optional)
type of value to set
0 tap position (default)
1 operation mode
2 tap changer command
3 tap operation mode
4 tap operation mode command
copyToCtrlObj (optional)
Only for “type” is 0 or 1. Default 0 (=off), else sets value additionally to variables
of controlled object with given “dbSync” mode.
dbSync (optional)
Default 1(=on), synchronices set value to DB.

R ETURNS
0 on success
0 on error

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

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.

254
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit29 0x20000000 Read

bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None StaExttapmea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

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
mask Mask of bits to set to 1. A bit is unchanged if already set before.
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExttapmea.SetStatus()
for details on the status bits.
None StaExttapmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExttapmea.SetStatus() for details on
the status bits.
None StaExttapmea.SetStatusTmp(int status)

255
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
status Bitfield for status flags, see above

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 StaExttapmea.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.
Note: Calculation results will not be reset by this value transfer.
int StaExttapmea.UpdateCtrl(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

256
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.14 StaExtv3mea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtv3mea.CopyExtMeaStatusToStatusTmp()

GetMeaValue
Returns the value for voltage currently stored in the measurement object.
[int error,
float value] StaExtv3mea.GetMeaValue([int unused,]
[int applyMultiplicator])

A RGUMENTS
value (out)
Value for voltage, optionally multiplied by configured multiplicator
phase (optional)
Index of desired phase. Index must be 0 (default), 1 or 2.
applyMultiplicator (optional)
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
0 on success
1 on error, e.g. phase index does not exist

257
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtv3mea.SetStatus() for details on the status bits.
int StaExtv3mea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtv3mea.SetStatus() for details on the status bits.
int StaExtv3mea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 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
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
StaExtv3mea.SetStatus() for details on the status bits.
int StaExtv3mea.IsStatusBitSetTmp(int mask)

258
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtv3mea.SetStatus()
for details on the status bits.
None StaExtv3mea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value stored in the measurement object.
int StaExtv3mea.SetMeaValue(float value,
[int meaIdx])

A RGUMENTS
value New value.
meaIdx (optional)
Specifies which value to set.

0 Measured voltage of measurement 1 (default)

1 Measured voltage of measurement 2
2 Measured voltage of measurement 3

R ETURNS
0 on success
1 on error, meaIdx out of range

259
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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 StaExtv3mea.SetStatus(int status, int dbSync)

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

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
mask Mask of bits to set to 1. A bit is unchanged if already set before.

dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

260
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtv3mea.SetStatus() for
details on the status bits.
None StaExtv3mea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtv3mea.SetStatus() for details on
the status bits.
None StaExtv3mea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

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 StaExtv3mea.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.
Note: Calculation results will not be reset by this value transfer.
int StaExtv3mea.UpdateCtrl(int dbSync)

261
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

5.3.15 StaExtvmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

CopyExtMeaStatusToStatusTmp
Copies the (persistent) status of current measurement object to temporary (in memory) status.
None StaExtvmea.CopyExtMeaStatusToStatusTmp()

GetMeaValue
Returns the value for voltage currently stored in the measurement object.
[int error,
float value] StaExtvmea.GetMeaValue([int phase,]
[int applyMultiplicator])

A RGUMENTS
value (out)
Value for voltage, optionally multiplied by configured multiplicator
phase (optional)
If measurement is unbalanced specifies which value to get, also depending on
voltage input type of the measurement object.
0 Measured voltage of Phase 1 - Ground or Phase 1 - Phase 2 (default)

262
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

1 Measured voltage of Phase 2 - Ground or Phase 2 - Phase 3

2 Measured voltage of Phase 3 - Ground or Phase 3 - Phase 1

applyMultiplicator (optional)
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
Return value has no meaning. It is always 0.

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See
StaExtvmea.SetStatus() for details on the status bits.
int StaExtvmea.GetStatuts()

R ETURNS
Status bitfield as an integer value.

GetStatusTmp
Returns the temporary (in memory) status flags. Please note, this value is interpreted as a
bitfield. See StaExtvmea.SetStatus() for details on the status bits.
int StaExtvmea.GetStatusTmp()

R ETURNS
Status bitfield as an integer value.

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 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)

263
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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
StaExtvmea.SetStatus() for details on the status bits.
int StaExtvmea.IsStatusBitSetTmp(int mask)

R ETURNS
0 if at least one bit in mask is not set
1 if all bit(s) in mask are set

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
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 StaExtvmea.SetStatus()
for details on the status bits.
None StaExtvmea.ResetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 0. A bit is unchanged if already unset before.

SetMeaValue
Sets the value stored in the measurement object.
int StaExtvmea.SetMeaValue(float value,
[int phase],
[int copyToCtrlObj],
[int dbSync])

264
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
value New value.
phase (optional)
If measurement is unbalanced specifies which value to set, also depending on
voltage input type of the measurement object.

0 Measured voltage of Phase 1 - Ground or Phase 1 - Phase 2 (default)

1 Measured voltage of Phase 2 - Ground or Phase 2 - Phase 3
2 Measured voltage of Phase 3 - Ground or Phase 3 - Phase 1
copyToCtrlObj (optional)
Only for balanced measurement object. Default 0 (=off), else sets value addition-
ally to variables of controlled object with given “dbSync” mode.
dbSync (optional)
Only relevant if parameter “copyToCtrlObj” is non-zero, see descriptiong there.

R ETURNS
0 on success
1 copying to controlled object was selected but measurement is unbalanced

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

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 StaExtvmea.SetStatus(int status, int dbSync)

265
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
status Bitfield for status flags, see above
dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

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
mask Mask of bits to set to 1. A bit is unchanged if already set before.

dbSync (optional)
0 New status flags are applied in memory only
1 Default, new status flags are stored on db (persistent)

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See StaExtvmea.SetStatus() for
details on the status bits.
None StaExtvmea.SetStatusBitTmp(int mask)

A RGUMENTS
mask Mask of bits to set to 1. A bit is unchanged if already set before.

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 StaExtvmea.SetStatus() for details on
the status bits.
None StaExtvmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

266
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 StaExtvmea.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.
Note: Calculation results will not be reset by this value transfer.
int StaExtvmea.UpdateCtrl(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

5.3.16 StaSwitch
Overview

Close
IsClosed
IsOpen
Open

267
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 StaSwitch.Close()

R ETURNS
0 On success
6= 0 On error

S EE ALSO

StaSwitch.Open()

IsClosed
Returns information about current switch state.
int StaSwitch.IsClosed()

R ETURNS
1 switch is closed
0 switch is open

S EE ALSO

StaSwitch.IsOpen()

IsOpen
Returns information about current switch state.
int StaSwitch.IsOpen()

R ETURNS
1 switch is open
0 switch is closed

S EE ALSO

StaSwitch.IsClosed()

Open
Opens the switch by changing its status to ’open’. This action will fail if the status is currently
determined by an active running arrangement.
int StaSwitch.Open()

R ETURNS
0 On success
6= 0 On error

268
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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 valid plot object (classname should either be
PltLinebarplot or it should start with Vis).
4 The object plot was found in any open graphic.
5 The object plot is not a diagram.
6 An internal error occured (plot is incomplete).

269
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
1 An error occurred.

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)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.

270
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
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 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
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.

271
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
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.
• 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
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
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

272
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.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
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

size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

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.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineDoubleVector shall be used instead.

S EE ALSO

ComAddon.DefineDoubleVector()

273
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

DefineInteger
Creates a new integer parameter for the given type of objects.
int ComAddon.DefineInteger(str class,
str name,
str desc,
str unit,
int initial)

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.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
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

274
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineInteger shall be used instead.

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
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
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

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.DefineInteger() ComAddon.DefineIntegerPerConnection()

275
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
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
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

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.
• The elements of class are not branch elements. Therefore there is no con-
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
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

initial Default object of new parameter

276
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.DefineObjectPerConnection()

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
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
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.
• The elements of class are not branch elements. Therefore there is no con-
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)

277
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

initial Default value of new parameter.

size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

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.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
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.

initial Default value of new parameter.
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

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.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineObjectVector shall be used instead.

278
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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)

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.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
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

279
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineString shall be used instead.

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.

280
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComAddon.SetActiveModule()

ModuleExists
Checks if the module for this add-on was already created using the method CreateModule.
int ComAddon.ModuleExists()

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.

281
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.4 ComArcreport
Overview

GetLocationsToReport
GetUnitFor
GetValueFor
IsDguv
IsEpri

GetLocationsToReport
Returns the accessible locations with stored results, i.e. which can be reported.
list ComArcreport.GetLocationsToReport()

R ETURNS
Container with reportable accessible locations.

GetUnitFor
Returns the unit for the given variable. The unit corresponds the selected display unit for each
variable at the time the result file was read.
str ComArcreport.GetUnitFor(str variable)

A RGUMENTS
variable Variable for which to retrieve the unit.

R ETURNS
The unit or an empty string if no stored result exists for the given arguments.

GetValueFor
Returns the stored value for the given location and variable.
float ComArcreport.GetValueFor(DataObject location,
str variable,
[int arc])

A RGUMENTS
location Accessible location for which to retrieve the result.
variable Variable for which to retrieve the result. In addition to the arc-flash related monitor
variables stored in the result file, the following artificial variables can be retrieved.
The availablility of the artificial variables dependes on the arc-flash standard used
to write the result file.
m:Ik Short-circuit current
m:Ikmax Max. short-circuit current
m:Ikmin Min. short-circuit current
arc (optional)
Flag which result should be retrieved:

282
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

-1 Worst case (default)

0 Full arcing current
1 Reduced arcing current

R ETURNS
The stored value or 0.0 if no stored result exists for the given arguments.

IsDguv
Returns whether or not the results were written for a DGUV 203-077 calculation.
int ComArcreport.IsDguv()

R ETURNS
1 The results were written for a DGUV 203-077 calculation.
0 The results were written for different calculation.

IsEpri
Returns whether or not the results were written for an EPRI calculation.
int ComArcreport.IsEpri()

R ETURNS
1 The results were written for an EPRI calculation.
0 The results were written for a different calculation.

5.4.5 ComAuditlog
Overview

Check

Check
Checks integrity of Audit Log.
int ComAuditlog.Check()

R ETURNS
number of errors

283
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.6 ComBoundary
Overview

GetCreatedBoundaries

GetCreatedBoundaries
Gets created boundaries after the command has been executed.
list ComBoundary.GetCreatedBoundaries()

R ETURNS
Container of created boundaries.

5.4.7 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

284
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

285
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.8 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

E XAMPLE
The following example exports CIM archive to a file using a preconfigured CIM Data Export
command from the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

cimdbexp = app.GetFromStudyCase("ComCimdbexp")
result = cimdbexp.Execute()
if result == 0:
app.PrintInfo("OK")
else:
app.PrintError("Error: export failed")

5.4.9 ComCimdbimp
Overview

Execute
ImportAndConvert

286
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
is executed. Possible values are
0 Do not validate
1 Validate

R ETURNS
0 OK
1 Error: import failed

E XAMPLE
The following example creates a new CIM Data Import command, configures it and imports
the data into the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

cimdbimp = app.GetFromStudyCase("ComCimdbimp")
cimdbimp.SetAttribute("targetName", "testArchive")
cimdbimp.SetAttribute("fileName", "E:\\test\\test.zip")
result = cimdbimp.Execute()
if result == 0:
app.PrintInfo("OK")
else:
app.PrintError("Error: import failed")

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
is executed. Possible values are
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.

287
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 OK
1 Error: import failed
2 Error: conversion failed

E XAMPLE
The following example imports and converts a CimArchive from a specified ZIP file.
import powerfactory
app = powerfactory.GetApplicationExt()

cimdbimp = app.GetFromStudyCase("ComCimdbimp")
cimdbimp.SetAttribute("fileName", "E:\\test\\test.zip")
result = cimdbimp.ImportAndConvert()
if result == 0:
app.PrintInfo("OK")
elif result == 1:
app.PrintError("Error: import failed")
else:
app.PrintError("Error: conversion failed")

5.4.10 ComCimtogrid
Overview

AppendMessage
GetMessageDescription
GetMessageObject
GetMessageSeverity
GetNumberOfMessages

AppendMessage
Appends the conversion message.
None ComCimtogrid.AppendMessage(str severity,
str description,
str objectFullname
)

A RGUMENTS
severity Message severity.
description
Message description.
objectFullname
Full name of the object for which the message is reported, or type and name of
the object.

E XAMPLE
The following example appends the conversion message.
import powerfactory
app = powerfactory.GetApplicationExt()

288
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

cimtogrid = app.GetFromStudyCase("ComCimtogrid")
objectFullname = cimtogrid.GetFullName()
cimtogrid.AppendMessage("Warning",
"This is a sample message.",
objectFullname)

GetMessageDescription
Returns the description from the selected conversion message.
str ComCimtogrid.GetMessageDescription(int messageIndex)

A RGUMENTS
messageIndex
Index of the conversion message.

R ETURNS
Message description.

E XAMPLE
The following example prints the description text from each conversion message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimtogrid = app.GetFromStudyCase("ComCimtogrid")
nMessages = cimtogrid.GetNumberOfMessages()
for i in range(nMessages):
descriptionText = cimtogrid.GetMessageDescription(i)
app.PrintInfo("%s" % descriptionText)

GetMessageObject
Returns the object from the selected conversion message.
str ComCimtogrid.GetMessageObject(int messageIndex)

A RGUMENTS
messageIndex
Index of the conversion message.

R ETURNS
Object for which the message is reported.

E XAMPLE
The following example prints the object from each conversion message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimtogrid = app.GetFromStudyCase("ComCimtogrid")
nMessages = cimtogrid.GetNumberOfMessages()

289
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

for i in range(nMessages):
messageObject = cimtogrid.GetMessageObject(i)
app.PrintInfo("%s" % messageObject)

GetMessageSeverity
Returns the severity of the selected conversion message.
str ComCimtogrid.GetMessageSeverity(int messageIndex)

A RGUMENTS
messageIndex
Index of the conversion message.

R ETURNS
Message severity.

E XAMPLE
The following example prints the severity for each conversion message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimtogrid = app.GetFromStudyCase("ComCimtogrid")
nMessages = cimtogrid.GetNumberOfMessages()
for i in range(nMessages):
severity = cimtogrid.GetMessageSeverity(i)
app.PrintInfo("%s" % severity)

GetNumberOfMessages
Returns the number of conversion messages generated.
int ComCimtogrid.GetNumberOfMessages()

R ETURNS
Number of conversion messages.

E XAMPLE
The following example prints the number of conversion messages got for the last grid to CIM
conversion.
import powerfactory
app = powerfactory.GetApplicationExt()

cimtogrid = app.GetFromStudyCase("ComCimtogrid")
nMessages = cimtogrid.GetNumberOfMessages()
app.PrintInfo("Number of messages: %d" % nMessages)

290
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.11 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
0 Do not open report
1 Open report

R ETURNS
0 OK
1 Error: validation failed

E XAMPLE
The following example executes the validation for the configured CIM Data Validation (Com-
Cimvalidate) command in the active project. In case of error the validation report is not
opened.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
error = cimvalidate.Execute(0)
if error == 0:
app.PrintInfo("OK")
else:
app.PrintError("Error: validation failed")

GetClassType
Returns the object class type from the selected validation message.
str ComCimvalidate.GetClassType(int messageIndex)

291
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Object class type.

E XAMPLE
The following example prints the object class type from each validation message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
for i in range(nMessages):
classType = cimvalidate.GetClassType(i)
app.PrintInfo("%s" % classType)

GetDescriptionText
Returns the description from the selected validation message.
str ComCimvalidate.GetDescriptionText(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Message description.

E XAMPLE
The following example prints the description text from each validation message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
for i in range(nMessages):
descriptionText = cimvalidate.GetDescriptionText(i)
app.PrintInfo("%s" % descriptionText)

GetInputObject
Returns the object selected for validation.
DataObject ComCimvalidate.GetInputObject()

R ETURNS
Pointer to CimArchive, CimModel, or SetSelect.

292
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

E XAMPLE
The following example prints the class of object and object selected for validation in the active
project.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
selectedObject = cimvalidate.GetInputObject()
objectClass = selectedObject.GetClassName()
app.PrintInfo("%s: %s" % (objectClass, selectedObject))

GetModel
This function is deprecated. Please use ComCimValidate.GetObject() to access to the CIM
model, or CIM object affected by the validation message.
DataObject ComCimvalidate.GetModel(int messageIndex)

E XAMPLE
The following example prints the CimModel object for each validation message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
for i in range(nMessages):
object = cimvalidate.GetObject(i)
if object.GetClassName() == "CimModel":
cimModel = object
else:
cimClassFolder = object.GetParent()
cimModel = cimClassFolder.GetParent()
app.PrintInfo(cimModel)

GetModelId
This function is deprecated. Please use ComCimValidate.GetObject() to access to the CIM
model, or CIM object affected by the validation message.
str ComCimvalidate.GetModelId(int messageIndex)

E XAMPLE
The following example prints the ID of the CIM model for each validation message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
for i in range(nMessages):
object = cimvalidate.GetObject(i)
if object.GetClassName() == "CimModel":

293
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

modelId = object.GetAttribute("resID")
else:
cimClassFolder = object.GetParent()
model = cimClassFolder.GetParent()
modelId = model.GetAttribute("resID")
app.PrintInfo(modelId)

GetNumberOfValidationMessages
Returns the number of validation messages generated.
int ComCimvalidate.GetNumberOfValidationMessages()

R ETURNS
Number of validation messages.

E XAMPLE
The following example prints the number of validation messages got for the last CIM data
validation.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
app.PrintInfo("Number of validation messages: %d" % nMessages)

GetObject
Returns the CimObject object from the selected validation message.
DataObject ComCimvalidate.GetObject(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Pointer to CimObject.

E XAMPLE
The following example prints the CimObject object from each validation message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
for i in range(nMessages):
cimObject = cimvalidate.GetObject(i)
app.PrintInfo("%s" % cimObject)

294
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetObjectId
This function is deprecated. Please use ComCimValidate.GetObject() to access to the CIM
model, or CIM object affected by the validation message.
str ComCimvalidate.GetObjectId(int messageIndex)

E XAMPLE
The following example prints the object ID for each validation message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
for i in range(nMessages):
object = cimvalidate.GetObject(i);
objectId = object.GetAttribute("resID")
app.PrintInfo(objectId)

GetProfile
Returns the model profile from the selected validation message.
str ComCimvalidate.GetProfile(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Model profile.

E XAMPLE
The following example prints the profile for each validation message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
for i in range(nMessages):
profile = cimvalidate.GetProfile(i)
app.PrintInfo("%s" % profile)

GetSeverity
Returns the severity of the selected validation message.
str ComCimvalidate.GetSeverity(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

295
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
Message severity.

E XAMPLE
The following example prints the severity for each validation message.
import powerfactory
app = powerfactory.GetApplicationExt()

cimvalidate = app.GetFromStudyCase("ComCimvalidate")
nMessages = cimvalidate.GetNumberOfValidationMessages()
for i in range(nMessages):
severity = cimvalidate.GetSeverity(i)
app.PrintInfo("%s" % severity)

GetType
This function is deprecated. There is no replacement function offered. Please use ComCimVal-
idate.GetDescriptionText() to retrieve the description of the validation message instead.
str ComCimvalidate.GetType(int messageIndex)

5.4.12 ComConreq
Overview

Execute

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

296
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.13 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)

A RGUMENTS
resultFileInput
Read from this result file.

R ETURNS
0 On success.
1 On error.

297
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ 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.
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.

298
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 On error.

GetInterruptedPowerAndCustomersForTimeStep
Gets recovery information of a contingency.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ float interruptedPower,
float newInterruptedPower,
float interruptedCustomers,
float newInterruptedCustomers ]
ComContingency.
GetInterruptedPowerAndCustomersForTimeStep(int currentTimeStep)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via
ComContingency.GetNumberOfTimeSteps()
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.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ DataObject load,
float changedP,
float changedQ,
int isTransfer ]
ComContingency.GetLoadEvent(int currentTimeStep,
int loadEvent)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via
ComContingency.GetNumberOfTimeSteps()
switchEvent
Input: Number of load events for a certain time step are get via ComContin-
gency.GetNumberOfSwitchEventsForTimeStep()
load (out) Output: Load that is shed or transfered

299
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetNumberOfGeneratorEventsForTimeStep([int currentTimeStep])

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via
ComContingency.GetNumberOfTimeSteps()

GetNumberOfLoadEventsForTimeStep
Returns the number of load events of a certain step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetNumberOfLoadEventsForTimeStep([int currentTimeStep])

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via
ComContingency.GetNumberOfTimeSteps()

GetNumberOfSwitchEventsForTimeStep
Returns the number of switch events of a certain step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetNumberOfSwitchEventsForTimeStep([int currentTimeStep])

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via
ComContingency.GetNumberOfTimeSteps()

GetNumberOfTimeSteps
Returns the number of time steps during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetNumberOfTimeSteps()

300
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ DataObject switchToBeActuated,
int isClosed,
int sectionalizingStep ]
ComContingency.GetSwitchEvent(int currentTimeStep,
int switchEvent)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via
ComContingency.GetNumberOfTimeSteps()

switchEvent
Input: Number of switch event for a certain time step are get via ComContin-
gency.GetNumberOfSwitchEventsForTimeStep()
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

GetTimeOfStepInSeconds
Returns the time of the current step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetTimeOfStepInSeconds(int currentTimeStep)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via
ComContingency.GetNumberOfTimeSteps()

301
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

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.

302
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.14 ComCoordreport
Overview

DevicesToReport
HasResultsForDirectionalBackup
HasResultsForFuse
HasResultsForInstantaneous
HasResultsForNonDirectionalBackup
HasResultsForOverload
HasResultsForOverreach
HasResultsForShortCircuit
HasResultsForZone
MaxZoneNumberFor
ResultForDirectionalBackupVariable
ResultForFuseVariable
ResultForInstantaneousVariable
ResultForMaxCurrent
ResultForNonDirectionalBackupVariable
ResultForOverloadVariable
ResultForOverreachVariable
ResultForShortCircuitVariable
ResultForZoneVariable
TopologyForDirectionalBackupVariable
TopologyForFuseVariable
TopologyForInstantaneousVariable
TopologyForMaxCurrent
TopologyForNonDirectionalBackupVariable
TopologyForOverloadVariable
TopologyForOverreachVariable
TopologyForShortCircuitVariable
TopologyForZoneVariable
TransferDirectionalBackupResultsTo
TransferNonDirectionalBackupResultsTo
TransferOverreachResultsTo
TransferResultsTo
TransferZoneResultsTo

303
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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(),
ComCoordreport.HasResultsForNonDirectionalBackup()

HasResultsForFuse
Checks whether there is a stored fuse result for the given device.
int ComCoordreport.HasResultsForFuse(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An fuse result is stored for this device.
0 The device has no stored results or no fuse result.

HasResultsForInstantaneous
Checks whether there is a stored instantaneous stage result for the given device.
int ComCoordreport.HasResultsForInstantaneous(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An instantaneous stage result is stored for this device.
0 The device has no stored results or no result for the instantaneous stage.

304
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.HasResultsForOverload(),
ComCoordreport.HasResultsForShortCircuit()

HasResultsForNonDirectionalBackup
Checks whether there is a stored non-directional backup result for the given device.
int ComCoordreport.HasResultsForNonDirectionalBackup(object device)

A RGUMENTS
device Device for which to check.

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(),
ComCoordreport.HasResultsForDirectionalBackup()

HasResultsForOverload
Checks whether there is a stored overload stage result for the given device.
int ComCoordreport.HasResultsForOverload(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An overload stage result is stored for this device.
0 The device has no stored results or no result for the overload stage.

S EE ALSO

ComCoordreport.HasResultsForShortCircuit(),
ComCoordreport.HasResultsForInstantaneous()

HasResultsForOverreach
Checks whether there is a stored overreach zone result for the given device.
int ComCoordreport.HasResultsForOverreach(DataObject device)

A RGUMENTS
device Device for which to check.

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.

305
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.HasResultsForZone(),
ComCoordreport.HasResultsForDirectionalBackup(),
ComCoordreport.HasResultsForNonDirectionalBackup()

HasResultsForShortCircuit
Checks whether there is a stored short-circuit stage result for the given device.
int ComCoordreport.HasResultsForShortCircuit(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An short-circuit stage result is stored for this device.
0 The device has no stored results or no result for the short-circuit stage.

S EE ALSO

ComCoordreport.HasResultsForOverload(),
ComCoordreport.HasResultsForInstantaneous()

HasResultsForZone
Checks whether there is a stored result for the given device and zone number.
int ComCoordreport.HasResultsForZone(DataObject device,
int zoneNumber)

A RGUMENTS
device Device for which to check.
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.

306
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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)

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).
4 The correponding equation required a nominal current and none could be deter-
mined.

S EE ALSO

ComCoordreport.ResultForZoneVariable(),
ComCoordreport.ResultForOverreachVariable(),
ComCoordreport.ResultForNonDirectionalBackupVariable()

ResultForFuseVariable
Provides access to the fuse result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForFuseVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.
variable Variable for which to retrieve the result:
char Overcurrent characteristic
dir Tripping direction
Iset Overcurrent setpoint
result (out)
Value of the stored result.

307
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
5 The calculated value exceeded the calculated maximum current.

S EE ALSO

ComCoordreport.ResultForMaxCurrent()

ResultForInstantaneousVariable
Provides access to the instantaneous result for a given device and variable.
[ int error,
float result ]
ComCoordreport.ResultForInstantaneousVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.

variable Variable for which to retrieve the result:

char Overcurrent characteristic
dir Tripping direction
Iset Overcurrent setpoint
Tset Overcurrent delay
result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
5 The calculated value exceeded the calculated maximum current.

S EE ALSO

ComCoordreport.ResultForOverloadVariable(),
ComCoordreport.ResultForShortCircuitVariable(),
ComCoordreport.ResultForMaxCurrent()

308
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

ResultForMaxCurrent
Provides access to the maximum current result for a given device.
[ int error,
float result ] ComCoordreport.ResultForMaxCurrent(DataObject device)

A RGUMENTS
device Device for which to retrieve the result.
result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
6 The orientation of the device is ambuous.

S EE ALSO

ComCoordreport.ResultForOverloadVariable(),
ComCoordreport.ResultForShortCircuitVariable(),
ComCoordreport.ResultForInstantaneousVariable()

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
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).
4 The correponding equation required a nominal current and none could be deter-
mined.

309
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.ResultForZoneVariable(),
ComCoordreport.ResultForOverreachVariable(),
ComCoordreport.ResultForDirectionalBackupVariable()

ResultForOverloadVariable
Provides access to the overload result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForOverloadVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.

variable Variable for which to retrieve the result:

char Overcurrent characteristic
dir Tripping direction
Iset Overcurrent setpoint
Tset Overcurrent delay
result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
5 The calculated value exceeded the calculated maximum current.

S EE ALSO

ComCoordreport.ResultForShortCircuitVariable(),
ComCoordreport.ResultForInstantaneousVariable(),
ComCoordreport.ResultForMaxCurrent()

ResultForOverreachVariable
Provides access to the overreach result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForOverreachVariable(DataObject device,
str variable)

310
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
device Device for which to retrieve the result.
variable Variable for which to retrieve the result:
X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
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).
4 The correponding equation required a nominal current and none could be deter-
mined.

S EE ALSO

ComCoordreport.ResultForZoneVariable(),
ComCoordreport.ResultForDirectionalBackupVariable(),
ComCoordreport.ResultForNonDirectionalBackupVariable()

ResultForShortCircuitVariable
Provides access to the short-circuit result for a given device and variable.
[ int error,
float result ]
ComCoordreport.ResultForShortCircuitVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.
variable Variable for which to retrieve the result:
char Overcurrent characteristic
dir Tripping direction
Iset Overcurrent setpoint
Tset Overcurrent delay
result (out)
Value of the stored result.

311
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
5 The calculated value exceeded the calculated maximum current.

S EE ALSO

ComCoordreport.ResultForOverloadVariable(),
ComCoordreport.ResultForInstantaneousVariable(),
ComCoordreport.ResultForMaxCurrent()

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)

A RGUMENTS
device Device for which to retrieve the result.
zoneNumber
Zone number for which to retrieve the result (1-4).
variable Variable for which to retrieve the result:
X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
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).
4 The correponding equation required a nominal current and none could be deter-
mined.

312
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.ResultForOverreachVariable(),
ComCoordreport.ResultForDirectionalBackupVariable(),
ComCoordreport.ResultForNonDirectionalBackupVariable()

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()

TopologyForFuseVariable
Returns the associated fuse topology for a given device and variable.
list ComCoordreport.TopologyForFuseVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Iset Overcurrent setpoint

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForMaxCurrent()

TopologyForInstantaneousVariable
Returns the associated instantaneous stage topology for a given device and variable.
list ComCoordreport.TopologyForInstantaneousVariable(DataObject device,
str variable)

313
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Iset Overcurrent setpoint
Tset Overcurrent delay

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForOverloadVariable(),
ComCoordreport.TopologyForShortCircuitVariable(),
ComCoordreport.TopologyForMaxCurrent()

TopologyForMaxCurrent
Returns the associated maximum current topology for a given device.
list ComCoordreport.TopologyForMaxCurrent(DataObject device)

A RGUMENTS
device Device for which to retrieve the topology.

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForOverloadVariable(),
ComCoordreport.TopologyForShortCircuitVariable(),
ComCoordreport.TopologyForInstantaneousVariable()

TopologyForNonDirectionalBackupVariable
Returns the associated non-directional backup topology for a given device and variable.
list ComCoordreport.TopologyForNonDirectionalBackupVariable(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.

314
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.TopologyForZoneVariable(),
ComCoordreport.TopologyForOverreachVariable(),
ComCoordreport.TopologyForDirectionalBackupVariable()

TopologyForOverloadVariable
Returns the associated overload stage topology for a given device and variable.
list ComCoordreport.TopologyForOverloadVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Iset Overcurrent setpoint
Tset Overcurrent delay

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForShortCircuitVariable(),
ComCoordreport.TopologyForInstantaneousVariable(),
ComCoordreport.TopologyForMaxCurrent()

TopologyForOverreachVariable
Returns the associated overreach zone topology for a given device and variable.
list ComCoordreport.TopologyForOverreachVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
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

R ETURNS
Elements traversed by the topological search determining this variables result.

315
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.TopologyForZoneVariable(),
ComCoordreport.TopologyForDirectionalBackupVariable(),
ComCoordreport.TopologyForNonDirectionalBackupVariable()

TopologyForShortCircuitVariable
Returns the associated short-circuit stage topology for a given device and variable.
list ComCoordreport.TopologyForShortCircuitVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Iset Overcurrent setpoint
Tset Overcurrent delay

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForOverloadVariable(),
ComCoordreport.TopologyForInstantaneousVariable(),
ComCoordreport.TopologyForMaxCurrent()

TopologyForZoneVariable
Returns the associated topology for a given device, zone number and variable.
list ComCoordreport.TopologyForZoneVariable(DataObject device,
int zoneNumber,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
zoneNumber
Zone number for which to retrieve the topology (1-4).
variable Variable for which to retrieve the topology:

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

316
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForOverreachVariable(),
ComCoordreport.TopologyForDirectionalBackupVariable(),
ComCoordreport.TopologyForNonDirectionalBackupVariable()

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:
dir Tripping direction
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)

A RGUMENTS
device Device to transfer the results to.
variable Variables to transfer as semi-colon separated string:
dir Tripping direction
Tp Polygonal delay
Tc Circular delay

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

317
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
device Device to transfer the results to.
variable Variables to transfer as semi-colon separated string:
X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
dir Tripping direction
Tp Polygonal delay
Tc Circular delay

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

S EE ALSO

ComCoordreport.TransferZoneResultsTo(),
ComCoordreport.TransferDirectionalBackupResultsTo(),
ComCoordreport.TransferNonDirectionalBackupResultsTo()

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.
variable Variables to transfer as semi-colon separated string:
X Polygonal reactance
R Polygonal phase-phase resistance

318
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

RE Polygonal phase-earth resistance

Z Circular impedance
phi Circular angle
dir Tripping direction
Tp Polygonal delay
Tc Circular delay
char Overcurrent characteristic
Iset Overcurrent setpoint
Tset Overcurrent delay

R ETURNS
0 At least one transfer did non succeed.
1 Result transfer successful.

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
device Device to transfer the results to.
zoneNumber
Zone number for which to to transfer the results (1-4).

variable Variables to transfer as semi-colon separated string:

X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
dir Tripping direction
Tp Polygonal delay
Tc Circular delay

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

S EE ALSO

ComCoordreport.TransferOverreachResultsTo(),
ComCoordreport.TransferDirectionalBackupResultsTo(),
ComCoordreport.TransferNonDirectionalBackupResultsTo()

319
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.15 ComCosim
Overview

PartitionNetwork

PartitionNetwork
Detects and defines regions usable for single-domain internal co-simulation. The regions are
displayed on the subpage R̈egionsöf the ComCosim command window. Here, optimisation
parameters such as the number of regions and the minimum travel time of boundary elements
can be set too.
int ComCosim.PartitionNetwork()

R ETURNS
0 on success, 1 otherwise.

5.4.16 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.17 ComDpl
Overview

CheckSyntax
Encrypt
Execute
GetExternalObject
GetInputParameterDouble
GetInputParameterInt
GetInputParameterString
IsEncrypted
ResetThirdPartyModule
SetExternalObject
SetInputParameterDouble
SetInputParameterInt
SetInputParameterString
SetThirdPartyModule

320
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

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])

321
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

R ETURNS
For scripts without the use of Application.exit() the following values are returned:

0 On a successful execution.
1 An error occurred.
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()

GetInputParameterDouble
Gets the double input parameter value defined in the ComDpl edit dialog.
[int error,
float value] ComDpl.GetInputParameterDouble(str name)

322
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

GetInputParameterInt
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(), ComDpl.GetExternalObject()

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.

323
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComDpl.SetInputParameterString(), ComDpl.GetInputParameterInt(),
ComDpl.GetInputParameterDouble(), ComDpl.GetExternalObject()

IsEncrypted
Returns the encryption state of the script.
int ComDpl.IsEncrypted()

R ETURNS
1 Script is encrypted.
0 Script is not encrypted.

S EE ALSO

ComDpl.Encrypt()

ResetThirdPartyModule
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
name Name of the external object parameter.

value The external object.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.GetExternalObject(), ComDpl.SetInputParameterInt(),
ComDpl.SetInputParameterDouble(), ComDpl.SetInputParameterString()

324
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetInputParameterDouble
Sets the double input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterDouble(str name,
float value
)

A RGUMENTS
name Name of the double input parameter.
value Value of the double input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.GetInputParameterDouble(), ComDpl.SetInputParameterInt(),
ComDpl.SetInputParameterString(), ComDpl.SetExternalObject()

SetInputParameterInt
Sets the integer input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterInt(str name,
int value
)

A RGUMENTS
name Name of the integer input parameter.
value Value of the integer input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.GetInputParameterInt(), ComDpl.SetInputParameterDouble(),
ComDpl.SetInputParameterString(), ComDpl.SetExternalObject()

SetInputParameterString
Sets the string input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterString(str name,
str value
)

A RGUMENTS
name Name of the string input parameter.
value Value of the string input parameter.

325
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.GetInputParameterString(), ComDpl.SetInputParameterInt(),
ComDpl.SetInputParameterDouble(), ComDpl.SetExternalObject()

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
)

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.18 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

326
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.19 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.

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.20 ComGridtocim
Overview

AppendMessage
AssignCimRdfIds
ConvertAndExport
GetMessageDescription
GetMessageObject
GetMessageSeverity
GetNumberOfMessages
SetAuthorityUri
SetBoundaries
SetGridsToExport

AppendMessage
Appends the conversion message.
None ComGridtocim.AppendMessage(str severity,
str description,
str objectFullname
)

A RGUMENTS
severity Message severity.

327
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

description
Message description.

objectFullname
Full name of the object for which the message is reported, or type and name of
the object.

E XAMPLE
The following example appends the conversion message.
import powerfactory
app = powerfactory.GetApplicationExt()
gridtocim = app.GetFromStudyCase("ComGridtocim")
objectFullname = gridtocim.GetFullName()
gridtocim.AppendMessage("Warning","This is a sample message.",objectFullname)

AssignCimRdfIds
Assigns CIM RDF IDs for all PowerFactory objects in the active project.
int ComGridtocim.AssignCimRdfIds()

R ETURNS
0 OK
1 Error: The active project was not found
2 Error: Duplicate CIM RDF IDs found in the active project

E XAMPLE
The following example sets CIM RDF IDs to all PowerFactory objects in the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

gridtocim = app.GetFromStudyCase("ComGridtocim")
result = gridtocim.AssignCimRdfIds()
if result == 0:
app.PrintInfo("CIM RDF IDs are successfully assigned.")
elif result == 1:
app.PrintError("The active project was not found.")
elif result == 2:
app.PrintError("Duplicate CIM RDF IDs found in the active project.")

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])

328
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
filePath File path for CIM data.
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: conversion failed
2 Error: export failed

E XAMPLE
This example converts the configured grids in the Grid to the CIM Conversion command, and
export the results to a specified ZIP archive.
import powerfactory
app = powerfactory.GetApplicationExt()

gridtocim = app.GetFromStudyCase("ComGridtocim")
error = gridtocim.ConvertAndExport("e:\export.zip", 1)
if error == 0:
app.PrintInfo("OK")
elif error == 1:
app.PrintError("Error: conversion failed")
else:
app.PrintError("Error: export failed")

GetMessageDescription
Returns the description from the selected conversion message.
str ComGridtocim.GetMessageDescription(int messageIndex)

A RGUMENTS
messageIndex
Index of the conversion message.

R ETURNS
Message description.

E XAMPLE
The following example prints the description text from each conversion message.
import powerfactory
app = powerfactory.GetApplicationExt()

gridtocim = app.GetFromStudyCase("ComGridtocim")
nMessages = gridtocim.GetNumberOfMessages()
for i in range(nMessages):
descriptionText = gridtocim.GetMessageDescription(i)
app.PrintInfo("%s" % descriptionText)

329
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetMessageObject
Returns the object from the selected conversion message.
str ComGridtocim.GetMessageObject(int messageIndex)

A RGUMENTS
messageIndex
Index of the conversion message.

R ETURNS
Object for which the message is reported.

E XAMPLE
The following example prints the object from each conversion message.
import powerfactory
app = powerfactory.GetApplicationExt()

gridtocim = app.GetFromStudyCase("ComGridtocim")
nMessages = gridtocim.GetNumberOfMessages()
for i in range(nMessages):
messageObject = gridtocim.GetMessageObject(i)
app.PrintInfo("%s" % messageObject)

GetMessageSeverity
Returns the severity of the selected conversion message.
str ComGridtocim.GetMessageSeverity(int messageIndex)

A RGUMENTS
messageIndex
Index of the conversion message.

R ETURNS
Message severity.

E XAMPLE
The following example prints the severity for each conversion message.
import powerfactory
app = powerfactory.GetApplicationExt()

gridtocim = app.GetFromStudyCase("ComGridtocim")
nMessages = gridtocim.GetNumberOfMessages()
for i in range(nMessages):
severity = gridtocim.GetMessageSeverity(i)
app.PrintInfo("%s" % severity)

330
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetNumberOfMessages
Returns the number of conversion messages generated.
int ComGridtocim.GetNumberOfMessages()

R ETURNS
Number of conversion messages.

E XAMPLE
The following example prints the number of conversion messages got for the last grid to CIM
conversion.
import powerfactory
app = powerfactory.GetApplicationExt()

gridtocim = app.GetFromStudyCase("ComGridtocim")
nMessages = gridtocim.GetNumberOfMessages()
app.PrintInfo("Number of messages: %d" % nMessages)

SetAuthorityUri
Sets the authority uri for a specific grid.
None ComGridtocim.SetAuthorityUri(DataObject grid,
str uri)

A RGUMENTS
grid Grid for which the URI is to be set.
uri URI of the model authority to be set.

E XAMPLE
This example sets the URI of the model authority for all grids in Grid to the CIM Conversion
command in the active study case.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
grids = project.GetContents("*.ElmNet", 1)
gridtocim = app.GetFromStudyCase("ComGridtocim")
for grid in grids:
gridtocim.SetAuthorityUri(grid, "testUri")

SetBoundaries
Sets "Fictitious border grid" parameter on the grids.
None ComGridtocim.SetBoundaries(list grids)

A RGUMENTS
grids The grids to be set as boundary.

331
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

E XAMPLE
This example sets a selected grid as a boundary grid. The grid is selected in the grid variable
in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, grid] = script.GetExternalObject("grid")
boundaries = [grid] # create a list of boundary grids
gridtocim = app.GetFromStudyCase("ComGridtocim")
gridtocim.SetBoundaries(boundaries)

SetGridsToExport
Sets the grids as "Selected" and clears any previous setting.
None ComGridtocim.SetGridsToExport(list grids)

A RGUMENTS
grids The grids to be exported.

E XAMPLE
This example sets all non-boundary grids in the active project for conversion from grid to
CIM.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
gridsToExport = []
grids = project.GetContents("*.ElmNet", 1)
for grid in grids:
if grid.GetAttribute("fictborder") == 0:
gridsToExport.append(grid)

gridtocim = app.GetFromStudyCase("ComGridtocim")
gridtocim.SetGridsToExport(gridsToExport)

5.4.21 ComHostcap
Overview

CalcMaxHostedPower

332
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

limitingComponent (out)
Element where the limiting violation occurs.

R ETURNS
-1 Selected object is not a terminal.
0 Calculation OK. No violations.
1 Calculation failed.
2 Thermal violation.
3 Voltage violation.
4 Thermal and voltage violation.
5 Protection violation.
6 Power quality violation.
7 Base case violations.
8 Calculation interrupted.

5.4.22 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.

333
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.23 ComInc
Overview

CompileDynamicModelTypes
ZeroDerivative

CompileDynamicModelTypes
Compile automatically all relevant dynamic model types.
int ComInc.CompileDynamicModelTypes([int modelType = 0],
[int forceRebuild = 0],
[int outputLevel = 0])

A RGUMENTS
modelType (optional)
0 All relevant dynamic model types are considered.
1 All relevant Modelica Model Types are considered.
2 All relevant DSL Model Types are considered.
forceRebuild (optional)
0 Dynamic model types already compiled and valid will not be recom-
piled.
1 Force all dynamic model types to be compiled.
outputLevel (optional)
0 No output messages regarding compilation of dynamic model types.
1 Warnings and error messages will be printed to the output window
regarding compilation of dynamic model types.

R ETURNS
0 On success.
1 On success but some DSL Model Types will run interpreted.
2 On error.

334
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

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.24 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.

335
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
)

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()

336
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

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.25 ComLink
Overview

LoadMicroSCADAFile
ReceiveData
SendData
SentDataStatus
SetOPCReceiveQuality
SetSwitchShcEventMode

337
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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)

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

338
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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)

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.26 ComMerge
Overview

CheckAssignments
Compare
CompareActive
CompareRecording
ExecuteRecording
ExecuteWithActiveProject
GetCorrespondingObject
GetModification
GetModificationResult
GetModifiedObjects
Merge
PrintComparisonReport
PrintModifications

339
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
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()

R ETURNS
0 On success.
1 On errors.
2 Cancelled by user.

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()

R ETURNS
0 On success.
1 On errors.
2 Cancelled by user.

CompareRecording
Starts a comparison according to the settings in this ComMerge object. Allows comparing to an
active target project and recording modifications in the active scenario and/or expansion stage
of the target project, but assignments are not set, the merge browser is not shown and no merge
is executed.
int ComMerge.CompareRecording()

340
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 On errors.
2 Cancelled by user.

ExecuteRecording
Starts a comparison according to the settings in this ComMerge object and sets assignments,
shows the merge browser or merges automatically, depending on settings of this ComMerge.
Records modifications in the active scenario and/or expansion stage of the target project.
int ComMerge.ExecuteRecording()

R ETURNS
0 On success.
1 Cancelled by user.
2 On other errors.

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”

R ETURNS
object Corresponding object.
None Corresponding object not found.

341
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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]
)

A RGUMENTS
modType
1 get unmodified objects
2 get modified objects

342
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
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)

A RGUMENTS
objs Set of objects for which the modifications are printed.
obj Object for which the modifications are printed.

343
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

344
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.27 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
motor The motor element

R ETURNS
Returns the switch element.

345
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetMotorTerminal
Finds the terminal to which the motor will be connected.
DataObject ComMot.GetMotorTerminal(DataObject motor)

A RGUMENTS
motor The motor element

R ETURNS
Returns the terminal element.

5.4.28 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.
int ComNmink.GenerateContingenciesForAnalysis()

R ETURNS
0 On success.
1 On error.

346
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.29 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.

347
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.30 ComOpc
Overview

GetCertificatePath
ReceiveData
SendData

GetCertificatePath
Gets the path to the PowerFactory certificate (OpenSSL file in DER format) used for the OPC
communication. The certificate is always placed in the workspace directory of the running
PowerFactory instance.
str ComOpc.GetCertificatePath([int create = 0])

A RGUMENTS
create (optional)
0 Do not create the certificate if it does not exist (default).
1 Create the certificate if it does not exist or has expired.
2 Always recreate the certificate.

R ETURNS
The path to the certificate file. The string is empty if the certificate file does not exist.

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)

348
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

5.4.31 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.

349
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

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.

350
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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])

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.32 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.

351
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.33 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()

5.4.34 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.35 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)

352
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.36 ComPython
Overview

GetExternalObject
GetInputParameterDouble
GetInputParameterInt
GetInputParameterString
SetExternalObject
SetInputParameterDouble
SetInputParameterInt
SetInputParameterString

GetExternalObject
Gets the external object defined in the ComPython edit dialog.
[int error,
DataObject value] ComPython.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

ComPython.SetExternalObject(), ComPython.GetInputParameterInt(),
ComPython.GetInputParameterDouble(), ComPython.GetInputParameterString()

GetInputParameterDouble
Gets the double input parameter value defined in the ComPython edit dialog.
[int error,
float value] ComPython.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.

353
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComPython.SetInputParameterDouble(), ComPython.GetInputParameterInt(),
ComPython.GetInputParameterString(), ComPython.GetExternalObject()

GetInputParameterInt
Gets the integer input parameter value defined in the ComPython edit dialog.
[int error,
int value ] ComPython.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

ComPython.SetInputParameterInt(), ComPython.GetInputParameterDouble(),
ComPython.GetInputParameterString(), ComPython.GetExternalObject()

GetInputParameterString
Gets the string input parameter value defined in the ComPython edit dialog.
[int error,
str value ] ComPython.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

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
)

354
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
name Name of the external object parameter.
value The external object.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComPython.GetExternalObject(), ComPython.SetInputParameterInt(),
ComPython.SetInputParameterDouble(), ComPython.SetInputParameterString()

SetInputParameterDouble
Sets the double input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterDouble(str name,
float value
)

A RGUMENTS
name Name of the double input parameter.

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()

SetInputParameterInt
Sets the integer input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterInt(str name,
int value
)

A RGUMENTS
name Name of the integer input parameter.
value Value of the integer input parameter.

R ETURNS
0 On success.
1 On error.

355
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComPython.GetInputParameterInt(), ComPython.SetInputParameterDouble(),
ComPython.SetInputParameterString(), ComPython.SetExternalObject()

SetInputParameterString
Sets the string input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterString(str name,
str value
)

A RGUMENTS
name Name of the string input parameter.

value Value of the string input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComPython.GetInputParameterString(), ComPython.SetInputParameterInt(),
ComPython.SetInputParameterDouble(), ComPython.SetExternalObject()

5.4.37 ComRed
Overview

LdfEquivalentVerification
ReductionInMemory
ResetReductionInMemory
SimEquivalentVerification

LdfEquivalentVerification
Right after Network Reduction execution, get the verification results of the load flow equivalents.
int ComRed.LdfEquivalentVerification()

R ETURNS
-1 Calculation is not available or the varification is not enabled.
0 The reduced network is equivalent to the original network.
1 The load flow doesn’t converge after reduction.
2 The load flow converges after reduction but the results differ from original net-
work.

356
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

SimEquivalentVerification
Right after Network Reduction execution, get the verification results of the dynamic simulation
equivalents.
int ComRed.SimEquivalentVerification()

R ETURNS
-1 Calculation is not available or the varification cannot be carried out.
0 The reduced network is equivalent to the original network.
1 The dynamic simulation fails after reduction.
2 The dynamic simulation works after reduction but the results differ from original
network.

5.4.38 ComRel3
Overview

AnalyseElmRes
ExeEvt
OvlAlleviate
RemoveEvents
RemoveOutages
ValidateConstraints

AnalyseElmRes
Evaluate the results object created by the last calculation.
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

357
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
=0 On success.
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.

358
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
−2 Load flow did not converge.
−3 Network error.

5.4.39 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.

GetContributionOfComponent
Gets the contributions of a component to a certain reliability indice.
float ComRelpost.GetContributionOfComponent(int componentNr,
str indice)

359
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
componentNr 1. Lines
2. Cables
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.40 ComRelreport
Overview

GetContingencies
GetContributionOfComponent

GetContingencies
Gets all contingencies of reliability for reporting.
list ComRelpost.GetContingencies()

R ETURNS
All contingencies of reliability for reporting.

GetContributionOfComponent
Is described in ComRelpost.GetContributionOfComponent().
float ComRelreport.GetContributionOfComponent(int componentNr,
str indice)

5.4.41 ComReltabreport
Overview

GetContingencies
GetContributionOfComponent

360
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetContingencies
Gets all contingencies of reliability for reporting.
list ComReltabreport.GetContingencies()

R ETURNS
All contingencies of reliability for reporting.

GetContributionOfComponent
Is described in ComRelpost.GetContributionOfComponent().
float ComReltabreport.GetContributionOfComponent(int componentNr,
str indice)

5.4.42 ComReport
Overview

ExecuteWithCustomSelection
SetParameter

ExecuteWithCustomSelection
Executes report generation with the given reports as well as front matter and header/footer
template.

This method allows to override the regular report selection configured for the currently active
calculation as well as the configured front matter and header/footer template, with a freely
defined selection.

Since virtually any report templates can be selected (even those that were not designed for the
currently active calculation), this method should be employed by experienced users only.
int ComReport.ExecuteWithCustomSelection(list reports,
[DataObject frontMatter],
[DataObject headerFooter])

A RGUMENTS
reports The reports to be selected.

frontMatter (optional)
The front matter template to be used. If not given, no front matter will be selected.
headerFooter (optional)
The header/footer template to be used. If not given, no header/footer will be
selected.

R ETURNS
The same return value as a regular ’Execute’ call.

361
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetParameter
Overrides the initial value of the given report’s parameter with the given value.

This method is the scripting equivalent of overriding the value of a report parameter in the Report
Generation command (ComReport) dialog and should only be employed by experienced users.
int ComReport.SetParameter(DataObject report,
str parameterIdentifier,
int|float|str value)

A RGUMENTS
report The report that provides the desired parameter.
parameterIdentifier
The identifier (not the localised name) of the parameter.
value The new value for the parameter.

R ETURNS
An error code. Possible values are

0 No error has occurred, the parameter has been successfully set.

1 The given object is not a report template (either a null reference or not of class
IntReport).
2 There is no valid report parameter with the given identifier.
3 The data type of the given value cannot be converted to the data type of the
parameter.
4 The data type of the given value is not supported by this method.

5.4.43 ComRes
Overview

ExportFullRange
FileNmResNm

ExportFullRange
Executes the export command for the whole data range.
None ComRes.ExportFullRange()

FileNmResNm
Sets the filename for the data export to the name of the result object being exported (classes:
ElmRes, IntComtrade)
None ComRes.FileNmResNm()

362
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.44 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
9 three phase to neutral fault
10 three phase, neutral to ground fault
20 DC fault

363
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

364
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.45 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()

365
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 No error occurred, the short-circuit trace is now running.
!=0 An error occurred, calculation was reset.

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 .
!=0 An error occurred, calculation was reset.

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.

366
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

367
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.46 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()

368
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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)
Pop-up suppression level:
0 No pop-up suppression. All pop-ups are shown. (default)
1 The pop-up asking for data overwrite is suppressed.
2 All pop-ups are suppressed.

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])

369
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.47 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.

370
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
1 n-1 (multiple cases).
2 n-2 (multiple cases).

371
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

372
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

373
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

374
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.48 ComStationware
Overview

GetAuthenticationTicket

GetAuthenticationTicket
Returns authentication ticket used by the current connection to the StationWare server.
str ComStationware.GetAuthenticationTicket()

R ETURNS
Authentication ticket or "" if there is currently no open connection.

5.4.49 ComSvgexport
Overview

SetFileName
SetObject
SetObjects

375
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

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.50 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)

376
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
obj Target annotation layer (IntGrflayer) or group (IntGrfgroup)

5.4.51 ComTablereport
Overview

ExportToExcel
ExportToHTML

ExportToExcel
Exports the report with its current filter settings and sorting to Excel.
None ComTablereport.ExportToExcel([str file,]
[int show]
)

A RGUMENTS
file (optional)
Path and name of file to be written (default: empty = temp. file is written)
show (optional)
0 Write only
1 Open written file in default application (default)

ExportToHTML
Exports the report with its current filter settings and sorting to HTML.
None ComTablereport.ExportToHTML([str file,]
[int show]
)

A RGUMENTS
file (optional)
Path and name of file to be written (default: empty = temp. file is written)
show (optional)
0 Write only
1 Open written file in default application (default)

377
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.52 ComTasks
Overview

AppendCommand
AppendStudyCase
GetCommandsForStudyCase
GetNumberOfCommandsForStudyCase
GetNumberOfStudyCases
GetStudyCases
IsAdditionalResultsFlagSetForCommand
IsCommandIgnored
IsStudyCaseIgnored
RemoveCmdsForStudyCaseRow
RemoveCommand
RemoveStudyCase
RemoveStudyCases
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.

378
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

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.
>0 Optionally, the row in the study case table containing the study case
for which 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.

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.
>0 Optionally, the row in the study case table containing the study case
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.

379
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

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)

380
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

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.
>0 Optionally, the row in the study case table containing the study case
for which ignore-flag 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.

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.

381
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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)

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.
>0 Optionally, the row in the study case table containing the 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.

382
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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).
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.

383
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

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.
>0 Optionally, the row in the study case table containing the study case
for which the ignore-flag shall be set can be passed. This is helpful,
e.g., if a study case has been added multiple times for calculation with
different command lists.

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.

384
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

5.4.53 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.54 ComTececocmp
Overview

AppendStudyCase
CalcDiscountedEstimatedPaybackPeriod
CalcEstimatedPaybackPeriod
CalcInternalRateOfReturn
RemoveStudyCases

AppendStudyCase
Appends a study case to the list of study cases.
int ComTececocmp.AppendStudyCase(DataObject studyCase,
[int isIgnored = 0])

R ETURNS
0 Study case could not be added for calculation.
1 Study case has been successfully added for calculation.

385
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
studyCase
Study case to add for calculation.
isIgnored Sets the flag to ignore the study case to add or not (default 0).

CalcDiscountedEstimatedPaybackPeriod
Calculates the discounted estimated payback period (in years) for a grid expansion w.r.t. a
base grid configuration. The grid expansion and base configurations must be given by means
of two study cases and their configured variation. Moreover, these study cases must contain
corresponding result files calculated by techno-economical calculations. The calculatory interest
rate from the result file written by the Techno-economical Calculation to evaluate will be used
for discounting.
[int error,
float epp]
Application.CalcDiscountedEstimatedPaybackPeriod(DataObject strategyToEval,
DataObject baseStrategy)

A RGUMENTS
strategyToEval
Study case defining grid expansion to evaluate.
baseStrategy
Study case defining base grid configuration.
epp (out) Resulting discounted estimated payback period (in years).

R ETURNS
Returns 0, if calculation was successfull and 1 otherwise.

CalcEstimatedPaybackPeriod
Calculates the estimated payback period (in years) for a grid expansion w.r.t. a base grid
configuration. The grid expansion and base configurations must be given by means of two study
cases and their configured variation. Moreover, these study cases must contain corresponding
result files calculated by techno-economical calculations.
[int error,
float epp]
ComTececocmp.CalcEstimatedPaybackPeriod(DataObject strategyToEval,
DataObject baseStrategy)

A RGUMENTS
strategyToEval
Study case defining grid expansion to evaluate.
baseStrategy
Study case defining base grid configuration.
epp (out) Resulting estimated payback period (in years).

386
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns 0, if calculation was successfull and 1 otherwise.

CalcInternalRateOfReturn
Calculates the internal rate of return for a grid expansion w.r.t. a base grid configuration.
The grid expansion and base configurations must be given by means of two study cases and
their configured variation. Moreover, these study cases must contain corresponding result files
calculated by techno-economical calculations.
[int error,
float irr]
ComTececocmp.CalcInternalRateOfReturn(DataObject strategyToEval,
DataObject baseStrategy)

A RGUMENTS
strategyToEval
Study case defining grid expansion to evaluate.
baseStrategy
Study case defining base grid configuration.
irr (out) Resulting internal rate of return.

R ETURNS
Returns 0, if calculation was successfull and 1 otherwise.

RemoveStudyCases
Removes all study cases from calculation.
None ComTececocmp.RemoveStudyCases()

5.4.55 ComTransfer
Overview

GetTransferCalcData
IsLastIterationFeasible

387
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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()

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.56 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.

388
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.57 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])

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
Index of the quick access cache (must be greater than or equals to 0)

389
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

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])

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
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

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
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

390
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

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])

A RGUMENTS
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

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
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

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])

391
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

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.58 ComWr
Overview

ExportGraphicTab

ExportGraphicTab
Exports the selected graphic tab to the specified file.
int ComWr.ExportGraphicTab(object graphicTab,
str filename
)

A RGUMENTS
graphicTab
Object that specifies the graphic tab (Diagram or Plot) to be exported.
filename Specifies the path of the exported file (including filetype).

R ETURNS
0 On success.
1 On failure.

392
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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.

GetNumberOfClusters
Get the number of clusters.
int SetCluster.GetNumberOfClusters()

R ETURNS
The number of clusters.

393
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.2 SetColscheme
Overview

GetAlarmColouringMode
GetColouringMode
GetEnergisingColouringMode
SetColouring
SetFilter

GetAlarmColouringMode
Returns the alarm colouring number for the given or currently valid calculation.
int SetColscheme.GetAlarmColouringMode(str page)

A RGUMENTS
page
empty for currently valid calculation
set page (see dialog page name table)

R ETURNS
The colouring number of "Alarm" colouring or negative value if not set.

GetColouringMode
Returns the "other" colouring number for the given or currently valid calculation.
int SetColscheme.GetColouringMode(str page)

A RGUMENTS
page
empty for currently valid calculation
set page (see dialog page name table)

R ETURNS
The colouring number of "Other" colouring or negative value if not set.

GetEnergisingColouringMode
Returns the energising status colouring number for the given or currently valid calculation.
int SetColscheme.GetEnergisingColouringMode(str page)

A RGUMENTS
page
empty for currently valid calculation
set page (see dialog page name table)

394
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

R ETURNS
The colouring number of "Energising Status" colouring or negative value if not set.

SetColouring
Sets colouring for given or currently valid calculation.
int SetColscheme.SetColouring(str page,
int energizing,
[int alarm,]
[int normal]
)

A RGUMENTS
page
empty set for currently valid calculation
set page for which modes are set (see dialog page name table)

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
-2 enable (set to previously selected mode),
-1 do not change (default)
0 disable
>0 set to this mode (see table below)
normal Other Colouring

-2 enable (set to previously selected mode),

-1 do not change (default)
0 disable
>0 set to this mode (see table below)

395
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Table 5.5.3

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.4

Energizing State Name "energizing" value

De-energized 33
Out of Calculation 37
De-energised, Planned Outage 61

396
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Table 5.5.5

Alarm Name "alarm" value

Voltage Violations / Overloading 29
Outages 32
Overloading of Thermal / Peak Short Circuit Current 31
Feeder Radiality Check 38

397
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Table 5.5.6

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
Layers Groupings 66
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

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.

398
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 the "other" colouring for the given or currently valid calculation if that mode is available for
that calculation.
int SetColscheme.SetFilter(int modeNumber,
[int page]
)
int SetColscheme.SetFilter(DataObject obj,
[int page]
)

A RGUMENTS
modeNumber
Colouring mode number to be set (for numbers see table listed in
SetColscheme.SetColouring()).
obj User-defined filter to be set. The filter needs to be an "IntFiltset" stored inside the
project colour settings.

page (optional)
Dialog page number for which colouring is set (see table below).

399
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Table 5.5.7

Dialog Page Name "page" 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 Ok.
1 Error (colouring mode or page not found).

400
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.3 SetDatabase
Overview

EmptyCache

EmptyCache
Empties characteristics cache for this database connection.
None SetDatabase.EmptyCache()

5.5.4 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)

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. Returns nothing if the object cannot be modified.

S EE ALSO

IntAddonvars.AddDouble(), IntAddonvars.AddDoubleMatrix(),
IntAddonvars.AddDoubleVector(), IntAddonvars.AddInteger(),
IntAddonvars.AddIntegerVector(), IntAddonvars.AddObject(),
IntAddonvars.AddObjectVector(), IntAddonvars.AddString(),
IntAddonvars.RemoveParameter()

401
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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
The class filter of the IntAddonvars object
descriptiveName (optional)
The object name of the IntAddonvars object

R ETURNS
The IntAddonvars object which exactly matches the classFilter and optionally the descriptive-
Name or nothing.

S EE ALSO

IntAddonvars.AddDouble(), IntAddonvars.AddDoubleMatrix(),
IntAddonvars.AddDoubleVector(), IntAddonvars.AddInteger(),
IntAddonvars.AddIntegerVector(), IntAddonvars.AddObject(),
IntAddonvars.AddObjectVector(), IntAddonvars.AddString(),
IntAddonvars.RemoveParameter()

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.

S EE ALSO

IntAddonvars.AddDouble(), IntAddonvars.AddDoubleMatrix(),
IntAddonvars.AddDoubleVector(), IntAddonvars.AddInteger(),
IntAddonvars.AddIntegerVector(), IntAddonvars.AddObject(),
IntAddonvars.AddObjectVector(), IntAddonvars.AddString(),
IntAddonvars.RemoveParameter()

RemoveAllConfigurations
Removes all IntAddonvars objects effectively removing all Data Extensions.
None SetDataext.RemoveAllConfigurations()

402
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

RemoveConfiguration
Removes the IntAddonvars object exactly matching classFilter and descriptive name.
None SetDataext.RemoveConfiguration(str classFilter,
[str descriptiveName])

A RGUMENTS
classFilter
The class filter of the IntAddonvars object
descriptiveName (optional)
The object name of the IntAddonvars object

5.5.5 SetDeskpage
Overview

Close
Show

Close
Closes the graphic page, if currently shown in the desktop.
int SetDeskpage.Close()

R ETURNS
0 On success, no error occurred.
1 Otherwise

Show
Displays the diagram page in the desktop.
int SetDeskpage.Show()

R ETURNS
0 On success, no error occurred.
1 Otherwise

403
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.6 SetDesktop
Overview

AddPage
BeginTabGroup
Close
CloseAllTemporaryTabs
DoAutoScaleX
EndTabGroup
Freeze
GetActivePage
GetCanvasSize
GetPage
GetSplitOrientation
GetTabGroups
IsFrozen
IsOpened
OpenScriptInTab
OpenTextFileInTab
RemovePage
SetAdaptX
SetAutoScaleX
SetResults
SetScaleX
SetSplitOrientation
SetViewArea
SetXVar
Show
Unfreeze
WriteWMF
ZoomAll

AddPage
Adds an existing page to a graphics and activates it

• Opens the desktop if not already open.

• Adds the page if it is not already part of the desktop.

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.

404
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

BeginTabGroup
This function is not supported in GUI-less mode.

Collects all subsequently created or opened tabs in one new floating tab group.
After all desired tabs have been opened, the function SetDesktop.EndTabGroup() should be
called to end the collection mechanism and obtain a tab group object (SetTabgroup), which
can be used to perform further actions on the tab group.
None SetDesktop.BeginTabGroup()

E XAMPLE
The following example demonstrates the usage of this method.
import powerfactory

app = powerfactory.GetApplicationExt()

# get currently opened desktop

desktop = app.GetDesktop()

desktop.BeginTabGroup()
# open/create tabs here

tabGroup = desktop.EndTabGroup()

# optionally, perform operations on returned tab group

if tabGroup:
tabGroup.ExportAllTableReports(0)

S EE ALSO

SetDesktop.EndTabGroup()

Close
Closes the desktop, if it is currently shown.
int SetDesktop.Close()

R ETURNS
0 on success
1 on error

CloseAllTemporaryTabs
This function is not supported in GUI-less mode.

Closes all temporary tabs, i.e. tabs that are not part of the Desktop (except Data Managers).
None SetDesktop.CloseAllTemporaryTabs()

405
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

DoAutoScaleX
Scales the x-axes of all plots in the desktop which use the x-axis scale defined in the desktop.
None SetDesktop.DoAutoScaleX()

EndTabGroup
This function is not supported in GUI-less mode.

Stops collecting newly created tabs in a single tab group and returns the tab group object
(SetTabgroup) of the tab group containing previously created tabs.
DataObject SetDesktop.EndTabGroup()

R ETURNS
The tab group containing all tabs opened after the last SetDesktop.BeginTabGroup() call or
NULL/None if no tab group or no tabs were opened.

S EE ALSO

SetDesktop.BeginTabGroup()

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.

406
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 desktop. If “create” is
true, then a new page will be created and added to the desktop if no page with name was
found.
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)

GetSplitOrientation
This function is not supported in GUI-less mode.

Returns the current split orientation of the main window.

As soon as more than one tab group is open in the main window, its central area is either split
horizontally (aligning tab groups from left to right) or vertically (aligning tab groups from top to
bottom).
int SetDesktop.GetSplitOrientation()

R ETURNS
A value representing the orientation of the main window:

0 Main window is split horizontally.

1 Main window is split vertically.

S EE ALSO

SetDesktop.SetSplitOrientation()

407
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

GetTabGroups
This function is not supported in GUI-less mode.

Returns the set of the currently opened tab groups. Each tab group is represented by a
SetTabgroup object.
The optional filter argument provides the possibility to limit the collection to only docked or only
floating tab groups.
list SetDesktop.GetTabGroups([int filter])

A RGUMENTS
filter Filter specifying which kind of tab groups are returned:
0 All tab groups (default).
1 Only docked tab groups.
2 Only floating tab groups.

R ETURNS
The (optionally filtered) set of the currently opened tab groups.

IsFrozen
Returns whether the graphical freeze mode is currently enabled.
int SetDesktop.IsFrozen()

R ETURNS
0 freeze mode is disabled, or the desktop is not open
1 desktop is open and freeze mode is enabled

IsOpened
Returns whether the desktop is currently shown.
int SetDesktop.IsOpened()

R ETURNS
1 if desktop is shown
0 otherwise

OpenScriptInTab
This function is not supported in GUI-less mode.

Opens the script associated with the given attribute of the given object. Only scripts that can
also be opened in a new Editor tab using the graphical user interface can be opened this way.
Note that it is not possible to open scripts of read-only objects (e.g. objects located in an inactive
project).
int SetDesktop.OpenScriptInEditor(DataObject sourceObject,
str attribute
)

408
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
sourceObject
The object that contains the desired script (e.g. a ComDpl object).
attribute The attribute of the desired script (e.g. ’xScript’ for the script stored in a ComDpl
object).

R ETURNS
An error code. Possible values are

0 No error has occurred, the script has been opened successfully in a new Editor
tab.
1 The given object is NULL/None.
2 The given attribute does not exist or cannot be opened in the Editor.

S EE ALSO

SetDesktop.OpenTextFileInTab()

OpenTextFileInTab
This function is not supported in GUI-less mode.

Opens the given file in a new Editor tab. Only plain text files should be opened this way.
If the given file path ends in ’.py’ or ’.pyw’ the opened Editor will provide syntax highlighting for
the Python scripting language.
int SetDesktop.OpenTextFileInTab(str path)

A RGUMENTS
path The path to the text file to open.

R ETURNS
An error code. Possible values are

0 No error has occurred, the file has been opened successfully in a new Editor tab.
1 The given path does not point to a valid file.

S EE ALSO

SetDesktop.OpenScriptInTab()

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)

A RGUMENTS
pageName
Name of graphics page.
pageObject
A graphics page object.

409
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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
mode Possible values:
0 never
1 after simulation
2 during simulation

SetResults
Sets default results object of desktop.
None SetDesktop.SetResults(DataObject res)

A RGUMENTS
res Result object to set or None to reset. Valid result object is any of class ElmRes,
IntComtrade and IntComtradeset.

410
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

SetSplitOrientation
This function is not supported in GUI-less mode.

Sets the current split orientation of the main window, see SetDesktop.GetSplitOrientation() for
details on split orientations.
None SetDesktop.SetSplitOrientation(int orientation)

A RGUMENTS
orientation
The desired orientation of the main window:
0 Split main window horizontally.
1 Split main window vertically.

S EE ALSO

SetDesktop.GetSplitOrientation()

SetViewArea
Adjusts the view area of the currently active (top-most) graphic page. Coordinates are expected
in millimetres for schematic diagrams or in geographic coordinates for geographic diagrams,
respectively.
None SetDesktop.SetViewArea(float left,
float right,
float bottom,
float top)

411
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 desktop. 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 desktop.
int SetDesktop.Show()
int SetDesktop.Show(str pageName)
int SetDesktop.Show(DataObject pageObject)

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

412
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

5.5.7 SetDistrstate
Overview

CalcCluster

CalcCluster
Calculates a load flow with a given load distribution state applied.
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.

413
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.8 SetFilt
Overview

Get

Get
Returns a container with the filtered objects.
list SetFilt.Get()

R ETURNS
The set of filtered objects.

5.5.9 SetLevelvis
Overview

AdaptWidth
Align
ChangeFont
ChangeLayer
ChangeRefPoints
ChangeWidthVisibilityAndColour
CreateLayer
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

414
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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)

ChangeLayer
This function sets the specified group of text boxes to a given layer.
None SetLevelvis.ChangeLayer(str sLayer)

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

415
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

iVisibility Sets the visibility

0 not visible
1 visible
iColour Sets the colour
0..255 colour

CreateLayer
Creation of user-defined layers.
DataObject SetLevelvis.CreateLayer([str name,]
[int type]
)

A RGUMENTS
name Layer name
type Sets the visibility
2 Net elements, annotations, text boxes
3 Background image
5 Filtered

R ETURNS
The created layer if successful, null-pointer otherwise.

Mark
Marks the specified group of text boxes in the currently shown diagram.
None SetLevelvis.Mark()

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')

416
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.10 SetLvscale
Overview

AddCalcRelevantCoincidenceDefinitions

AddCalcRelevantCoincidenceDefinitions
Adds all calculation relevant coincidence definitions.
None SetLvscale.AddCalcRelevantCoincidenceDefinitions()

5.5.11 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)

417
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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.12 SetPath
Overview

AllBreakers
AllClosedBreakers
AllOpenBreakers
AllProtectionDevices
Create
CreateTimeOvercurrentPlot
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.

418
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 a path based on the provided elements.
DataObject SetPath.Create(list elements)

A RGUMENTS
elements Elements the path shall be created with. If two elements are provided, the re-
turned path will be the shortest path (SP) between those. If an incomplete path
v1,v2,...,vk is provided, then the result will be the concatenation of SP(v1,v2),
SP(v2,v3), ... (it is not possible to visit the same element twice). If the elements
form a complete path, this path will be returned.

R ETURNS
DataObject Modification was successful.
None Modification failed. (e.g. elements can not be joined to a path.)

CreateTimeOvercurrentPlot
Generates and opens a graphic page containing a time-overcurrent plot showing the path’s
protection devices. In addition, the page shows a single line diagram of the path (SGL legend).
DataObject SetPath.CreateTimeOvercurrentPlot()

R ETURNS
The generated graphic page (GrpPage).

GetAll
Returns all objects in the path definition.
list SetPath.GetAll()

R ETURNS
The set of objects.

419
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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.

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.13 SetPrj
Overview

GetFontID
SetFontFor

420
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

GetFontID
Determines the ID for given font. The font is automatically internally registered if it has not been
used before.
int SetPrj.GetFontID(const char* fontName,
int fontSize,
[int fontStyle = 0]
)

A RGUMENTS
fontName
Font name
fontSize Font size
fontStyle (optional)
Bitfield if bold, italic and/or underline
0 Regular (no style used
1 Bold
2 Italic
3 Bold and italic
4 Underline

R ETURNS
Returns the font ID. The value is always greater than zero.

SetFontFor
Sets a font for a specified group of text boxes.
None SetPrj.SetFontFor(int sglOrBlock,
int labelResultOrTitle,
int nodesOrBranches,
string fontName,
int fontSize,
int fontStyle
)

A RGUMENTS
sglOrBlock
Font settings for single line or block diagrams
0 Single line diagrams
1 Block diagrams
labelResultOrTitle
Type of text box to be modified.
0 Labels
1 Results
2 Title and Legends
nodesOrBranches
Type of parent object

421
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

0 Nodes
1 Branches

fontName
Font name
fontSize Font size
fontStyle Font style

1 Bold
2 Italic
3 Bold and italic
4 Underline

5.5.14 SetScenario
Overview

Check
Default
Print

Check
Checks the scenario configuration. The action is identical to pressing the corresponding button
in the dialog.
NB: This function is only available if called on the configuration (SetScenario) of the currently
active project.
int IntScenario.Check()

R ETURNS
0 Ok, check did not reveal any problems
1 Not ok, check found some problems. See the output window for details.

Default
Resets the scenario configuration to the default, built-in configuration. The action is identical to
pressing the corresponding button in the dialog.
NB: This function is only available if no scenario is active and called on the configuration
(SetScenario) of the currently active project.
None IntScenario.Default()

Print
Prints the scenario configuration to the output window. The action is identical to pressing the
corresponding button in the dialog.
NB: This function is only available if called on the configuration (SetScenario) of the currently
active project.
None IntScenario.Print()

422
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.15 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.
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

423
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

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()

424
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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()

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

425
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.16 SetTabgroup
Overview

Activate
Close
CloseTab
ExportAllReportDocuments
ExportAllTableReports
GetTabCount
GetTabObject
GetTabTitle
GetTabType
IsClosed
IsInMainWindow
MoveTab
MoveTabs
MoveTabToMainWindow
MoveTabToNewFloatingGroup
MoveToMainWindow
MoveToNewFloatingWindow

Activate
This function is not supported in GUI-less mode.

Activates the tab group.

Calling this method before opening Graphic or Text Editor tabs will ensure that they are opened
in this group.
None SetTabgroup.Activate()

Close
This function is not supported in GUI-less mode.

Closes all tabs in the tab group, effectively closing the complete tab group.
None SetTabgroup.Close()

S EE ALSO

SetTabgroup.IsClosed()

CloseTab
This function is not supported in GUI-less mode.

Closes the specified tab.

None SetTabgroup.CloseTab(int tabIndex)

A RGUMENTS
tabIndex The index of the desired tab in the group. The first tab always has index 0.

426
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

ExportAllReportDocuments
This function is not supported in GUI-less mode.

Exports all report documents (displayed by PDF Viewer tabs) in the tab group to the specified
folder.
If no folder path is given, a folder selection dialog will pop up, allowing to manually select a
folder.
The names of the exported files are chosen based on the name of the corresponding report
document objects and are automatically adapted to avoid overwritting existing files.
int SetTabgroup.ExportAllReportDocuments([str folderPath])

A RGUMENTS
folderPath (optional)
The path to the folder the report documents should be exported to. If not given, a
folder selection dialog will pop up.

R ETURNS
An error code:

0 No error occurred, export was successful.

1 User cancelled the folder selection dialog.
2 The specified folder path does not point to an existing folder.
3 User has no write access to the folder specified by the folder path.
4 This tab group does not contain any report documents.

ExportAllTableReports
This function is not supported in GUI-less mode.

Exports all tabular reports contained in the tab group in the selected format to the specified
folder.
If no folder path is given, a folder selection dialog will pop up, allowing to manually select a
folder.
The names of the exported files are chosen based on the name of the corresponding tabular
report objects and are automatically adapted to avoid overwritting existing files.
int SetTabgroup.ExportAllTableReports(int format,
[str folderPath]
)

A RGUMENTS
format The desired export format, specified by one of these values:
0 Excel (xlsx)
1 HTML
folderPath (optional)
The path to the folder the tabular reports should be exported to. If not given, a
folder selection dialog will pop up.

427
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

R ETURNS
An error code:

0 No error occurred, export was successful.

1 User cancelled the folder selection dialog.
2 The specified folder path does not point to an existing folder.
3 User has no write access to the folder specified by the folder path.
4 This tab group does not contain any tabular reports.

GetTabCount
This function is not supported in GUI-less mode.

Returns the number of tabs in this tab group.

int SetTabgroup.GetTabCount()

R ETURNS
The number of tabs in this tab group.

GetTabObject
This function is not supported in GUI-less mode.

Returns the object associated with the tab at the given index. Please note that not all tabs have
an associated object.
DataObject SetTabgroup.GetTabObject(int tabIndex)

A RGUMENTS
tabIndex The index of the desired tab in the group. The first tab always has index 0.

R ETURNS
If the specified tab has an associated object this method returns one of these types:

SetDeskpage Graphics Page

GrpPage Plot Page
IntTextref Text reference (used by Text Editor tabs stored in Desktop)
ComTableport Tabular Report (only if report is stored in Desktop)
IntReportdoc Report document (displayed by PDF Viewer tab)

If the tab has no associated object or the given index is out of bounds, this method returns
NULL/None.

GetTabTitle
This function is not supported in GUI-less mode.

Returns the title of the tab at the given index.

str SetTabgroup.GetTabTitle(int tabIndex)

428
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
tabIndex The index of the desired tab in the group. The first tab always has index 0.

R ETURNS
The title of the specified tab (empty if index is out of bounds).

GetTabType
This function is not supported in GUI-less mode.

Returns the type of the tab at the given index.

int SetTabgroup.GetTabType(int tabIndex)

A RGUMENTS
tabIndex The index of the desired tab in the group. The first tab always has index 0.

R ETURNS
The type of the specified tab:

-1 Error, the given tab index is out of bounds.

0 Graphic (Diagram, Plot, etc.)
1 Text Editor
2 Tabular Report
3 Variation Manager
4 Report document (displayed by PDF Viewer tab)
5 Data Manager
6 Network Model Manager

IsClosed
This function is not supported in GUI-less mode.

Determines wether the group is closed. Closed groups cannot be used for any operations.
Please note that opened tab groups are automatically closed as soon as they become empty,
e.g. when their last remaining tab is closed or moved to another group.
int SetTabgroup.IsClosed()

R ETURNS
The state of the group:

0 The group is open.

1 The group is closed.

S EE ALSO

SetTabgroup.Close()

429
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

IsInMainWindow
This function is not supported in GUI-less mode.

Determines wether the group is docked to the main window or if it is floating.

int SetTabgroup.IsInMainWindow()

R ETURNS
The location of the group:

0 The group is floating.

1 The group is docked to the main window.

S EE ALSO

SetTabgroup.MoveToMainWindow(), SetTabgroup.MoveToNewFloatingWindow()

MoveTab
This function is not supported in GUI-less mode.

Moves the tab at the specified index to the end of the given tab group.
None SetTabgroup.MoveTab(int tabIndex,
DataObject otherTabGroup)

A RGUMENTS
tabIndex The index of the desired tab in this group. The first tab always has index 0.
otherTabGroup
The tab group (SetTabgroup) the tab should be moved to.

MoveTabs
This function is not supported in GUI-less mode.

Moves all tabs of the group to the end of the specified group.
Please note that this group is automatically closed after all of its tabs are moved.
None SetTabgroup.MoveTabs(DataObject otherTabGroup)

A RGUMENTS
otherTabGroup
The tab group (SetTabgroup) the tabs should be moved to.

MoveTabToMainWindow
This function is not supported in GUI-less mode.

Moves the specified tab to a new group docked in the main window.
DataObject SetTabgroup.MoveTabToMainWindow(int tabIndex)

430
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
tabIndex The index of the desired tab in the group. The first tab always has index 0.

R ETURNS
The new tab group.

MoveTabToNewFloatingGroup
This function is not supported in GUI-less mode.

Moves the specified tab to a new floating group.

DataObject SetTabgroup.MoveTabToNewFloatingGroup(int tabIndex)

A RGUMENTS
tabIndex The index of the desired tab in the group. The first tab always has index 0.

R ETURNS
The new tab group.

MoveToMainWindow
This function is not supported in GUI-less mode.

Docks this group to the main window.

If the group is already docked to the main window, calling this method has no effect.
None SetTabgroup.MoveToMainWindow()

S EE ALSO

SetTabgroup.IsInMainWindow(), SetTabgroup.MoveToNewFloatingWindow()

MoveToNewFloatingWindow
This function is not supported in GUI-less mode.

Moves this group to a new floating window.

If the group is already located in a floating window, calling this method has no effect.
None SetTabgroup.MoveToNewFloatingWindow()

S EE ALSO

SetTabgroup.IsInMainWindow(), SetTabgroup.MoveToMainWindow()

431
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.17 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'.

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.

432
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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.18 SetTime
Overview

Date
GetTimeUTC
SetTime
SetTimeUTC
Time

Date
Sets date component to current system date.
None SetTime.Date()

S EE ALSO

SetTime.Time(), SetTime.SetTimeUTC()

GetTimeUTC
Gets UTC time as seconds since 01.01.1970 00:00 GMT.
int SetTime.GetTimeUTC()

R ETURNS
UTC time as seconds since 01.01.1970 00:00 GMT.

S EE ALSO

SetTime.SetTimeUTC()

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.

433
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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.19 SetUser
Overview

GetNumProcesses

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.

434
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.20 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
0 On success, no error occurred.
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()

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

435
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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.

None SetVipage.MigratePage()

R ETURNS
The migrated plot page (GrpPage)

SetAdaptX
Sets the Adapt Scale option of the x-scale.
None SetVipage.SetAdaptX(int mode,
[float trigger]
)

436
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 SetVipage.SetAutoScaleX(int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

SetResults
Sets default results object of virtual instrument panel.
None SetVipage.SetResults(DataObject res)

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 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.

437
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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
)

A RGUMENTS
obj (optional)
x-axis object

varname (optional)
variable of obj

Show
Displays the plot page in the desktop.
int SetVipage.Show()

438
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success, no error occurred.
1 Otherwise

5.6 Others

5.6.1 BlkDef
Overview

Check
Compile
Encrypt
GetCheckSum
Pack
PackAsMacro
ResetThirdPartyModule
SetThirdPartyModule

Check
Verifies the DSL model equations.
int BlkDef.Check()

R ETURNS
0 BlkDef is OK.
1 Error during parsing.
2 Compiled model, no check is possible.

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])

439
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
removeObjectHistory (optional)
H andling 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.

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([int inclGlobalLib])

A RGUMENTS
inclGlobalLib (optional)
Include also objects from DIgSILENT Library (default = 1)

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.

440
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

BlkDef.Encrypt()

ResetThirdPartyModule
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
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.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.

441
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 CimArchive
Overview

ConvertToBusBranch

ConvertToBusBranch
Performs the conversion of CimModels in the selected CimArchive to bus-branch model repre-
sentation.
Note that this function will work only on CGMES v2.4.15 CimArchives. Conversion of CimArchives
to bus-branch model representation for other CGMES versions is not supported.
None CimArchive.ConvertToBusBranch()

E XAMPLE
This example converts a CimArchive to a Bus-Branch model. The CimArchive is selected in
the archive variable in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

442
5.6. OTHERS CHAPTER 5. OBJECT METHODS

script = app.GetCurrentScript()
[error, archive] = script.GetExternalObject("archive")
archive.ConvertToBusBranch();

5.6.5 CimModel
Overview

DeleteParameterAtIndex
GetAttributeEnumerationType
GetModelsReferencingThis
GetParameterCount
GetParameterNamespace
GetParameterValue
HasParameter
RemoveParameter
SetAssociationValue
SetAssociationValue
SetAttributeEnumeration
SetAttributeEnumeration
SetAttributeValue
SetAttributeValue

DeleteParameterAtIndex
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

E XAMPLE
This example deletes the "Model.profile" parameter of the CimModel at index 1. The Cim-
Model is selected in the model variable in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, model] = script.GetExternalObject("model")
model.DeleteParameterAtIndex("Model.profile", 1)

GetAttributeEnumerationType
Returns the enumeration type of the attribute.
str CimModel.GetAttributeEnumerationType(str attribute)

443
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

E XAMPLE
This example prints the profile of CIM models referencing a selected CimModel. The Cim-
Model is selected in the model variable in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, model] = script.GetExternalObject("model")
cimModels = model.GetModelsReferencingThis()
for cimModel in cimModels:
app.PrintInfo(cimModel.GetParameterValue("Model.profile"))

GetParameterCount
Returns the number of parameters (attribute, or association) of given type.
int CimModel.GetParameterCount(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association
(e.g. "Model.profile")

E XAMPLE
This example prints the "Model.profile" attributes for all CIM models from the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
cimModels = project.GetContents("*.CimModel", 1)
for cimModel in cimModels :
nProfiles = cimModel.GetParameterCount("Model.profile")
app.PrintInfo("Model %s has %d profiles" % (cimModel, nProfiles))
for i in range(nProfiles):
profile = cimModel.GetParameterValue("Model.profile", i)
app.PrintInfo("Profile:%d = %s" % (i, profile))

444
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetParameterNamespace
Returns the namesace of the parameter (attribute, or association).
str CimModel.GetParameterNamespace(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association
(e.g. "Model.created")

E XAMPLE
This example prints the namespace of the "Model.created" parameter for the CimModel that
is selected in the model variable in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, model] = script.GetExternalObject("model")
namespace = model.GetParameterNamespace("Model.created")
app.PrintInfo(namespace)

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

E XAMPLE
This example prints the "Model.modelingAuthoritySet" parameter for a CimModel. The Cim-
Model is selected in the model variable in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, model] = script.GetExternalObject("model")
app.PrintInfo(model.GetParameterValue("Model.modelingAuthoritySet"))

445
5.6. OTHERS CHAPTER 5. OBJECT METHODS

HasParameter
Checks whether the CimModel has the parameter (attribute, or association) specified.
int CimModel.HasParameter(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association
(e.g. "Model.modelingAuthoritySet")

R ETURNS
1 if parameter is specified
0 if parameter is not specified

E XAMPLE
This example checks if a selected CimModel contains the "Model.scenarioTime" parameter.
The CimModel is selected in the model variable in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, model] = script.GetExternalObject("model")
hasParameter = model.HasParameter("Model.scenarioTime")
if hasParameter == 1:
app.PrintInfo("Parameter exists.")
else:
app.PrintInfo("Parameter does not exist.")

RemoveParameter
Removes all occurrences of the parameter (attribute, or association).
None CimModel.RemoveParameter(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association
(e.g. "Model.scenarioTime")

E XAMPLE
This example removes the "Model.scenarioTime" parameter from all CIM models from the
active project.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
cimModels = project.GetContents("*.CimModel", 1)
for cimModel in cimModels :
cimModel.RemoveParameter("Model.scenarioTime")

446
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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])

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

E XAMPLE
This example sets the "Model.DependentOn" parameter at index 1 for a selected CimModel.
The CimModel is selected in the model variable in External Objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, model] = script.GetExternalObject("model")
dependentOnId = "21df3d4d-3f82-4998-be21-772e3d2d573f"
model.SetAssociationValue("Model.DependentOn", dependentOnId, 1)

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")
value Value of the association
nspace Namespace of the association (e.g. "md")

E XAMPLE
This example sets the "Model.DependentOn" parameter for a selected CimModel. The Cim-
Model is selected in the model variable in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, model] = script.GetExternalObject("model")
dependentOnId = "21df3d4d-3f82-4998-be21-772e3d2d573f"
model.SetAssociationValue("Model.DependentOn", dependentOnId, "md")

447
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAttributeEnumeration
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
attribute Full-name specifier of the attribute (e.g. "GeneratingUnit.genControlSource")
enumerationType
Enumeration type of the attribute (e.g. "GeneratorControlSource")

value Value of the enumeration (e.g. "offAGC")

SetAttributeEnumeration
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 enumerationType,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. "GeneratingUnit.genControlSource")

enumerationType
Enumeration type of the attribute (e.g. "GeneratorControlSource")
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

448
5.6. OTHERS CHAPTER 5. OBJECT METHODS

E XAMPLE
This example sets the "Model.profile" parameter at index 2 for a selected CimModel. The
CimModel is selected in the equipmentModel variable in External objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, equipmentModel] = script.GetExternalObject("equipmentModel")
equipmentShortCircuit = "http://entsoe.eu/CIM/EquipmentShortCircuit/3/1"
equipmentModel.SetAttributeValue("Model.profile",
equipmentShortCircuit,
2)

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")
value Value of the attribute

nspace Namespace of the attribute (e.g. "md")

E XAMPLE
This example sets the "Model.modelingAuthoritySet" parameter for all CIM models from the
active project.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
cimModels = project.GetContents("*.CimModel", 1)
for cimModel in cimModels :
cimModel.SetAttributeValue("Model.modelingAuthoritySet", "mas", "md")

449
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.6 CimObject
Overview

DeleteParameterAtIndex
GetAttributeEnumerationType
GetObjectsReferencingThis
GetObjectsWithSameId
GetParameterCount
GetParameterNamespace
GetParameterValue
GetPfObjects
HasParameter
RemoveParameter
SetAssociationValue
SetAssociationValue
SetAttributeEnumeration
SetAttributeEnumeration
SetAttributeValue
SetAttributeValue

DeleteParameterAtIndex
Removes the parameter (attribute, or association) value at the given index.
None CimObject.DeleteParameterAtIndex(str parameter,
int index)

A RGUMENTS
parameter
Full-name of the attribute, or association
(e.g. "TopologicalIsland.TopologicalNodes")

index Index of the parameter

E XAMPLE
This example removes all "TopologicalIsland.TopologicalNodes" parameters values from all
"TopologicalIsland" CIM objects in the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
topoNodesParameter = "TopologicalIsland.TopologicalNodes"
cimObjects = project.GetContents("*.CimObject", 1)
for cimObject in cimObjects :
if cimObject.GetAttribute("cimClass") == "TopologicalIsland":
nNodes = cimObject.GetParameterCount(topoNodesParameter)
app.PrintInfo("TP-island %s has %d TP-nodes" % (cimObject, nNodes))
for i in range(nNodes, -1, -1):
cimObject.DeleteParameterAtIndex(topoNodesParameter, i)

450
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetAttributeEnumerationType
Returns the enumeration type of the attribute.
str CimObject.GetAttributeEnumerationType(str attribute)

A RGUMENTS
attribute Full-name of the attribute (e.g. "SynchronousMachine.shortCircuitRotorType")

E XAMPLE
This example prints the enumeration type of the "SynchronousMachine.shortCircuitRotorType"
attribute of a "SynchronousMachine" CimObject. The CimObject is selected in the cimObject
variable in External Objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, cimObject] = script.GetExternalObject("cimObject")
attributeName = "SynchronousMachine.shortCircuitRotorType"
app.PrintInfo(cimObject.GetAttributeEnumerationType(attributeName))

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()

R ETURNS
CIM objects that reference the calling object. The order of the set is undefined.

E XAMPLE
This example prints all CIM objects which reference the "SynchronousMachine" CimObject.
The SynchronousMachine is selected in the machine variable in External Objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, machine] = script.GetExternalObject("machine")
cimObjects = machine.GetObjectsReferencingThis()
for cimObject in cimObjects:
app.PrintInfo(cimObject)

GetObjectsWithSameId
Returns all CIM objects (CimObject) that have the same Resource ID as this object.
list CimObject.GetObjectsWithSameId()

451
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
CIM objects that have the same Resource ID as this object.

E XAMPLE
This example prints all CIM objects with the same CIM RDF ID as the "SynchronousMa-
chine" CimObject. The SynchronousMachine is selected in the machine variable in External
Objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, machine] = script.GetExternalObject("machine")
cimObjects = machine.GetObjectsWithSameId()
for cimObject in cimObjects:
app.PrintInfo(cimObject)

GetParameterCount
Returns the number of parameters (attribute, or association) of given type.
int CimObject.GetParameterCount(str parameter)

A RGUMENTS
parameter
Full-name of the attribute, or association
(e.g. "TopologicalIsland.TopologicalNodes")

E XAMPLE
This example prints the IDs of all "TopologicalNode" CIM objects from all "TopologicalIsland"
CIM objects in the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
topoNodesParameter = "TopologicalIsland.TopologicalNodes"
cimObjects = project.GetContents("*.CimObject", 1)
for cimObject in cimObjects :
if cimObject.GetAttribute("cimClass") == "TopologicalIsland":
nNodes = cimObject.GetParameterCount(topoNodesParameter)
app.PrintInfo("TP-island %s has %d TP-nodes" % (cimObject, nNodes))
for i in range(nNodes):
nodeId = cimObject.GetParameterValue(topoNodesParameter, i)
app.PrintInfo("CIM RDF ID of TP-node %d is: %s" % (i, nodeId))

GetParameterNamespace
Returns the namesace of the parameter (attribute, or association).
str CimObject.GetParameterNamespace(str parameter)

452
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
parameter
Full-name of the attribute, or association
(e.g. "IdentifiedObject.name")

E XAMPLE
This example prints the namespace of the "IdentifedObject.name" parameter of a CimObject.
The CimObject is selected in the acLineSegment variable in External Objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, acLineSegment] = script.GetExternalObject("acLineSegment")
app.PrintInfo(acLineSegment.GetParameterNamespace("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
Full-name of the attribute, or association
(e.g. "IdentifiedObject.name")
index Index of the parameter:
0 Default index

E XAMPLE
This example prints the "IdentifedObject.name" parameter of a selected CimObject. The
CimObject is selected in the cimObject variable in External Objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, cimObject] = script.GetExternalObject("cimObject")
app.PrintInfo(cimObject.GetParameterValue("IdentifiedObject.name"))

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.

453
5.6. OTHERS CHAPTER 5. OBJECT METHODS

E XAMPLE
This example prints all PowerFactory objects with the same CIM RDF ID as the "Synchronous-
Machine" CimObject. The SynchronousMachine is selected in the machine variable in Exter-
nal objects.
import powerfactory
app = powerfactory.GetApplicationExt()

script = app.GetCurrentScript()
[error, machine] = script.GetExternalObject("machine")
pfObjects = machine.GetPfObjects()
for pfObject in pfObjects:
app.PrintInfo(pfObject)

HasParameter
Checks whether the CimObject has the parameter (attribute, or association) specified.
int CimObject.HasParameter(str parameter)

A RGUMENTS
parameter
Full-name of the attribute, or association
(e.g. "IdentifiedObject.name")

R ETURNS
1 if parameter is specified
0 if parameter is not specified

E XAMPLE
This example checks if a CimObject contains the "IdentifiedObject.name" parameter. The
CimObject is selected in the cimObject variable in External Objects.
import powerfactory
app = powerfactory.GetApplicationExt()
script = app.GetCurrentScript()
[error, cimObject] = script.GetExternalObject("cimObject")
hasParameter = cimObject.HasParameter("IdentifiedObject.name")
if hasParameter == 1:
app.PrintInfo("Parameter exists.")
else:
app.PrintInfo("Parameter does not exist.")

RemoveParameter
Removes all occurrences of the parameter (attribute, or association).
None CimObject.RemoveParameter(str parameter)

A RGUMENTS
parameter
Full-name of the attribute, or association
(e.g. "SynchronousMachine.shortCircuitRotorType")

454
5.6. OTHERS CHAPTER 5. OBJECT METHODS

E XAMPLE
This example removes the "SynchronousMachine.shortCircuitRotorType" parameter from all
"SynchronousMachine" CIM objects in the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
cimObjects = project.GetContents("*.CimObject", 1)
for cimObject in cimObjects :
if cimObject.GetAttribute("cimClass") == "SynchronousMachine":
cimObject.RemoveParameter("SynchronousMachine.shortCircuitRotorType")

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 of the association (e.g. "Equipment.EquipmentContainer")
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 CimObject.SetAssociationValue(str association,
str value,
str nspace)

A RGUMENTS
attribute Full-name of the association (e.g. "NonConformLoad.LoadGroup")
value Value of the association
nspace Namespace of the association (e.g. "cim")

E XAMPLE
This example adds the missing association "NonConformLoad.LoadGroup" on "NonConform-
Load" CIM objects in the active project. The association is set to the object defined in the
loadGroup variable in External Objects.

455
5.6. OTHERS CHAPTER 5. OBJECT METHODS

import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
script = app.GetCurrentScript()
[error, loadGroup] = script.GetExternalObject("loadGroup")
loadGroupId = loadGroup.GetAttribute("resID")
loadGroupParameter = "NonConformLoad.LoadGroup"
cimObjects = project.GetContents("*.CimObject", 1)
for cimObject in cimObjects :
cimClass = cimObject.GetAttribute("cimClass")
if cimClass == "NonConformLoad":
# concrete CimObject has the about parameter set to 0
if cimObject.GetAttribute("about") == 0:
if cimObject.HasParameter(loadGroupParameter) == 0:
cimObject.SetAssociationValue(loadGroupParameter,
loadGroupId,
"cim")

SetAttributeEnumeration
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 enumerationType,
str value)

A RGUMENTS
attribute Full-name of the attribute (e.g. "SynchronousMachine.shortCircuitRotorType")
enumerationType
Enumeration type of the attribute (e.g. "ShortCircuitRotorKind")
value Value of the enumeration (e.g. "salientPole1")

E XAMPLE
This example adds the missing attribute "SynchronousMachine.shortCircuitRotorType" on
"SyncronousMachine" CIM objects in the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

parameter = "SynchronousMachine.shortCircuitRotorType"
type = "ShortCircuitRotorKind"
value = "salientPole1"

project = app.GetActiveProject()
cimObjects = project.GetContents("*.CimObject", 1)
for cimObject in cimObjects :
cimClass = cimObject.GetAttribute("cimClass")
if cimClass == "SynchronousMachine":
# concrete CimObject has the about parameter set to 0
if cimObject.GetAttribute("about") == 0:
if cimObject.HasParameter(parameter) == 0:
cimObject.SetAttributeEnumeration(parameter, type, value)

456
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAttributeEnumeration
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 enumerationType,
str value,
str nspace)

A RGUMENTS
attribute Full-name of the attribute (e.g. "SynchronousMachine.shortCircuitRotorType")
enumerationType
Enumeration type of the attribute (e.g. "ShortCircuitRotorKind")
value Value of the attribute (e.g. "salientPole1")
nspace Namespace of the attribute (e.g. "cim")

E XAMPLE
This example adds the missing attribute "SynchronousMachine.shortCircuitRotorType" on
"SyncronousMachine" CIM objects in the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

parameter = "SynchronousMachine.shortCircuitRotorType"
type = "ShortCircuitRotorKind"
value = "salientPole1"
namespace = "cim"

project = app.GetActiveProject()
cimObjects = project.GetContents("*.CimObject", 1)
for cimObject in cimObjects :
if cimObject.GetAttribute("cimClass") == "SynchronousMachine":
# concrete CimObject has the about parameter set to 0
if cimObject.GetAttribute("about") == 0:
if cimObject.HasParameter(parameter) == 0:
cimObject.SetAttributeEnumeration(parameter, type, value, namespace)

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 of the attribute (e.g. "IdentifiedObject.name")
value Value of the attribute
index Index of the attribute:
0 Default index

457
5.6. OTHERS CHAPTER 5. OBJECT METHODS

E XAMPLE
This example adds the prefix "Load_" to the "IdentifiedObjet.name" attribute for all concrete
"NonConformLoad" CIM objects in the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
cimObjects = project.GetContents("*.CimObject", 1)
for cimObject in cimObjects :
cimClass = cimObject.GetAttribute("cimClass")
if cimClass == "NonConformLoad":
# concrete CimObject has the about parameter set to 0
if cimObject.GetAttribute("about") == 0:
oldName = cimObject.GetParameterValue("IdentifiedObject.name")
newName = "Load_" + oldName
cimObject.SetAttributeValue("IdentifiedObject.name", newName)

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 of the attribute (e.g. "Equipment.aggregate")
value Value of the attribute
nspace Namespace of the attribute (e.g. "cim")

E XAMPLE
This example sets the "Equipment.aggregate" attribute to "false" for all concrete "NonCon-
formLoad" CIM objects in the active project.
import powerfactory
app = powerfactory.GetApplicationExt()

project = app.GetActiveProject()
cimObjects = project.GetContents("*.CimObject", 1)
for cimObject in cimObjects :
cimClass = cimObject.GetAttribute("cimClass")
if cimClass == "NonConformLoad":
# concrete CimObject has the about parameter set to 0
if cimObject.GetAttribute("about") == 0:
cimObject.SetAttributeValue("Equipment.aggregate", "false", "cim")

458
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.7 GrpPage
Overview

ChangeStyle
DoAutoScale
DoAutoScaleX
DoAutoScaleY
GetOrInsertCurvePlot
GetOrInsertPlot
GetPlot
RemovePage
SetAutoScaleModeX
SetAutoScaleModeY
SetLayoutMode
SetResults
SetScaleTypeX
SetScaleTypeY
SetScaleX
SetScaleY
Show

ChangeStyle
Applies the plot style identified by the given name to all plots on this page.
int GrpPage.ChangeStyle(str styleName)

A RGUMENTS
styleName
Name of the style template to apply.

R ETURNS
0 On success.
1 On error.

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.

459
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.
This function is deprecated. Please use the more general function GrpPage.GetOrInsertPlot()
instead.
DataObject GrpPage.GetOrInsertCurvePlot(str name,
[int create = 1]
)

A RGUMENTS
name Name of plot-
create (optional)
Possible values:
0 Do not create new plot if it does not exist already.
1 Create plot if it does not exist already (default).

R ETURNS
Found or created PltLinebarplot object.

GetOrInsertPlot
Finds a plot by name, or creates it if not found.
DataObject GrpPage.GetOrInsertPlot(str name,
int type,
[int create = 1]
)

A RGUMENTS
name Name of plot.
type Type of plot to create:
1 Curve plot.
2 XY plot: curve plot whose x-axis mode is set to ’XY’.
3 Discrete bar plot: curve plot whose x-axis mode is set to ’discrete’.
4 Vector plot.
6 Eigenvalue plot: scatter plot displaying modal eigenvalues.

460
5.6. OTHERS CHAPTER 5. OBJECT METHODS

7 Mode polar plot: vector plot displaying state vectors of an eigenmode.

8 Mode bar plot: bar plot displaying state vectors of an eigenmode.
10 Time-overcurrent plot.
12 R-X plot.
13 Relay operational limits plot.
14 Biased current differential plot.
20 Network graphic: shows a single line diagram on a plot page.
create (optional)
Possible values:
0 Do not create new plot if it does not exist already.
1 Create plot if it does not exist already (default).

R ETURNS
Found or created plot object:

None No matching plot with name was found or created.

PltVectorplot Vector plot, mode polar plot.
PltNetgraphic Network graphic.
PltLinebarplot All other plot types.

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 None otherwise.

S EE ALSO

GrpPage.GetOrInsertPlot()

RemovePage
Closes the graphic page, if currently shown, and deletes it from the database.
None GrpPage.RemovePage()

SetAutoScaleModeX
Defines whether the x-axes on the page should automatically adapt their range on data changes.

None GrpPage.SetAutoScaleModeX(int mode)

461
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mode Possible values:
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
mode Possible values:
0 Off (do not react to data changes).
1 Adapt scale after calculation has finished.
2 Adapt scale during live plotting.

SetLayoutMode
Defines the automatic arrangement of plots on the page.
None GrpPage.SetLayoutMode(int mode)

A RGUMENTS
mode Possible values:
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
res Result object to set or None to reset. Valid result object is any of class ElmRes,
IntComtrade and IntComtradeset.

SetScaleTypeX
Sets the scale type (linear, logarithmic) of all x-axes on the page.
None GrpPage.SetScaleTypeX(int scaleType)

462
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

Show
Displays the diagram page in the desktop.
int GrpPage.Show()

463
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success, no error occurred.
1 Otherwise.

5.6.8 IntAddonvars
Overview

AddDouble
AddDoubleMatrix
AddDoubleVector
AddInteger
AddIntegerVector
AddObject
AddObjectVector
AddString
RemoveParameter
RenameClass
RenameParameter
SetConstraint

AddDouble
Adds a new double parameter to the Data 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
0 attribute was successfully added
-1 error (object cannot be modified)
-2 error (parameter name contains illegal characters)
row error (parameter with same name already exists in returned row)

464
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddDoubleMatrix
Adds a new double vector parameter to the Data Extension configuration object.
int IntAddonvars.AddDoubleMatrix(str parameterName,
str desc,
int initialRows,
int initialColumns,
str unitText,
float initialValue)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
initialRows
The initial number of rows for the matrix

initialColumns
The initial number of columns for the matrix
unitText The unit of the new parameter
initialValue
The initial value for the elements

R ETURNS
0 attribute was successfully added
-1 error (object cannot be modified)
-2 error (parameter name contains illegal characters)
row error (parameter with same name already exists in returned row)

AddDoubleVector
Adds a new double vector parameter to the Data Extension configuration object.
int IntAddonvars.AddDoubleVector(str parameterName,
str desc,
int initialSize,
str unitText,
float initialValue
)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
initialSize The initial size of the vector

unitText The unit of the new parameter

initialValue
The initial value for the elements

465
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 attribute was successfully added
-1 error (object cannot be modified)
-2 error (parameter name contains illegal characters)
row error (parameter with same name already exists in returned row)

AddInteger
Adds a new integer parameter to the Data Extension configuration object.
int IntAddonvars.AddInteger(str parameterName,
str desc,
str unitText,
int 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
0 attribute was successfully added
-1 error (object cannot be modified)
-2 error (parameter name contains illegal characters)
row error (parameter with same name already exists in returned row)

AddIntegerVector
Adds a new integer vector parameter to the Data Extension configuration object.
int IntAddonvars.AddIntegerVector(str parameterName,
str desc,
int initialSize,
str unitText,
int initialValue)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
initialSize The initial size of the vector
unitText The unit of the new parameter
initialValue
The initial value for the elements

466
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 attribute was successfully added
-1 error (object cannot be modified)
-2 error (parameter name contains illegal characters)
row error (parameter with same name already exists in returned row)

AddObject
Adds a new string parameter to the Data Extension configuration object.
int IntAddonvars.AddObject(str parameterName,
str desc,
str classFilter
)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
classFilter
The filter for the objects which are allowed for selection

R ETURNS
Zero if attribute was successfully added. One based row number if there already is a param-
eter with the same name. Returns -1 if the object cannot be modified.

AddObjectVector
Adds a new object vector parameter to the Data Extension configuration object.
int IntAddonvars.AddObjectVector(str parameterName,
str desc,
int initialSize,
str classFilter
)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
initialSize The initial size of the vector
classFilter
The filter for the objects which are allowed for selection

R ETURNS
0 attribute was successfully added
-1 error (object cannot be modified)
-2 error (parameter name contains illegal characters)
row error (parameter with same name already exists in returned row)

467
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddString
Adds a new string parameter to the Data Extension configuration object.
int IntAddonvars.AddString(str parameterName,
str desc,
str unitText,
str 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
0 attribute was successfully added
-1 error (object cannot be modified)
-2 error (parameter name contains illegal characters)
row error (parameter with same name already exists in returned row)

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

RenameClass
Renames the class from the Data Extension configuration.
int IntAddonvars.RenameClass(str newClassName)

A RGUMENTS
newClassName
The new name of the parameter

R ETURNS
0 parameter was successfully renamed
-1 error (new class name contains illegal characters or is too long)
-2 error (current configuration object does not define a custom class)

468
5.6. OTHERS CHAPTER 5. OBJECT METHODS

RenameParameter
Renames the given parameter from the Data Extension configuration.
int IntAddonvars.RenameParameter(str oldPparameterName,
str newPparameterName)

A RGUMENTS
oldParameterName
The old name of the parameter
newParameterName
The new name of the parameter

R ETURNS
0 parameter was successfully renamed
-1 error (new parameter name contains illegal characters)
-2 error (old parameter name does not exist)
-3 error (new parameter name already exists)

SetConstraint
Adds a constraint for the parameter to the Data Extension configuration object.
The arguments passed must be convertible into the configured data type for the parameter.
Upper and lower bounds are mutually exclusive with a list of values. An empty string should be
passed when a constraint should not be used or removed.
int IntAddonvars.SetConstraint(str parameterName,
str minValue,
str maxValue,
str allowedValues
)

A RGUMENTS
parameterName
The name of the parameter to be modified
minValue The minimum value
maxValue
The maximum value

allowedValues
List of the allowed values (;-separated)

R ETURNS
0 ok
-1 error (parameter does not exist)
-2 error (upper/lower bounds and list of values are mutually exclusive)
-3 error (underlying type does not support constraints)
-4 error (upper/lower bounds cannot be used for strings)
-5 error (the values passed cannot be converted into the underlying type)

469
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.9 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.
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

470
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

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.

471
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.10 IntComtrade
Overview

ConvertToASCIIFormat
ConvertToBinaryFormat
FindColumn
FindMaxInColumn
FindMinInColumn
GetAnalogueDescriptions
GetColumnValues
GetDescription
GetDigitalDescriptions
GetNumberOfAnalogueSignalDescriptions
GetNumberOfColumns
GetNumberOfDigitalSignalDescriptions
GetNumberOfRows
GetObjectValue
GetSignalHeader
GetUnit
GetValue
GetVariable
Load
Release
SortAccordingToColumn

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()

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.

472
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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
Find the maximum value of the variable in the given column. IntComtrade.Load() must be called
before using this function.
[int row,
float value] IntComtrade.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.

R ETURNS
<0 The maximum value of column was not found.
≥0 The row with the maximum value of the column.

FindMinInColumn
Find the minimum value of the variable in the given column. IntComtrade.Load() must be called
before using this function.
[int row,
float value] IntComtrade.FindMinInColumn(int column)

A RGUMENTS
column The column index.

value (optional, out)

The minimum value found. The value is 0. in case that the minimum value was
not found.

473
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
<0 The minimum value of column was not found.
≥0 The row with the minimum value of the column.

GetAnalogueDescriptions
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.

GetColumnValues
Get complete column values. IntComtrade.Load() must be called before using this function.
int IntComtrade.GetColumnValues(DataObject dataVector,
int column)

A RGUMENTS
dataVector
IntVec which will be filled with column values.
column The column index. -1 for default (e.g. time).

R ETURNS
=0 Column values were found.
=1 dataVector is None.
=2 dataVector is not of class IntVec.
=3 Column index is out of range.

GetDescription
Get the description of a column. IntComtrade.Load() must be called before using this function.
str IntComtrade.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

474
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns the description which is empty in case that the column index is not part of the data.

GetDigitalDescriptions
Get the descriptions of the digital 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.GetDigitalDescriptions(int index)

A RGUMENTS
index Digital channel index

R ETURNS
Descriptions for digital channel in the comtrade info file.

GetNumberOfAnalogueSignalDescriptions
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
Returns the number of variables (columns) in result file excluding the default variable (e.g. time
for time domain simulation). IntComtrade.Load() must be called before using this function.
int IntComtrade.GetNumberOfColumns()

R ETURNS
Number of variables (columns) in result file.

GetNumberOfDigitalSignalDescriptions
Get the number of descriptions for digital 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.GetNumberOfDigitalSignalDescriptions()

R ETURNS
Number of descriptions for digital channels in the comtrade info file.

475
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetNumberOfRows
Returns the number of values per column (rows) stored in result object. IntComtrade.Load()
must be called before using this function.
int IntComtrade.GetNumberOfRows()

R ETURNS
Returns the number of values per column stored in result object.

GetObjectValue
Returns a value from a result object for row iX of curve col. IntComtrade.Load() must be called
before using this function.
[int error,
DataObject o ] IntComtrade.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
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.

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
Get the unit of a column. IntComtrade.Load() must be called before using this function.
str IntComtrade.GetUnit([int column])

476
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

GetValue
Returns a value from a result object for row iX of curve col. IntComtrade.Load() must be called
before using this function.
[int error,
float d ] IntComtrade.GetValue(int iX,
[int col])

A RGUMENTS
d (out) The value 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
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.

GetVariable
Get variable name of column. IntComtrade.Load() must be called before using this function.
str IntComtrade.GetVariable([int column])

A RGUMENTS
column (optional)
The column index. The variable name of the default variable is returned if the
parameter is nor passed to the function.

R ETURNS
Returns the variable name which is empty in case that the column index is not part of the
data.

477
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Load
Loads the data of a result object (IntComtrade) in memory for reading.
None IntComtrade.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 IntComtrade.Release()

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The IntComtrade itself remains
unchanged. IntComtrade.Load() must be called before using this function.
int IntComtrade.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.

5.6.11 IntComtradeset
Overview

FindColumn
FindMaxInColumn
FindMinInColumn
GetAnalogueDescriptions
GetColumnValues
GetDescription
GetDigitalDescriptions
GetNumberOfAnalogueSignalDescriptions
GetNumberOfColumns
GetNumberOfDigitalSignalDescriptions
GetNumberOfRows
GetObjectValue
GetSignalHeader
GetUnit
GetValue
GetVariable
Load
Release
SortAccordingToColumn

478
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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
Find the maximum value of the variable in the given column. IntComtradeset.Load() must be
called before using this function.
[int row,
float value] IntComtradeset.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.

R ETURNS
<0 The maximum value of column was not found.
≥0 The row with the maximum value of the column.

FindMinInColumn
Find the minimum value of the variable in the given column. IntComtradeset.Load() must be
called before using this function.
[int row,
float value] IntComtradeset.FindMinInColumn(int column)

A RGUMENTS
column The column index.

value (optional, out)

The minimum value found. The value is 0. in case that the minimum value was
not found.

479
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
<0 The minimum value of column was not found.
≥0 The row with the minimum value of the column.

GetAnalogueDescriptions
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 IntComtradeset.GetAnalogueDescriptions(int index)

A RGUMENTS
index Digital channel index.

R ETURNS
Descriptions for analogue channel in the comtrade info file.

GetColumnValues
Get complete column values. IntComtradeset.Load() must be called before using this function.
int IntComtradeset.GetColumnValues(DataObject dataVector,
int column)

A RGUMENTS
dataVector
IntVec which will be filled with column values.
column The column index. -1 for default (e.g. time).

R ETURNS
=0 Column values were found.
=1 dataVector is None.
=2 dataVector is not of class IntVec.
=3 Column index is out of range.

GetDescription
Get the description of a column. IntComtradeset.Load() must be called before using this func-
tion.
str IntComtradeset.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

480
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns the description which is empty in case that the column index is not part of the data.

GetDigitalDescriptions
Get the descriptions of the digital channel Please note that the comtrade info file contains
proprietary data from PFM. Info files not written by DIgSILENT PFM are not supported.
str IntComtradeset.GetDigitalDescriptions(int index)

A RGUMENTS
index Digital channel index

R ETURNS
Descriptions for digital channel in the comtrade info file.

GetNumberOfAnalogueSignalDescriptions
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 IntComtradeset.GetNumberOfAnalogueSignalDescriptions()

R ETURNS
Number of descriptions for analogue channels in the comtrade info file.

GetNumberOfColumns
Returns the number of variables (columns) in result file excluding the default variable (e.g. time
for time domain simulation). IntComtradeset.Load() must be called before using this function.
int IntComtradeset.GetNumberOfColumns()

R ETURNS
Number of variables (columns) in result file.

GetNumberOfDigitalSignalDescriptions
Get the number of descriptions for digital 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 IntComtradeset.GetNumberOfDigitalSignalDescriptions()

R ETURNS
Number of descriptions for digital channels in the comtrade info file.

481
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetNumberOfRows
Returns the number of values per column (rows) stored in result object. IntComtradeset.Load()
must be called before using this function.
int IntComtradeset.GetNumberOfRows()

R ETURNS
Returns the number of values per column stored in result object.

GetObjectValue
Returns a value from a result object for row iX of curve col. IntComtradeset.Load() must be
called before using this function.
[int error,
DataObject o ] IntComtradeset.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
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.

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
Get the unit of a column. IntComtradeset.Load() must be called before using this function.
str IntComtradeset.GetUnit([int column])

482
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

GetValue
Returns a value from a result object for row iX of curve col. IntComtradeset.Load() must be
called before using this function.
[int error,
float d ] IntComtradeset.GetValue(int iX,
[int col])

A RGUMENTS
d (out) The value 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
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.

GetVariable
Get variable name of column. IntComtradeset.Load() must be called before using this function.
str IntComtradeset.GetVariable([int column])

A RGUMENTS
column (optional)
The column index. The variable name of the default variable is returned if the
parameter is nor passed to the function.

R ETURNS
Returns the variable name which is empty in case that the column index is not part of the
data.

483
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Load
Loads the data of a result object (IntComtradeset) in memory for reading.
None IntComtradeset.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 IntComtradeset.Release()

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The IntComtradeset itself
remains unchanged. IntComtradeset.Load() must be called before using this function.
int IntComtradeset.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.

5.6.12 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

484
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

R ETURNS
All objects of given class stored in dataset object.

5.6.13 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.

485
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

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.14 IntDplmap
Overview

Clear
Contains
First
GetValue
Insert
Next
Remove
Size
Update
486
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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:

• 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)

487
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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)

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()

488
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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
key Key of the associated pair in the container

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.

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
key Key of the associated pair in the container
value Value of the associated pair in the container

489
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.15 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]
)

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.

490
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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:

string lexically
double/int
according to value

object according to full name (path + name) or given attribute

None IntDplvec.Sort([int descending,]

[str attribute]
)

491
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.16 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.
1 Remove all switch events only when this fault case is used for contin-
gency analysis.

492
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.17 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.18 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.19 IntGrf
Overview

MoveToLayer
Orthogonalise
SnapToGrid

MoveToLayer
Moves an IntGrf object to the selected target layer, provided that the object is a valid object
for that layer. Annotation elements stored as (obsolete) IntGrf objects can be moved to any
annotation layer (IntGrflayer ) or group (IntGrfgroup).
None IntGrf.MoveToLayer(DataObject layer)

493
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
layer Target IntGrflayer or IntGrfgroup object.

Orthogonalise
Orthogonalises this IntGrf object. Only suitable for branch elements.
Note: The parent diagram of this object needs to be the active graphic page during execution of
this function, and ’Ortho’ mode needs to be enabled.
int IntGrf.Orthogonalise()

R ETURNS
0 On success.
1 An error occurred. See log file for details.

SnapToGrid
Snaps this IntGrf object to grid.
Note: The parent diagram of this object needs to be the active graphic page during execution of
this function, and ’Snap’ mode needs to be enabled.
int IntGrf.SnapToGrid()

R ETURNS
0 On success.
1 An error occurred. See log file for details.

5.6.20 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

494
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

5.6.21 IntGrflayer
Overview

AdaptWidth
AddAnnotationElement
Align
ChangeFont
ChangeLayer
ChangeRefPoints
ChangeWidthVisibilityAndColour
CheckAnnotationString
ClearData
Export
ExportToVec
GetAnnotationElement
GetNumberOfAnnotationElements
Import
ImportFromVec
Mark
RemoveAnnotationElement
Reset
UpdateAnnotationElement

AdaptWidth
Resizes the specified group of text boxes regarding their maximum text length.
None IntGrflayer.AdaptWidth(int objectType,
[str symbolName])

A RGUMENTS
objectType
Object type

0 Nodes and branches

1 Nodes

495
5.6. OTHERS CHAPTER 5. OBJECT METHODS

2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

AddAnnotationElement
Adds the element specified in intDplMap to the current layer. If a batch of annotation elements
is processed, one should only enable writeToDB for the last process to increase performance.
Refer to IntGrflayer.UpdateAnnotationElement() for an example. Composite elements such as
"Polyline with arrow" are not supported.
int IntGrflayer.AddAnnotationElement(object intDplMap,
bool writeToDB
)

A RGUMENTS
intDplMap
IntDplmap object which contains the element to be added
writeToDB
True by default: If set to false, the changes only occur in memory (and the validity
of the inserted element is not verfied)

R ETURNS
0 on success
1 on failure

Align
Aligns the text within a text box.
None IntGrflayer.Align(int alignPos,
int objectType,
[string symbolName])

A RGUMENTS
alignPos Alignment within bounding box
0 left
1 middle
2 right
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

496
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ChangeFont
Sets the font number for the specified group of text boxes.
None IntGrflayer.ChangeFont(str fontName,
int fontSize,
int fontStyle,
int objectType,
[str symbolName])

A RGUMENTS
fontName
Font name
fontSize Font size
fontStyle Font style
0 Regular
1 Bold
2 Italic
3 Bold and Italic
4 Underline
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

ChangeLayer
Sets the specified group of text boxes to a given layer.
None IntGrflayer.ChangeLayer(DataObject newLayer,
int objectType,
[str symbolName])

A RGUMENTS
newLayer Layer object
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

497
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ChangeRefPoints
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 IntGrflayer.ChangeRefPoints(int parentRef,

int textBoxRef,
int objectType,
[str symbolName])

A RGUMENTS
parentRef
Defines the reference point on the parent object (e.g. busbar)
textBoxRef
Defines the reference point on the text box
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

ChangeWidthVisibilityAndColour
Sets the visibility of the frame, the width (in number of letters), the visibility and the colour of text
boxes.
None IntGrflayer.ChangeWidthVisibilityAndColour(int objectType,
[string symbolName],
[int columns],
[int visibility],
[int colorNumber])

A RGUMENTS
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent

498
5.6. OTHERS CHAPTER 5. OBJECT METHODS

symbolName
Symbol name (only relevant if objectType == 3)

columns Sets the width in number of letters

0..n columns
visibility Sets the visibility

0 not visible
1 visible
colorNumber
Sets the colour
0..255 colorNumber

CheckAnnotationString
Checks if the annotation string is valid. Refer to IntGrflayer.UpdateAnnotationElement() for an
example.
int IntGrflayer.CheckAnnotationString()

R ETURNS
0 on success
1 on failure,outputs a list of errors in the console.

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 or plain text (.txt), inclusive annotation objects of
contained group objects.
None IntGrflayer.Export(str path,
[int OpenDialog]
)

A RGUMENTS
path Full export file path. Supported formats: .svg and .txt.

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

499
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

GetAnnotationElement
Retrieves attributes of a single annotation element and writes them into an IntDplmap. Clears
IntDplmap before filling it. Refer to IntGrflayer.UpdateAnnotationElement() for an example. For
composite geometries (such as "Polyline with Arrow"), the first element will be retrieved.
int IntGrflayer.GetAnnotationElement(int index,
object intDplMap
)

A RGUMENTS
index index of the annotation element to be retrieved
intDplMap
IntDplmap) object to be filled

R ETURNS
0 on success
1 on failure

GetNumberOfAnnotationElements
Returns the number of annotation elements contained by this layer. Refer to
IntGrflayer.UpdateAnnotationElement() for an example.
int IntGrflayer.GetNumberOfAnnotationElements()

R ETURNS
≥0 number of annotation elements
-1 if internal annotation elements string is invalid

Import
Imports svg file or plain text (.txt) into layer.
None IntGrflayer.Import(str path)

A RGUMENTS
path Path of file to be imported. Supported formats: .svg and .txt.

500
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

Mark
Marks the specified group of text boxes in the currently shown diagram.
None IntGrflayer.Mark(int objectType,
[string symbolName])

A RGUMENTS
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

RemoveAnnotationElement
Removes annotation element at position index of current layer. If a batch of annotation elements
is processed, one should only enable writeToDB for the last process to increase performance.
Refer to IntGrflayer.UpdateAnnotationElement() for an example.
int IntGrflayer.RemoveAnnotationElement(int index)

A RGUMENTS
index Index of the element that will be removed
writeToDB
True by default: If set to false, the changes only occur in memory

R ETURNS
0 on success
1 on failure

Reset
Resets the individually modified text box settings.
None IntGrflayer.Reset(int mode,
int objectType,
[str symbolName])

501
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 'Labels')
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

UpdateAnnotationElement
Updates the element at position index in the current layer with the information contained in
intDplMap. For composite geometries (such as "Polyline with Arrow"), the first element will be
updated.
int IntGrflayer.UpdateAnnotationElement(int index,
object intDplMap,
bool writeToDB
)

A RGUMENTS
index The index of the element that will be updated.
intDplMap
IntDplmap object which contains the updated element.
writeToDB
True by default: If set to false, the changes only occur in memory.

R ETURNS
0 On success.
1 On failure.

S EE ALSO

IntGrflayer.AddAnnotationElement(), IntGrflayer.RemoveAnnotationElement(),
IntGrflayer.GetAnnotationElement()

E XAMPLE
import powerfactory
app = powerfactory.GetApplicationExt()
script = app.GetCurrentScript()
annotationLayer = script.annotationLayer
dplMap = script.dplMap

502
5.6. OTHERS CHAPTER 5. OBJECT METHODS

dplMap.Clear();
dplMap.Insert('type','Line');
dplMap.Insert('color','{0,255,0}');
dplMap.Insert('points','{{10,100},{30,200}}');
dplMap.Insert('thickness','1');

annotationLayer.AddAnnotationElement(dplMap);

dplMap.Clear();
dplMap.Insert('type','Polygon');
dplMap.Insert('points','{{20,20},{50,20},{50,50},{20,50}}');
dplMap.Insert('lineColor','{255,0,0}');
dplMap.Insert('lineThickness','1');

annotationLayer.AddAnnotationElement(dplMap);

dplMap.Clear();
dplMap.Insert('type','Line');
dplMap.Insert('color','{255,255,0}');
dplMap.Insert('points','{{10,100},{30,200}}');
dplMap.Insert('thickness','1');

annotationLayer.AddAnnotationElement(dplMap);

numElements = annotationLayer.GetNumberOfAnnotationElements()
app.PrintPlain(str(annotationLayer) + ': ' + str(numElements) +
'elements')

for i in range(numElements):
ret = annotationLayer.GetAnnotationElement(i,dplMap)
app.PrintPlain(
'Attributes of annotation element at index {}:'.format(i));
_,key,value = dplMap.First()
app.PrintPlain('{} -> {}'.format(key,value))
for j in range(dplMap.Size()-1):
_,key,value = dplMap.Next()
app.PrintPlain('{} -> {}'.format(key,value))

dplMap.Clear();
dplMap.Insert('type','Polygon');
dplMap.Insert('points','{{20,20},{50,20},{50,50},{20,50}}');
dplMap.Insert('lineColor','{0,255,0}');
dplMap.Insert('lineThickness','1');

annotationLayer.UpdateAnnotationElement(1,dplMap)
annotationLayer.RemoveAnnotationElement(2);

numElements = annotationLayer.GetNumberOfAnnotationElements()
app.PrintPlain(str(annotationLayer) + ': ' + str(numElements) +
' elements')

for i in range(numElements):
ret = annotationLayer.GetAnnotationElement(i,dplMap)
app.PrintPlain(
'Attributes of annotation element at index {}:'.format(i));
_,key,value = dplMap.First()

503
5.6. OTHERS CHAPTER 5. OBJECT METHODS

app.PrintPlain('{} -> {}'.format(key,value))

for j in range(dplMap.Size()-1):
_,key,value = dplMap.Next()
app.PrintPlain('{} -> {}'.format(key,value))

5.6.22 IntGrfnet
Overview

Close
SetFontFor
SetLayerVisibility
SetSymbolComponentVisibility
Show

Close
Closes the graphic page that displays this diagram.
int IntGrfnet.Close()

R ETURNS
0 On success, no error occurred.
1 Otherwise

SetFontFor
Sets a font for a specified group of text boxes.
None IntGrfnet.SetFontFor(int labelResultOrTitle,
int nodesOrBranches,
str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
labelResultOrTitle
Type of text box to be modified.
0 Labels
1 Results
2 Title and Legends

nodesOrBranches
Type of parent object
0 Nodes
1 Branches

fontName
Font name
fontSize Font size

504
5.6. OTHERS CHAPTER 5. OBJECT METHODS

fontStyle Font style

1 Bold
2 Italic
3 Bold and italic
4 Underline

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)

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.

505
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Show
Opens a diagram.
int IntGrfnet.Show()

R ETURNS
0 On success, no error occurred.
1 Otherwise

5.6.23 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’

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()

506
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.24 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

5.6.25 IntMat
Overview

ColLbl
Get
GetColumnLabel
GetColumnLabelIndex
GetNumberOfColumns
GetNumberOfRows
GetRowLabel
GetRowLabelIndex
Init
Invert
Multiply
Resize
RowLbl
Save
Set
SetColumnLabel
SetRowLabel
SortToColumn

507
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

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)

508
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

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.

509
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

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
Always 1 and can be ignored.

S EE ALSO

IntMat.Resize()

510
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Invert
Inverts the matrix.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
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.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
int IntMat.Multiply(DataObject M1,
DataObject M2
)

A RGUMENTS
object M1
Matrix 1 to be multiplied.
object M2
Matrix 2 to be multiplied.

R ETURNS
Always 0 and can be ignored.

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.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
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.

511
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Always 1 and can be ignored.

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.
If the matrix is calculation relevant, an optional parameter allows to control whether available
calculation results shall be reset afterwards or not.
Note: In QDSL, the calculation results are never reset and the parameter "resetCalculation" is
ignored.
None IntMat.Save()
None IntMat.Save(int resetCalculation)

A RGUMENTS
resetCalculation (optional)
1 reset calculation results (default)
0 keep calculation results

Set
Sets a value at the position (row, column) of the matrix. The matrix is resized automatically if
the given coordinates exceed the size.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
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.

512
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Always 1 and can be ignored.

S EE ALSO

IntMat.Get()

SetColumnLabel
Sets the label of a column.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
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.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
str IntMat.SetRowLabel(int row,
str label
)

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])

513
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.26 IntMon
Overview

AddVar
AddVars
ClearVars
GetVar
NVars
PrintAllVal
PrintVal
RemoveVar

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.

514
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

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.

515
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 If variable with name was found and removed.
1 If the variable name was not found.

5.6.27 IntNndata
Overview

CheckConsistency

CheckConsistency
Checks whether the current power grid state matches the state with which the dataset was
originally generated.
int IntNndata.CheckConsistency()

R ETURNS
0 The power grid state matches the state the dataset was generated with.
1 The power grid state does not match the state the dataset was generated with.

5.6.28 IntNnet
Overview

CheckConsistency

CheckConsistency
Checks whether the current power grid state matches the state with which the neural network
was originally trained.
int IntNnet.CheckConsistency()

R ETURNS
0 The power grid state matches the state the neural network was trained with.
1 The power grid state does not match the state the neural network was trained
with.

5.6.29 IntOutage
Overview

Apply
ApplyAll
Check
CheckAll
IsInStudyTime
ResetAll

516
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

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
reportSwitches (optional)
Flag to enable the reporting of changed switches to the output window.
0 No output (default)
1 Print switches to output window

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.
0 No output (default)
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,])

517
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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).

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
reportSwitches (optional)
Flag to enable the reporting of changed switches to the output window.
0 No output (default)
1 Print switches to output window

518
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.30 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)

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.31 IntPrj
Overview

Activate
AddProjectToCombined
AddProjectToRemoteDatabase
Archive
BeginDataExtensionModification
CanAddProjectToRemoteDatabase
CanSubscribeProjectReadOnly
CanSubscribeProjectReadWrite
CopyDataExtensionFrom
CopyProjectSettings
CreateVersion
Deactivate
EndDataExtensionModification
GetDerivedProjects
GetExternalReferences
GetGeoCoordinateSystem
GetLatestVersion
GetVersions
HasExternalReferences
LoadCimData
LoadData
MergeToBaseProject
NormaliseCombined
PackExternalReferences
Purge
PurgeObjectKeys
RemoveProjectFromCombined
Restore

519
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetGeoCoordinateSystem
SubscribeProjectReadOnly
SubscribeProjectReadWrite
TransformGeoCoordinates
TransformToGeographicCoordinateSystem
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()

520
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 project has been archived
1 project has not been archived

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()

521
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 no permission to subscribe project
1 project can be subscribed

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

CopyProjectSettings
Copies project settings from another project or the default project into this project. The target
project must not be active.
int IntPrj.CopyProjectSettings([object other])

A RGUMENTS
other (optional)
Project to copy the settings from. Copy settings from default project if omitted.

R ETURNS
0 Copied successfully
1 Project is active
2 Source object is not a project

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 = "",]

522
5.6. OTHERS CHAPTER 5. OBJECT METHODS

[float timestamp = 0,]

[str description = ""]
)

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

523
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

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()

524
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
EPSG code of the project’s geographic coordinate system, or 0 if the coordinate system is
not known.

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.
externalReferencesSettings (optional)
External References settings object (SetExtref). Defines the properties for objects
being external references.

525
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 No external reference was found.
1 An external reference was found.

S EE ALSO

IntPrj.PackExternalReferences(), IntPrj.GetExternalReferences()

LoadCimData
Efficiently loads all objects of a project’s CIM Model folder from the database.
Project activation loads everything but the CIM Model folder from the database. This function is
useful to optimise the traversal of the CIM Model folder.
None IntPrj.LoadCimData()

S EE ALSO

IntPrj.LoadData()

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()

S EE ALSO

IntPrj.LoadCimData()

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).

526
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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).

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
0 operation was successful
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
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 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()

PurgeObjectKeys
Purges project’s object key table.

527
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Number of purged records. −1 in case of errors.
int IntPrj.PurgeObjectKeys()

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

R ETURNS
0 operation was successful
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.

528
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SubscribeProjectReadOnly
Subscribes a project read only if the permission is granted.
Can only be used if the database driver is set to Offline Mode.
None IntPrj.SubscribeProjectReadOnly()

SubscribeProjectReadWrite
Subscribes a project read/write if the permission is granted.
Can only be used if the database driver is set to Offline Mode.
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.
[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
0 operation was successful
1 an error occurred

TransformToGeographicCoordinateSystem
Transforms geographic coordinates of all net elements contained by the project to a destina-
tion coordinate system, and updates the configured project coordinate system accordingly.
Please note: The project’s geographic diagram needs to be shown when this function is called.
Otherwise, annotations will not be transformed.
[int error] IntPrj.TransformToGeographicCoordinateSystem(int destEpsg)

529
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
destEpsg EPSG code of the destination coordinate system

R ETURNS
0 operation was successful
1 an error occurred

UnsubscribeProject
Unsubscribes a project.
Can only be used if the database driver is set to Offline Mode.
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
)

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
0 operation was successful
1 operation was not successful, e.g. project not active

530
5.6. OTHERS CHAPTER 5. OBJECT METHODS

UpdateToMostRecentBaseVersion
Creates a new derived project from most recent version of the base project and (optionally)
merges the modifications from the existing derived project into it. The existing derived project is
moved to the recycle bin.
[ int errorCode,
DataObject newDerivedProject ]
IntPrj.UpdateToMostRecentBaseVersion(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 derived 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.

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.32 IntPrjfolder
Overview

GetProjectFolderType
IsProjectFolderType

531
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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
• lvdata - Coincidence Definitions
• mvar - Mvar Limit Curves
• netdat - Network Data
• netmod - Network Model
• oplib - Operational Library
• outage - Outages
• qpc - QP-Curves
• qvc - QV-Curves
• ra - Running Arrangements
• report - Reports
• docs - Document Reports
• tables - Tabular Reports
• scen - Operation Scenarios
• scheme - Variations
• script - Scripts
• study - Study Cases
• sw - StationWare

532
5.6. OTHERS CHAPTER 5. OBJECT METHODS

• 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.33 IntQlim
Overview

GetQlim

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.

533
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.34 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.

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.

534
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.35 IntReport
Overview

AddObject
AddObjects
CreateField
CreateTable
GetFieldCount
GetFieldDataType
GetFieldName
GetObjects
GetParameterValueAsDouble
GetParameterValueAsInteger
GetParameterValueAsString
GetRowCount
GetTableCount
GetTableName
GetValueAsDouble
GetValueAsInteger
GetValueAsObject
GetValueAsString
Reset
SetDefaultValue
SetValue

AddObject
Adds the given object to the set of objects that are considered during report creation.
Typically, objects are automatically collected based on the Variable Selections in the report.
In some cases, however, it might be necessary to manually add objects to the report creation
mechanism.
The added object will be included in the return value of IntReport.GetObjects(). Moreover, if a
Variable Selection for the class of the given object exists in the report, the corresponding table
will include a row for the given object.
If the given object is already present in the set of collected objects (regardless if it was automat-
ically collected or added with a previous call of this method or IntReport.SetObjects()), it will not
be added a second time.
None IntReport.AddObject(DataObject objectToAdd)

A RGUMENTS
objectToAdd
The object to be added to the report generation mechanism. Null objects are
ignored.

S EE ALSO

IntReport.AddObjects(), IntReport.GetObjects()

535
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddObjects
Adds the given list of objects to the set of objects that are considered during report creation.
See IntReport.AddObject() for more details on adding objects.
None IntReport.AddObjects(list objectsToAdd)

A RGUMENTS
objectsToAdd
List of objects to be added to the report generation mechanism.

S EE ALSO

IntReport.AddObject(), IntReport.GetObjects()

CreateField
Creates a new field (i.e. a column) with the specified name and data type, appending it
to the specified table. The referenced table must have been previously created using the
IntReport.CreateTable() method.
int IntReport.CreateField(str tableName,
str fieldName,
int dataType)

A RGUMENTS
tableName
The name of a table (previously created using IntReport.CreateTable()).
fieldName
The name of the new field, which must satisfy all of the following conditions:

• The name is not empty.

• The name only includes characters of the English alphabet, digits and under-
scores.
• The name does not start with a digit or a capital (upper-case) character.

dataType An integer specifying the data type of the field. Possible values are
0 String
1 Integer
2 Floating point number (double)
3 Object

R ETURNS
An error code. Possible values are

0 No error has occurred, the field has been successfully created.

1 No table with the given name has been found.
2 The given field name is empty or blank.
3 Another field with the given name was already created for the specified table.
4 The given data type has no valid value (see argument description of dataType).

536
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

IntReport.GetFieldCount(), IntReport.GetFieldName(), IntReport.GetFieldDataType()

CreateTable
Creates a new table with the given name.
In order to be visible in the Report Designer, a table needs to have at least one field (i.e. a
column). Fields are created using the IntReport.CreateField() method.
Using the IntReport.SetValue() method, a table with fields can be filled with values, which are
stored in rows (containing one value per table field).
Please note that the name of the table will be shown with the prefix ’Scripted’ in the Report
Designer (e.g. a table created with the name ’MyTable’ will be shown as ’ScriptedMyTable’ in
the Report Designer). This mechanism helps to avoid name collisions with other, automatically
generated tables (e.g. tables based on Variable Selections) and allows to quickly identify tables
created by scripts in the Report Designer.
int IntReport.CreateTable(str name)

A RGUMENTS
name The name of the new table, which may only include characters of the English
alphabet, digits and underscores and must not be empty.

R ETURNS
An error code. Possible values are

0 No error has occurred, the table has been successfully created.

1 The given table name is empty or blank.
2 The given table name contains invalid characters (see description of argument
name).
3 Another table with the given name was already created.

GetFieldCount
Returns the number of fields in the specified table.
int IntReport.GetFieldCount(str tableName)

A RGUMENTS
tableName
The name of the table.

R ETURNS
The number of fields in the specified table or -1 if the specified table does not exist.

S EE ALSO

IntReport.CreateField(), IntReport.GetFieldName(), IntReport.GetFieldDataType()

537
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetFieldDataType
Returns the data type (encoded as integer) of the specified field in the specified table.
int IntReport.GetFieldDataType(str tableName,
str fieldName)

A RGUMENTS
tableName
The name of the table.
fieldName
The name of the field.

R ETURNS
An integer specifying the data type of the field or signalling an error. Possible values are

-1 Error. The specified table or the specified field does not exist.
0 String
1 Integer
2 Floating point number (double)
3 Object

S EE ALSO

IntReport.CreateField(), IntReport.GetFieldCount(), IntReport.GetFieldName()

GetFieldName
Determines the name of the field at the given field index of the specified table.
The given field index must be a non-negative number that is smaller than the field count of the
specified table, which can be determined by calling IntReport.GetFieldCount().
[int error, str name] IntReport.GetFieldName(str tableName,
int fieldIndex)

A RGUMENTS
tableName
The name of the table.
fieldIndex The index of the field (non-negative integer that is smaller than the field count of
the specified table).

name (out)
The name of the field.

R ETURNS
An error code. Possible values are:

0 No error has occurred, the field name has been successfully determined.
1 The specified table does not exist or the field index is out of bounds.

538
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

IntReport.CreateField(), IntReport.GetFieldCount(), IntReport.GetFieldDataType()

GetObjects
Returns all objects that were collected by the report generation mechanism.
Besides objects that were automatically collected based the Variable Selections of a report,
this set also includes objects that were added in the AddObjects script of the report (see
IntReport.AddObject() for details).
list IntReport.GetObjects()

R ETURNS
A list of all collected objects.

S EE ALSO

IntReport.AddObject(), IntReport.AddObjects()

GetParameterValueAsDouble
Returns the current value of the report parameter with the specified identifier as double.
This method is intended to be used with report parameters of data type ’Double’ only.
[int error, float value] IntReport.GetParameterValueAsDouble(str identifier)

A RGUMENTS
identifier The identifier of the report parameter.
value (out)
The current value of the report parameter.

R ETURNS
An error code. Possible values are

0 No error has occurred, the value has been successfully read.

1 No report parameter with the given identifier has been found.
2 The data type of the specified parameter is not numeric, conversion into double is
not possible.

S EE ALSO

IntReport.GetParameterValueAsString(), IntReport.GetParameterValueAsInteger()

GetParameterValueAsInteger
Returns the current value of the report parameter with the specified identifier as integer.
This method is intended to be used with report parameters of data type ’Integer’ or ’Boolean’
only.
Please note that the values of boolean report parameters are treated as integers, with 0 repre-
senting ’false’ and 1 representing ’true’.
[int error, int value] IntReport.GetParameterValueAsInteger(str identifier)

539
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
identifier The identifier of the report parameter.
value (out)
The current value of the report parameter.

R ETURNS
An error code. Possible values are

0 No error has occurred, the value has been successfully read.

1 No report parameter with the given identifier has been found.
2 The data type of the specified parameter is not numeric, conversion into integer is
not possible.

S EE ALSO

IntReport.GetParameterValueAsString(), IntReport.GetParameterValueAsDouble()

GetParameterValueAsString
Returns the current value of the report parameter with the specified identifier as string.
This method is intended to be used with report parameters of data type ’String’ only.
[int error, str value] IntReport.GetParameterValueAsString(str identifier)

A RGUMENTS
identifier The identifier of the report parameter.
value (out)
The current value of the report parameter.

R ETURNS
An error code. Possible values are

0 No error has occurred, the value has been successfully read.

1 No report parameter with the given identifier has been found.

S EE ALSO

IntReport.GetParameterValueAsInteger(), IntReport.GetParameterValueAsDouble()

GetRowCount
Returns the number of rows of the specified table.
The row count of a table is determined by the highest position, for which any of its field was
assigned a value using the method IntReport.SetValue(). As positions start with zero (i.e. the
first table row has position zero, the second table row has position one, and so on), the row
count is always the highest position plus one. If the method IntReport.SetValue() method has
not been called on any field of the table, the row count will be zero. The value returned by this
method can thus be used to determine the position for a new table row.
int IntReport.GetRowCount(str tableName)

540
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
tableName
The name of the table.

R ETURNS
The number of rows in the specified table or -1 if the specified table does not exist.

S EE ALSO

IntReport.SetValue(), IntReport.GetValue()

GetTableCount
Returns the number of tables that have been created (using IntReport.CreateTable()).
int IntReport.GetTableCount()

R ETURNS
The number of tables that have been created (using IntReport.CreateTable()).

S EE ALSO

IntReport.GetTableName()

GetTableName
Determines the name of the table with the given table index.
The given table index must be a non-negative number that is smaller than the current table
count, which can be determined by calling IntReport.GetTableCount().
[int error, str name] IntReport.GetTableName(int tableIndex)

A RGUMENTS
tableIndex
The index of the table (a non-negative integer that is smaller than the current table
count).
name (out)
The name of the table.

R ETURNS
An error code. Possible values are:

0 No error has occurred, the table name was successfully determined.

1 The given table index is out of bounds.

S EE ALSO

IntReport.GetTableCount()

541
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetValueAsDouble
Determines the double value at the given position (row) of the specified field in the specified
table.
If the value at the given position of the specified field was not previously set (see
IntReport.SetValue()), the default value of the field is returned instead (see
IntReport.SetDefaultValue()).
This method is intended to be used with double fields only.
[int error, float value] IntReport.GetValueAsDouble(str tableName,
str fieldName,
int position)

A RGUMENTS
tableName
The name of the table.

fieldName
The name of the field.
position The position (row).
value (out)
The value at the given position (row) of the specified field in the specified table.

R ETURNS
An error code. Possible values are

0 No error has occurred, the value has been successfully read.

1 No table with the given name has been found.
2 No field with the given name has been found in the given table.
3 The data type of the given value argument does not match the data type of the
given field.
4 The given position is out of bounds (negative or equal or greater than the row
count of the table).

S EE ALSO

IntReport.SetValue(), IntReport.SetDefaultValue(), IntReport.GetValueAsString(),

IntReport.GetValueAsInteger(), IntReport.GetValueAsObject()

GetValueAsInteger
Determines the integer value at the given position (row) of the specified field in the specified
table.
If the value at the given position of the specified field was not previously set (see
IntReport.SetValue()), the default value of the field is returned instead (see
IntReport.SetDefaultValue()).
This method is intended to be used with integer fields only.
[int error, int value] IntReport.GetValueAsInteger(str tableName,
str fieldName,
int position)

542
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
tableName
The name of the table.
fieldName
The name of the field.
position The position (row).
value (out)
The value at the given position (row) of the specified field in the specified table.

R ETURNS
An error code. Possible values are

0 No error has occurred, the value has been successfully read.

1 No table with the given name has been found.
2 No field with the given name has been found in the given table.
3 The data type of the given value argument does not match the data type of the
given field.
4 The given position is out of bounds (negative or equal or greater than the row
count of the table).

S EE ALSO

IntReport.SetValue(), IntReport.SetDefaultValue(), IntReport.GetValueAsString(),

IntReport.GetValueAsDouble(), IntReport.GetValueAsObject()

GetValueAsObject
Determines the object at the given position (row) of the specified field in the specified table.
If the object at the given position of the specified field was not previously set (see IntRe-
port.SetValue()), the null object is returned instead.
This method is intended to be used with object fields only.
[int error, DataObject value] IntReport.GetValueAsObject(str tableName,
str fieldName,
int position)

A RGUMENTS
tableName
The name of the table.
fieldName
The name of the field.
position The position (row).
value (out)
The object at the given position (row) of the specified field in the specified table.

R ETURNS
An error code. Possible values are

0 No error has occurred, the value has been successfully read.

543
5.6. OTHERS CHAPTER 5. OBJECT METHODS

1 No table with the given name has been found.

2 No field with the given name has been found in the given table.
3 The data type of the given value argument does not match the data type of the
given field.
4 The given position is out of bounds (negative or equal or greater than the row
count of the table).

S EE ALSO

IntReport.SetValue(), IntReport.SetDefaultValue(), IntReport.GetValueAsString(),

IntReport.GetValueAsInteger(), IntReport.GetValueAsDouble()

GetValueAsString
Determines the string value at the given position (row) of the specified field in the specified table.
If the value at the given position of the specified field was not previously set (see
IntReport.SetValue()), the default value of the field is returned instead (see
IntReport.SetDefaultValue()).
This method is intended to be used with string fields only.
[int error, str value] IntReport.GetValueAsString(str tableName,
str fieldName,
int position)

A RGUMENTS
tableName
The name of the table.
fieldName
The name of the field.
position The position (row).

value (out)
The value at the given position (row) of the specified field in the specified table.

R ETURNS
An error code. Possible values are

0 No error has occurred, the value has been successfully read.

1 No table with the given name has been found.
2 No field with the given name has been found in the given table.
3 The data type of the given value argument does not match the data type of the
given field.
4 The given position is out of bounds (negative or equal or greater than the row
count of the table).

S EE ALSO

IntReport.SetValue(), IntReport.SetDefaultValue(), IntReport.GetValueAsInteger(),

IntReport.GetValueAsDouble(), IntReport.GetValueAsObject()

544
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Reset
Removes all objects and tables added by the extension script.
When an extension script is executed outside of the regular Report Generation mechanism (e.g.
by pressing the ’Execute’ button of the script), all added objects and tables remain in the memory
of the corresponding Report Template (IntReport) object even after the script was executed. By
calling this method at the beginning of the extension script, i.e. before any objects or tables
are added, users can make sure that no added objects or tables from a previous, manual script
execution are left.
When running the regular Report Generation command, this method is automatically called
before the extension script is executed.
None IntReport.Reset()

SetDefaultValue
Stores the given value as default value for the specified field of the specified table. The specified
table and field must have been previously created using IntReport.CreateTable() and IntRe-
port.CreateField(), respectively.
If the default value of a field is not explicitly set, its default value is either an empty string (for
string fields), zero (for integer and double fields) or null (for object fields).
Please note that the default value of object fields cannot be changed.
int IntReport.SetDefaultValue(str tableName,
str fieldName,
int|float|str value)

A RGUMENTS
tableName
The name of the table.

fieldName
the name of the field.
value The value that should be used as default value.

R ETURNS
An error code. Possible values are

0 No error has occurred, the default value has been successfully set.
1 No table with the given name has been found.
2 No field with the given name has been found in the given table.
3 The data type of the given value does not match the data type of the given field.
4 The data type of the given value is not supported by this method.

S EE ALSO

IntReport.SetValue(), IntReport.GetValue()

545
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetValue
Stores the given value at the position in the specified field of the specified table. The specified
table and field must have been previously created using IntReport.CreateTable() and IntRe-
port.CreateField(), respectively.
If the given field is a string field, numeric values are implicitly converted into strings and if
the given field is an integer field, double values are implicitly converted into integers (and vice
versa). Trying to store a string value to a numeric (i.e. integer or double) will result in an error
(see return value). Furthermore, objects can only be stored in object fields and object fields
only accept objects.
In order to use this method effectively, it is important to understand how fields work. Each
field maps positions (non-negative integers) to values of its data type, e.g. a string field maps
positions to strings. When a field is created (see IntReport.CreateField()), it does not map any
position to a value. By calling this method (for each desired field and position), users specify
what value is stored at which position. The highest position, for which at least one field in a table
has a value set, determines the row count of the table (see IntReport.GetRowCount()).
This means that users can conveniently set the value of a field at any desired position in any
order, but need to be aware that the row count of the whole table will be the highest position
they set a value for. If a valid position of a field (i.e. a non-negative integer that is smaller than
the current row count of the table) has not been assigned a value, the field will return its default
value whenever the value at the position is to be determined (see IntReport.GetValue()). The
default value of a field can be changed by calling the method IntReport.SetDefaultValue().
int IntReport.SetValue(str tableName,
str fieldName,
int rowIndex,
int|float|str|DataObject value)

A RGUMENTS
tableName
The name of the table.
fieldName
The name of the field.

position The position (a non-negative integer; negative positions are treated as zero and
should not be used).
value The value that should be set in the given table, field and position.

R ETURNS
An error code. Possible values are

0 No error has occurred, the value has been successfully set.

1 No table with the given name has been found.
2 No field with the given name has been found in the given table.
3 The data type of the given value does not match the data type of the given field.
4 The data type of the given value is not supported by this method.

S EE ALSO

IntReport.SetDefaultValue(), IntReport.GetValue(), IntReport.GetRowCount()

546
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.36 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.37 IntScenario
Overview

Activate
Apply
ApplySelective
Deactivate
DiscardChanges
GetObjects
GetOperationValue
ReleaseMemory
Save
SetOperationValue

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

547
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

requestUserConfirmation(optional)
0 silent, just apply the data without further confirmation requests
1 request a user confirmation first (default)

R ETURNS
0 on succes

Deactivate
Deactivates the currently active scenario.
int IntScenario.Deactivate([int saveOrUndo])

548
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
saveOrUndo(optional)
Determines whether changes in active scenario will be saved or discarded before
the scenario is deactivated.
0 discard changes(default)
1 save changes
2 ask the user

R ETURNS
0 on success

DiscardChanges
Discards all unsaved changes made to a scenario.
int IntScenario.DiscardChanges([int resetCalculation])

A RGUMENTS
resetCalculation(optional)
Determines whether calculation results should be reset afterwards.
0 no reset, retain results
1 default, reset results

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])

549
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.SetOperationValue(int|float|str|DataObject newvalue,
DataObject obj,
str attribute,
[int toObject = 1]
)

550
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.38 IntScensched
Overview

Activate
Deactivate
DeleteRow
GetScenario
GetStartEndTime
SearchScenario

Activate
Activates a scenario scheduler.
int IntScensched.Activate()

R ETURNS
0 successfully activated
1 error, e.g. already activate, no project and study case active

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])

551
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

552
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
−1 Scenario not found (not part of scenario scheduler).
≥0 Vector index (row, index of scenario).

5.6.39 IntScheme
Overview

Activate
Consolidate
Deactivate
GetActiveScheduler
IsActive
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
0 successfully activated
1 error, e.g. already activate, no project and study case active

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()

553
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

IsActive
Checks if this variation is active.
int IntScheme.IsActive()

R ETURNS
1 Variation is active.
0 Variation is not active.

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.

554
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.40 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
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.41 IntSstage
Overview

Activate
CreateStageObject
EnableDiffMode
GetVariation
IsExcluded
PrintModifications
ReadValue
WriteValue
555
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.
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

556
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.
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)

557
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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)

R ETURNS
=0 On success.
6= 0 Error e.g. wrong data type.

5.6.42 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
requestUserConfirmation(optional)
0 silent, just apply the data without further confirmation requests
1 request a user confirmation first (default)

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
)

558
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
applyConfiguration
folder containing variable selection objects
requestUserConfirmation(optional)
0 silent, just apply the data without further confirmation requests
1 request a user confirmation first (default)

R ETURNS
0 on succes

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

559
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.43 IntSym
Overview

ConvertGeometriesToMDLString

ConvertGeometriesToMDLString
Converts the internal legacy geometry string to Modelica geometry description language intro-
duced in PowerFactory version 23.
None IntSym.ConvertGeometriesToMDLString()

5.6.44 IntThrating
Overview

GetCriticalTimePhase
GetRating
Resize

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 %.

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

560
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Rating in MVA or 0 if not found.

Resize
Resizes the configuration vectors like configTa,condigWind,configSolar,preload or duration
void IntThrating.Resize(int size, str name)

A RGUMENTS
size size of the referenced vector

name reference to the vector (’configTa’,’configWind’,’configSolar’, ’preload’ or ’duration’)

R ETURNS
If the resize is unsuccessful the error message shall be issued.

5.6.45 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)

561
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.46 IntUser
Overview

Purge
SetPassword
TerminateSession

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()

562
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.47 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)

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

563
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

5.6.48 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)

564
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

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.
This operation is performed in memory only. Use IntVec.Save() to save the modified vector to
database.
None IntVec.Resize(int size)

A RGUMENTS
size The new size.

Save
Saves the current state of this vector to database.
If the matrix is calculation relevant, an optional parameter allows to control whether available
calculation results shall be reset afterwards or not.
Note: In QDSL, the calculation results are never reset and the parameter "resetCalculation" is
ignored.

565
5.6. OTHERS CHAPTER 5. OBJECT METHODS

None IntVec.Save()
None IntVec.Save(int resetCalculation)

A RGUMENTS
resetCalculation (optional)
1 reset calculation results (default)
0 keep calculation results

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.
This operation is performed in memory only. Use IntVec.Save() to save the modified vector to
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()

Size
Returns the size of the vector.
int IntVec.Size()

R ETURNS
The size of the vector.

Sort
Sorts the vector.
This operation is performed in memory only. Use IntVec.Save() to save the modified vector to
database.
None IntVec.Sort([int ascending = 0])

A RGUMENTS
ascending
Sort order:
0 Highest value first (descending, default).
1 Smallest value first (ascending).

566
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.49 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.
None IntVecobj.Resize(int size)

A RGUMENTS
size The new size.

Save
Saves the current state of this vector to database.
If the vector is calculation relevant, an optional parameter allows to control whether available
calculation results shall be reset afterwards or not.
Note: In QDSL, the calculation results are never reset and the parameter "resetCalculation" is
ignored.
None IntVecobj.Save()
None IntVecobj.Save(int resetCalculation)

A RGUMENTS
resetCalculation (optional)
1 reset calculation results (default)
0 keep calculation results

567
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

R ETURNS
The size of the vector.

5.6.50 IntVersion
Overview

CreateDerivedProject
GetDerivedProjects
GetHistoricalProject
Rollback

568
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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()

R ETURNS
0 on success
1 otherwise

569
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.51 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.52 PltAxis
Overview

DoAutoScale
SetFont

DoAutoScale
Adapts the axis range such that it includes the entire data range. Note: Only works if the plot
this axis belongs to is currently shown.
None PltAxis.DoAutoScale()

SetFont
Sets the font for this axis
None PltAxis.SetFont(str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
fontName
Font name
fontSize Font size
fontStyle Font style
1 Bold
2 Italic
3 Bold and italic
4 Underline

570
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.53 PltBiasdiff
Overview

AddCurve
AddCurves
ClearCurves

AddCurve
Adds an element to the plot and optionally sets the drawing style.
None PltBiasdiff.AddCurve(DataObject element,
[int colour,]
[int lineStyle,]
[float lineWidth])

A RGUMENTS
element The protection device to be added.
colour (optional)
Encoded colour value to be used. See: Application.EncodeColour()
lineStyle (optional)
The line style to be used.
lineWidth (optional)
The line width to be used.

AddCurves
Adds elements to the plot.
None PltBiasdiff.AddCurves(list elements)

A RGUMENTS
elements The protection devices to be added.

ClearCurves
Removes all elements from the plot.
None PltBiasdiff.ClearCurves()

571
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.54 PltComplexdata
Overview

AddVector
ChangeColourPalette
ClearVectors

AddVector
Appends a vector to the plot.
None PltComplexdata.AddVector(DataObject element,
string complexVariable)

A RGUMENTS
element Element to display
complexVariable
Complex variable to display, e.g.: ’m:ur:bus1 + j * m:ui:bus1’

ChangeColourPalette
Colours the vectors according to the colour palette identified by the given name. Additionally,
the colour palette is set as the object’s default palette.
None PltComplexdata.ChangeColourPalette(str paletteName)

A RGUMENTS
paletteName
Name of the colour palette to apply

R ETURNS
0 on success
1 on error

ClearVectors
Removes all vectors from the plot.
None PltComplexdata.ClearVectors()

572
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.55 PltDataseries
Overview

AddCurve
AddXYCurve
ChangeColourPalette
ClearCurves
GetDataSource
GetIntCalcres
RemoveCurve

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.

S EE ALSO

GrpPage.GetOrInsertPlot()

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.

573
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ChangeColourPalette
Colours the curves according to the colour palette identified by the given name. Additionally,
the colour palette is set as the dataseries’ default palette.
None PltDataseries.ChangeColourPalette(str paletteName)

A RGUMENTS
paletteName
Name of the colour palette to apply

R ETURNS
0 on success
1 on error

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()

R ETURNS
All Calculated Result objects (IntCalcres) stored inside the data series.

RemoveCurve
Removes a single curve from the plot.
None PltDataseries.RemoveCurve(int curveIndex)

574
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
int curveIndex
curve index in table, must be ≥ 0

5.6.56 PltImpedancerx
Overview

AddRelayCurve
AddRelayCurves
ClearRelayCurves

AddRelayCurve
Adds a relay to the plot and optionally sets the drawing style.
None PltImpedancerx.AddRelayCurve(DataObject element,
[int colour,]
[int lineStyle,]
[float lineWidth])

A RGUMENTS
element The relay to be added.
colour (optional)
Encoded colour value to be used. See: Application.EncodeColour()
lineStyle (optional)
The line style to be used.
lineWidth (optional)
The line width to be used.

AddRelayCurves
Adds relays to the plot.
None PltImpedancerx.AddRelayCurves(list elements)

A RGUMENTS
elements The relays to be added.

ClearRelayCurves
Removes all relays from the plot.
None PltImpedancerx.ClearRelayCurves()

575
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.57 PltLegend
Overview

SetFont

SetFont
Sets the font for this axis
None PltAxis.SetFont(str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
fontName
Font name
fontSize Font size
fontStyle Font style

1 Bold
2 Italic
3 Bold and italic
4 Underline

5.6.58 PltLinebarplot
Overview

ChangeStyle
DoAutoScale
DoAutoScaleX
DoAutoScaleY
GetAxisX
GetAxisY
GetDataSeries
GetDataSource
GetLegend
GetTitleObject
SetAutoScaleModeX
SetAutoScaleModeY
SetAxisSharingLevelX
SetAxisSharingLevelY
SetScaleTypeX
SetScaleTypeY
SetScaleX
SetScaleY

576
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ChangeStyle
Applies the plot style identified by the given name to this plot.
None PltLinebarplot.ChangeStyle(str styleName)

A RGUMENTS
styleName
Name of the style template to apply

R ETURNS
0 on success
1 on error

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

DoAutoScaleX
Adapts the plot’s x-axes ranges such that they show the entire data range.
None PltLinebarplot.DoAutoScaleX()

DoAutoScaleY
Adapts the plot’s y-axes ranges such that they show the entire data range.
None PltLinebarplot.DoAutoScaleY()

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)

577
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
PltAxis object

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)

GetDataSource
Returns the plot’s data source object.
DataObject PltLinebarplot.GetDataSource()

R ETURNS
Data source object. Object type depends on type of the plot:

PltDataseries Curve plot

PltEigenvalues Eigenvalue plot
PltEigenmode Mode bar plot
PltOvercurrent Time-overcurrent plot
PltBiasdiff Biased current differential plot

GetLegend
Returns the plot’s legend object (PltLegend).
DataObject PltLinebarplot.GetLegend()

578
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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)

A RGUMENTS
mode Possible values:
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 plot should automatically adapt its main y-axis range on data changes.
None PltLinebarplot.SetAutoScaleModeY(int mode)

A RGUMENTS
mode Possible values:
0 off (do not react to data changes)
1 adapt scale after calculation has finished
2 adapt scale during live plotting

SetAxisSharingLevelX
Defines whether the plot has its own x-axis or should share its x-axis across the page or the
entire desktop.
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 desktop

579
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAxisSharingLevelY
Defines whether the plot has its own y-axis or should share its y-axis across the page or the
entire desktop.
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 desktop

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
)

580
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets the scale of the plot’s main y-axis.
None PltLinebarplot.SetScaleY(float min,
float max
)

A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.

5.6.59 PltNetgraphic
Overview

ChangeStyle

ChangeStyle
Applies the plot style identified by the given name to this plot.
None PltNetgraphic.ChangeStyle(str styleName)

A RGUMENTS
styleName
Name of the style template to apply

R ETURNS
0 on success
1 on error

5.6.60 PltOvercurrent
Overview

AddCurve
AddCurves
ClearCurves
IsSubCurveVisible
SetSubCurveVisible

581
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddCurve
Adds an element to the plot and optionally sets the drawing style.
None PltOvercurrent.AddCurve(DataObject element,
[int colour,]
[int lineStyle,]
[float lineWidth])

A RGUMENTS
element The protection device or net element to be added.
colour (optional)
Encoded colour value to be used. See: Application.EncodeColour()
lineStyle (optional)
The line style to be used.
lineWidth (optional)
The line width to be used.

AddCurves
Adds elements to the plot.
None PltOvercurrent.AddCurves(list elements)

A RGUMENTS
elements The protection devices or net elements to be added.

ClearCurves
Removes all elements from the plot.
None PltOvercurrent.ClearCurves()

IsSubCurveVisible
Returns whether a sub curve of a curve is shown.
int Application.IsSubCurveVisible(int curveIndex, int subCurveType)

A RGUMENTS
curveIndex
Index of the curve to query
subCurveType
Sub curve to query. See: SetSubCurveVisible.

R ETURNS
0 Sub curve is not shown.
1 Sub curve is shown.

582
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetSubCurveVisible
Sets the visibility of a sub curve for one or all curves in the plot.
None Application.SetSubCurveVisible(int curveIndex, int subCurveType, int visible)

A RGUMENTS
curveIndex
Index of the curve to modify. Use -1 for modifying all curves.
subCurveType
Sub curve to modify:
-1 All sub curves
1 Transformer nominal current
2 Transformer inrush current
3 Transformer cold load curve
4 Transformer damage curve (IEC)
5 Transformer damage curve (Ansi)
10 Line/cable nominal current
11 Line/cable inrush current
12 Line/cable overload curve
15 Motor damage curve
16 Motor inrush current
visible 0 Do not show sub curve.
1 Show sub curve.

5.6.61 PltPowerpq
Overview

AddRelayCurve
AddRelayCurves
ClearRelayCurves

AddRelayCurve
Adds a relay to the plot and optionally sets the drawing style.
None PltPowerpq.AddRelayCurve(DataObject element,
[int colour,]
[int lineStyle,]
[int lineWidth])

A RGUMENTS
element The relay to be added.
colour (optional)
Encoded colour value to be used. See: Application.EncodeColour()
lineStyle (optional)
The line style to be used.

583
5.6. OTHERS CHAPTER 5. OBJECT METHODS

lineWidth (optional)
The line width to be used.

AddRelayCurves
Adds relays to the plot.
None PltPowerpq.AddRelayCurves(list elements)

A RGUMENTS
elements The relays to be added.

ClearRelayCurves
Removes all relays from the plot.
None PltPowerpq.ClearRelayCurves()

5.6.62 PltTitle
Overview

SetFont

SetFont
Sets the font for this axis
None PltAxis.SetFont(str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
fontName
Font name
fontSize Font size
fontStyle Font style

1 Bold
2 Italic
3 Bold and italic
4 Underline

584
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.63 PltVectorplot
Overview

ChangeStyle
DoAutoScale
GetAxisX
GetAxisY
GetComplexData
GetLegend
GetTitleObject
SetAutoScaleModeX
SetAutoScaleModeY
SetScaleX
SetScaleY

ChangeStyle
Applies the plot style identified by the given name to this plot.
None PltVectorplot.ChangeStyle(str styleName)

A RGUMENTS
styleName
Name of the style template to apply

R ETURNS
0 on success
1 on error

DoAutoScale
Adapts the plot’s axes ranges such that they show the entire data range.
None PltVectorplot.DoAutoScale()

GetAxisX
Returns the plot’s x-axis.
DataObject PltVectorplot.GetAxisX()

R ETURNS
PltAxis object

GetAxisY
Returns the plot’s y-aies.
DataObject PltVectorplot.GetAxisY()

585
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
PltAxis object

GetComplexData
Returns the plot’s complex data definition object (PltComplexdata).
DataObject PltVectorplot.GetComplexData()

R ETURNS
Complex data definition object (PltComplexdata)

GetLegend
Returns the plot’s legend object (PltLegend).
DataObject PltVectorplot.GetLegend()

R ETURNS
Legend object (PltLegend)

GetTitleObject
Returns the plot’s title object (PltTitle).
DataObject PltVectorplot.GetTitleObject()

R ETURNS
Title object (PltTitle)

SetAutoScaleModeX
Defines whether the plot should automatically adapt its main x-axis range on data changes.
None PltVectorplot.SetAutoScaleModeX(int mode)

A RGUMENTS
mode Possible values:
0 off (do not react to data changes)
1 adapt scale after calculation has finished

SetAutoScaleModeY
Defines whether the plot should automatically adapt its main y-axis range on data changes.
None PltVectorplot.SetAutoScaleModeY(int mode)

586
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mode Possible values:
0 off (do not react to data changes)
1 adapt scale after calculation has finished

SetScaleX
Sets the scale of the plot’s x-axis.
None PltVectorplot.SetScaleX(float min,
float max
)

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets the scale of the plot’s y-axis.
None PltVectorplot.SetScaleY(float min,
float max
)

A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.

5.6.64 RelChar
Overview

SetCurve

SetCurve
Assign a tripping curve by name. The curve must be defined in the associated type object.
int RelChar.SetCurve(str name)

A RGUMENTS
name Name of the curve to assign (may contain wildcards).

R ETURNS
0 The curve was found and assigned.
1 No curve with the given name is defined or multiple curves matched the name.

587
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.65 RelToc
Overview

SetCurve

SetCurve
Assign a tripping curve by name. The curve must be defined in the associated type object.
int RelToc.SetCurve(str name)

A RGUMENTS
name Name of the curve to assign (may contain wildcards).

R ETURNS
0 The curve was found and assigned.
1 No curve with the given name is defined or multiple curves matched the name.

5.6.66 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
0 The compensation factor was successfully calculated.
1 An error occurred (e.g. conencted branch was not found).

588
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AssumeXeXl
Triggers a calculation of the imaginary part of the decoupled compensation factor and stores
the result.
int RelZpol.AssumeXeXl()

R ETURNS
0 The compensation factor was successfully calculated.
1 An error occurred (e.g. conencted branch was not found).

5.6.67 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’.

GetNumberOfViolations
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

589
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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)

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
than the number of violations, then the function returns ’nan’.

590
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.68 ScnFrt
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float ScnFrt.GetLimit(int vIdx)

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’.

GetNumberOfViolations
Returns the number of violations.
int ScnFrt.GetNumberOfViolations()

R ETURNS
The number of violations.

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
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 ScnFrt.GetVariable(int vIdx)

591
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 ScnFrt.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 ScnFrt.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
than the number of violations, then the function returns ’nan’.

5.6.69 ScnSpeed
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

592
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float ScnSpeed.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’.

GetNumberOfViolations
Returns the number of violations.
int ScnSpeed.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float ScnSpeed.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 ScnSpeed.GetVariable(int vIdx)

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".

593
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetViolatedElement
Returns the element of the ith violation, given by vIdx.
DataObject ScnSpeed.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 ScnSpeed.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
than the number of violations, then the function returns ’nan’.

5.6.70 ScnSync
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float ScnSync.GetLimit(int vIdx)

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’.

594
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetNumberOfViolations
Returns the number of violations.
int ScnSync.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value, given by vIdx, which causes the violation.
float ScnSync.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
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 ScnSync.GetVariable(int vIdx)

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 ScnSync.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.

595
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetViolationTime
Returns the time (in seconds) of the ith violation, given by vIdx.
float ScnSync.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
than the number of violations, then the function returns ’nan’.

5.6.71 ScnVar
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float ScnVar.GetLimit(int vIdx)

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’.

GetNumberOfViolations
Returns the number of violations.
int ScnVar.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value, given by vIdx, which causes the violation.
float ScnVar.GetValue(int vIdx)

596
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The ith value, 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 ScnVar.GetVariable(int vIdx)

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 ScnVar.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 ScnVar.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
than the number of violations, then the function returns ’nan’.

597
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.72 ScnVolt
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float ScnVolt.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’.

GetNumberOfViolations
Returns the number of violations.
int ScnVolt.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float ScnVolt.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 ScnVolt.GetVariable(int vIdx)

598
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 ScnVolt.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 ScnVolt.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
than the number of violations, then the function returns ’nan’.

5.6.73 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

599
5.6. OTHERS CHAPTER 5. OBJECT METHODS

multipleElements
multiple Elements for Maintenance

5.6.74 TypAsmo
Overview

CalcElParams

CalcElParams
Calculates the electrical parameters from the input data. Behaves as the calculate button on
the basic data page was pressed and the parameter estimation is executed. Shall be applied
only if the Input mode is set to ’Slip-Torque/Current Characteristic’ or ’Measurement curves’.
int TypAsmo.CalcElParams([float acceptSqError = 1.e-03],
[int solverType = 0],
[int useLinConst = 1],
[int considerEff = 1],
[float kx = 0.5],
[float kr = 1.])

A RGUMENTS
acceptSqError (optional)
If calculated squared error is bolow this value, calculation is successfull.
solverType (optional)
Solver used in the parameter estimation. Possible values are:
0 LBFGS (default).
1 Particle swarm optimisation.
2 Conjugate gradient descent.
3 Newton (old, deprecated).
useLinConst (optional)
0: Xs from type is used, 1: linear constraints used.
considerEff (optional)
If = 1, efficiency is considered in the estimation.

kx (optional)
value for kx (only if linear constraints selected).
kr (optional)
value for kr (only if linear constraints selected and efficiency not considered).

R ETURNS
0 Calculation successfully (squared error less than acceptSqError).
1 Error.

600
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.75 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)

A RGUMENTS
ratio New ratio to add.

R ETURNS
0 New ratio was added.
1 An error occurred.

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.
1 An error occurred.

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.
1 An error occurred.

601
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.76 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

5.6.77 TypMdl
Overview

Check
Compile
Pack

Check
Checks the model for errors e.g during parsing of interpreted model, during loading of compiled
model.
int TypMdl.Check()

R ETURNS
0 TypMdl is OK.
1 Error during parsing of interpreted model.
2 Error during loading of compiled model.

Compile
Compile the model.
int TypMdl.Compile([const char* modelPath], [int overrideModel])

A RGUMENTS
modelPath (optional)
Full path to a location where the model should be stored. Leave empty to use
default.

overrideModel (optional)
The model will be overrided if already present at the selected location and if the
value is set to 1. (default = 0)

602
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Compilation is Ok.
1 Compilation failled

Pack
Copies all used Modelica model types (i.e. referenced TypMdl) to a child folder ”Externals”.
int TypMdl.Pack[(int inclGlobalLib])

A RGUMENTS
inclGlobalLib (optional)
Include also objects from DIgSILENT Library (default = 1)

R ETURNS
0 On success.
1 On error.

5.6.78 TypQdsl
Overview

Encrypt
IsEncrypted
ResetThirdPartyModule
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.
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 types. Third party licence codes already set in the type will be
overwritten by this value (default = 0).

603
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

S EE ALSO

TypQdsl.Encrypt()

ResetThirdPartyModule
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
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.

604
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.79 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()

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
0 No error occurred.
1 An error occurred; the values are invalid.

5.6.80 VisPath
Overview

Clear
DoAutoScaleX
DoAutoScaleY
SetAdaptX
SetAdaptY
SetScaleX
SetScaleY

605
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Clear
Removes all curves by clearing table named 'Variables' on page 'Curves'.
None VisPath.Clear()

DoAutoScaleX
Scales x-axis automatically.
int VisPath.DoAutoScaleX()

R ETURNS
Always 0

DoAutoScaleY
Scales y-axis automatically.
int VisPath.DoAutoScaleY()

R ETURNS
Always 0

SetAdaptX
Sets the Adapt Scale option of the x-scale.
None VisPath.SetAdaptX(int mode)

A RGUMENTS
mode Possible values:
0 off
1 on

SetAdaptY
Sets the Adapt Scale option of the x-scale.
None VisPath.SetAdaptY(int mode)

A RGUMENTS
mode Possible values:

0 off
1 on

606
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetScaleX
Sets x-axis scale.
None VisPath.SetScaleX(float min,
float max
)

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets y-axis scale limits.
None VisPath.SetScaleY(float min,
float max,
[int log]
)

A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.
log (optional)
Possible values:

0 linear
1 logarithmic

5.6.81 VisPcompdiffplt
Overview

AddRelay
AddRelays
CentreOrigin
Clear
DoAutoScaleX
DoAutoScaleY

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None VisPcompdiffplt.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])

A RGUMENTS
relay The protection device to be added.

607
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 VisPcompdiffplt.AddRelays(list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

CentreOrigin
Centre the origin of the plot
None VisPcompdiffplt.CentreOrigin()

Clear
Removes all protection devices from the plot.
None VisPcompdiffplt.Clear()

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 VisPcompdiffplt.DoAutoScaleX()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

DoAutoScaleY
Scales the y-axis of the plot automatically. The function works for local y-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 VisPcompdiffplt.DoAutoScaleY()

608
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

5.6.82 VisPlottz
Overview

AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None VisPlottz.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 VisPlottz.AddRelays(list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

Clear
Removes all protection devices from the plot.
None VisPlottz.Clear()

609
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 VisPlottz.DoAutoScaleX()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

DoAutoScaleY
Scales the y-axis of the plot automatically. The function works for local y-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 VisPlottz.DoAutoScaleY()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

5.6.83 VisValue
Overview

SetUserDefined

SetUserDefined
Converts an auto-generated label (impedance marker, result legend) into a user-defined one.
None VisValue.SetUserDefined()

610
Index

__version__ IntAddonvars, 465

Module Functions, 2 AddEvent
IntRas, 534
Activate AddInteger
ElmNet, 126 IntAddonvars, 466
IntCase, 470 AddIntegerVector
IntLibrary, 507 IntAddonvars, 466
IntPrj, 520 AddObject
IntScenario, 547 IntAddonvars, 467
IntScensched, 551 IntReport, 535
IntScheme, 553 AddObjects
IntSscheduler, 555 IntReport, 536
IntSstage, 556 AddObjectVector
SetTabgroup, 426 IntAddonvars, 467
ActivateProject AddPage
Application Methods, 6 SetDesktop, 404
AdaptWidth AddProjectToCombined
IntGrflayer, 495 IntPrj, 520
SetLevelvis, 414 AddProjectToRemoteDatabase
AddAnnotationElement IntPrj, 520
IntGrflayer, 496 AddRas
AddCalcRelevantCoincidenceDefinitions ComSimoutage, 371
SetLvscale, 417 AddRatio
AddCntcy TypCtcore, 601
ComSimoutage, 370 AddRef
AddConfiguration ComNmink, 346
SetDataext, 401 IntDataset, 484
AddContingencies SetSelect, 423
ComSimoutage, 371 AddRelay
AddCopy VisPcompdiffplt, 607
General Object Methods, 65 VisPlottz, 609
AddCubicle AddRelayCurve
ElmBoundary, 103 PltImpedancerx, 575
AddCurve PltPowerpq, 583
PltBiasdiff, 571 AddRelayCurves
PltDataseries, 573 PltImpedancerx, 575
PltOvercurrent, 582 PltPowerpq, 584
AddCurves AddRelays
PltBiasdiff, 571 VisPcompdiffplt, 608
PltOvercurrent, 582 VisPlottz, 609
AddDouble AddString
IntAddonvars, 464 IntAddonvars, 468
AddDoubleMatrix AddToUpdatePages
IntAddonvars, 465 ComProtgraphic, 352
AddDoubleVector AddTrigger

611
INDEX INDEX

IntGate, 493 ClearRecycleBin, 6

IntRas, 534 CommitTransaction, 6
AddVar ConvertGeometryStringToMDL, 6
IntMon, 514 CreateFaultCase, 7
AddVariable CreateProject, 7
ElmRes, 138 DecodeColour, 8
AddVars DefineTransferAttributes, 8
ElmRes, 138 DeleteUntouchedObjects, 9
IntMon, 514 EncodeColour, 9
AddVector ExecuteCmd, 9
PltComplexdata, 572 GetActiveCalculationStr, 10
AddXYCurve GetActiveNetworkVariations, 10
PltDataseries, 573 GetActiveProject, 10
Align GetActiveScenario, 10
IntGrflayer, 496 GetActiveScenarioScheduler, 10
SetLevelvis, 414 GetActiveStages, 11
All GetActiveStudyCase, 11
IntDataset, 485 GetAllUsers, 11
SetSelect, 423 GetAttributeDescription, 11
AllAsm GetAttributeUnit, 12
SetSelect, 423 GetAvailableAttributes, 12
AllBars GetAvailableAttributesAsJson, 13
SetSelect, 424 GetBorderCubicles, 17
AllBreakers GetBrowserSelection, 17
SetPath, 418 GetCalcRelevantObjects, 18
SetSelect, 424 GetCalculationBalancedMode, 18
AllClosedBreakers GetCalculationDescription, 19
SetPath, 418 GetCalculations, 19
SetSelect, 424 GetCalculationsAsJson, 21
AllElm GetClassDescription, 22
SetSelect, 424 GetClassId, 22
AllLines GetCurrentDiagram, 22
SetSelect, 424 GetCurrentScript, 22
AllLoads GetCurrentSelection, 23
SetSelect, 424 GetCurrentUser, 23
AllOpenBreakers GetCurrentZoomScaleLevel, 23
SetPath, 418 GetDataFolder, 23
SetSelect, 425 GetDesktop, 24
AllProtectionDevices GetDiagramSelection, 24
SetPath, 419 GetFlowOrientation, 24
AllSym GetFromStudyCase, 25
SetSelect, 425 GetGlobalLibrary, 25
AllTypLne GetInterfaceVersion, 25
SetSelect, 425 GetLanguage, 26
AnalyseElmRes GetLocalLibrary, 26
ComRel3, 357 GetMem, 26
AppendCommand GetObjectByDbObjectKey, 27
ComTasks, 378 GetProjectFolder, 27
AppendMessage GetRecordingStage, 27
ComCimtogrid, 288 GetSettings, 28
ComGridtocim, 327 GetSummaryGrid, 28
AppendStudyCase GetTouchedObjects, 28
ComTasks, 378 GetTouchingExpansionStages, 29
ComTececocmp, 385 GetTouchingStageObjects, 29
Application Methods, 4 GetTouchingVariations, 29
ActivateProject, 6 GetUserManager, 30

612
INDEX INDEX

GetUserSettings, 30 Apply
Hide, 30 ElmBmu, 102
ImportDz, 30 IntOutage, 517
ImportSnapshot, 31 IntScenario, 548
IsAttributeModeInternal, 31 IntSubset, 558
IsLdfValid, 31 ApplyAll
IsNAN, 31 IntOutage, 517
IsRmsValid, 32 ApplyAndResetRA
IsScenarioAttribute, 32 ElmSubstat, 154
IsShcValid, 32 ApplyNetworkState
IsSimValid, 32 IntCase, 470
IsWriteCacheEnabled, 33 ApplySelective
LicenceHasModule, 33 IntScenario, 548
LoadProfile, 34 IntSubset, 558
MarkInGraphics, 35 ApplyStudyTime
MigrateAllProjects, 35 IntCase, 470
OutputFlexibleData, 35 Archive
PostCommand, 36 IntPrj, 520
PrepForUntouchedDelete, 36 AreDistParamsPossible
Rebuild, 36 ElmLne, 118
ReloadProfile, 36 AssignCimRdfIds
ResetCalculation, 37 ComGridtocim, 328
ResGetData, 37 AssumeCompensationFactor
ResGetDescription, 37 RelZpol, 588
ResGetFirstValidObject, 37 AssumeReRl
ResGetFirstValidObjectVariable, 38 RelZpol, 588
ResGetFirstValidVariable, 38 AssumeXeXl
ResGetIndex, 38 RelZpol, 589
ResGetMax, 38
ResGetMin, 38 BeginDataExtensionModification
ResGetNextValidObject, 39 IntPrj, 521
ResGetNextValidObjectVariable, 39 BeginTabGroup
ResGetNextValidVariable, 39 SetDesktop, 405
ResGetObject, 39 BlkDef, 439
ResGetUnit, 39 CalculateCheckSum, 440
ResGetValueCount, 39 Check, 439
ResGetVariable, 40 Compile, 439
ResGetVariableCount, 40 Encrypt, 439
ResLoadData, 40 GetCheckSum, 440
ResReleaseData, 40 Pack, 440
ResSortToVariable, 40 PackAsMacro, 440
SaveAsScenario, 40 ResetThirdPartyModule, 441
SearchObjectByForeignKey, 41 SetThirdPartyModule, 441
SearchObjectsByCimId, 41 BlkSig, 441
SelectToolbox, 41 GetFromSigName, 441
SetAttributeInRootAndStageObjects, 42 GetToSigName, 442
SetAttributeModeInternal, 42 BlockSwitch
SetInterfaceVersion, 42 ComShctrace, 365
SetShowAllUsers, 43 BuildNodeNames
SetWriteCacheEnabled, 43 ComUcteexp, 389
Show, 43
SplitLine, 44 CalcAggrVarsInRadFeed
StatFileGetXrange, 44 ElmFeeder, 110
StatFileResetXrange, 45 CalcCluster
StatFileSetXrange, 45 SetCluster, 393
WriteChangesToDb, 45 SetDistrstate, 413

613
INDEX INDEX

CalcContributions ChangeStyle
ComRelpost, 359 GrpPage, 459
CalcDiscountedEstimatedPaybackPeriod PltLinebarplot, 577
ComTececocmp, 386 PltNetgraphic, 581
CalcEfficiency PltVectorplot, 585
ElmAsm, 95 ChangeWidthVisibilityAndColour
ElmGenstat, 114 IntGrflayer, 498
ElmPvsys, 128 SetLevelvis, 415
ElmSym, 159 ChaVecfile, 442
ElmXnet, 192 Update, 442
CalcElParams Check
TypAsmo, 600 BlkDef, 439
CalcEstimatedPaybackPeriod ComAuditlog, 283
ComTececocmp, 386 ElmMdl, 124
CalcInternalRateOfReturn IntOutage, 517
ComTececocmp, 387 SetScenario, 422
CalcMaxHostedPower SetTboxconfig, 432
ComHostcap, 333 TypMdl, 602
CalcShiftedReversedBoundary CheckAll
ElmBoundary, 103 IntOutage, 517
CalculateCheckSum CheckAnnotationString
BlkDef, 440 IntGrflayer, 499
CalculateInterchangeTo CheckAssignments
ElmArea, 92 ComMerge, 340
ElmNet, 126 CheckBbPath
ElmZone, 194 ElmBbone, 99
CalculateMaxFaultCurrents CheckConsistency
ElmRelay, 132 IntNndata, 516
CalculateVoltageLevel IntNnet, 516
ElmArea, 92 CheckControllers
ElmNet, 127 ComLdf, 335
ElmZone, 194 CheckRanges
CalculateVoltInterVolt ElmRelay, 132
ElmArea, 93 CheckSyntax
ElmNet, 127 ComDpl, 321
ElmZone, 195 CheckUrl
CanAddProjectToRemoteDatabase IntExtaccess, 493
IntPrj, 521 CimArchive, 442
CanSubscribeProjectReadOnly ConvertToBusBranch, 442
IntPrj, 521 CimModel, 443
CanSubscribeProjectReadWrite DeleteParameterAtIndex, 443
IntPrj, 521 GetAttributeEnumerationType, 443
CentreOrigin GetModelsReferencingThis, 444
VisPcompdiffplt, 608 GetParameterCount, 444
ChangeColourPalette GetParameterNamespace, 445
PltComplexdata, 572 GetParameterValue, 445
PltDataseries, 574 HasParameter, 446
ChangeFont RemoveParameter, 446
IntGrflayer, 497 SetAssociationValue, 447
SetLevelvis, 415 SetAttributeEnumeration, 448
ChangeLayer SetAttributeValue, 448, 449
IntGrflayer, 497 CimObject, 450
SetLevelvis, 415 DeleteParameterAtIndex, 450
ChangeRefPoints GetAttributeEnumerationType, 451
IntGrflayer, 498 GetObjectsReferencingThis, 451
SetLevelvis, 415 GetObjectsWithSameId, 451

614
INDEX INDEX

GetParameterCount, 452 CloseTab

GetParameterNamespace, 452 SetTabgroup, 426
GetParameterValue, 453 CloseTableReports
GetPfObjects, 453 Dialogue Boxes Functions, 47
HasParameter, 454 ColLbl
RemoveParameter, 454 IntMat, 508
SetAssociationValue, 455 ComAddlabel, 269
SetAttributeEnumeration, 456, 457 Execute, 269
SetAttributeValue, 457, 458 ComAddon, 270
Clear CreateModule, 270
ComNmink, 346 DefineDouble, 270
ElmBoundary, 103 DefineDoubleMatrix, 271
ElmRes, 138 DefineDoublePerConnection, 272
IntDataset, 485 DefineDoubleVector, 272
IntDplmap, 487 DefineDoubleVectorPerConnection, 273
IntDplvec, 490 DefineInteger, 274
IntSubset, 559 DefineIntegerPerConnection, 274
Output Window Methods, 62 DefineIntegerVector, 275
SetSelect, 425 DefineIntegerVectorPerConnection, 276
VisPath, 606 DefineObject, 276
VisPcompdiffplt, 608 DefineObjectPerConnection, 277
VisPlottz, 609 DefineObjectVector, 277
ClearCont DefineObjectVectorPerConnection, 278
ComSimoutage, 371 DefineString, 279
ClearCurves DefineStringPerConnection, 279
PltBiasdiff, 571 DeleteModule, 280
PltDataseries, 574 FinaliseModule, 280
PltOvercurrent, 582 GetActiveModule, 280
ClearData ModuleExists, 281
IntGrfgroup, 494 SetActiveModule, 281
IntGrflayer, 499 ComAmpacity, 281
ClearOutputWindow ExecuteAmpacityCalc, 281
Output Window Functions, 59 ComArcreport, 282
ClearRecycleBin GetLocationsToReport, 282
Application Methods, 6 GetUnitFor, 282
ClearRelayCurves GetValueFor, 282
PltImpedancerx, 575 IsDguv, 283
PltPowerpq, 584 IsEpri, 283
ClearUpdatePages ComAuditlog, 283
ComProtgraphic, 352 Check, 283
ClearVars ComBoundary, 284
IntMon, 515 GetCreatedBoundaries, 284
ClearVectors ComCapo, 284
PltComplexdata, 572 ConnectShuntToBus, 284
Close LossCostAtBusTech, 285
ElmCoup, 106 TotalLossCost, 285
ElmGndswt, 117 ComCimdbexp, 286
ElmRes, 141 Execute, 286
IntGrfnet, 504 ComCimdbimp, 286
SetDeskpage, 403 Execute, 287
SetDesktop, 405 ImportAndConvert, 287
SetTabgroup, 426 ComCimtogrid, 288
SetVipage, 435 AppendMessage, 288
StaSwitch, 268 GetMessageDescription, 289
CloseAllTemporaryTabs GetMessageObject, 289
SetDesktop, 405 GetMessageSeverity, 290

615
INDEX INDEX

GetNumberOfMessages, 290 ResultForShortCircuitVariable, 311

ComCimvalidate, 291 ResultForZoneVariable, 312
Execute, 291 TopologyForDirectionalBackupVariable, 313
GetClassType, 291 TopologyForFuseVariable, 313
GetDescriptionText, 292 TopologyForInstantaneousVariable, 313
GetInputObject, 292 TopologyForMaxCurrent, 314
GetModel, 293 TopologyForNonDirectionalBackupVariable,
GetModelId, 293 314
GetNumberOfValidationMessages, 294 TopologyForOverloadVariable, 315
GetObject, 294 TopologyForOverreachVariable, 315
GetObjectId, 295 TopologyForShortCircuitVariable, 316
GetProfile, 295 TopologyForZoneVariable, 316
GetSeverity, 295 TransferDirectionalBackupResultsTo, 317
GetType, 296 TransferNonDirectionalBackupResultsTo, 317
ComConreq, 296 TransferOverreachResultsTo, 318
Execute, 296 TransferResultsTo, 318
ComContingency, 297 TransferZoneResultsTo, 319
ContinueTrace, 297 ComCosim, 320
CreateRecoveryInformation, 297 PartitionNetwork, 320
GetGeneratorEvent, 298 ComDllmanager, 320
GetInterruptedPowerAndCustomersForStage, Report, 320
298 ComDpl, 320
GetInterruptedPowerAndCustomersForTimeStep,CheckSyntax, 321
299 Encrypt, 321
GetLoadEvent, 299 Execute, 321
GetNumberOfGeneratorEventsForTimeStep, GetExternalObject, 322
300 GetInputParameterDouble, 322
GetNumberOfLoadEventsForTimeStep, 300 GetInputParameterInt, 323
GetNumberOfSwitchEventsForTimeStep, 300 GetInputParameterString, 323
GetNumberOfTimeSteps, 300 IsEncrypted, 324
GetObj, 301 ResetThirdPartyModule, 324
GetSwitchEvent, 301 SetExternalObject, 324
GetTimeOfStepInSeconds, 301 SetInputParameterDouble, 325
GetTotalInterruptedPower, 302 SetInputParameterInt, 325
JumpToLastStep, 302 SetInputParameterString, 325
RemoveEvents, 302 SetThirdPartyModule, 326
StartTrace, 302 ComFlickermeter, 326
StopTrace, 303 Execute, 326
ComCoordreport, 303 ComGenrelinc, 327
DevicesToReport, 304 GetCurrentIteration, 327
HasResultsForDirectionalBackup, 304 GetMaxNumIterations, 327
HasResultsForFuse, 304 ComGridtocim, 327
HasResultsForInstantaneous, 304 AppendMessage, 327
HasResultsForNonDirectionalBackup, 305 AssignCimRdfIds, 328
HasResultsForOverload, 305 ConvertAndExport, 328
HasResultsForOverreach, 305 GetMessageDescription, 329
HasResultsForShortCircuit, 306 GetMessageObject, 330
HasResultsForZone, 306 GetMessageSeverity, 330
MaxZoneNumberFor, 306 GetNumberOfMessages, 331
ResultForDirectionalBackupVariable, 307 SetAuthorityUri, 331
ResultForFuseVariable, 307 SetBoundaries, 331
ResultForInstantaneousVariable, 308 SetGridsToExport, 332
ResultForMaxCurrent, 309 ComHostcap, 332
ResultForNonDirectionalBackupVariable, 309 CalcMaxHostedPower, 333
ResultForOverloadVariable, 310 ComImport, 333
ResultForOverreachVariable, 310 GetCreatedObjects, 333

616
INDEX INDEX

GetModifiedObjects, 334 GetRegionCount, 348

ComInc, 334 ComOpc, 348
CompileDynamicModelTypes, 334 GetCertificatePath, 348
ZeroDerivative, 335 ReceiveData, 348
ComLdf, 335 SendData, 349
CheckControllers, 335 ComOutage, 349
DoNotResetCalc, 335 ContinueTrace, 349
EstimateOutage, 336 ExecuteTime, 349
Execute, 336 GetObject, 350
IsAC, 336 RemoveEvents, 350
IsBalanced, 336 SetObjs, 350
IsDC, 337 StartTrace, 351
PrintCheckResults, 337 StopTrace, 351
SetOldDistributeLoadMode, 337 Compare
ComLink, 337 ComMerge, 340
LoadMicroSCADAFile, 338 CompareActive
ReceiveData, 338 ComMerge, 340
SendData, 338 CompareRecording
SentDataStatus, 339 ComMerge, 340
SetOPCReceiveQuality, 339 ComPfdimport, 351
SetSwitchShcEventMode, 339 GetImportedObjects, 351
Commands Methods, 269 Compile
Execute, 269 BlkDef, 439
ComMerge, 339 TypMdl, 602
CheckAssignments, 340 CompileDynamicModelTypes
Compare, 340 ComInc, 334
CompareActive, 340 ComPrjconnector, 352
CompareRecording, 340 GetSuccesfullyConnectedItems, 352
ExecuteRecording, 341 GetUnsuccesfullyConnectedItems, 352
ExecuteWithActiveProject, 341 ComProtgraphic, 352
GetCorrespondingObject, 341 AddToUpdatePages, 352
GetModification, 342 ClearUpdatePages, 352
GetModificationResult, 342 ComPvcurves, 352
GetModifiedObjects, 342 FindCriticalBus, 352
Merge, 343 ComPython, 353
PrintComparisonReport, 343 GetExternalObject, 353
PrintModifications, 343 GetInputParameterDouble, 353
Reset, 344 GetInputParameterInt, 354
SetAutoAssignmentForAll, 344 GetInputParameterString, 354
SetObjectsToCompare, 344 SetExternalObject, 354
ShowBrowser, 344 SetInputParameterDouble, 355
WereModificationsFound, 345 SetInputParameterInt, 355
CommitTransaction SetInputParameterString, 356
Application Methods, 6 ComRed, 356
ComMot, 345 LdfEquivalentVerification, 356
GetMotorConnections, 345 ReductionInMemory, 357
GetMotorSwitch, 345 ResetReductionInMemory, 357
GetMotorTerminal, 346 SimEquivalentVerification, 357
ComNmink, 346 ComRel3, 357
AddRef, 346 AnalyseElmRes, 357
Clear, 346 ExeEvt, 358
GenerateContingenciesForAnalysis, 346 OvlAlleviate, 358
GetAll, 347 RemoveEvents, 358
ComOmr, 347 RemoveOutages, 358
GetFeeders, 347 ValidateConstraints, 359
GetOMR, 347 ComRelpost, 359

617
INDEX INDEX

CalcContributions, 359 Reset, 374

GetContributionOfComponent, 359 SetLimits, 375
ComRelreport, 360 Update, 375
GetContingencies, 360 ComStationware, 375
GetContributionOfComponent, 360 GetAuthenticationTicket, 375
ComReltabreport, 360 ComSvgexport, 375
GetContingencies, 361 SetFileName, 376
GetContributionOfComponent, 361 SetObject, 376
ComReport, 361 SetObjects, 376
ExecuteWithCustomSelection, 361 ComSvgimport, 376
SetParameter, 362 SetFileName, 376
ComRes, 362 SetObject, 376
ExportFullRange, 362 ComTablereport, 377
FileNmResNm, 362 ExportToExcel, 377
ComShc, 363 ExportToHTML, 377
ExecuteRXSweep, 363 ComTasks, 378
GetFaultType, 363 AppendCommand, 378
GetOverLoadedBranches, 364 AppendStudyCase, 378
GetOverLoadedBuses, 364 GetCommandsForStudyCase, 379
ComShctrace, 365 GetNumberOfCommandsForStudyCase, 379
BlockSwitch, 365 GetNumberOfStudyCases, 380
ExecuteAllSteps, 365 GetStudyCases, 380
ExecuteInitialStep, 365 IsAdditionalResultsFlagSetForCommand, 380
ExecuteNextStep, 366 IsCommandIgnored, 380
GetBlockedSwitches, 366 IsStudyCaseIgnored, 381
GetCurrentTimeStep, 366 RemoveCmdsForStudyCaseRow, 381
GetDeviceSwitches, 366 RemoveCommand, 382
GetDeviceTime, 367 RemoveStudyCase, 382
GetNonStartedDevices, 367 RemoveStudyCases, 383
GetStartedDevices, 367 SetAdditionalResultsFlagForCommand, 383
GetSwitchTime, 367 SetIgnoreFlagForCommand, 383
GetTrippedDevices, 367 SetIgnoreFlagForStudyCase, 384
NextStepAvailable, 368 SetResultsFolder, 384
ComSim, 368 ComTececo, 385
GetSimulationTime, 368 UpdateTablesByCalcPeriod, 385
GetTotalWarnA, 368 ComTececocmp, 385
GetTotalWarnB, 368 AppendStudyCase, 385
GetTotalWarnC, 369 CalcDiscountedEstimatedPaybackPeriod, 386
GetViolatedScanModules, 369 CalcEstimatedPaybackPeriod, 386
LoadSimulationState, 369 CalcInternalRateOfReturn, 387
LoadSnapshot, 369 RemoveStudyCases, 387
SaveSimulationState, 369 ComTransfer, 387
SaveSnapshot, 369 GetTransferCalcData, 388
ComSimoutage, 370 IsLastIterationFeasible, 388
AddCntcy, 370 ComUcte, 388
AddContingencies, 371 SetBatchMode, 388
AddRas, 371 ComUcteexp, 389
ClearCont, 371 BuildNodeNames, 389
CreateFaultCase, 371 DeleteCompleteQuickAccess, 389
Execute, 372 ExportAndInitQuickAccess, 389
ExecuteAndCheck, 372 GetConnectedBranches, 390
GetNTopLoadedElms, 373 GetFromToNodeNames, 390
MarkRegions, 374 GetOrderCode, 390
RemoveAllRas, 374 GetUcteNodeName, 391
RemoveContingencies, 374 InitQuickAccess, 391
RemoveRas, 374 QuickAccessAvailable, 391

618
INDEX INDEX

ResetQuickAccess, 391 ElmTrmult, 187

SetGridSelection, 392 ElmVoltreg, 190
ComWr, 392 StaExtdatmea, 210
ExportGraphicTab, 392 CreateFaultCase
ConnectShuntToBus Application Methods, 7
ComCapo, 284 ComSimoutage, 371
Consolidate CreateFeederWithRoutes
IntCase, 471 ElmLne, 119
IntScheme, 553 CreateField
Contains IntReport, 536
IntDplmap, 487 CreateGroup
ContinueTrace IntUserman, 563
ComContingency, 297 CreateLayer
ComOutage, 349 SetLevelvis, 416
ConvertAndExport CreateModule
ComGridtocim, 328 ComAddon, 270
ConvertGeometriesToMDLString CreateObject
IntSym, 560 General Object Methods, 66
ConvertGeometryStringToMDL CreateProject
Application Methods, 6 Application Methods, 7
ConvertToASCIIFormat CreateRecoveryInformation
IntComtrade, 472 ComContingency, 297
ConvertToBinaryFormat CreateStageObject
IntComtrade, 472 IntSstage, 556
ConvertToBusBranch CreateTable
CimArchive, 442 IntReport, 537
CopyData CreateTimeOvercurrentPlot
General Object Methods, 66 SetPath, 419
CopyDataExtensionFrom CreateUser
IntPrj, 522 IntUserman, 563
CopyExtMeaStatusToStatusTmp CreateVersion
StaExtbrkmea, 201 IntPrj, 522
StaExtcmdmea, 205 CreateVI
StaExtdatmea, 210 SetVipage, 436
StaExtfmea, 215
StaExtfuelmea, 220 Date/Time Functions, 47
StaExtimea, 225 GetStudyTimeObject, 47
StaExtpfmea, 231 Date
StaExtpmea, 236 SetTime, 433
StaExtqmea, 241 Deactivate
StaExtsmea, 247 ElmNet, 128
StaExttapmea, 251 IntCase, 471
StaExtv3mea, 257 IntLibrary, 507
StaExtvmea, 262 IntPrj, 523
CopyProjectSettings IntScenario, 548
IntPrj, 522 IntScensched, 551
Create IntScheme, 553
SetPath, 419 IntSscheduler, 555
CreateCBEvents DecodeColour
IntEvt, 492 Application Methods, 8
CreateDerivedProject Default
IntVersion, 569 SetScenario, 422
CreateEvent DefineBoundary
ElmTr2, 171 ElmArea, 93
ElmTr3, 174 ElmNet, 128
ElmTr4, 179 ElmZone, 195

619
INDEX INDEX

DefineDouble ShowModelessBrowser, 49
ComAddon, 270 UpdateTableReports, 49
DefineDoubleMatrix DiscardChanges
ComAddon, 271 IntScenario, 549
DefineDoublePerConnection Disconnect
ComAddon, 272 ElmGenstat, 114
DefineDoubleVector ElmPvsys, 129
ComAddon, 272 ElmSym, 159
DefineDoubleVectorPerConnection ElmXnet, 193
ComAddon, 273 DoAutoScale
DefineInteger GrpPage, 459
ComAddon, 274 PltAxis, 570
DefineIntegerPerConnection PltLinebarplot, 577
ComAddon, 274 PltVectorplot, 585
DefineIntegerVector DoAutoScaleX
ComAddon, 275 GrpPage, 460
DefineIntegerVectorPerConnection PltLinebarplot, 577
ComAddon, 276 SetDesktop, 406
DefineObject SetVipage, 435
ComAddon, 276 VisPath, 606
DefineObjectPerConnection VisPcompdiffplt, 608
ComAddon, 277 VisPlottz, 610
DefineObjectVector DoAutoScaleY
ComAddon, 277 GrpPage, 460
DefineObjectVectorPerConnection PltLinebarplot, 577
ComAddon, 278 SetVipage, 435
DefineString VisPath, 606
ComAddon, 279 VisPcompdiffplt, 608
DefineStringPerConnection VisPlottz, 610
ComAddon, 279 DoNotResetCalc
DefineTransferAttributes ComLdf, 335
Application Methods, 8
Delete EchoOff
General Object Methods, 66 Environment Functions, 50
DeleteCompleteQuickAccess EchoOn
ComUcteexp, 389 Environment Functions, 50
DeleteModule ElmArea, 92
ComAddon, 280 CalculateInterchangeTo, 92
DeleteParameterAtIndex CalculateVoltageLevel, 92
CimModel, 443 CalculateVoltInterVolt, 93
CimObject, 450 DefineBoundary, 93
DeleteRow GetAll, 93
IntScensched, 551 GetBranches, 94
DeleteUntouchedObjects GetBuses, 94
Application Methods, 9 GetObjs, 94
Derate ElmAsm, 94
ElmGenstat, 114 CalcEfficiency, 95
ElmPvsys, 129 GetAvailableGenPower, 95
ElmSym, 159 GetElecTorque, 95
DevicesToReport GetGroundingImpedance, 96
ComCoordreport, 304 GetMechTorque, 96
Dialogue Boxes Functions, 47 GetMotorStartingFlag, 97
CloseTableReports, 47 GetStepupTransformer, 97
GetTableReports, 47 IsPQ, 97
ShowModalBrowser, 47 ElmAsmsc, 98
ShowModalSelectBrowser, 48 GetAvailableGenPower, 98

620
INDEX INDEX

GetGroundingImpedance, 98 ElmGenstat, 113

GetStepupTransformer, 99 CalcEfficiency, 114
ElmBbone, 99 Derate, 114
CheckBbPath, 99 Disconnect, 114
GetBbOrder, 100 GetAvailableGenPower, 114
GetCompleteBbPath, 100 GetGroundingImpedance, 115
GetFOR, 100 GetStepupTransformer, 115
GetMeanCs, 101 IsConnected, 116
GetMinCs, 101 Reconnect, 116
GetTieOpenPoint, 101 ResetDerating, 116
GetTotLength, 101 ElmGndswt, 116
HasGnrlMod, 102 Close, 117
ElmBmu, 102 GetGroundingImpedance, 117
Apply, 102 IsClosed, 117
Update, 102 IsOpen, 117
ElmBoundary, 102 Open, 118
AddCubicle, 103 ElmLne, 118
CalcShiftedReversedBoundary, 103 AreDistParamsPossible, 118
Clear, 103 CreateFeederWithRoutes, 119
GetInterior, 103 FitParams, 119
IsSplitting, 104 GetIthr, 120
Resize, 104 GetType, 120
Update, 104 GetY0m, 120
ElmBranch, 104 GetY1m, 121
Update, 105 GetZ0m, 121
ElmCabsys, 105 GetZ1m, 121
FitParams, 105 GetZmatDist, 122
GetLineCable, 105 HasRoutes, 122
Update, 105 HasRoutesOrSec, 122
ElmComp, 106 IsCable, 123
slotupd, 106 IsNetCoupling, 123
SlotUpdate, 106 MeasureLength, 123
ElmCoup, 106 SetDetailed, 124
Close, 106 ElmLnesec, 124
GetRemoteBreakers, 106 IsCable, 124
IsBreaker, 107 ElmMdl, 124
IsClosed, 107 Check, 124
IsOpen, 107 ExportToClipboard, 124
Open, 108 ExportToFile, 125
ElmDcu, 108 ElmNec, 125
GetGroundingImpedance, 108 GetGroundingImpedance, 125
ElmDsl, 109 ElmNet, 126
ExportToClipboard, 109 Activate, 126
ExportToFile, 109 CalculateInterchangeTo, 126
ElmFeeder, 110 CalculateVoltageLevel, 127
CalcAggrVarsInRadFeed, 110 CalculateVoltInterVolt, 127
GetAll, 110 Deactivate, 128
GetBranches, 111 DefineBoundary, 128
GetBuses, 111 ElmPvsys, 128
GetNodesBranches, 111 CalcEfficiency, 128
GetObjs, 112 Derate, 129
ElmFile, 112 Disconnect, 129
LoadFile, 112 GetAvailableGenPower, 129
SaveFile, 112 GetGroundingImpedance, 130
ElmFilter, 113 IsConnected, 130
GetGroundingImpedance, 113 Reconnect, 130

621
INDEX INDEX

ResetDerating, 130 NCol, 146

ElmRecmono, 131 NRow, 147
GetGroundingImpedance, 131 Release, 150
ElmRelay, 131 SetAsDefault, 150
CalculateMaxFaultCurrents, 132 SetObj, 150
CheckRanges, 132 SetSubElmResKey, 151
GetCalcRX, 132 SizeX, 147
GetMaxFdetectCalcI, 132 SizeY, 146
GetSlot, 133 SortAccordingToColumn, 151
GetUnom, 133 Write, 151
IsStarted, 133 WriteDraw, 152
SetImpedance, 134 ElmShnt, 152
SetMaxI, 135 GetGroundingImpedance, 152
SetMaxIearth, 135 ElmStactrl, 152
SetMinI, 135 GetControlledHVNode, 153
SetMinIearth, 135 GetControlledLVNode, 153
SetOutOfService, 135 GetStepupTransformer, 153
SetTime, 136 Info, 154
slotupd, 136 ElmSubstat, 154
SlotUpdate, 136 ApplyAndResetRA, 154
ElmRes, 137 GetSplit, 154
AddVariable, 138 GetSplitCal, 155
AddVars, 138 GetSplitIndex, 156
Clear, 138 GetSuppliedElements, 156
Close, 141 OverwriteRA, 157
ExecuteLoadingCommand, 138 ResetRA, 157
FindColumn, 138 SaveAsRA, 157
FindMaxInColumn, 139 SetRA, 157
FindMaxOfVariableInRow, 139 ElmSvs, 158
FindMaxRowsInColumns, 140 GetStepupTransformer, 158
FindMinInColumn, 140 ElmSym, 158
FindMinOfVariableInRow, 141 CalcEfficiency, 159
FindMinRowsInColumns, 141 Derate, 159
FinishWriting, 141 Disconnect, 159
Flush, 142 GetAvailableGenPower, 159
GetColumnValues, 142 GetGroundingImpedance, 160
GetDescription, 142 GetMotorStartingFlag, 160
GetFirstValidObject, 143 GetStepupTransformer, 161
GetFirstValidObjectVariable, 144 IsConnected, 161
GetFirstValidVariable, 144 Reconnect, 161
GetNextValidObject, 145 ResetDerating, 161
GetNextValidObjectVariable, 146 ElmTerm, 162
GetNextValidVariable, 146 GetBusType, 162
GetNumberOfColumns, 146 GetCalcRelevantCubicles, 162
GetNumberOfRows, 147 GetConnectedBrkCubicles, 162
GetObj, 147 GetConnectedCubicles, 163
GetObject, 147 GetConnectedMainBuses, 163
GetObjectValue, 147 GetConnectionInfo, 163
GetRelCase, 148 GetEquivalentTerminals, 164
GetSubElmRes, 148 GetMinDistance, 164
GetUnit, 148 GetNextHVBus, 165
GetValue, 149 GetNodeName, 165
GetVariable, 149 GetSepStationAreas, 166
Init, 149 GetShortestPath, 166
InitialiseWriting, 149 GetShortestPathWithIndex, 167
Load, 150 HasCreatedCalBus, 167

622
INDEX INDEX

InitAllShortestPaths, 167 NTap, 189

IsElectrEquivalent, 168 ElmVac, 190
IsEquivalent, 169 GetGroundingImpedance, 190
IsInternalNodeInStation, 169 ElmVoltreg, 190
UpdateSubstationTerminals, 170 CreateEvent, 190
ElmTow, 170 GetGroundingImpedance, 191
Update, 170 GetZpu, 191
ElmTr2, 170 NTap, 191
CreateEvent, 171 ElmVscmono, 192
GetGroundingImpedance, 171 GetGroundingImpedance, 192
GetSuppliedElements, 171 ElmXnet, 192
GetTapPhi, 172 CalcEfficiency, 192
GetTapRatio, 172 Disconnect, 193
GetZ0pu, 173 GetGroundingImpedance, 193
GetZpu, 173 GetStepupTransformer, 193
IsQuadBooster, 174 Reconnect, 194
NTap, 174 ElmZone, 194
ElmTr3, 174 CalculateInterchangeTo, 194
CreateEvent, 174 CalculateVoltageLevel, 194
GetGroundingImpedance, 175 CalculateVoltInterVolt, 195
GetSuppliedElements, 175 DefineBoundary, 195
GetTapPhi, 176 GetAll, 196
GetTapRatio, 176 GetBranches, 196
GetTapZDependentSide, 176 GetBuses, 196
GetZ0pu, 177 GetObjs, 196
GetZpu, 177 SetLoadScaleAbsolute, 196
IsQuadBooster, 178 EmptyCache
NTap, 178 SetDatabase, 401
ElmTr4, 178 EnableDiffMode
CreateEvent, 179 IntSstage, 556
GetGroundingImpedance, 179 EncodeColour
GetSuppliedElements, 179 Application Methods, 9
GetTapPhi, 180 Encrypt
GetTapRatio, 180 BlkDef, 439
GetTapZDependentSide, 181 ComDpl, 321
GetZ0pu, 181 TypQdsl, 603
GetZpu, 182 EndDataExtensionModification
IsQuadBooster, 182 IntPrj, 524
NTap, 182 EndTabGroup
ElmTrain, 183 SetDesktop, 406
SetPosition, 183 Energize
ElmTrb, 183 General Object Methods, 67
GetGroundingImpedance, 183 Environment Functions, 49
ElmTrfstat, 184 EchoOff, 50
GetSplit, 184 EchoOn, 50
GetSplitCal, 185 IsAutomaticCalculationResetEnabled, 50
GetSplitIndex, 185 IsFinalEchoOnEnabled, 50
GetSuppliedElements, 186 SetAutomaticCalculationResetEnabled, 51
ElmTrmult, 186 SetEnableUserBreak, 53
CreateEvent, 187 SetFinalEchoOnEnabled, 51
GetGroundingImpedance, 187 SetGraphicUpdate, 51
GetSuppliedElements, 187 SetGuiUpdateEnabled, 52
GetTapPhi, 188 SetProgressBarUpdatesEnabled, 52
GetTapRatio, 188 SetRescheduleFlag, 52
GetZpu, 189 SetUserBreakEnabled, 53
IsQuadBooster, 189 EstimateOutage

623
INDEX INDEX

ComLdf, 336 ExportToExcel

Execute ComTablereport, 377
ComAddlabel, 269 ExportToFile
ComCimdbexp, 286 ElmDsl, 109
ComCimdbimp, 287 ElmMdl, 125
ComCimvalidate, 291 ExportToHTML
ComConreq, 296 ComTablereport, 377
ComDpl, 321 ExportToVec
ComFlickermeter, 326 IntGrflayer, 500
ComLdf, 336
Commands Methods, 269 File System Functions, 46
ComSimoutage, 372 GetInstallationDirectory, 46
ExecuteAllSteps GetInstallDir, 46
ComShctrace, 365 GetTempDir, 46
ExecuteAmpacityCalc GetTemporaryDirectory, 46
ComAmpacity, 281 GetWorkingDir, 46
ExecuteAndCheck GetWorkspaceDirectory, 46
ComSimoutage, 372 FileNmResNm
ExecuteCmd ComRes, 362
Application Methods, 9 FinaliseModule
ExecuteInitialStep ComAddon, 280
ComShctrace, 365 FindColumn
ExecuteLoadingCommand ElmRes, 138
ElmRes, 138 IntComtrade, 473
ExecuteNextStep IntComtradeset, 479
ComShctrace, 366 FindCriticalBus
ExecuteRecording ComPvcurves, 352
ComMerge, 341 FindMaxInColumn
ExecuteRXSweep ElmRes, 139
ComShc, 363 IntComtrade, 473
ExecuteTime IntComtradeset, 479
ComOutage, 349 FindMaxOfVariableInRow
ExecuteWithActiveProject ElmRes, 139
ComMerge, 341 FindMaxRowsInColumns
ExecuteWithCustomSelection ElmRes, 140
ComReport, 361 FindMinInColumn
ExeEvt ElmRes, 140
ComRel3, 358 IntComtrade, 473
Export IntComtradeset, 479
IntDocument, 485 FindMinOfVariableInRow
IntGrfgroup, 494 ElmRes, 141
IntGrflayer, 499 FindMinRowsInColumns
IntIcon, 506 ElmRes, 141
ExportAllReportDocuments FinishWriting
SetTabgroup, 427 ElmRes, 141
ExportAllTableReports First
SetTabgroup, 427 IntDplmap, 487
ExportAndInitQuickAccess FitParams
ComUcteexp, 389 ElmCabsys, 105
ExportFullRange ElmLne, 119
ComRes, 362 Flush
ExportGraphicTab ElmRes, 142
ComWr, 392 Output Window Methods, 62
ExportToClipboard FlushOutputWindow
ElmDsl, 109 Output Window Functions, 59
ElmMdl, 124 Freeze

624
INDEX INDEX

SetDesktop, 406 IsOutOfService, 84

IsReducible, 85
General Description, 1 IsShortCircuited, 85
General Object Methods, 64 MarkInGraphics, 85
AddCopy, 65 Move, 86
CopyData, 66 PasteCopy, 86
CreateObject, 66 PurgeUnusedObjects, 87
Delete, 66 ReportUnusedObjects, 87
Energize, 67 SearchObject, 87
GetAttribute, 67 SetAttribute, 87
GetAttributeDescription, 68 SetAttributeInRootAndStageObjects, 88
GetAttributeLength, 68 SetAttributeLength, 88
GetAttributes, 68 SetAttributes, 88
GetAttributeShape, 69 SetAttributeShape, 89
GetAttributeType, 69 ShowEditDialog, 89
GetAttributeUnit, 70 ShowModalSelectTree, 89
GetChildren, 70 SwitchOff, 90
GetClassName, 70 SwitchOn, 91
GetCombinedProjectSource, 71 WriteChangesToDb, 91
GetConnectedElements, 71 GenerateContingenciesForAnalysis
GetConnectionCount, 71 ComNmink, 346
GetContents, 72 Get
GetControlledNode, 72 IntDplvec, 490
GetCubicle, 72 IntMat, 508
GetDbObjectId, 73 IntVec, 564
GetDbObjectKey, 73 IntVecobj, 567
GetDbProjectId, 73 SetFilt, 414
GetFullName, 74 GetActiveCalculationStr
GetImpedance, 74 Application Methods, 10
GetInom, 75 GetActiveModule
GetNode, 75 ComAddon, 280
GetOperator, 76 GetActiveNetworkVariations
GetOwner, 76 Application Methods, 10
GetParent, 76 GetActivePage
GetReferences, 76 SetDesktop, 406
GetRegion, 77 GetActiveProject
GetSupplyingSubstations, 77 Application Methods, 10
GetSupplyingTransformers, 78 GetActiveScenario
GetSupplyingTrfstations, 78 Application Methods, 10
GetSystemGrounding, 78 GetActiveScenarioScheduler
GetUnom, 78 Application Methods, 10
GetZeroImpedance, 79 GetActiveScheduler
HasAttribute, 79 IntScheme, 554
HasReferences, 80 GetActiveStages
HasResults, 80 Application Methods, 11
IsCalcRelevant, 80 GetActiveStudyCase
IsDeleted, 81 Application Methods, 11
IsEarthed, 81 GetAlarmColouringMode
IsEnergized, 81 SetColscheme, 394
IsHidden, 81 GetAll
IsInFeeder, 82 ComNmink, 347
IsNetworkDataFolder, 82 ElmArea, 93
IsNode, 83 ElmFeeder, 110
IsObjectActive, 83 ElmZone, 196
IsObjectModifiedByVariation, 83 IntDataset, 485
Isolate, 84 SetPath, 419

625
INDEX INDEX

SetSelect, 425 GetBorderCubicles

StaCubic, 197 Application Methods, 17
GetAllUsers GetBranch
Application Methods, 11 StaCubic, 198
GetAnalogueDescriptions GetBranches
IntComtrade, 474 ElmArea, 94
IntComtradeset, 480 ElmFeeder, 111
GetAnnotationElement ElmZone, 196
IntGrflayer, 500 SetPath, 420
GetApplication GetBrowserSelection
Module Functions, 2 Application Methods, 17
GetApplicationExt GetBuses
Module Functions, 3 ElmArea, 94
GetAttribute ElmFeeder, 111
General Object Methods, 67 ElmZone, 196
GetAttributeDescription SetPath, 420
Application Methods, 11 GetBusType
General Object Methods, 68 ElmTerm, 162
GetAttributeEnumerationType GetCalcRelevantCubicles
CimModel, 443 ElmTerm, 162
CimObject, 451 GetCalcRelevantObjects
GetAttributeLength Application Methods, 18
General Object Methods, 68 GetCalcRX
GetAttributes ElmRelay, 132
General Object Methods, 68 GetCalculationBalancedMode
GetAttributeShape Application Methods, 18
General Object Methods, 69 GetCalculationDescription
GetAttributeType Application Methods, 19
General Object Methods, 69 GetCalculations
GetAttributeUnit Application Methods, 19
Application Methods, 12 GetCalculationsAsJson
General Object Methods, 70 Application Methods, 21
GetAuthenticationTicket GetCanvasSize
ComStationware, 375 SetDesktop, 406
GetAvailableAttributes GetCertificatePath
Application Methods, 12 ComOpc, 348
GetAvailableAttributesAsJson GetCheckSum
Application Methods, 13 BlkDef, 440
GetAvailableButtons GetChildren
SetTboxconfig, 432 General Object Methods, 70
GetAvailableGenPower GetClassDescription
ElmAsm, 95 Application Methods, 22
ElmAsmsc, 98 GetClassId
ElmGenstat, 114 Application Methods, 22
ElmPvsys, 129 GetClassName
ElmSym, 159 General Object Methods, 70
GetAxisX GetClassType
PltLinebarplot, 577 ComCimvalidate, 291
PltVectorplot, 585 GetColouringMode
GetAxisY SetColscheme, 394
PltLinebarplot, 578 GetColumnLabel
PltVectorplot, 585 IntMat, 508
GetBbOrder GetColumnLabelIndex
ElmBbone, 100 IntMat, 508
GetBlockedSwitches GetColumnValues
ComShctrace, 366 ElmRes, 142

626
INDEX INDEX

IntComtrade, 474 GetCriticalTimePhase

IntComtradeset, 480 IntThrating, 560
GetCombinedProjectSource GetCubicle
General Object Methods, 71 General Object Methods, 72
GetCommandsForStudyCase GetCurrentDiagram
ComTasks, 379 Application Methods, 22
GetCompleteBbPath GetCurrentIteration
ElmBbone, 100 ComGenrelinc, 327
GetComplexData GetCurrentScript
PltVectorplot, 586 Application Methods, 22
GetConfiguration GetCurrentSelection
IntSubset, 559 Application Methods, 23
SetDataext, 402 GetCurrentTimeStep
GetConfigurations ComShctrace, 366
SetDataext, 402 GetCurrentUser
GetConnectedBranches Application Methods, 23
ComUcteexp, 390 GetCurrentZoomScaleLevel
GetConnectedBrkCubicles Application Methods, 23
ElmTerm, 162 GetDataFolder
GetConnectedCubicles Application Methods, 23
ElmTerm, 163 GetDataSeries
GetConnectedElements PltLinebarplot, 578
General Object Methods, 71 GetDataSource
GetConnectedMainBuses PltDataseries, 574
ElmTerm, 163 PltLinebarplot, 578
GetConnectedMajorNodes GetDbObjectId
StaCubic, 198 General Object Methods, 73
GetConnectionCount GetDbObjectKey
General Object Methods, 71 General Object Methods, 73
GetConnectionInfo GetDbProjectId
ElmTerm, 163 General Object Methods, 73
GetConnections GetDerivedProjects
StaCubic, 198 IntPrj, 524
GetContent IntVersion, 569
Output Window Methods, 62 GetDescription
GetContents ElmRes, 142
General Object Methods, 72 IntComtrade, 474
GetContingencies IntComtradeset, 480
ComRelreport, 360 GetDescriptionText
ComReltabreport, 361 ComCimvalidate, 292
GetContributionOfComponent GetDesktop
ComRelpost, 359 Application Methods, 24
ComRelreport, 360 GetDeviceSwitches
ComReltabreport, 361 ComShctrace, 366
GetControlledHVNode GetDeviceTime
ElmStactrl, 153 ComShctrace, 367
GetControlledLVNode GetDiagramSelection
ElmStactrl, 153 Application Methods, 24
GetControlledNode GetDigitalDescriptions
General Object Methods, 72 IntComtrade, 475
GetCorrespondingObject IntComtradeset, 481
ComMerge, 341 GetDisplayedButtons
GetCreatedBoundaries SetTboxconfig, 432
ComBoundary, 284 GetElecTorque
GetCreatedObjects ElmAsm, 95
ComImport, 333 GetEnergisingColouringMode

627
INDEX INDEX

SetColscheme, 394 ElmTr2, 171

GetEquivalentTerminals ElmTr3, 175
ElmTerm, 164 ElmTr4, 179
GetExternalObject ElmTrb, 183
ComDpl, 322 ElmTrmult, 187
ComPython, 353 ElmVac, 190
GetExternalReferences ElmVoltreg, 191
IntPrj, 524 ElmVscmono, 192
GetFaultType ElmXnet, 193
ComShc, 363 GetGroups
GetFeeders IntUserman, 563
ComOmr, 347 GetHistoricalProject
GetFieldCount IntVersion, 569
IntReport, 537 GetImpedance
GetFieldDataType General Object Methods, 74
IntReport, 538 GetImportedObjects
GetFieldName ComPfdimport, 351
IntReport, 538 GetInom
GetFirstValidObject General Object Methods, 75
ElmRes, 143 GetInputObject
GetFirstValidObjectVariable ComCimvalidate, 292
ElmRes, 144 GetInputParameterDouble
GetFirstValidVariable ComDpl, 322
ElmRes, 144 ComPython, 353
GetFlowOrientation GetInputParameterInt
Application Methods, 24 ComDpl, 323
GetFontID ComPython, 354
SetPrj, 421 GetInputParameterString
GetFOR ComDpl, 323
ElmBbone, 100 ComPython, 354
GetFromSigName GetInstallationDirectory
BlkSig, 441 File System Functions, 46
GetFromStudyCase GetInstallDir
Application Methods, 25 File System Functions, 46
GetFromToNodeNames GetIntCalcres
ComUcteexp, 390 PltDataseries, 574
GetFullName GetInterfaceVersion
General Object Methods, 74 Application Methods, 25
GetGeneratorEvent GetInterior
ComContingency, 298 ElmBoundary, 103
GetGeoCoordinateSystem GetInterruptedPowerAndCustomersForStage
IntPrj, 524 ComContingency, 298
GetGlobalLibrary GetInterruptedPowerAndCustomersForTimeStep
Application Methods, 25
GetGroundingImpedance ComContingency, 299
ElmAsm, 96 GetIthr
ElmAsmsc, 98 ElmLne, 120
ElmDcu, 108 GetLanguage
ElmFilter, 113 Application Methods, 26
ElmGenstat, 115 GetLatestVersion
ElmGndswt, 117 IntPrj, 525
ElmNec, 125 GetLegend
ElmPvsys, 130 PltLinebarplot, 578
ElmRecmono, 131 PltVectorplot, 586
ElmShnt, 152 GetLimit
ElmSym, 160 ScnFreq, 589

628
INDEX INDEX

ScnFrt, 591 ComMerge, 342

ScnSpeed, 593 GetModificationResult
ScnSync, 594 ComMerge, 342
ScnVar, 596 GetModifiedObjects
ScnVolt, 598 ComImport, 334
GetLineCable ComMerge, 342
ElmCabsys, 105 GetMotorConnections
GetLoadEvent ComMot, 345
ComContingency, 299 GetMotorStartingFlag
GetLocalLibrary ElmAsm, 97
Application Methods, 26 ElmSym, 160
GetLocationsToReport GetMotorSwitch
ComArcreport, 282 ComMot, 345
GetMaxFdetectCalcI GetMotorTerminal
ElmRelay, 132 ComMot, 346
GetMaxNumIterations GetNearestBusbars
ComGenrelinc, 327 StaCubic, 199
GetMeanCs GetNextHVBus
ElmBbone, 101 ElmTerm, 165
GetMeaValue GetNextValidObject
StaExtbrkmea, 201 ElmRes, 145
StaExtcmdmea, 206 GetNextValidObjectVariable
StaExtdatmea, 211 ElmRes, 146
StaExtfmea, 216 GetNextValidVariable
StaExtfuelmea, 220 ElmRes, 146
StaExtimea, 225 GetNode
StaExtpfmea, 231 General Object Methods, 75
StaExtpmea, 236 GetNodeName
StaExtqmea, 241 ElmTerm, 165
StaExttapmea, 251 GetNodesBranches
StaExtv3mea, 257 ElmFeeder, 111
StaExtvmea, 262 GetNonStartedDevices
GetMechTorque ComShctrace, 367
ElmAsm, 96 GetNTopLoadedElms
GetMem ComSimoutage, 373
Application Methods, 26 GetNumberOfAnalogueSignalDescriptions
GetMessageDescription IntComtrade, 475
ComCimtogrid, 289 IntComtradeset, 481
ComGridtocim, 329 GetNumberOfAnnotationElements
GetMessageObject IntGrflayer, 500
ComCimtogrid, 289 GetNumberOfClusters
ComGridtocim, 330 SetCluster, 393
GetMessageSeverity GetNumberOfColumns
ComCimtogrid, 290 ElmRes, 146
ComGridtocim, 330 IntComtrade, 475
GetMinCs IntComtradeset, 481
ElmBbone, 101 IntMat, 509
GetMinDistance GetNumberOfCommandsForStudyCase
ElmTerm, 164 ComTasks, 379
GetModel GetNumberOfDigitalSignalDescriptions
ComCimvalidate, 293 IntComtrade, 475
GetModelId IntComtradeset, 481
ComCimvalidate, 293 GetNumberOfGeneratorEventsForTimeStep
GetModelsReferencingThis ComContingency, 300
CimModel, 444 GetNumberOfLoadEventsForTimeStep
GetModification ComContingency, 300

629
INDEX INDEX

GetNumberOfMessages GetOperationValue
ComCimtogrid, 290 IntScenario, 549
ComGridtocim, 331 GetOperator
GetNumberOfRows General Object Methods, 76
ElmRes, 147 GetOrderCode
IntComtrade, 476 ComUcteexp, 390
IntComtradeset, 482 GetOrInsertCurvePlot
IntMat, 509 GrpPage, 460
GetNumberOfStudyCases GetOrInsertPlot
ComTasks, 380 GrpPage, 460
GetNumberOfSwitchEventsForTimeStep SetVipage, 435
ComContingency, 300 GetOutputWindow
GetNumberOfTimeSteps Output Window Functions, 60
ComContingency, 300 GetOverLoadedBranches
GetNumberOfValidationMessages ComShc, 364
ComCimvalidate, 294 GetOverLoadedBuses
GetNumberOfViolations ComShc, 364
ScnFreq, 589 GetOwner
ScnFrt, 591 General Object Methods, 76
ScnSpeed, 593 GetPage
ScnSync, 595 SetDesktop, 407
ScnVar, 596 GetParameterCount
ScnVolt, 598 CimModel, 444
GetNumProcesses CimObject, 452
SetUser, 434 GetParameterNamespace
GetNumSlave CimModel, 445
SetParalman, 417 CimObject, 452
GetObj GetParameterValue
ComContingency, 301 CimModel, 445
ElmRes, 147 CimObject, 453
GetObject GetParameterValueAsDouble
ComCimvalidate, 294 IntReport, 539
ComOutage, 350 GetParameterValueAsInteger
ElmRes, 147 IntReport, 539
GetObjectByDbObjectKey GetParameterValueAsString
Application Methods, 27 IntReport, 540
GetObjectId GetParent
ComCimvalidate, 295 General Object Methods, 76
GetObjects GetPathFolder
IntReport, 539 SetPath, 420
IntScenario, 549 GetPathToNearestBusbar
IntSubset, 559 StaCubic, 199
GetObjectsReferencingThis GetPfObjects
CimObject, 451 CimObject, 453
GetObjectsWithSameId GetPlot
CimObject, 451 GrpPage, 461
GetObjectValue GetProfile
ElmRes, 147 ComCimvalidate, 295
IntComtrade, 476 GetProjectFolder
IntComtradeset, 482 Application Methods, 27
GetObjs GetProjectFolderType
ElmArea, 94 IntPrjfolder, 532
ElmFeeder, 112 GetQlim
ElmZone, 196 IntQlim, 533
GetOMR GetRandomNumber
ComOmr, 347 Mathematical Functions, 54

630
INDEX INDEX

GetRandomNumberEx GetStartEndTime
Mathematical Functions, 54 IntScensched, 552
GetRating GetStatus
IntThrating, 560 StaExtbrkmea, 201
GetRecordingStage StaExtcmdmea, 206
Application Methods, 27 StaExtdatmea, 211
GetReferences StaExtfmea, 216
General Object Methods, 76 StaExtfuelmea, 221
GetRegion StaExtimea, 226
General Object Methods, 77 StaExtpfmea, 231
GetRegionCount StaExtpmea, 237
ComOmr, 348 StaExtqmea, 242
GetRelCase StaExtsmea, 247
ElmRes, 148 StaExttapmea, 252
GetRemoteBreakers StaExtv3mea, 258
ElmCoup, 106 StaExtvmea, 263
GetRowCount GetStatusTmp
IntReport, 540 StaExtbrkmea, 201
GetRowLabel StaExtcmdmea, 206
IntMat, 509 StaExtdatmea, 211
GetRowLabelIndex StaExtfmea, 216
IntMat, 510 StaExtfuelmea, 221
GetScenario StaExtimea, 226
IntScensched, 552 StaExtpfmea, 232
GetScheme StaExtpmea, 237
IntSstage, 557 StaExtqmea, 242
GetSepStationAreas StaExtsmea, 247
ElmTerm, 166 StaExttapmea, 252
GetSettings StaExtv3mea, 258
Application Methods, 28 StaExtvmea, 263
GetSeverity GetStepupTransformer
ComCimvalidate, 295 ElmAsm, 97
GetShortestPath ElmAsmsc, 99
ElmTerm, 166 ElmGenstat, 115
GetShortestPathWithIndex ElmStactrl, 153
ElmTerm, 167 ElmSvs, 158
GetSignalHeader ElmSym, 161
IntComtrade, 476 ElmXnet, 193
IntComtradeset, 482 GetStudyCases
GetSimulationTime ComTasks, 380
ComSim, 368 GetStudyTimeObject
GetSlot Date/Time Functions, 47
ElmRelay, 133 GetSubElmRes
GetSplit ElmRes, 148
ElmSubstat, 154 GetSuccesfullyConnectedItems
ElmTrfstat, 184 ComPrjconnector, 352
GetSplitCal GetSummaryGrid
ElmSubstat, 155 Application Methods, 28
ElmTrfstat, 185 GetSuppliedElements
GetSplitIndex ElmSubstat, 156
ElmSubstat, 156 ElmTr2, 171
ElmTrfstat, 185 ElmTr3, 175
GetSplitOrientation ElmTr4, 179
SetDesktop, 407 ElmTrfstat, 186
GetStartedDevices ElmTrmult, 187
ComShctrace, 367 GetSupplyingSubstations

631
INDEX INDEX

General Object Methods, 77 BlkSig, 442

GetSupplyingTransformers GetTotalInterruptedPower
General Object Methods, 78 ComContingency, 302
GetSupplyingTrfstations GetTotalWarnA
General Object Methods, 78 ComSim, 368
GetSwitchEvent GetTotalWarnB
ComContingency, 301 ComSim, 368
GetSwitchStatus GetTotalWarnC
IntRunarrange, 547 ComSim, 369
GetSwitchTime GetTotLength
ComShctrace, 367 ElmBbone, 101
GetSystemGrounding GetTouchedObjects
General Object Methods, 78 Application Methods, 28
GetTabCount GetTouchingExpansionStages
SetTabgroup, 428 Application Methods, 29
GetTabGroups GetTouchingStageObjects
SetDesktop, 408 Application Methods, 29
GetTableCount GetTouchingVariations
IntReport, 541 Application Methods, 29
GetTableName GetTransferCalcData
IntReport, 541 ComTransfer, 388
GetTableReports GetTrippedDevices
Dialogue Boxes Functions, 47 ComShctrace, 367
GetTabObject GetType
SetTabgroup, 428 ComCimvalidate, 296
GetTabTitle ElmLne, 120
SetTabgroup, 428 GetUcteNodeName
GetTabType ComUcteexp, 391
SetTabgroup, 429 GetUnit
GetTapPhi ElmRes, 148
ElmTr2, 172 IntComtrade, 476
ElmTr3, 176 IntComtradeset, 482
ElmTr4, 180 GetUnitFor
ElmTrmult, 188 ComArcreport, 282
GetTapRatio GetUnom
ElmTr2, 172 ElmRelay, 133
ElmTr3, 176 General Object Methods, 78
ElmTr4, 180 GetUnsuccesfullyConnectedItems
ElmTrmult, 188 ComPrjconnector, 352
GetTapZDependentSide GetUserManager
ElmTr3, 176 Application Methods, 30
ElmTr4, 181 GetUsers
GetTempDir IntUserman, 564
File System Functions, 46 GetUserSettings
GetTemporaryDirectory Application Methods, 30
File System Functions, 46 GetValue
GetTieOpenPoint ElmRes, 149
ElmBbone, 101 IntComtrade, 477
GetTimeOfStepInSeconds IntComtradeset, 483
ComContingency, 301 IntDplmap, 487
GetTimeUTC ScnFreq, 589
SetTime, 433 ScnFrt, 591
GetTitleObject ScnSpeed, 593
PltLinebarplot, 579 ScnSync, 595
PltVectorplot, 586 ScnVar, 596
GetToSigName ScnVolt, 598

632
INDEX INDEX

GetValueAsDouble GetZ1m
IntReport, 542 ElmLne, 121
GetValueAsInteger GetZeroImpedance
IntReport, 542 General Object Methods, 79
GetValueAsObject GetZeroSequenceHVLVT
IntReport, 543 TypTr2, 605
GetValueAsString GetZmatDist
IntReport, 544 ElmLne, 122
GetValueFor GetZpu
ComArcreport, 282 ElmTr2, 173
GetVar ElmTr3, 177
IntMon, 515 ElmTr4, 182
GetVariable ElmTrmult, 189
ElmRes, 149 ElmVoltreg, 191
IntComtrade, 477 GrpPage, 459
IntComtradeset, 483 ChangeStyle, 459
ScnFreq, 590 DoAutoScale, 459
ScnFrt, 591 DoAutoScaleX, 460
ScnSpeed, 593 DoAutoScaleY, 460
ScnSync, 595 GetOrInsertCurvePlot, 460
ScnVar, 597 GetOrInsertPlot, 460
ScnVolt, 598 GetPlot, 461
GetVariation RemovePage, 461
IntSstage, 557 SetAutoScaleModeX, 461
GetVersions SetAutoScaleModeY, 462
IntPrj, 525 SetLayoutMode, 462
GetViolatedElement SetResults, 462
ScnFreq, 590 SetScaleTypeX, 462
ScnFrt, 592 SetScaleTypeY, 463
ScnSpeed, 594 SetScaleX, 463
ScnSync, 595 SetScaleY, 463
ScnVar, 597 Show, 463
ScnVolt, 599
GetViolatedScanModules HasAttribute
ComSim, 369 General Object Methods, 79
GetViolationTime HasCreatedCalBus
ScnFreq, 590 ElmTerm, 167
ScnFrt, 592 HasExternalReferences
ScnSpeed, 594 IntPrj, 525
ScnSync, 596 HasGnrlMod
ScnVar, 597 ElmBbone, 102
ScnVolt, 599 HasParameter
GetWorkingDir CimModel, 446
File System Functions, 46 CimObject, 454
GetWorkspaceDirectory HasReferences
File System Functions, 46 General Object Methods, 80
GetY0m HasResults
ElmLne, 120 General Object Methods, 80
GetY1m HasResultsForDirectionalBackup
ElmLne, 121 ComCoordreport, 304
GetZ0m HasResultsForFuse
ElmLne, 121 ComCoordreport, 304
GetZ0pu HasResultsForInstantaneous
ElmTr2, 173 ComCoordreport, 304
ElmTr3, 177 HasResultsForNonDirectionalBackup
ElmTr4, 181 ComCoordreport, 305

633
INDEX INDEX

HasResultsForOverload Insert
ComCoordreport, 305 IntDplmap, 488
HasResultsForOverreach IntDplvec, 491
ComCoordreport, 305 InsertPlot
HasResultsForShortCircuit SetVipage, 436
ComCoordreport, 306 IntAddonvars, 464
HasResultsForZone AddDouble, 464
ComCoordreport, 306 AddDoubleMatrix, 465
HasRoutes AddDoubleVector, 465
ElmLne, 122 AddInteger, 466
HasRoutesOrSec AddIntegerVector, 466
ElmLne, 122 AddObject, 467
Hide AddObjectVector, 467
Application Methods, 30 AddString, 468
RemoveParameter, 468
Import RenameClass, 468
IntDocument, 486 RenameParameter, 469
IntGrfgroup, 495 SetConstraint, 469
IntGrflayer, 500 IntCase, 470
IntIcon, 506 Activate, 470
ImportAndConvert ApplyNetworkState, 470
ComCimdbimp, 287 ApplyStudyTime, 470
ImportDz Consolidate, 471
Application Methods, 30 Deactivate, 471
ImportFromVec SetStudyTime, 471
IntGrflayer, 501 IntComtrade, 472
ImportSnapshot ConvertToASCIIFormat, 472
Application Methods, 31 ConvertToBinaryFormat, 472
IndexOf FindColumn, 473
IntDplvec, 490 FindMaxInColumn, 473
Info FindMinInColumn, 473
ElmStactrl, 154 GetAnalogueDescriptions, 474
Init GetColumnValues, 474
ElmRes, 149 GetDescription, 474
IntMat, 510 GetDigitalDescriptions, 475
IntVec, 564 GetNumberOfAnalogueSignalDescriptions,
InitAllShortestPaths 475
ElmTerm, 167 GetNumberOfColumns, 475
InitialiseWriting GetNumberOfDigitalSignalDescriptions, 475
ElmRes, 149 GetNumberOfRows, 476
InitQuickAccess GetObjectValue, 476
ComUcteexp, 391 GetSignalHeader, 476
InitTmp GetUnit, 476
StaExtbrkmea, 201 GetValue, 477
StaExtcmdmea, 206 GetVariable, 477
StaExtdatmea, 211 Load, 478
StaExtfmea, 216 NCol, 475
StaExtfuelmea, 221 NRow, 476
StaExtimea, 226 Release, 478
StaExtpfmea, 232 SizeX, 476
StaExtpmea, 237 SizeY, 475
StaExtqmea, 242 SortAccordingToColumn, 478
StaExtsmea, 247 IntComtradeset, 478
StaExttapmea, 252 FindColumn, 479
StaExtv3mea, 258 FindMaxInColumn, 479
StaExtvmea, 263 FindMinInColumn, 479

634
INDEX INDEX

GetAnalogueDescriptions, 480 IntGrf, 493

GetColumnValues, 480 MoveToLayer, 493
GetDescription, 480 Orthogonalise, 494
GetDigitalDescriptions, 481 SnapToGrid, 494
GetNumberOfAnalogueSignalDescriptions, IntGrfgroup, 494
481 ClearData, 494
GetNumberOfColumns, 481 Export, 494
GetNumberOfDigitalSignalDescriptions, 481 Import, 495
GetNumberOfRows, 482 IntGrflayer, 495
GetObjectValue, 482 AdaptWidth, 495
GetSignalHeader, 482 AddAnnotationElement, 496
GetUnit, 482 Align, 496
GetValue, 483 ChangeFont, 497
GetVariable, 483 ChangeLayer, 497
Load, 484 ChangeRefPoints, 498
NCol, 481 ChangeWidthVisibilityAndColour, 498
NRow, 482 CheckAnnotationString, 499
Release, 484 ClearData, 499
SizeX, 482 Export, 499
SizeY, 481 ExportToVec, 500
SortAccordingToColumn, 484 GetAnnotationElement, 500
IntDataset, 484 GetNumberOfAnnotationElements, 500
AddRef, 484 Import, 500
All, 485 ImportFromVec, 501
Clear, 485 Mark, 501
GetAll, 485 RemoveAnnotationElement, 501
IntDocument, 485 Reset, 501
Export, 485 UpdateAnnotationElement, 502
Import, 486 IntGrfnet, 504
Reset, 486 Close, 504
View, 486 SetFontFor, 504
IntDplmap, 486 SetLayerVisibility, 505
Clear, 487 SetSymbolComponentVisibility, 505
Contains, 487 Show, 506
First, 487 IntIcon, 506
GetValue, 487 Export, 506
Insert, 488 Import, 506
Next, 488 IntLibrary, 507
Remove, 489 Activate, 507
Size, 489 Deactivate, 507
Update, 489 IntMat, 507
IntDplvec, 490 ColLbl, 508
Clear, 490 Get, 508
Get, 490 GetColumnLabel, 508
IndexOf, 490 GetColumnLabelIndex, 508
Insert, 491 GetNumberOfColumns, 509
Remove, 491 GetNumberOfRows, 509
Size, 491 GetRowLabel, 509
Sort, 491 GetRowLabelIndex, 510
IntEvt, 492 Init, 510
CreateCBEvents, 492 Invert, 511
RemoveSwitchEvents, 492 Multiply, 511
IntExtaccess, 493 NCol, 509
CheckUrl, 493 NRow, 509
IntGate, 493 Resize, 511
AddTrigger, 493 RowLbl, 509, 512

635
INDEX INDEX

Save, 512 Purge, 527

Set, 512 PurgeObjectKeys, 527
SetColumnLabel, 513 RemoveProjectFromCombined, 528
SetRowLabel, 513 Restore, 528
SizeX, 509 SetGeoCoordinateSystem, 528
SizeY, 509 SubscribeProjectReadOnly, 529
SortToColum, 513 SubscribeProjectReadWrite, 529
SortToColumn, 513 TransformGeoCoordinates, 529
IntMon, 514 TransformToGeographicCoordinateSystem,
AddVar, 514 529
AddVars, 514 UnsubscribeProject, 530
ClearVars, 515 UpdateStatistics, 530
GetVar, 515 UpdateToDefaultStructure, 530
NVars, 515 UpdateToMostRecentBaseVersion, 531
PrintAllVal, 515 IntPrjfolder, 531
PrintVal, 515 GetProjectFolderType, 532
RemoveVar, 515 IsProjectFolderType, 533
IntNndata, 516 IntQlim, 533
CheckConsistency, 516 GetQlim, 533
IntNnet, 516 IntRas, 534
CheckConsistency, 516 AddEvent, 534
IntOutage, 516 AddTrigger, 534
Apply, 517 IsValid, 534
ApplyAll, 517 IntReport, 535
Check, 517 AddObject, 535
CheckAll, 517 AddObjects, 536
IsInStudyTime, 518 CreateField, 536
IsInStudytime, 518 CreateTable, 537
ResetAll, 518 GetFieldCount, 537
IntPlannedout, 519 GetFieldDataType, 538
SetRecurrence, 519 GetFieldName, 538
IntPrj, 519 GetObjects, 539
Activate, 520 GetParameterValueAsDouble, 539
AddProjectToCombined, 520 GetParameterValueAsInteger, 539
AddProjectToRemoteDatabase, 520 GetParameterValueAsString, 540
Archive, 520 GetRowCount, 540
BeginDataExtensionModification, 521 GetTableCount, 541
CanAddProjectToRemoteDatabase, 521 GetTableName, 541
CanSubscribeProjectReadOnly, 521 GetValueAsDouble, 542
CanSubscribeProjectReadWrite, 521 GetValueAsInteger, 542
CopyDataExtensionFrom, 522 GetValueAsObject, 543
CopyProjectSettings, 522 GetValueAsString, 544
CreateVersion, 522 Reset, 545
Deactivate, 523 SetDefaultValue, 545
EndDataExtensionModification, 524 SetValue, 546
GetDerivedProjects, 524 IntRunarrange, 547
GetExternalReferences, 524 GetSwitchStatus, 547
GetGeoCoordinateSystem, 524 IntScenario, 547
GetLatestVersion, 525 Activate, 547
GetVersions, 525 Apply, 548
HasExternalReferences, 525 ApplySelective, 548
LoadCimData, 526 Deactivate, 548
LoadData, 526 DiscardChanges, 549
MergeToBaseProject, 526 GetObjects, 549
NormaliseCombined, 527 GetOperationValue, 549
PackExternalReferences, 527 ReleaseMemory, 550

636
INDEX INDEX

Save, 550 Init, 564

SetOperationValue, 550 Max, 565
IntScensched, 551 Mean, 565
Activate, 551 Min, 565
Deactivate, 551 Resize, 565
DeleteRow, 551 Save, 565
GetScenario, 552 Set, 566
GetStartEndTime, 552 Size, 566
SearchScenario, 552 Sort, 566
IntScheme, 553 IntVecobj, 567
Activate, 553 Get, 567
Consolidate, 553 Resize, 567
Deactivate, 553 Save, 567
GetActiveScheduler, 554 Search, 568
IsActive, 554 Set, 568
NewStage, 554 Size, 568
IntSscheduler, 555 IntVersion, 568
Activate, 555 CreateDerivedProject, 569
Deactivate, 555 GetDerivedProjects, 569
Update, 555 GetHistoricalProject, 569
IntSstage, 555 Rollback, 569
Activate, 556 IntViewbookmark, 570
CreateStageObject, 556 JumpTo, 570
EnableDiffMode, 556 UpdateFromCurrentView, 570
GetScheme, 557 Invert
GetVariation, 557 IntMat, 511
IsExcluded, 557 InvertMatrix
PrintModifications, 557 Mathematical Functions, 55
ReadValue, 557 IsAC
WriteValue, 558 ComLdf, 336
IntSubset, 558 IsActive
Apply, 558 IntScheme, 554
ApplySelective, 558 IsAdditionalResultsFlagSetForCommand
Clear, 559 ComTasks, 380
GetConfiguration, 559 IsAttributeModeInternal
GetObjects, 559 Application Methods, 31
IntSym, 560 IsAutomaticCalculationResetEnabled
ConvertGeometriesToMDLString, 560 Environment Functions, 50
IntThrating, 560 IsBalanced
GetCriticalTimePhase, 560 ComLdf, 336
GetRating, 560 IsBreaker
Resize, 561 ElmCoup, 107
IntUrl, 561 IsCable
View, 561 ElmLne, 123
IntUser, 562 ElmLnesec, 124
Purge, 562 TypLne, 602
SetPassword, 562 IsCalcRelevant
TerminateSession, 562 General Object Methods, 80
IntUserman, 563 IsClosed
CreateGroup, 563 ElmCoup, 107
CreateUser, 563 ElmGndswt, 117
GetGroups, 563 SetTabgroup, 429
GetUsers, 564 StaCubic, 200
UpdateGroups, 564 StaSwitch, 268
IntVec, 564 IsCommandIgnored
Get, 564 ComTasks, 380

637
INDEX INDEX

IsConnected IsObjectModifiedByVariation
ElmGenstat, 116 General Object Methods, 83
ElmPvsys, 130 Isolate
ElmSym, 161 General Object Methods, 84
StaCubic, 200 IsOpen
IsDC ElmCoup, 107
ComLdf, 337 ElmGndswt, 117
IsDeleted StaSwitch, 268
General Object Methods, 81 IsOpened
IsDguv SetDesktop, 408
ComArcreport, 283 IsOutOfService
IsEarthed General Object Methods, 84
General Object Methods, 81 IsPQ
IsElectrEquivalent ElmAsm, 97
ElmTerm, 168 IsProjectFolderType
IsEncrypted IntPrjfolder, 533
ComDpl, 324 IsQuadBooster
TypQdsl, 604 ElmTr2, 174
IsEnergized ElmTr3, 178
General Object Methods, 81 ElmTr4, 182
IsEpri ElmTrmult, 189
ComArcreport, 283 IsReducible
IsEquivalent General Object Methods, 85
ElmTerm, 169 IsRmsValid
IsExcluded Application Methods, 32
IntSstage, 557 IsScenarioAttribute
IsFinalEchoOnEnabled Application Methods, 32
Environment Functions, 50 IsShcValid
IsFrozen Application Methods, 32
SetDesktop, 408 IsShortCircuited
IsHidden General Object Methods, 85
General Object Methods, 81 IsSimValid
IsInFeeder Application Methods, 32
General Object Methods, 82 IsSplitting
IsInMainWindow ElmBoundary, 104
SetTabgroup, 430 IsStarted
IsInStudyTime ElmRelay, 133
IntOutage, 518 IsStatusBitSet
IsInStudytime StaExtbrkmea, 202
IntOutage, 518 StaExtcmdmea, 206
IsInternalNodeInStation StaExtdatmea, 212
ElmTerm, 169 StaExtfmea, 216
IsLastIterationFeasible StaExtfuelmea, 221
ComTransfer, 388 StaExtimea, 227
IsLdfValid StaExtpfmea, 232
Application Methods, 31 StaExtpmea, 237
IsNAN StaExtqmea, 243
Application Methods, 31 StaExtsmea, 248
IsNetCoupling StaExttapmea, 253
ElmLne, 123 StaExtv3mea, 258
IsNetworkDataFolder StaExtvmea, 263
General Object Methods, 82 IsStatusBitSetTmp
IsNode StaExtbrkmea, 202
General Object Methods, 83 StaExtcmdmea, 207
IsObjectActive StaExtdatmea, 212
General Object Methods, 83 StaExtfmea, 217

638
INDEX INDEX

StaExtfuelmea, 222 GetRandomNumber, 54

StaExtimea, 227 GetRandomNumberEx, 54
StaExtpfmea, 232 InvertMatrix, 55
StaExtpmea, 237 RndExp, 55
StaExtqmea, 243 RndGetMethod, 56
StaExtsmea, 248 RndGetSeed, 56
StaExttapmea, 253 RndNormal, 56
StaExtv3mea, 258 RndSetup, 57
StaExtvmea, 264 RndUnifInt, 58
IsStudyCaseIgnored RndUnifReal, 58
ComTasks, 381 RndWeibull, 58
IsSubCurveVisible SetRandomSeed, 59
PltOvercurrent, 582 Max
IsValid IntVec, 565
IntRas, 534 MaxZoneNumberFor
IsWriteCacheEnabled ComCoordreport, 306
Application Methods, 33 Mean
IntVec, 565
JumpTo MeasureLength
IntViewbookmark, 570 ElmLne, 123
JumpToLastStep Merge
ComContingency, 302 ComMerge, 343
MergeToBaseProject
LdfEquivalentVerification
IntPrj, 526
ComRed, 356
MigrateAllProjects
LicenceHasModule
Application Methods, 35
Application Methods, 33
MigratePage
Load
SetVipage, 436
ElmRes, 150
Min
IntComtrade, 478
IntVec, 565
IntComtradeset, 484
Module Functions, 2
LoadCimData
__version__, 2
IntPrj, 526
GetApplication, 2
LoadData
GetApplicationExt, 3
IntPrj, 526
ModuleExists
LoadFile
ComAddon, 281
ElmFile, 112
Move
LoadMicroSCADAFile
General Object Methods, 86
ComLink, 338
MoveTab
LoadProfile
SetTabgroup, 430
Application Methods, 34
MoveTabs
LoadSimulationState
SetTabgroup, 430
ComSim, 369
MoveTabToMainWindow
LoadSnapshot
SetTabgroup, 430
ComSim, 369
MoveTabToNewFloatingGroup
LossCostAtBusTech
SetTabgroup, 431
ComCapo, 285
MoveToLayer
Mark IntGrf, 493
IntGrflayer, 501 MoveToMainWindow
SetLevelvis, 416 SetTabgroup, 431
MarkInGraphics MoveToNewFloatingWindow
Application Methods, 35 SetTabgroup, 431
General Object Methods, 85 Multiply
MarkRegions IntMat, 511
ComSimoutage, 374
NCol
Mathematical Functions, 53

639
INDEX INDEX

ElmRes, 146 Application Methods, 35

IntComtrade, 475 OverwriteRA
IntComtradeset, 481 ElmSubstat, 157
IntMat, 509 OvlAlleviate
Network Elements Methods, 92 ComRel3, 358
NewStage
IntScheme, 554 Pack
Next BlkDef, 440
IntDplmap, 488 TypMdl, 603
NextStepAvailable PackAsMacro
ComShctrace, 368 BlkDef, 440
NormaliseCombined PackExternalReferences
IntPrj, 527 IntPrj, 527
NRow PartitionNetwork
ElmRes, 147 ComCosim, 320
IntComtrade, 476 PasteCopy
IntComtradeset, 482 General Object Methods, 86
IntMat, 509 PltAxis, 570
NTap DoAutoScale, 570
ElmTr2, 174 SetFont, 570
ElmTr3, 178 PltBiasdiff, 571
ElmTr4, 182 AddCurve, 571
ElmTrmult, 189 AddCurves, 571
ElmVoltreg, 191 ClearCurves, 571
NVars PltComplexdata, 572
IntMon, 515 AddVector, 572
ChangeColourPalette, 572
Object Methods, 64 ClearVectors, 572
Open PltDataseries, 573
ElmCoup, 108 AddCurve, 573
ElmGndswt, 118 AddXYCurve, 573
StaSwitch, 268 ChangeColourPalette, 574
OpenScriptInTab ClearCurves, 574
SetDesktop, 408 GetDataSource, 574
OpenTextFileInTab GetIntCalcres, 574
SetDesktop, 409 RemoveCurve, 574
Orthogonalise PltImpedancerx, 575
IntGrf, 494 AddRelayCurve, 575
Other Objects Methods, 439 AddRelayCurves, 575
Output Window Functions, 59 ClearRelayCurves, 575
ClearOutputWindow, 59 PltLegend, 576
FlushOutputWindow, 59 SetFont, 576
GetOutputWindow, 60 PltLinebarplot, 576
PrintError, 60 ChangeStyle, 577
PrintInfo, 60 DoAutoScale, 577
PrintPlain, 60 DoAutoScaleX, 577
PrintWarn, 60 DoAutoScaleY, 577
SetOutputWindowState, 60 GetAxisX, 577
Output Window Methods, 62 GetAxisY, 578
Clear, 62 GetDataSeries, 578
Flush, 62 GetDataSource, 578
GetContent, 62 GetLegend, 578
Print, 63 GetTitleObject, 579
Save, 63 SetAutoScaleModeX, 579
SetState, 63 SetAutoScaleModeY, 579
OutputFlexibleData SetAxisSharingLevelX, 579

640
INDEX INDEX

SetAxisSharingLevelY, 580 Output Window Functions, 60

SetScaleTypeX, 580 Purge
SetScaleTypeY, 580 IntPrj, 527
SetScaleX, 580 IntUser, 562
SetScaleY, 581 SetTboxconfig, 432
PltNetgraphic, 581 PurgeObjectKeys
ChangeStyle, 581 IntPrj, 527
PltOvercurrent, 581 PurgeUnusedObjects
AddCurve, 582 General Object Methods, 87
AddCurves, 582
ClearCurves, 582 QuickAccessAvailable
IsSubCurveVisible, 582 ComUcteexp, 391
SetSubCurveVisible, 583
PltPowerpq, 583 ReadValue
AddRelayCurve, 583 IntSstage, 557
AddRelayCurves, 584 Rebuild
ClearRelayCurves, 584 Application Methods, 36
PltTitle, 584 ReceiveData
SetFont, 584 ComLink, 338
PltVectorplot, 585 ComOpc, 348
ChangeStyle, 585 Reconnect
DoAutoScale, 585 ElmGenstat, 116
GetAxisX, 585 ElmPvsys, 130
GetAxisY, 585 ElmSym, 161
GetComplexData, 586 ElmXnet, 194
GetLegend, 586 ReductionInMemory
GetTitleObject, 586 ComRed, 357
SetAutoScaleModeX, 586 RelChar, 587
SetAutoScaleModeY, 586 SetCurve, 587
SetScaleX, 587 Release
SetScaleY, 587 ElmRes, 150
PostCommand IntComtrade, 478
Application Methods, 36 IntComtradeset, 484
PrepForUntouchedDelete ReleaseMemory
Application Methods, 36 IntScenario, 550
Print ReloadProfile
Output Window Methods, 63 Application Methods, 36
SetScenario, 422 RelToc, 588
PrintAllVal SetCurve, 588
IntMon, 515 RelZpol, 588
PrintCheckResults AssumeCompensationFactor, 588
ComLdf, 337 AssumeReRl, 588
PrintComparisonReport AssumeXeXl, 589
ComMerge, 343 Remove
PrintError IntDplmap, 489
Output Window Functions, 60 IntDplvec, 491
PrintInfo RemoveAllConfigurations
Output Window Functions, 60 SetDataext, 402
PrintModifications RemoveAllRas
ComMerge, 343 ComSimoutage, 374
IntSstage, 557 RemoveAnnotationElement
PrintPlain IntGrflayer, 501
Output Window Functions, 60 RemoveCmdsForStudyCaseRow
PrintVal ComTasks, 381
IntMon, 515 RemoveCommand
PrintWarn ComTasks, 382

641
INDEX INDEX

RemoveConfiguration ElmGenstat, 116

SetDataext, 403 ElmPvsys, 130
RemoveContingencies ElmSym, 161
ComSimoutage, 374 ResetQuickAccess
RemoveCurve ComUcteexp, 391
PltDataseries, 574 ResetRA
RemoveEvents ElmSubstat, 157
ComContingency, 302 ResetReductionInMemory
ComOutage, 350 ComRed, 357
ComRel3, 358 ResetStatusBit
RemoveOutages StaExtbrkmea, 202
ComRel3, 358 StaExtcmdmea, 207
RemovePage StaExtdatmea, 212
GrpPage, 461 StaExtfmea, 217
SetDesktop, 409 StaExtfuelmea, 222
RemoveParameter StaExtimea, 227
CimModel, 446 StaExtpfmea, 233
CimObject, 454 StaExtpmea, 238
IntAddonvars, 468 StaExtqmea, 243
RemoveProjectFromCombined StaExtsmea, 248
IntPrj, 528 StaExttapmea, 253
RemoveRas StaExtv3mea, 259
ComSimoutage, 374 StaExtvmea, 264
RemoveRatio ResetStatusBitTmp
TypCtcore, 601 StaExtbrkmea, 202
RemoveRatioByIndex StaExtcmdmea, 207
TypCtcore, 601 StaExtdatmea, 212
RemoveStudyCase StaExtfmea, 217
ComTasks, 382 StaExtfuelmea, 222
RemoveStudyCases StaExtimea, 227
ComTasks, 383 StaExtpfmea, 233
ComTececocmp, 387 StaExtpmea, 238
RemoveSwitchEvents StaExtqmea, 243
IntEvt, 492 StaExtsmea, 248
RemoveVar StaExttapmea, 253
IntMon, 515 StaExtv3mea, 259
RenameClass StaExtvmea, 264
IntAddonvars, 468 ResetThirdPartyModule
RenameParameter BlkDef, 441
IntAddonvars, 469 ComDpl, 324
Report TypQdsl, 604
ComDllmanager, 320 ResGetData
ReportUnusedObjects Application Methods, 37
General Object Methods, 87 ResGetDescription
Reset Application Methods, 37
ComMerge, 344 ResGetFirstValidObject
ComSimoutage, 374 Application Methods, 37
IntDocument, 486 ResGetFirstValidObjectVariable
IntGrflayer, 501 Application Methods, 38
IntReport, 545 ResGetFirstValidVariable
SetLevelvis, 416 Application Methods, 38
ResetAll ResGetIndex
IntOutage, 518 Application Methods, 38
ResetCalculation ResGetMax
Application Methods, 37 Application Methods, 38
ResetDerating ResGetMin

642
INDEX INDEX

Application Methods, 38 Mathematical Functions, 56

ResGetNextValidObject RndSetup
Application Methods, 39 Mathematical Functions, 57
ResGetNextValidObjectVariable RndUnifInt
Application Methods, 39 Mathematical Functions, 58
ResGetNextValidVariable RndUnifReal
Application Methods, 39 Mathematical Functions, 58
ResGetObject RndWeibull
Application Methods, 39 Mathematical Functions, 58
ResGetUnit Rollback
Application Methods, 39 IntVersion, 569
ResGetValueCount RowLbl
Application Methods, 39 IntMat, 509, 512
ResGetVariable
Application Methods, 40 Save
ResGetVariableCount IntMat, 512
Application Methods, 40 IntScenario, 550
Resize IntVec, 565
ElmBoundary, 104 IntVecobj, 567
IntMat, 511 Output Window Methods, 63
IntThrating, 561 SaveAsRA
IntVec, 565 ElmSubstat, 157
IntVecobj, 567 SaveAsScenario
ResLoadData Application Methods, 40
Application Methods, 40 SaveFile
ResReleaseData ElmFile, 112
Application Methods, 40 SaveSimulationState
ResSortToVariable ComSim, 369
Application Methods, 40 SaveSnapshot
Restore ComSim, 369
IntPrj, 528 ScnFreq, 589
ResultForDirectionalBackupVariable GetLimit, 589
ComCoordreport, 307 GetNumberOfViolations, 589
ResultForFuseVariable GetValue, 589
ComCoordreport, 307 GetVariable, 590
ResultForInstantaneousVariable GetViolatedElement, 590
ComCoordreport, 308 GetViolationTime, 590
ResultForMaxCurrent ScnFrt, 591
ComCoordreport, 309 GetLimit, 591
ResultForNonDirectionalBackupVariable GetNumberOfViolations, 591
ComCoordreport, 309 GetValue, 591
ResultForOverloadVariable GetVariable, 591
ComCoordreport, 310 GetViolatedElement, 592
ResultForOverreachVariable GetViolationTime, 592
ComCoordreport, 310 ScnSpeed, 592
ResultForShortCircuitVariable GetLimit, 593
ComCoordreport, 311 GetNumberOfViolations, 593
ResultForZoneVariable GetValue, 593
ComCoordreport, 312 GetVariable, 593
RndExp GetViolatedElement, 594
Mathematical Functions, 55 GetViolationTime, 594
RndGetMethod ScnSync, 594
Mathematical Functions, 56 GetLimit, 594
RndGetSeed GetNumberOfViolations, 595
Mathematical Functions, 56 GetValue, 595
RndNormal GetVariable, 595

643
INDEX INDEX

GetViolatedElement, 595 CimObject, 456, 457

GetViolationTime, 596 SetAttributeInRootAndStageObjects
ScnVar, 596 Application Methods, 42
GetLimit, 596 General Object Methods, 88
GetNumberOfViolations, 596 SetAttributeLength
GetValue, 596 General Object Methods, 88
GetVariable, 597 SetAttributeModeInternal
GetViolatedElement, 597 Application Methods, 42
GetViolationTime, 597 SetAttributes
ScnVolt, 598 General Object Methods, 88
GetLimit, 598 SetAttributeShape
GetNumberOfViolations, 598 General Object Methods, 89
GetValue, 598 SetAttributeValue
GetVariable, 598 CimModel, 448, 449
GetViolatedElement, 599 CimObject, 457, 458
GetViolationTime, 599 SetAuthorityUri
Search ComGridtocim, 331
IntVecobj, 568 SetAutoAssignmentForAll
SearchObject ComMerge, 344
General Object Methods, 87 SetAutomaticCalculationResetEnabled
SearchObjectByForeignKey Environment Functions, 51
Application Methods, 41 SetAutoScaleModeX
SearchObjectsByCimId GrpPage, 461
Application Methods, 41 PltLinebarplot, 579
SearchScenario PltVectorplot, 586
IntScensched, 552 SetAutoScaleModeY
SelectToolbox GrpPage, 462
Application Methods, 41 PltLinebarplot, 579
SendData PltVectorplot, 586
ComLink, 338 SetAutoScaleX
ComOpc, 349 SetDesktop, 410
SentDataStatus SetVipage, 437
ComLink, 339 SetAxisSharingLevelX
Set PltLinebarplot, 579
IntMat, 512 SetAxisSharingLevelY
IntVec, 566 PltLinebarplot, 580
IntVecobj, 568 SetBatchMode
SetActiveModule ComUcte, 388
ComAddon, 281 SetBoundaries
SetAdaptX ComGridtocim, 331
SetDesktop, 410 SetCluster, 393
SetVipage, 436 CalcCluster, 393
VisPath, 606 GetNumberOfClusters, 393
SetAdaptY SetColouring
VisPath, 606 SetColscheme, 395
SetAdditionalResultsFlagForCommand SetColscheme, 394
ComTasks, 383 GetAlarmColouringMode, 394
SetAsDefault GetColouringMode, 394
ElmRes, 150 GetEnergisingColouringMode, 394
SetAssociationValue SetColouring, 395
CimModel, 447 SetFilter, 399
CimObject, 455 SetColumnLabel
SetAttribute IntMat, 513
General Object Methods, 87 SetConstraint
SetAttributeEnumeration IntAddonvars, 469
CimModel, 448 SetCurve

644
INDEX INDEX

RelChar, 587 ComPython, 354

RelToc, 588 SetFileName
SetDatabase, 401 ComSvgexport, 376
EmptyCache, 401 ComSvgimport, 376
SetDataext, 401 SetFilt, 414
AddConfiguration, 401 Get, 414
GetConfiguration, 402 SetFilter
GetConfigurations, 402 SetColscheme, 399
RemoveAllConfigurations, 402 SetFinalEchoOnEnabled
RemoveConfiguration, 403 Environment Functions, 51
SetDefaultValue SetFont
IntReport, 545 PltAxis, 570
SetDeskpage, 403 PltLegend, 576
Close, 403 PltTitle, 584
Show, 403 SetFontFor
SetDesktop, 404 IntGrfnet, 504
AddPage, 404 SetPrj, 421
BeginTabGroup, 405 SetGeoCoordinateSystem
Close, 405 IntPrj, 528
CloseAllTemporaryTabs, 405 SetGraphicUpdate
DoAutoScaleX, 406 Environment Functions, 51
EndTabGroup, 406 SetGridSelection
Freeze, 406 ComUcteexp, 392
GetActivePage, 406 SetGridsToExport
GetCanvasSize, 406 ComGridtocim, 332
GetPage, 407 SetGuiUpdateEnabled
GetSplitOrientation, 407 Environment Functions, 52
GetTabGroups, 408 SetIgnoreFlagForCommand
IsFrozen, 408 ComTasks, 383
IsOpened, 408 SetIgnoreFlagForStudyCase
OpenScriptInTab, 408 ComTasks, 384
OpenTextFileInTab, 409 SetImpedance
RemovePage, 409 ElmRelay, 134
SetAdaptX, 410 SetInputParameterDouble
SetAutoScaleX, 410 ComDpl, 325
SetResults, 410 ComPython, 355
SetScaleX, 411 SetInputParameterInt
SetSplitOrientation, 411 ComDpl, 325
SetViewArea, 411 ComPython, 355
SetXVar, 412 SetInputParameterString
Show, 412 ComDpl, 325
Unfreeze, 412 ComPython, 356
WriteWMF, 413 SetInterfaceVersion
ZoomAll, 413 Application Methods, 42
SetDetailed SetLayerVisibility
ElmLne, 124 IntGrfnet, 505
SetDisplayedButtons SetLayoutMode
SetTboxconfig, 433 GrpPage, 462
SetDistrstate, 413 SetLevelvis, 414
CalcCluster, 413 AdaptWidth, 414
SetElms Align, 414
StoMaint, 599 ChangeFont, 415
SetEnableUserBreak ChangeLayer, 415
Environment Functions, 53 ChangeRefPoints, 415
SetExternalObject ChangeWidthVisibilityAndColour, 415
ComDpl, 324 CreateLayer, 416

645
INDEX INDEX

Mark, 416 SetParameter

Reset, 416 ComReport, 362
SetLimits SetPassword
ComSimoutage, 375 IntUser, 562
SetLoadScaleAbsolute SetPath, 418
ElmZone, 196 AllBreakers, 418
SetLvscale, 417 AllClosedBreakers, 418
AddCalcRelevantCoincidenceDefinitions, 417 AllOpenBreakers, 418
SetMaxI AllProtectionDevices, 419
ElmRelay, 135 Create, 419
SetMaxIearth CreateTimeOvercurrentPlot, 419
ElmRelay, 135 GetAll, 419
SetMeaValue GetBranches, 420
StaExtbrkmea, 202 GetBuses, 420
StaExtcmdmea, 207 GetPathFolder, 420
StaExtdatmea, 212 SetPosition
StaExtfmea, 217 ElmTrain, 183
StaExtfuelmea, 222 SetPrimaryTap
StaExtimea, 228 StaCt, 197
StaExtpfmea, 233 SetPrj, 420
StaExtpmea, 238 GetFontID, 421
StaExtqmea, 244 SetFontFor, 421
StaExttapmea, 254 SetProgressBarUpdatesEnabled
StaExtv3mea, 259 Environment Functions, 52
StaExtvmea, 264 SetRA
SetMinI ElmSubstat, 157
ElmRelay, 135 SetRandomSeed
SetMinIearth Mathematical Functions, 59
ElmRelay, 135 SetRecurrence
SetNumSlave IntPlannedout, 519
SetParalman, 417 SetRescheduleFlag
SetObj Environment Functions, 52
ElmRes, 150 SetResults
SetObject GrpPage, 462
ComSvgexport, 376 SetDesktop, 410
ComSvgimport, 376 SetVipage, 437
SetObjects SetResultsFolder
ComSvgexport, 376 ComTasks, 384
SetObjectsToCompare SetRowLabel
ComMerge, 344 IntMat, 513
SetObjs SetScaleTypeX
ComOutage, 350 GrpPage, 462
SetOldDistributeLoadMode PltLinebarplot, 580
ComLdf, 337 SetScaleTypeY
SetOPCReceiveQuality GrpPage, 463
ComLink, 339 PltLinebarplot, 580
SetOperationValue SetScaleX
IntScenario, 550 GrpPage, 463
SetOutOfService PltLinebarplot, 580
ElmRelay, 135 PltVectorplot, 587
SetOutputWindowState SetDesktop, 411
Output Window Functions, 60 SetVipage, 437
SetParalman, 417 VisPath, 607
GetNumSlave, 417 SetScaleY
SetNumSlave, 417 GrpPage, 463
SetTransfType, 417 PltLinebarplot, 581

646
INDEX INDEX

PltVectorplot, 587 StaExtbrkmea, 204

VisPath, 607 StaExtcmdmea, 209
SetScenario, 422 StaExtdatmea, 214
Check, 422 StaExtfmea, 219
Default, 422 StaExtfuelmea, 224
Print, 422 StaExtimea, 229
SetSelect, 423 StaExtpfmea, 234
AddRef, 423 StaExtpmea, 240
All, 423 StaExtqmea, 245
AllAsm, 423 StaExtsmea, 250
AllBars, 424 StaExttapmea, 255
AllBreakers, 424 StaExtv3mea, 261
AllClosedBreakers, 424 StaExtvmea, 266
AllElm, 424 SetStatusTmp
AllLines, 424 StaExtbrkmea, 204
AllLoads, 424 StaExtcmdmea, 209
AllOpenBreakers, 425 StaExtdatmea, 214
AllSym, 425 StaExtfmea, 219
AllTypLne, 425 StaExtfuelmea, 224
Clear, 425 StaExtimea, 229
GetAll, 425 StaExtpfmea, 235
SetShowAllUsers StaExtpmea, 240
Application Methods, 43 StaExtqmea, 245
SetSplitOrientation StaExtsmea, 250
SetDesktop, 411 StaExttapmea, 255
SetState StaExtv3mea, 261
Output Window Methods, 63 StaExtvmea, 266
SetStatus SetStudyTime
StaExtbrkmea, 203 IntCase, 471
StaExtcmdmea, 208 SetStyle
StaExtdatmea, 213 SetVipage, 438
StaExtfmea, 218 SetSubCurveVisible
StaExtfuelmea, 223 PltOvercurrent, 583
StaExtimea, 228 SetSubElmResKey
StaExtpfmea, 233 ElmRes, 151
StaExtpmea, 239 SetSwitchShcEventMode
StaExtqmea, 244 ComLink, 339
StaExtsmea, 249 SetSymbolComponentVisibility
StaExttapmea, 254 IntGrfnet, 505
StaExtv3mea, 260 SetTabgroup, 426
StaExtvmea, 265 Activate, 426
SetStatusBit Close, 426
StaExtbrkmea, 203 CloseTab, 426
StaExtcmdmea, 208 ExportAllReportDocuments, 427
StaExtdatmea, 213 ExportAllTableReports, 427
StaExtfmea, 218 GetTabCount, 428
StaExtfuelmea, 223 GetTabObject, 428
StaExtimea, 229 GetTabTitle, 428
StaExtpfmea, 234 GetTabType, 429
StaExtpmea, 239 IsClosed, 429
StaExtqmea, 245 IsInMainWindow, 430
StaExtsmea, 249 MoveTab, 430
StaExttapmea, 255 MoveTabs, 430
StaExtv3mea, 260 MoveTabToMainWindow, 430
StaExtvmea, 266 MoveTabToNewFloatingGroup, 431
SetStatusBitTmp MoveToMainWindow, 431

647
INDEX INDEX

MoveToNewFloatingWindow, 431 SetDesktop, 412

SetTboxconfig, 432 SetVipage, 438
Check, 432 Show
GetAvailableButtons, 432 Application Methods, 43
GetDisplayedButtons, 432 GrpPage, 463
Purge, 432 IntGrfnet, 506
SetDisplayedButtons, 433 SetDeskpage, 403
SetThirdPartyModule SetDesktop, 412
BlkDef, 441 SetVipage, 438
ComDpl, 326 ShowBrowser
TypQdsl, 604 ComMerge, 344
SetTile ShowEditDialog
SetVipage, 438 General Object Methods, 89
SetTime, 433 ShowModalBrowser
Date, 433 Dialogue Boxes Functions, 47
GetTimeUTC, 433 ShowModalSelectBrowser
SetTime, 433 Dialogue Boxes Functions, 48
SetTimeUTC, 434 ShowModalSelectTree
Time, 434 General Object Methods, 89
SetTime ShowModelessBrowser
ElmRelay, 136 Dialogue Boxes Functions, 49
SetTime, 433 SimEquivalentVerification
SetTimeUTC ComRed, 357
SetTime, 434 Size
Settings Methods, 393 IntDplmap, 489
SetTransfType IntDplvec, 491
SetParalman, 417 IntVec, 566
SetUser, 434 IntVecobj, 568
GetNumProcesses, 434 SizeX
SetUserBreakEnabled ElmRes, 147
Environment Functions, 53 IntComtrade, 476
SetUserDefined IntComtradeset, 482
VisValue, 610 IntMat, 509
SetValue SizeY
IntReport, 546 ElmRes, 146
SetViewArea IntComtrade, 475
SetDesktop, 411 IntComtradeset, 481
SetVipage, 435 IntMat, 509
Close, 435 slotupd
CreateVI, 436 ElmComp, 106
DoAutoScaleX, 435 ElmRelay, 136
DoAutoScaleY, 435 SlotUpdate
GetOrInsertPlot, 435 ElmComp, 106
InsertPlot, 436 ElmRelay, 136
MigratePage, 436 SnapToGrid
SetAdaptX, 436 IntGrf, 494
SetAutoScaleX, 437 Sort
SetResults, 437 IntDplvec, 491
SetScaleX, 437 IntVec, 566
SetStyle, 438 SortAccordingToColumn
SetTile, 438 ElmRes, 151
SetXVar, 438 IntComtrade, 478
Show, 438 IntComtradeset, 484
SetWriteCacheEnabled SortToColum
Application Methods, 43 IntMat, 513
SetXVar SortToColumn

648
INDEX INDEX

IntMat, 513 IsStatusBitSetTmp, 212

SplitLine ResetStatusBit, 212
Application Methods, 44 ResetStatusBitTmp, 212
StaCt, 197 SetMeaValue, 212
SetPrimaryTap, 197 SetStatus, 213
StaCubic, 197 SetStatusBit, 213
GetAll, 197 SetStatusBitTmp, 214
GetBranch, 198 SetStatusTmp, 214
GetConnectedMajorNodes, 198 UpdateControl, 214
GetConnections, 198 UpdateCtrl, 215
GetNearestBusbars, 199 StaExtfmea, 215
GetPathToNearestBusbar, 199 CopyExtMeaStatusToStatusTmp, 215
IsClosed, 200 GetMeaValue, 216
IsConnected, 200 GetStatus, 216
StaExtbrkmea, 200 GetStatusTmp, 216
CopyExtMeaStatusToStatusTmp, 201 InitTmp, 216
GetMeaValue, 201 IsStatusBitSet, 216
GetStatus, 201 IsStatusBitSetTmp, 217
GetStatusTmp, 201 ResetStatusBit, 217
InitTmp, 201 ResetStatusBitTmp, 217
IsStatusBitSet, 202 SetMeaValue, 217
IsStatusBitSetTmp, 202 SetStatus, 218
ResetStatusBit, 202 SetStatusBit, 218
ResetStatusBitTmp, 202 SetStatusBitTmp, 219
SetMeaValue, 202 SetStatusTmp, 219
SetStatus, 203 UpdateControl, 219
SetStatusBit, 203 UpdateCtrl, 220
SetStatusBitTmp, 204 StaExtfuelmea, 220
SetStatusTmp, 204 CopyExtMeaStatusToStatusTmp, 220
UpdateControl, 204 GetMeaValue, 220
UpdateCtrl, 205 GetStatus, 221
StaExtcmdmea, 205 GetStatusTmp, 221
CopyExtMeaStatusToStatusTmp, 205 InitTmp, 221
GetMeaValue, 206 IsStatusBitSet, 221
GetStatus, 206 IsStatusBitSetTmp, 222
GetStatusTmp, 206 ResetStatusBit, 222
InitTmp, 206 ResetStatusBitTmp, 222
IsStatusBitSet, 206 SetMeaValue, 222
IsStatusBitSetTmp, 207 SetStatus, 223
ResetStatusBit, 207 SetStatusBit, 223
ResetStatusBitTmp, 207 SetStatusBitTmp, 224
SetMeaValue, 207 SetStatusTmp, 224
SetStatus, 208 UpdateControl, 224
SetStatusBit, 208 UpdateCtrl, 225
SetStatusBitTmp, 209 StaExtimea, 225
SetStatusTmp, 209 CopyExtMeaStatusToStatusTmp, 225
UpdateControl, 209 GetMeaValue, 225
UpdateCtrl, 210 GetStatus, 226
StaExtdatmea, 210 GetStatusTmp, 226
CopyExtMeaStatusToStatusTmp, 210 InitTmp, 226
CreateEvent, 210 IsStatusBitSet, 227
GetMeaValue, 211 IsStatusBitSetTmp, 227
GetStatus, 211 ResetStatusBit, 227
GetStatusTmp, 211 ResetStatusBitTmp, 227
InitTmp, 211 SetMeaValue, 228
IsStatusBitSet, 212 SetStatus, 228

649
INDEX INDEX

SetStatusBit, 229 StaExtsmea, 247

SetStatusBitTmp, 229 CopyExtMeaStatusToStatusTmp, 247
SetStatusTmp, 229 GetStatus, 247
UpdateControl, 230 GetStatusTmp, 247
UpdateCtrl, 230 InitTmp, 247
StaExtpfmea, 231 IsStatusBitSet, 248
CopyExtMeaStatusToStatusTmp, 231 IsStatusBitSetTmp, 248
GetMeaValue, 231 ResetStatusBit, 248
GetStatus, 231 ResetStatusBitTmp, 248
GetStatusTmp, 232 SetStatus, 249
InitTmp, 232 SetStatusBit, 249
IsStatusBitSet, 232 SetStatusBitTmp, 250
IsStatusBitSetTmp, 232 SetStatusTmp, 250
ResetStatusBit, 233 UpdateControl, 250
ResetStatusBitTmp, 233 UpdateCtrl, 251
SetMeaValue, 233 StaExttapmea, 251
SetStatus, 233 CopyExtMeaStatusToStatusTmp, 251
SetStatusBit, 234 GetMeaValue, 251
SetStatusBitTmp, 234 GetStatus, 252
SetStatusTmp, 235 GetStatusTmp, 252
UpdateControl, 235 InitTmp, 252
UpdateCtrl, 235 IsStatusBitSet, 253
StaExtpmea, 236 IsStatusBitSetTmp, 253
CopyExtMeaStatusToStatusTmp, 236 ResetStatusBit, 253
GetMeaValue, 236 ResetStatusBitTmp, 253
GetStatus, 237 SetMeaValue, 254
GetStatusTmp, 237 SetStatus, 254
InitTmp, 237 SetStatusBit, 255
IsStatusBitSet, 237 SetStatusBitTmp, 255
IsStatusBitSetTmp, 237 SetStatusTmp, 255
ResetStatusBit, 238 UpdateControl, 256
ResetStatusBitTmp, 238 UpdateCtrl, 256
SetMeaValue, 238 StaExtv3mea, 257
SetStatus, 239 CopyExtMeaStatusToStatusTmp, 257
SetStatusBit, 239 GetMeaValue, 257
SetStatusBitTmp, 240 GetStatus, 258
SetStatusTmp, 240 GetStatusTmp, 258
UpdateControl, 240 InitTmp, 258
UpdateCtrl, 241 IsStatusBitSet, 258
StaExtqmea, 241 IsStatusBitSetTmp, 258
CopyExtMeaStatusToStatusTmp, 241 ResetStatusBit, 259
GetMeaValue, 241 ResetStatusBitTmp, 259
GetStatus, 242 SetMeaValue, 259
GetStatusTmp, 242 SetStatus, 260
InitTmp, 242 SetStatusBit, 260
IsStatusBitSet, 243 SetStatusBitTmp, 261
IsStatusBitSetTmp, 243 SetStatusTmp, 261
ResetStatusBit, 243 UpdateControl, 261
ResetStatusBitTmp, 243 UpdateCtrl, 261
SetMeaValue, 244 StaExtvmea, 262
SetStatus, 244 CopyExtMeaStatusToStatusTmp, 262
SetStatusBit, 245 GetMeaValue, 262
SetStatusBitTmp, 245 GetStatus, 263
SetStatusTmp, 245 GetStatusTmp, 263
UpdateControl, 246 InitTmp, 263
UpdateCtrl, 246 IsStatusBitSet, 263

650
INDEX INDEX

IsStatusBitSetTmp, 264 ComCoordreport, 315

ResetStatusBit, 264 TopologyForShortCircuitVariable
ResetStatusBitTmp, 264 ComCoordreport, 316
SetMeaValue, 264 TopologyForZoneVariable
SetStatus, 265 ComCoordreport, 316
SetStatusBit, 266 TotalLossCost
SetStatusBitTmp, 266 ComCapo, 285
SetStatusTmp, 266 TransferDirectionalBackupResultsTo
UpdateControl, 267 ComCoordreport, 317
UpdateCtrl, 267 TransferNonDirectionalBackupResultsTo
StartTrace ComCoordreport, 317
ComContingency, 302 TransferOverreachResultsTo
ComOutage, 351 ComCoordreport, 318
StaSwitch, 267 TransferResultsTo
Close, 268 ComCoordreport, 318
IsClosed, 268 TransferZoneResultsTo
IsOpen, 268 ComCoordreport, 319
Open, 268 TransformGeoCoordinates
StatFileGetXrange IntPrj, 529
Application Methods, 44 TransformToGeographicCoordinateSystem
StatFileResetXrange IntPrj, 529
Application Methods, 45 TypAsmo, 600
StatFileSetXrange CalcElParams, 600
Application Methods, 45 TypCtcore, 601
Station Elements Methods, 197 AddRatio, 601
StoMaint, 599 RemoveRatio, 601
SetElms, 599 RemoveRatioByIndex, 601
StopTrace TypLne, 602
ComContingency, 303 IsCable, 602
ComOutage, 351 TypMdl, 602
SubscribeProjectReadOnly Check, 602
IntPrj, 529 Compile, 602
SubscribeProjectReadWrite Pack, 603
IntPrj, 529 TypQdsl, 603
SwitchOff Encrypt, 603
General Object Methods, 90 IsEncrypted, 604
SwitchOn ResetThirdPartyModule, 604
General Object Methods, 91 SetThirdPartyModule, 604
TypTr2, 605
TerminateSession GetZeroSequenceHVLVT, 605
IntUser, 562
Time Unfreeze
SetTime, 434 SetDesktop, 412
TopologyForDirectionalBackupVariable UnsubscribeProject
ComCoordreport, 313 IntPrj, 530
TopologyForFuseVariable Update
ComCoordreport, 313 ChaVecfile, 442
TopologyForInstantaneousVariable ComSimoutage, 375
ComCoordreport, 313 ElmBmu, 102
TopologyForMaxCurrent ElmBoundary, 104
ComCoordreport, 314 ElmBranch, 105
TopologyForNonDirectionalBackupVariable ElmCabsys, 105
ComCoordreport, 314 ElmTow, 170
TopologyForOverloadVariable IntDplmap, 489
ComCoordreport, 315 IntSscheduler, 555
TopologyForOverreachVariable UpdateAnnotationElement

651
INDEX INDEX

IntGrflayer, 502 SetAdaptY, 606

UpdateControl SetScaleX, 607
StaExtbrkmea, 204 SetScaleY, 607
StaExtcmdmea, 209 VisPcompdiffplt, 607
StaExtdatmea, 214 AddRelay, 607
StaExtfmea, 219 AddRelays, 608
StaExtfuelmea, 224 CentreOrigin, 608
StaExtimea, 230 Clear, 608
StaExtpfmea, 235 DoAutoScaleX, 608
StaExtpmea, 240 DoAutoScaleY, 608
StaExtqmea, 246 VisPlottz, 609
StaExtsmea, 250 AddRelay, 609
StaExttapmea, 256 AddRelays, 609
StaExtv3mea, 261 Clear, 609
StaExtvmea, 267 DoAutoScaleX, 610
UpdateCtrl DoAutoScaleY, 610
StaExtbrkmea, 205 VisValue, 610
StaExtcmdmea, 210 SetUserDefined, 610
StaExtdatmea, 215
StaExtfmea, 220 WereModificationsFound
StaExtfuelmea, 225 ComMerge, 345
StaExtimea, 230 Write
StaExtpfmea, 235 ElmRes, 151
StaExtpmea, 241 WriteChangesToDb
StaExtqmea, 246 Application Methods, 45
StaExtsmea, 251 General Object Methods, 91
StaExttapmea, 256 WriteDraw
StaExtv3mea, 261 ElmRes, 152
StaExtvmea, 267 WriteValue
UpdateFromCurrentView IntSstage, 558
IntViewbookmark, 570 WriteWMF
UpdateGroups SetDesktop, 413
IntUserman, 564
UpdateStatistics ZeroDerivative
IntPrj, 530 ComInc, 335
UpdateSubstationTerminals ZoomAll
ElmTerm, 170 SetDesktop, 413
UpdateTableReports
Dialogue Boxes Functions, 49
UpdateTablesByCalcPeriod
ComTececo, 385
UpdateToDefaultStructure
IntPrj, 530
UpdateToMostRecentBaseVersion
IntPrj, 531

ValidateConstraints
ComRel3, 359
View
IntDocument, 486
IntUrl, 561
VisPath, 605
Clear, 606
DoAutoScaleX, 606
DoAutoScaleY, 606
SetAdaptX, 606

652