PowerFactory 2024

Python Function Reference

F2024

POWER SYSTEM SOLUTIONS

MADE IN GERMANY
 Publisher:
DIgSILENT GmbH
Heinrich-Hertz-Straße 9
72810 Gomaringen / Germany
Tel.: +49 (0) 7072-9168-0
Fax: +49 (0) 7072-9168-88
info@[Link]

Please visit our homepage at:

[Link]

Copyright © 2024 DIgSILENT GmbH

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

January 15, 2024

r108412
CONTENTS CONTENTS

Contents

1 General Description 1

2 PowerFactory Module 2

3 Application Methods 4
3.1 File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
3.2 Date/Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.3 Dialogue Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.4 Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.5 Mathematics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
3.6 Output Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

4 Output Window 53

5 Object Methods 55
5.1 General Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
5.2 Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5.2.1 ElmArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5.2.2 ElmAsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
5.2.3 ElmAsmsc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
5.2.4 ElmBbone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
5.2.5 ElmBmu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
5.2.6 ElmBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
5.2.7 ElmBranch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
5.2.8 ElmCabsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
5.2.9 ElmComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
5.2.10 ElmCoup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
5.2.11 ElmDsl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
5.2.12 ElmFeeder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
5.2.13 ElmFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
5.2.14 ElmFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
5.2.15 ElmGenstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

2
CONTENTS CONTENTS

5.2.16 ElmGndswt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

5.2.17 ElmLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
5.2.18 ElmLnesec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
5.2.19 ElmMdl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
5.2.20 ElmNec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5.2.21 ElmNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5.2.22 ElmPvsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
5.2.23 ElmRelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
5.2.24 ElmRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
5.2.25 ElmShnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
5.2.26 ElmStactrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
5.2.27 ElmSubstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
5.2.28 ElmSvs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
5.2.29 ElmSym . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
5.2.30 ElmTerm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
5.2.31 ElmTow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
5.2.32 ElmTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
5.2.33 ElmTr3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
5.2.34 ElmTr4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
5.2.35 ElmTrain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
5.2.36 ElmTrb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
5.2.37 ElmTrfstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
5.2.38 ElmTrmult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
5.2.39 ElmVac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
5.2.40 ElmVoltreg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
5.2.41 ElmXnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
5.2.42 ElmZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
5.3 Station Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
5.3.1 StaCt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
5.3.2 StaCubic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
5.3.3 StaExtbrkmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
5.3.4 StaExtcmdmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
5.3.5 StaExtdatmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
5.3.6 StaExtfmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
5.3.7 StaExtfuelmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.3.8 StaExtimea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
5.3.9 StaExtpfmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
5.3.10 StaExtpmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
5.3.11 StaExtqmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
5.3.12 StaExtsmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

3
CONTENTS CONTENTS

5.3.13 StaExttapmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

5.3.14 StaExtv3mea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
5.3.15 StaExtvmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
5.3.16 StaSwitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
5.4 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
5.4.1 ComAddlabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
5.4.2 ComAddon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
5.4.3 ComAmpacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
5.4.4 ComArcreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
5.4.5 ComAuditlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
5.4.6 ComBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
5.4.7 ComCapo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
5.4.8 ComCimdbexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.4.9 ComCimdbimp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.4.10 ComCimvalidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
5.4.11 ComConreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
5.4.12 ComContingency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
5.4.13 ComCoordreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5.4.14 ComCosim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
5.4.15 ComDllmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
5.4.16 ComDpl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
5.4.17 ComFlickermeter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
5.4.18 ComGenrelinc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
5.4.19 ComGridtocim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
5.4.20 ComHostcap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
5.4.21 ComImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
5.4.22 ComInc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
5.4.23 ComLdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
5.4.24 ComLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
5.4.25 ComMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
5.4.26 ComMot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
5.4.27 ComNmink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
5.4.28 ComOmr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
5.4.29 ComOpc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
5.4.30 ComOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
5.4.31 ComPfdimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
5.4.32 ComPrjconnector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
5.4.33 ComProtgraphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
5.4.34 ComPvcurves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
5.4.35 ComPython . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

4
CONTENTS CONTENTS

5.4.36 ComRed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

5.4.37 ComRel3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
5.4.38 ComRelpost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
5.4.39 ComRelreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
5.4.40 ComReltabreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
5.4.41 ComReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
5.4.42 ComRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
5.4.43 ComShc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
5.4.44 ComShctrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
5.4.45 ComSim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
5.4.46 ComSimoutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.4.47 ComSvgexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
5.4.48 ComSvgimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
5.4.49 ComTablereport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
5.4.50 ComTasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
5.4.51 ComTececo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
5.4.52 ComTececocmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
5.4.53 ComTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
5.4.54 ComUcte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
5.4.55 ComUcteexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
5.4.56 ComWktimp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
5.4.57 ComWr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
5.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
5.5.1 SetCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
5.5.2 SetColscheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
5.5.3 SetDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
5.5.4 SetDataext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
5.5.5 SetDeskpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
5.5.6 SetDesktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
5.5.7 SetDistrstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
5.5.8 SetFilt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
5.5.9 SetLevelvis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
5.5.10 SetLvscale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
5.5.11 SetParalman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
5.5.12 SetPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
5.5.13 SetPrj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
5.5.14 SetScenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
5.5.15 SetSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
5.5.16 SetTabgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
5.5.17 SetTboxconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

5
CONTENTS CONTENTS

5.5.18 SetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

5.5.19 SetUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
5.5.20 SetVipage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
5.6 Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
5.6.1 BlkDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
5.6.2 BlkSig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
5.6.3 ChaVecfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
5.6.4 CimArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
5.6.5 CimModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
5.6.6 CimObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
5.6.7 GrpPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
5.6.8 IntAddonvars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
5.6.9 IntCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
5.6.10 IntComtrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
5.6.11 IntComtradeset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
5.6.12 IntDataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
5.6.13 IntDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
5.6.14 IntDplmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
5.6.15 IntDplvec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
5.6.16 IntEvt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
5.6.17 IntExtaccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
5.6.18 IntGate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
5.6.19 IntGrf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
5.6.20 IntGrfgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
5.6.21 IntGrflayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
5.6.22 IntGrfnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
5.6.23 IntIcon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
5.6.24 IntLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
5.6.25 IntMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
5.6.26 IntMon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
5.6.27 IntNndata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
5.6.28 IntNnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
5.6.29 IntOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
5.6.30 IntPlannedout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
5.6.31 IntPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
5.6.32 IntPrj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
5.6.33 IntPrjfolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
5.6.34 IntQlim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
5.6.35 IntRas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
5.6.36 IntReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

6
CONTENTS CONTENTS

5.6.37 IntRunarrange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526

5.6.38 IntScenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
5.6.39 IntScensched . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
5.6.40 IntScheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
5.6.41 IntSscheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
5.6.42 IntSstage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
5.6.43 IntSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
5.6.44 IntSym . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
5.6.45 IntThrating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
5.6.46 IntUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
5.6.47 IntUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
5.6.48 IntUserman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
5.6.49 IntVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
5.6.50 IntVecobj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
5.6.51 IntVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
5.6.52 IntViewbookmark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
5.6.53 PltAxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
5.6.54 PltBiasdiff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
5.6.55 PltComplexdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
5.6.56 PltDataseries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
5.6.57 PltLegend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
5.6.58 PltLinebarplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
5.6.59 PltOvercurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
5.6.60 PltTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
5.6.61 PltVectorplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
5.6.62 RelChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
5.6.63 RelToc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
5.6.64 RelZpol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
5.6.65 ScnFreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
5.6.66 ScnFrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
5.6.67 ScnSpeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
5.6.68 ScnSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
5.6.69 ScnVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
5.6.70 ScnVolt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
5.6.71 StoMaint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
5.6.72 TypAsmo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
5.6.73 TypCtcore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
5.6.74 TypLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
5.6.75 TypMdl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
5.6.76 TypQdsl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579

7
CONTENTS CONTENTS

5.6.77 TypTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581

5.6.78 VisBdia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
5.6.79 VisDraw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
5.6.80 VisHrm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
5.6.81 VisMagndiffplt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
5.6.82 VisOcplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
5.6.83 VisPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
5.6.84 VisPcompdiffplt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
5.6.85 VisPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
5.6.86 VisPlot2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
5.6.87 VisPlottz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
5.6.88 VisVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
5.6.89 VisVecres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
5.6.90 VisXyplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608

Index 610

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
Creates a [Link] 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 [Link]([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 [Link]() but throwing an exception with an error code when
PowerFactory was not able to start. Furthermore if PowerFactory exits due to an error, power-
[Link] 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 [Link]([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;
[Link](r"C:\Program Files\DIgSILENT\PowerFactory 2017\python\3.6")

import powerfactory

try:
app = [Link]()
# ... some calculations ...
except [Link] as error:
print(error)
print('[Link] = %d' % [Link])

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
GetBorderCubicles
GetBrowserSelection
GetCalcRelevantObjects
GetClassDescription
GetClassId
GetCurrentDiagram
GetCurrentScript
GetCurrentSelection
GetCurrentUser
GetCurrentZoomScaleLevel
GetDataFolder
GetDesktop
GetDiagramSelection
GetFlowOrientation
GetFromStudyCase
GetGlobalLibrary
GetInterfaceVersion
GetLanguage
GetLocalLibrary
GetMem
GetProjectFolder

4
 CHAPTER 3. APPLICATION METHODS

GetRecordingStage
GetSettings
GetSummaryGrid
GetTouchedObjects
GetTouchingExpansionStages
GetTouchingStageObjects
GetTouchingVariations
GetUserManager
GetUserSettings
Hide
ImportDz
ImportSnapshot
IsAttributeModeInternal
IsLdfValid
IsNAN
IsRmsValid
IsScenarioAttribute
IsShcValid
IsSimValid
IsWriteCacheEnabled
LicenceHasModule
LoadProfile
MarkInGraphics
OutputFlexibleData
PostCommand
PrepForUntouchedDelete
Rebuild
ReloadProfile
ResetCalculation
ResGetData
ResGetDescription
ResGetFirstValidObject
ResGetFirstValidObjectVariable
ResGetFirstValidVariable
ResGetIndex
ResGetMax
ResGetMin
ResGetNextValidObject
ResGetNextValidObjectVariable
ResGetNextValidVariable
ResGetObject
ResGetUnit
ResGetValueCount
ResGetVariable
ResGetVariableCount
ResLoadData
ResReleaseData
ResSortToVariable
SaveAsScenario
SearchObjectByForeignKey
SearchObjectsByCimId
SelectToolbox
SetAttributeModeInternal
SetInterfaceVersion
SetShowAllUsers
SetWriteCacheEnabled

5
 CHAPTER 3. APPLICATION METHODS

Show
SplitLine
StatFileGetXrange
StatFileResetXrange
StatFileSetXrange
WriteChangesToDb

ActivateProject
Activates a project with its name.
int [Link](str name)

A RGUMENTS
name Name (”Project”), full qualified name (”[Link]”) or full qualified path (”\User\[Link]”)
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 [Link]()

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 [Link]()

ConvertGeometryStringToMDL
Conversion of string geometry used in PowerFactory versions ¡ 23.
str [Link](str orgString,
DataObject intGrfOrLayer)

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

R ETURNS
The converted MDL-string.

6
 CHAPTER 3. APPLICATION METHODS

CreateFaultCase
Create fault cases from the given elements.
int [Link](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 [Link](str projectName,
str gridName,
[DataObject parent = None])
DataObject [Link](str projectName,
[DataObject parent = None])

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.

7
 CHAPTER 3. APPLICATION METHODS

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] [Link](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 [Link]()
and [Link]().
None [Link](str classname,
str attributes
)

A RGUMENTS
classname
Name of a class.
attributes Comma separated names of attributes.

S EE ALSO

[Link](), [Link]()

DeleteUntouchedObjects
Delete all objects stored in the grid (or stored in set) which are not modified. Requires call
of PrepForUntouchedDelete() first, see [Link](). Hint: function
should only be used when a variation is active. For details please contact support.
int [Link](DataObject grid)
int [Link](list grids)

8
 CHAPTER 3. APPLICATION METHODS

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 [Link](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 [Link](str command)

A RGUMENTS
command
The command string

GetActiveCalculationStr
Gets “calculation string” of currently valid calculation.
str [Link]()

R ETURNS
None basic
Load Flow ldf
AC Load Flow Sensitivities acsens
AC Contingency Analysis accont
DC Load Flow dcldf
DC Load Flow Sensitivities dcsens
DC Contingency Analysis dccont
VDE/IEC Short-Circuit shc

9
 CHAPTER 3. APPLICATION METHODS

Complete Short-Circuit shcfull

ANSI Short-Circuit shcansi
IEC 61363 shc61363
RMS-Simulation rms
Modal Analysis modal
EMT-Simulation emt
Harmonics/Power Quality harm
Frequency Sweep fsweep
Optimal Power Flow opf
DC Optimal Power Flow dcopf
DC OPF with Contingencies dccontopf
State Estimation est
Reliability rel
General Adequacy genrel
Tie Open Point Opt. topo
Motor Starting Calculation motstart
Arc Flash Calculation arcflash
Optimal Capacitor Placement optcapo
Voltage Plan Optimization mvplan
Backbone Calculation backbone
Optimal RCS Placement optrcs

GetActiveNetworkVariations
Returns all active variations for the 'Network Data' folder.
list [Link]()

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 [Link]()

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 [Link]()

10
 CHAPTER 3. APPLICATION METHODS

R ETURNS
Returns currently active IntScenario object or None in case of no scenario being currently
active.

GetActiveScenarioScheduler
Returns currently active scenario scheduler.
DataObject [Link]()

R ETURNS
Returns currently active IntScensched object or None in case of no scheduler being currently
active.

GetActiveStages
Returns all active stages currently active for a given folder, e.g. 'Network Data' folder.
list [Link]([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 [Link]()

R ETURNS
The active study case (IntCase object) or None.

R ETURNS
Returns currently active IntCase object or None in case of no study case being currently
active.

GetAllUsers
Returns all known users, regardless of any Data Manager filters.

A RGUMENTS
forceReload
0 Default, returns the cached state if function was called before.
1 Forces the cache to be cleared, may impact performance.

11
 CHAPTER 3. APPLICATION METHODS

R ETURNS
Returns a container with all known users.

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

A RGUMENTS
classname
Name of a class.

name Name of an attribute.

short 0 Return long attribute description (default).
1 Return short attribute description.

R ETURNS
None For an invalid class or attribute name.
str Long or short attribute description.

S EE ALSO

[Link]()

GetAttributeUnit
Returns the unit of an attribute e.g. km, MW. . . .
str [Link](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

[Link]()

12
 CHAPTER 3. APPLICATION METHODS

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 [Link](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
[Link]() this is independently of how the script is executed.
list [Link]()

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

S EE ALSO

[Link](), [Link]()

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 [Link]() it does not return objects of the active study case
e.g. simulation events (Evt*).
list [Link]([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’

13
 CHAPTER 3. APPLICATION METHODS

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

[Link]()

GetClassDescription
Returns a description for a PowerFactory class.
str [Link](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 [Link](str className)

A RGUMENTS
className
Class name e.g. ”ElmTerm”.

0 Class name invalid.

>0 Class id of valid class name.

14
 CHAPTER 3. APPLICATION METHODS

GetCurrentDiagram
This function offers access to the current diagram object (IntGrfnet).
DataObject [Link]()

GetCurrentScript
Returns the current script (ComPython).
DataObject [Link]()

R ETURNS
The current script (ComPython) or None if started from external.

GetCurrentSelection
Returns all objects marked in the “on top” Data Manager (Browser, right side) or diagram 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 [Link]()

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

S EE ALSO

[Link](), [Link]()

GetCurrentUser
Returns the PowerFactory user of current session.
DataObject [Link]()

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 [Link]()

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.

15
 CHAPTER 3. APPLICATION METHODS

GetDataFolder
This function returns the folder in which the network data for the given class are stored.
DataObject [Link](str classname,
[int iCreate = 0])

A RGUMENTS
classname
Classname of the elements:
ElmBmu
ElmArea
ElmZone
ElmRoute
ElmOwner
ElmOperator
ElmFeeder
ElmCircuit
ElmBoundary
IntScales
iCreate(optional)
0 The folder is searched and returned if found. If the folder does not
exist, None is returned (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

[Link]()

GetDesktop
Returns the currently active Desktop.
DataObject [Link]()

R ETURNS
The desktop object

GetDiagramSelection
Returns all objects marked in the “on top” diagram. In comparison to [Link]()
this is independently of how the script is executed.
list [Link]()

R ETURNS
Objects marked in the “on top” diagram.

16
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

[Link](), [Link]()

GetFlowOrientation
This function returns the flow orientation setting of the active project.
int [Link]()

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 [Link](str className)

A RGUMENTS
className
Class name of the object (“Class”), optionally preceded by an object name without
wildcards and a dot (“[Link]”).

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 [Link]([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

[Link]()

17
 CHAPTER 3. APPLICATION METHODS

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 [Link]()

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 [Link]()

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 [Link]([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

[Link]()

18
 CHAPTER 3. APPLICATION METHODS

GetMem
Allows to trace memory consumption (current working set size).
int [Link]([int calculateDelta=0],
[int inMegaByte=0]
)

A RGUMENTS
calculateDelta (optional)
Measure absolute memory consumption if 0, measure the delta since the last time
it was called if 1 (default: 0).
inMegaByte (optional)
Returns consumption in byte if 0, in megabyte if 1 (default: 0).

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

GetProjectFolder
Returns the project folder of a given type of active project. For each type (except ‘Generic’)
there exist not more than one folder per type.
DataObject [Link](str type, [int create = 0])

A RGUMENTS
type Type of the corresponding project folder. See [Link]()
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 [Link]()

R ETURNS
An IntSstage object; None if there is no recording stage.

GetSettings
Offers read-only access to some selected PowerFactory settings.
str [Link](str key)

19
 CHAPTER 3. APPLICATION METHODS

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 [Link]()

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 [Link](object varOrStage)
list [Link](list varsAndStages)

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

R ETURNS
Matching root objects.

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

20
 CHAPTER 3. APPLICATION METHODS

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 [Link](object rootObject)
list [Link](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 [Link](object rootObject)
list [Link](list rootObjects)

A RGUMENTS
rootObject
Root objects.
rootObjects
Root objects.

R ETURNS
Matching variations.

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

21
 CHAPTER 3. APPLICATION METHODS

R ETURNS
The user manager object

GetUserSettings
Convient routine to get the settings object (SetUser) of a user.
object [Link]([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 [Link]()

S EE ALSO

[Link]()

ImportDz
Imports a DZ file. Overwrites data if it already exists.
[int errorCode,
list importedObjects] [Link](DataObject target,
str dzFilePath)

A RGUMENTS
target Target object for imported data.

dzFilePath
Path to the DZ file that should be imported.
importedObjects (out)
Collection of top-level objects imported.

R ETURNS
0 Success
-1 Wrong file extension
nonzero Import failed

22
 CHAPTER 3. APPLICATION METHODS

ImportSnapshot
Imports a Snapshot DZS file.
[int errorCode,
list importedObjects ] [Link](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 [Link]()

R ETURNS
0 Attribute values accessed as displayed in PowerFactory (unit conversion ap-
plied).
1 Attribute values accessed as internally stored.

S EE ALSO

[Link]()

IsLdfValid
Checks to see if the last load-flow results are still valid and available.
int [Link]()

R ETURNS
0 if no load-flow results are available

IsNAN
Checks whether a double value is NAN (not a number).
int [Link](float value)

A RGUMENTS
value Double value to check.

23
 CHAPTER 3. APPLICATION METHODS

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 [Link]()

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 [Link](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 [Link]()

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 [Link]()

R ETURNS
0 if no simulation results are available

24
 CHAPTER 3. APPLICATION METHODS

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

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

S EE ALSO

[Link](), [Link]()

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
• motstart - Motor Starting Functions
• muld - Multi-User Database
• netred - Network Reduction

25
 CHAPTER 3. APPLICATION METHODS

• 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 - Reliability Analysis Functions

• 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 [Link](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 [Link](str profileName)

A RGUMENTS
profileName
Name of profile to be loaded.

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

26
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

[Link]()

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 [Link](list objects,
[int searchOpenedDiagramsOnly = 0])

A RGUMENTS
objects Objects to be marked.
searchOpenedDiagramsOnly (optional)
Search can be restricted to currently shown diagrams on the desktop, instead of
all diagrams.
0 Searching all diagrams, not only the ones which are currently shown
on the desktop. If there is more than one occurrence the user will be
prompted which diagrams shall be opened (default).
1 Only search in currently opened diagrams and open the first diagram
in which the elements were found.

OutputFlexibleData
Outputs the Flexible Data of the given objects to the output window.
Has identical functionality to that implemented in the Object Filter dialogue, whereby the user
can right-click on a single row or multiple rows in a Flexible Data page and select Output
. . . Flexible Data. The OutputFlexibleData() function assumes that the user has already defined
a Flexible Data page for the objects in the set. Upon execution of this function, all Flexible
Data defined for the objects in the set is output to the PowerFactory output window in a tabular
format.
None [Link](list objects,
[str flexibleDataPage = ''])

A RGUMENTS
objects Objects to output the Flexible Data for.
flexibleDataPage (optional)
Name of the Flexible Data page to be outputed. If multiple Flexible Data pages
are defined and no or an empty string is given then a dialog to select a Flexible
Data page is shown.

PostCommand
Adds a command 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 [Link](str commandString)
None [Link](DataObject command)

27
 CHAPTER 3. APPLICATION METHODS

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
[Link]().
None [Link](DataObject grid)
None [Link](list grids)

Rebuild
Rebuilds the currently visible single line diagram or plot.
None [Link]([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 [Link]()

S EE ALSO

[Link]()

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 [Link]()

28
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

[Link](), [Link]()

ResGetData
This function is deprecated. Please use [Link]() or [Link]() in-
stead.
[int error,
float d ] [Link](DataObject resultObject,
int iX,
[int col])

ResGetDescription
This function is deprecated. Please use [Link]() or
[Link]() instead.
str [Link](DataObject resultObject,
int col,
[int ishort])

ResGetFirstValidObject
This function is deprecated. Please use [Link]() instead.
int [Link](DataObject resultFile,
int row,
[str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[float limit2,]
[int limitOperator2])
int [Link]([DataObject resultFile,]
[int row,]
[list objects])

ResGetFirstValidObjectVariable
This function is deprecated. Please use [Link]() instead.
int [Link](DataObject resultFile,
[str variableNames])

ResGetFirstValidVariable
This function is deprecated. Please use [Link]() instead.
int [Link](DataObject resultFile,
int row,
[str variableNames])

29
 CHAPTER 3. APPLICATION METHODS

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

ResGetMax
This function is deprecated. Please use [Link]() or
[Link]() instead.
[int row,
float value] [Link](DataObject resultFile,
int col)

ResGetMin
This function is deprecated. Please use [Link]() or
[Link]() instead.
[int row,
float value] [Link](DataObject resultFile,
int col)

ResGetNextValidObject
This function is deprecated. Please use [Link]() instead.
int [Link](DataObject resultFile,
[str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[float limit2,]
[int limitOperator2])
int [Link](DataObject resultFile,
list objects)

ResGetNextValidObjectVariable
This function is deprecated. Please use [Link]() instead.
int [Link](DataObject resultFile,
[str variableNames])

30
 CHAPTER 3. APPLICATION METHODS

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

ResGetObject
This function is deprecated. Please use [Link]() instead.
DataObject [Link](DataObject resultObject,
int col)

ResGetUnit
This function is deprecated. Please use [Link]() or [Link]() instead.
str [Link](DataObject resultObject,
int col)

ResGetValueCount
This function is deprecated. Please use [Link]() or
[Link]() instead.
int [Link](DataObject resultObject,
[int col])

ResGetVariable
This function is deprecated. Please use [Link]() or [Link]()
instead.
str [Link](DataObject resultObject,
int col)

ResGetVariableCount
This function is deprecated. Please use [Link]() or
[Link]() instead.
int [Link](DataObject resultObject)

ResLoadData
This function is deprecated. Please use [Link]() or [Link]() instead.
None [Link](DataObject resultObject)

31
 CHAPTER 3. APPLICATION METHODS

ResReleaseData
This function is deprecated. Please use [Link]() or [Link]() instead.
None [Link](DataObject resultObject)

ResSortToVariable
This function is deprecated. Please use [Link]() or
[Link]() instead.
int [Link](DataObject resultObject,
int col)

SaveAsScenario
Saves the operational data or relevant network elements as a new scenario.
DataObject [Link](str pName,
int iSetActive)

A RGUMENTS
pName Name of the new scenario.
iSetActive
1 Activate the new scenario afterwards.
0 Do not activate the new scenario.

R ETURNS
Returns newly created IntScenario object. None is returned in case of creation of a new
scenario was not allowed (e.g. no active project).

SearchObjectByForeignKey
Searches for an object by foreign key within an active project.
DataObject [Link](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 [Link](str cimId)

32
 CHAPTER 3. APPLICATION METHODS

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 = [Link]()

objects = [Link]("_17086487-56ba-4979-b8de-064025a6b4da")
for object in objects:
[Link](object)

SelectToolbox
Sets tool box to be displayed at a switchable tool box group.
int [Link](int toolbar,
str groupName,
str toolboxName)

A RGUMENTS
toolbar 1 Main tool bar
2 Drawing tool bar (SGL)
groupName
Name of tool box group.
toolboxName
Name of tool box to be selected.

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

SetAttributeModeInternal
Changes the way how attribute values are accessed.
None [Link](int internalMode)

A RGUMENTS
internalMode 0 Access attribute values as displayed in PowerFactory (unit con-
version applied).
1 Access attribute values as internally stored.

33
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

[Link]()

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 [Link](int version)

A RGUMENTS
version interface version to be set

R ETURNS
0 if the version is successfully set, otherwise 1.

SetShowAllUsers
Enables or disables the filtering of all available users in data manager. All users are only
visualised in data manager when enabled.
int [Link](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 [Link]() 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
[Link]() 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 [Link](int enabled)

34
 CHAPTER 3. APPLICATION METHODS

A RGUMENTS
enabled 0 Disables the write cache.
1 Enables the write cache.

S EE ALSO

[Link](), [Link]()

Show
Shows the PowerFactory application window (only possible with a full license, not supported
for engine licenses).
None [Link]()

S EE ALSO

[Link]()

SplitLine
Splits the passed line or ElmBranch-object at a given position
DataObject [Link](DataObject Line,
[float percent = 50,]
[int createSwitchSide0 = 0,]
[int createSwitchSide1 = 0,]
[int graphicSplit = 0])

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

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

1 Create switch on first connection side.

int createSwitchSide1 (optional)

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

1 Create switch on second connection side.

int graphicSplit (optional)

0 (default) Do not perform line split graphically.

1 Split line also graphically.

35
 CHAPTER 3. APPLICATION METHODS

R ETURNS
Inserted terminal
0 = error

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

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 [Link]()

StatFileSetXrange
Sets the user defined x-range of the statistic result file. The statistic results consider only the
given time range.
None [Link](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 [Link]() 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 [Link]()

36
3.1. FILE SYSTEM CHAPTER 3. APPLICATION METHODS

S EE ALSO

[Link](), [Link]()

3.1 File System

Overview

GetInstallationDirectory
GetTemporaryDirectory
GetWorkspaceDirectory

GetInstallationDirectory
Returns the installation directory of PowerFactory .
str [Link]()

R ETURNS
Full path to installation directory of current PowerFactory .

D EPRECATED N AMES
GetInstallDir

S EE ALSO

[Link](), [Link]()

GetTemporaryDirectory
Returns the temporary directory of used by PowerFactory .
str [Link]()

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

[Link](), [Link]()

GetWorkspaceDirectory
Returns the workspace directory of PowerFactory .
str [Link]()

R ETURNS
Full path to the directory where currently used workspace is stored.

37
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS

D EPRECATED N AMES
GetWorkingDir

S EE ALSO

[Link](), [Link]()

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 [Link]()

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

Returns all open table reports.

list [Link]()

38
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS

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

Opens a modal browser window and lists all given objects.

None [Link](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 [Link](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.

39
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS

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

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

Opens a modeless browser window and lists all given objects.

None [Link](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 [Link]()

3.4 Environment
Overview

EchoOff
EchoOn
IsAutomaticCalculationResetEnabled
IsFinalEchoOnEnabled
SetAutomaticCalculationResetEnabled
SetFinalEchoOnEnabled
SetGraphicUpdate
SetGuiUpdateEnabled
SetProgressBarUpdatesEnabled
SetUserBreakEnabled

40
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 [Link]().
None [Link]()

S EE ALSO

[Link](), [Link](), [Link]()

EchoOn
Re-activates the user interface. For more informations see [Link]().
None [Link]()

S EE ALSO

[Link](), [Link](), [Link]()

IsAutomaticCalculationResetEnabled
Returns whether the automatic calculation reset while setting attributes is enabled. See Appli-
[Link]() for more informations.
int [Link]()

S EE ALSO

[Link](), [Link]()

IsFinalEchoOnEnabled
Returns whether the automatic [Link]() at the end of each ComDpl or ComPython
is enabled.
int [Link]()

R ETURNS
1 Final [Link]() is enabled.
0 Final [Link]() is disabled.

S EE ALSO

[Link](), [Link](), [Link]()

41
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 [Link]().
None [Link](int enabled)

S EE ALSO

[Link](), [Link]()

SetFinalEchoOnEnabled
Enables or disables the automatic [Link]() at the end of each ComDpl or ComPython.

None [Link](int enabled)

A RGUMENTS
enabled
1 Enables the final [Link]().
0 Disables the final [Link]().

S EE ALSO

[Link](), [Link](), [Link]()

SetGraphicUpdate
Enables or disables the updates of the single line graphics.
None [Link](int enabled)

A RGUMENTS
enabled
0 disabled (graphic will not be updated automatically)
1 enabled

42
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 [Link]().
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 [Link](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

[Link](), [Link]()

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 [Link](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.

43
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

S EE ALSO

[Link](), [Link]()

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 [Link]()).

None [Link](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

44
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

GetRandomNumber
This method is marked as deprecated since PowerFactory 2017. Please use [Link]()
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 [Link]([float x1,]
[float x2])

A RGUMENTS
x1 (optional)
x2 not given: maximum; x1 and x2 given: minimum
x2 (optional)
maximum

R ETURNS
A uniformly distributed random number

GetRandomNumberEx
This method is marked as deprecated since PowerFactory 2017. Please use [Link](),
[Link]() or [Link]() instead.
Draws a random number according to a specific probability distribution. Uses the ’global random
number generator’.
float [Link](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

45
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 [Link](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 [Link]().
float [Link](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.

46
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 [Link]().
str [Link]([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 [Link]().
int [Link]([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 [Link]().
float [Link](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.

47
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 [Link](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.

48
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 [Link]().
int [Link](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 [Link]().
float [Link](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 [Link]().
float [Link](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.

49
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS

R ETURNS
double Random number

SetRandomSeed
This method is marked as deprecated since PowerFactory 2017. Please use [Link]()
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 [Link](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 [Link]()

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

E XAMPLE
import powerfactory
app = [Link]()
[Link]('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.
[Link]()

50
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS

GetOutputWindow
Returns the PowerFactory Output Window.
OutputWindow [Link]()

R ETURNS
An instance of the class OutputWindow.

E XAMPLE
import powerfactory
app = [Link]()
outputWindow = [Link]()
[Link]([Link], "Hello World!")

PrintError
Prints a message as error into the PowerFactory Output Window. See [Link]()
for more informations.
None [Link](str message)

PrintInfo
Prints a message as information into the PowerFactory Output Window. See OutputWin-
[Link]() for more informations.
None [Link](str message)

PrintPlain
Prints a message as normal text into the PowerFactory Output Window. See OutputWin-
[Link]() for more informations.
None [Link](str message)

PrintWarn
Prints a message as warning into the PowerFactory Output Window. See [Link]()
for more informations.
None [Link](str message)

SetOutputWindowState
Changes the display state of the output window.
None [Link](int newState)

51
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS

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

52
 CHAPTER 4. OUTPUT WINDOW

4 Output Window

Overview

Clear
Flush
GetContent
Print
Save
SetState

Clear
Clears the output window.
None [Link]()

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

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

[Link]()

53
 CHAPTER 4. OUTPUT WINDOW

Print
Prints a message as normal text, as information, as warning or as error into the PowerFactory
Output Window.
None [Link](str message)
None [Link](MessageType type, str message)

A RGUMENTS
type Type of message to print:
[Link] Normal text.
[Link] Information.
[Link] Warning.
[Link] Error.
The message is printed as normal text if no message type is given.

message Message to print.

E XAMPLE
import powerfactory
app = [Link]()
outputWindow = [Link]()
[Link]([Link], "Hello World!")

Save
Saves the content of current output window to a file.
None [Link](str filePath)

A RGUMENTS
filePath Full file name with path e.g. d:\data\[Link]. Possible file formats are html, txt
and out.

SetState
Changes the display state of the output window.
None [Link](int newState)

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

54
 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
GetFullName
GetImpedance
GetInom
GetNode
GetOperator
GetOwner
GetParent
GetReferences
GetRegion
GetSupplyingSubstations
GetSupplyingTransformers
GetSupplyingTrfstations
GetSystemGrounding
GetUnom
GetZeroImpedance
HasAttribute
HasReferences
HasResults
IsCalcRelevant

55
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

IsDeleted
IsEarthed
IsEnergized
IsHidden
IsInFeeder
IsNetworkDataFolder
IsNode
IsObjectActive
IsObjectModifiedByVariation
Isolate
IsOutOfService
IsReducible
IsShortCircuited
MarkInGraphics
Move
PasteCopy
PurgeUnusedObjects
ReportUnusedObjects
SearchObject
SetAttribute
SetAttributeLength
SetAttributes
SetAttributeShape
ShowEditDialog
ShowModalSelectTree
SwitchOff
SwitchOn
WriteChangesToDb

AddCopy
Adds a copy of a single object or a set of objects to this object (= target object).
When copying a single object it is possible to give the new name. The new name will be
concatenated by the given name parts. This is not possible for a project (IntPrj).
The target object must be able to receive a copy of the objects.
Copying a set of objects will respect all internal references between those objects. Copying a
set of lines and their types, for example, will result in a set of copied lines and line types, where
the copied lines will use the copied line types.
When source object(s) and target object are inside different projects the method DataOb-
[Link]() has to be used instead, since it adapts all references automatically.
DataObject [Link](DataObject objectToCopy,
[int|str partOfName0,]
[...])
DataObject [Link](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.
objectsToCopy
Set of objects to copy.

56
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns the copy that has been created on success or None, when copying a single object.

S EE ALSO

[Link](), [Link](), [Link]()

CopyData
Copies all parameters except for loc name and containers from one object to another.
None [Link](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 [Link](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 [Link]()

R ETURNS
0 Object successfully deleted.
6= 0 Deletion failed e.g. not allowed.

57
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

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] [Link]([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

[Link](), [Link](), [Link]()

GetAttribute
Returns the value of an attribute.
int|float|str|DataObject|list [Link](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.

S EE ALSO

[Link](), [Link]()

58
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

GetAttributeDescription
Returns the description of an attribute.
str [Link](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

[Link](), [Link]()

GetAttributeLength
Returns the length of a vector or matrix attribute. The length of a matrix attribute is the number
of rows.
int [Link](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

[Link](), [Link](), [Link]()

GetAttributes
Gets the values of the transfer attributes defined via [Link]().
list [Link]()

R ETURNS
List of values for the defined transfer attributes. An exception is thrown for invalid attribute
names.

S EE ALSO

[Link](), [Link]()

59
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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 ] [Link](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

[Link](), [Link](), [Link]()

GetAttributeType
Returns the type of an attribute.
The following attribute types exist:
[Link] Attribute does not exist.
[Link] Integer attribute.
[Link] VEC Integer vector attribute.
[Link] Double attribute.
[Link] VEC Double vector attribute.
[Link] MAT Double matrix attribute.
[Link] Data object attribute.
[Link] VEC Data object vector attribute.
[Link] String attribute.
[Link] VEC String vector attribute.
AttributeType.INTEGER64 64-bit integer attribute.
AttributeType.INTEGER64 VEC 64-bit integer vector attribute.
AttributeType [Link](str name)

A RGUMENTS
name Name of an attribute.

R ETURNS
The type of an attribute or [Link] for an invalid attribute name.

S EE ALSO

[Link](), [Link]()

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

60
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

A RGUMENTS
name Name of an attribute.

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

S EE ALSO

[Link](), [Link]()

GetChildren
This function returns the objects that are stored within the object the function was called on.
In contrast to [Link]() this function gives access to objects that are currently
hidden due to scheme management.
list [Link](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

[Link]()

GetClassName
Returns the class name of the object.
str [Link]()

61
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 [Link]()

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 [Link]([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 [Link]([int includeNeutral=0])

R ETURNS
The number of electrical connections.

62
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 [Link]([str Name,]
[int recursive])

A RGUMENTS
Name (optional)
loc [Link] 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] [Link](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 [Link](int side)

63
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

A RGUMENTS
side The connection number.

R ETURNS
The cubicle object or None.

GetFullName
Returns the full name of the object as a string.
str [Link]([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] [Link](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.

64
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
1 An error occurred.
0 Otherwise.

S EE ALSO

[Link]()

GetInom
Returns the nominal current of the object at given bus index.
float [Link]([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

[Link]()

GetNode
Returns the node connected to the object at specified bus index.
DataObject [Link](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.

65
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

GetOperator
Returns the element’s operator (ElmOperator ).
DataObject [Link]()

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 [Link]()

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 [Link]()

R ETURNS
DataObject The parent folder object.
None On the root database folder e.g. parent of a user.

S EE ALSO

[Link]()

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 [Link]([str filter = '*',]
[int includeSubsets = 0,]
[int includeHiddenObjects = 0])

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

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

S EE ALSO

[Link]()

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 ⇔ [Link]() == [Link]().
A region is simply identified by a number that can be access via this function.
int [Link]()

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 [Link]()

R ETURNS
List of substations (objects of class ElmSubstat). Can be empty.

S EE ALSO

[Link](), [Link](), [Link](),

[Link](), [Link](), [Link]

67
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 [Link]()

R ETURNS
List of transformers (objects of class ElmTr2 or ElmTr3). Can be empty.

S EE ALSO

[Link](), [Link](), [Link](),

[Link](), [Link](), [Link]()

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 [Link]()

R ETURNS
List of transformer stations (objects of class ElmTrfstat). Can be empty.

S EE ALSO

[Link](), [Link](), [Link](),

[Link](), [Link](), [Link]

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 [Link]()

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 [Link]([int busIndex = 0])

A RGUMENTS
busIndex (optional)
Bus index, default value is 0.

68
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
The nominal voltage at bus index.

S EE ALSO

[Link]()

GetZeroImpedance
Returns the zero sequence impedance of an element referred to a given voltage.
[int error,
float real,
float imag] [Link](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

[Link]()

HasAttribute
Returns whether the given name is a currently valid attribute name.
int [Link](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.

69
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link]()

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

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

S EE ALSO

[Link]()

HasResults
Checks if the object has calculated result parameters.
int [Link]([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 [Link]() it also returns 1 for objects in the active
study case e.g. simulation events (Evt*).
int [Link]()

R ETURNS
0 When the object is not used for calculations.
1 When the object is currently used for calculations.

S EE ALSO

[Link]()

70
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

IsDeleted
Returns 1 if the object is deleted.
int [Link]()

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 [Link]()

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 [Link]()

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 [Link]()

R ETURNS
0 not hidden, currently ’active’
1 hidden, currently ’inactive’

71
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 [Link](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

[Link]()

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 [Link]()

72
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

[Link]()

IsNode
Indicates wtheter an object is a node (terminal or busbar).
int [Link]()

R ETURNS
1 Object is a node.
0 Otherwise.

IsObjectActive
Check if an object is active for specific time.
int [Link](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 [Link](int considerADD, int considerDEL, int considerDELTA)

A RGUMENTS
considerADD
checks if an ADD-object exists
0 ignore ADD-objects
1 consider ADD-objects
considerDEL
check if a DELETE-Object exists or exist for the parent objects
0 ignore DELETE-objects
1 consider DELETE-objects
considerDELTA
check if a DELTA-Object exists
0 ignore DELTA-objects
1 consider DELTA-objects

73
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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] [Link]([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

[Link](), [Link](), [Link]()

IsOutOfService
Indicates whether or not the object is currently out of service.
int [Link]()

74
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 [Link]()

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 [Link]()

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 [Link]([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.

75
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 [Link](DataObject objectToMove)
int [Link](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

[Link](), [Link](), [Link]()

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] [Link](DataObject objectToCopy,
[int resetMissingReferences = 0])
int [Link](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.

76
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link](), [Link]()

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 [Link]()

S EE ALSO

[Link]()

ReportUnusedObjects
Prints a report in the PowerFactory output window, which object will be deleted when function
[Link]() is called. It’s crucial that there is no study case active when
executing the function.
None [Link]()

S EE ALSO

[Link]()

SearchObject
Searches for an object with a full name, such as
'[Link]\[Link]\...\[Link] '.
DataObject [Link](str name)

A RGUMENTS
name string to search

R ETURNS
Returns the searched object.

S EE ALSO

[Link]()

SetAttribute
Sets the value of an attribute.
None [Link](str name,
int|float|str|DataObject|list value)

77
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

[Link](), [Link]()

SetAttributeLength
Sets the length of a vector or matrix attribute. The length of a matrix attribute is the number of
rows.
int [Link](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

[Link](), [Link](), [Link]()

SetAttributes
Sets the values of the transfer attributes defined via [Link]().
None [Link](list values)

A RGUMENTS
values Values to be set in its current unit (like in the edit dialog seen). The internal unit
can be used with [Link](). An exception is thrown
for invalid attribute names or values.

S EE ALSO

[Link](), [Link]()

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 [Link](str name, list shape)

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

78
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 On error.

S EE ALSO

[Link](), [Link](), [Link]()

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 [Link]()

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 [Link]([str title,]
[str filter])

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] [Link]([int resetRA,]
[int simulateOnly])

79
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

[Link](), [Link](), [Link]()

SwitchOn
Performs a “switch on” action on the network element. This action is identical to that in the
context menue.
[int error,
list changedSwitches] [Link]([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’)

80
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Iinformation about the success of the action:

0 Action was successful

1 Action failed

S EE ALSO

[Link](), [Link](), [Link]()

WriteChangesToDb
See [Link]() for a detailed description.
None [Link]()

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 [Link](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 [Link](double U)

81
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
U for voltage level (in kV)

R ETURNS
<0 error
=0 voltage level not exists in the area
>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 [Link](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 [Link](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

82
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
The set of contained objects.

GetBranches
Returns all branches which belong to this area.
list [Link]()

R ETURNS
The set of branch objects.

GetBuses
Returns all buses which belong to this area.
list [Link]()

R ETURNS
The set of objects.

GetObjs
Returns all objects of the given class which belong to this area.
list [Link](str classname)

A RGUMENTS
classname
Name of the class (i.e. ”ElmTr2”).

R ETURNS
The set of objects.

83
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.2 ElmAsm
Overview

CalcEfficiency
GetAvailableGenPower
GetElecTorque
GetGroundingImpedance
GetMechTorque
GetMotorStartingFlag
GetStepupTransformer
IsPQ

CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float [Link](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 [Link]()

84
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Available generation power

GetElecTorque
Calculates the electrical torque for a given speed and voltage.
float [Link](float speed,
float uReal,
[float addZReal,]
[float addZImag]
)

A RGUMENTS
speed speed value in p.u.
uReal voltage value (real part) in p.u.
addZReal (optional)
additional impedance (real part) in p.u.
addZImag (optional)
additional impedance (imaginary part) in p.u.

R ETURNS
Returns the calculated electrical torque.

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

85
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
speed speed value in p.u.
uReal voltage value (real part) in p.u.

R ETURNS
Returns the calculated mechanical torque.

GetMotorStartingFlag
Returns the starting motor condition.
int [Link]()

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 [Link](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 [Link]()

86
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns 1 if it is a ”PQ” machine.

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 [Link]()

R ETURNS
Available generation power

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

87
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 asynchronous machine.
DataObject [Link](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

88
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CheckBbPath
Check whether the backbone object is still valid. This means:

a Terminals determining backbone path are still directly connected.

b One switch is open on the path of an inter-feeder backbone.
c Contents of backbone match specified starting-feeder (and end feeder).
d Start and end of feeder are calculation-relevant.
e Path is unique via the defined terminals (no parallel elements (only warning!)).

int [Link](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 [Link]()

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 [Link](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

89
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link]()

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] [Link]()

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 [Link]()

R ETURNS
The switching device (ElmCoup or StaSwitch) or None if backbone is invalid.

90
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetTotLength
Get total lenth of all elements on the path of the backbone.
float [Link]()

R ETURNS
The total length of the backbone path [in km].

HasGnrlMod
Check whether backbone object ElmBbone has a valid CalBbone where corresponding results
are stored. This is only the case after a backbone calculation by scoring method (until the
calculation is reset).
int [Link]()

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 [Link]()

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 [Link]()

91
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.6 ElmBoundary
Overview

AddCubicle
CalcShiftedReversedBoundary
Clear
GetInterior
IsSplitting
Resize
Update

AddCubicle
Adds a given cubicle with given orientation to an existing boundary. The cubicle is added only if
it is not already contained within the boundary.
int [Link](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] [Link](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 [Link]()

92
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetInterior
Returns a set of all elements that are contained in the interior region of the boundary.
list [Link]()

R ETURNS
Returns the set of interior elements.

IsSplitting
Checks if the boundary splits the network into two regions. A boundary is called splitting, if and
only if, for each boundary cubicle, the adjacent terminal and the adjacent branch component
belong to different sides of the boundary.
[int isSplitting,
list notSplittingCubicles] [Link]()

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 [Link](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 [Link]()

93
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.7 ElmBranch
Overview

Update

Update
Updates connection points and contained elements of the branch. If the branch element exter-
nally modified by the user, then the update shall refresh all connections in the correct manner.
Behaves same as the update button within the ElmBranch.
None [Link]()

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 [Link]()

R ETURNS
0 on success
1 on error

GetLineCable
Gets cable type for the corresponding line, within the cable system.
DataObject [Link](int line)

A RGUMENTS
line Index of line.

R ETURNS
cable type On success.
None On error.

94
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

Update
Updates cable system element depending on configuration of the associated cable system
type.
int [Link]()

R ETURNS
1 Cable system was updated.
0 Update was not required.

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 [Link]()

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 [Link]()

R ETURNS
0 On success
6= 0 On error

S EE ALSO

[Link]()

95
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetRemoteBreakers
Returns the remote circuit breakers or connected bus bars.
This information is determined by a topological search that starts at given breaker in all direc-
tions, generally stopping at

• switches of type circuit breaker

• switches that are open
• busbars (ElmTerm::iUsage == 0)

If the search reaches a busbar while only reducible components have been passed (see DataOb-
[Link]()) it stops and returns the connected busbar (no breaker found). In case of
non-redubicle components have been passed, the search continues until next circuit breaker is
found. Only breakers with given breaker state are returned.
[list remoteBreakers,
list foundBreakers,
list foundBusbars ] [Link](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 [Link]()

R ETURNS
1 Switch is a circuit-breaker.
0 Switch is not a circuit-breaker.

IsClosed
Returns information about current switch state.
int [Link]()

R ETURNS
1 switch is closed
0 switch is open

96
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

IsOpen
Returns information about current switch state.
int [Link]()

R ETURNS
1 switch is open
0 switch is closed

S EE ALSO

[Link]()

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 [Link]()

R ETURNS
0 On success
6= 0 On error

S EE ALSO

[Link]()

5.2.11 ElmDsl
Overview

ExportToClipboard
ExportToFile

ExportToClipboard
Export the parameter list to clipboard.
None [Link]([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:

97
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

1 Yes (default).
0 No (use English language header).

ExportToFile
Export the parameter list to CSV file(s).
None [Link](str filePath,
[str colSeparator],
[int useLocalHeader]
)

A RGUMENTS
filePath Path of the CSV target file. In case of array and matrix parameters (names:
“array NAME” and “matrix NAME”), additional CSV files are created in the same
location with names obtained by appending “ array NAME” and “ matrix NAME”
to the target file name.

colSeparator (optional)
Separator between the columns (default: “;”).
useLocalHeader (optional)
Use the localised version of the header. Possible values are:

1 Yes (default).
0 No (use English language header).

5.2.12 ElmFeeder
Overview

CalcAggrVarsInRadFeed
GetAll
GetBranches
GetBuses
GetNodesBranches
GetObjs

CalcAggrVarsInRadFeed
Computes all the aggregated variables in radial feeders.
int [Link]([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:

98
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]([int iNested])

A RGUMENTS
iNested (optional)
Affects the collection of objects in case of nested feeders:
0 Only the objects of this feeder will be returned.
1 (default) All elements including those of nested feeders will be re-
turned.

R ETURNS
The set of network elements belonging to this feeder. Can be empty.

S EE ALSO

[Link]()

GetBranches
Returns a set with all branch elements belonging to this feeder.
list [Link]([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 [Link]([int iNested])

99
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]([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.

GetObjs
Returns a set with all objects of class 'ClassName' which belong to this feeder.
list [Link](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.

100
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.13 ElmFile
Overview

LoadFile
SaveFile

LoadFile
(Re)Loads the file into a buffer.
int [Link]([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 [Link]()

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

5.2.14 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 ] [Link](int busIdx)

A RGUMENTS
busIdx Bus index where the grounding should be determined.

101
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.15 ElmGenstat
Overview

CalcEfficiency
Derate
Disconnect
GetAvailableGenPower
GetGroundingImpedance
GetStepupTransformer
IsConnected
Reconnect
ResetDerating

CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float [Link](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 [Link](float deratingP)

A RGUMENTS
deratingP Derating value

102
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 [Link]()

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 [Link]()

R ETURNS
Available generation power

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

103
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](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 generator is topologically connected to any busbar.
int [Link]()

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 [Link]()

104
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

5.2.16 ElmGndswt
Overview

Close
GetGroundingImpedance
IsClosed
IsOpen
Open

Close
Closes the switch by changing its status to ’close’. If closed, the connected node will be
considered as being earthed.
int [Link]()

R ETURNS
1, always

S EE ALSO

[Link]()

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.
[int valid,
float resistance,
float reactance ] [Link](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.

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

IsClosed
Returns information about current switch state.
int [Link]()

R ETURNS
1 switch is closed
0 switch is open

S EE ALSO

[Link]()

IsOpen
Returns information about current switch state.
int [Link]()

R ETURNS
1 switch is open
0 switch is closed

S EE ALSO

[Link]()

Open
Opens the switch by changing its status to ’open’.
int [Link]()

R ETURNS
0, always

S EE ALSO

[Link]()

106
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.17 ElmLne
Overview

AreDistParamsPossible
CreateFeederWithRoutes
FitParams
GetIthr
GetType
GetY0m
GetY1m
GetZ0m
GetZ1m
GetZmatDist
HasRoutes
HasRoutesOrSec
IsCable
IsNetCoupling
MeasureLength
SetDetailed

AreDistParamsPossible
Check if the line fulfils conditions for the calculation of distributed parameters:

ElmLne No routes, no sections

TypTow only 1 circuit x 3 phases
TypGeo only 1 circuit x 3 phases

TypLne AC system, 3 phases and 0 neutral

TypCabsys only 1 circuit x 3 phases

int [Link]()

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

107
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CreateFeederWithRoutes
Creates a new feeder in the line by splitting the line into 2 routes and inserting a terminal.
int [Link](float dis,
float rem,
DataObject O)
int [Link](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 [Link]([int isRMSModel = 0,]
[int modify = 1])

A RGUMENTS
isRMSModel

modify

R ETURNS
0 Success
1 Error

GetIthr
Returns the rated short-time current of the line element.
float [Link]()

108
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns rated short-time current value

GetType
Returns the line type object.
DataObject [Link]()

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

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

109
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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)

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

110
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetZmatDist
The function gets impedance matrix in phase domain (only amplitudes), for a line with distributed
parameters, short-circuit ended.
int [Link](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 [Link]()

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 [Link]()

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 [Link]()

111
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link]([int iUseGraphic])

A RGUMENTS
iUseGraphic (optional)
Use SGL diagram for calculation or not.

1 Use displayed diagram for calculation (default)

0 Calculate distance without diagram

R ETURNS
≥0 Returns the graphical length of this line in its current unit
<0 Error: E.g. when line is not represented in the active diagram and iUseGraphic=1

SetDetailed
The function can be used to prevent the automatically reduction of a line e.g. if the line is a line
dropper (length = 0). The function should be called when no calculation method is valid (before
first load flow). The internal flag is automatically reset after the first calculation is executed.
int [Link]()

112
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.18 ElmLnesec
Overview

IsCable

IsCable
Checks if this line section is a cable.
int [Link]()

R ETURNS
1 Line section is a cable
0 Line section is not a cable
-1 Error

5.2.19 ElmMdl
Overview

ExportToClipboard
ExportToFile

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

113
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

GetGroundingImpedance

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

Activate
CalculateInterchangeTo
CalculateVoltageLevel
CalculateVoltInterVolt
Deactivate
DefineBoundary

114
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link](DataObject net)

A RGUMENTS
net Connected grid

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 [Link](double U)

A RGUMENTS
U for voltage level (in kV)

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

115
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 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 [Link](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

Deactivate
Removes a grid from the active study [Link] only be applied if there are is no currently active
calculation.
int [Link]()

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 [Link](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

116
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.22 ElmPvsys
Overview

CalcEfficiency
Derate
Disconnect
GetAvailableGenPower
GetGroundingImpedance
IsConnected
Reconnect
ResetDerating

CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float [Link](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 [Link](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 [Link]()

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

117
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
Available generation power

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

118
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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 [Link]()

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 [Link]()

5.2.23 ElmRelay
Overview

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

119
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

CheckRanges
Checks the settings of all elements in the relay for range violations.
int [Link]()

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 ] [Link](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 ] [Link](int earth,
int unit
)

120
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 [Link](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 [Link]()

R ETURNS
The nominal voltage of the local bus of the relay in kV.

IsStarted
Checks if the starting unit detected a fault.
int [Link]()

121
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 [Link](float real,
float imag,
int inSec,
int zone,
int unit
)
int [Link](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

122
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 [Link]()

SetMaxIearth
Sets the “Max. Earth Fault Current” of the relay to the currently measured value.
None [Link]()

SetMinI
Sets the “Min. Phase Fault Current” of the relay to the currently measured value.
None [Link]()

SetMinIearth
Sets the “Min. Earth Fault Current” of the relay to the currently measured value.
None [Link]()

SetOutOfService
Sets the “Out of Service” flag of elements contained in the relay.
int [Link](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.

123
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 [Link](int time,
int type,
int zone,
int unit
)

A RGUMENTS
time Time in s.

type
1 Set the time for overcurrent elements.
2 Set the time for distance elements.
zone Set the time for elments with this zone number (only when settings distance
elements).
unit
0 Set the time for Phase-Phase or Multifunctional elements.
1 Set the time for Phase-Earth or Multifunctional elements.
2 Set the time for Multifunctional elements.

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

SlotUpdate
Triggers a slot update of the relay.
None [Link]()

124
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

D EPRECATED N AMES
slotupd

5.2.24 ElmRes
Overview

AddVariable
Clear
ExecuteLoadingCommand
FindColumn
FindMaxInColumn
FindMaxOfVariableInRow
FindMinInColumn
FindMinOfVariableInRow
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

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

A RGUMENTS
element An object.

125
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
Always 0 and can be ignored.

ExecuteLoadingCommand
Loads results into memory.
int [Link]()

R ETURNS
0 Success
1 Failure

FindColumn
Returns the index of the first header column matching the given object and/or variable name.
int [Link](DataObject obj,
[str varName]
)
int [Link](DataObject obj,
[int startCol]
)
int [Link](DataObject obj,
str varName
)

A RGUMENTS
obj (optional)
Object of matching column.
varName (optional)
Variable name of matching column.
startCol (optional)
Index of first checked column; Search starts at first column if colIndex is not
given.

126
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
≥0 column index
<0 no valid column found
The index can be used in the ElmRes method GetData to retrieve the value of the column.

FindMaxInColumn
Find the maximum value of the variable in the given column.
[int row,
float value] [Link](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.
[int col,
float maxValue] [Link](str variable,
int row)

A RGUMENTS
variable The variable name
variable The row
maxValue (optional)
The corresponding maximum value.

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

FindMinInColumn
Find the minimum value of the variable in the given column.
[int row,
float value] [Link](int column)

127
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.

FindMinOfVariableInRow
Find the minimum value for the given row and variable.
[int col,
float minValue] [Link](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.

FinishWriting
Finishes the writing of values to a result file.
None [Link]()

D EPRECATED N AMES
Close

S EE ALSO

[Link](), [Link](), [Link]()

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 [Link]()

128
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetColumnValues
Get complete column values.
int [Link](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.
str [Link]([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

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

GetFirstValidObject
Gets the index of the column for the first valid variable in the given line. Starts at the beginning
of the given line and sets the internal iterator of the result file to the found position.
int [Link](int row,
[str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[float limit2,]
[int limitOperator2]
)
int [Link](int row,
list objects
)

129
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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.
int [Link]([str variableNames])

130
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.
int [Link](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

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.
int [Link]([str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[float limit2,]
[int limitOperator2]
)
int [Link](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).

131
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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.
int [Link]([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).

132
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.
int [Link]([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).
int [Link]()

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

GetNumberOfRows
Returns the number of values per column (rows) stored in result object.
int [Link]()

R ETURNS
Returns the number of values per column stored in result object.

GetObj
Returns an object used in the result file. Positive index means objects for which parameters
are being monitored (i.e. column objects). Negative index means objects which occur in written
result rows as values.
DataObject [Link](int index)

A RGUMENTS
index index of the object.

133
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The object found or None.

GetObject
Get object of given column.
DataObject [Link]([int column])

A RGUMENTS
col Column index. Object of default column is returned if col is not passed.

R ETURNS
The object of the variable stored in column ’column’.

GetObjectValue
Returns a value from a result object for row iX of curve col.
[int error,
DataObject o ] [Link](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.

GetRelCase
Get the contingency object for the given case number from the reliability result file.
DataObject [Link](int caseNumber)

A RGUMENTS
caseNumber
The reliability case number

134
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](int value)
DataObject [Link](DataObject obj)

A RGUMENTS
value The cnttime to look for

obj The pResElm to look for

R ETURNS
None The sub result file with value=cnttime (obj=pResElm) was not found.
any other value The sub result file with value=cnttime (obj=pResElm).

GetUnit
Get the unit of a column.
str [Link]([int column])

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

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

GetValue
Returns a value from a result object for row iX of curve col.
[int error,
float d ] [Link](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.

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

GetVariable
Get variable name of column
str [Link]([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).
int [Link]()
int [Link](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

136
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link](), [Link]()

Load
Loads the data of a result object (ElmRes) in memory for reading.
None [Link]()

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 [Link]()

SetAsDefault
Sets this results object as the default results object. Plots using the default result file will use
this file for displaying data.
None [Link]()

SetObj
Adds an object to the objects assigned to the result file
int [Link](DataObject element)

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 [Link](int value)
None [Link](DataObject obj)

A RGUMENTS
value Value to be assigned to parameter cnttime of ElmRes
value Object to be assigned to parameter pResElm of ElmRes

137
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The ElmRes itself remains
unchanged.
int [Link](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 [Link]([float defaultValue])

R ETURNS
0 on success

S EE ALSO

[Link](), [Link](), [Link]()

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

R ETURNS
0 on success

5.2.25 ElmShnt
Overview

GetGroundingImpedance

GetGroundingImpedance
Returns the impedance of the internal grounding. Single phase shunts connected to neutral
are considered as grounding devices themselves; i.e. instead of the dedicated grounding
parameters, the shunt parameters are used.
[int valid,
float resistance,
float reactance ] [Link](int busIdx)

138
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.26 ElmStactrl
Overview

GetControlledHVNode
GetControlledLVNode
GetStepupTransformer
Info

GetControlledHVNode
Returns the corresponding voltage controlled HV node for the machine at the specified index.
Switch status are always considered.
DataObject [Link]([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 [Link](int index)

A RGUMENTS
index Index of machine (starting from 0 − . . . ).

R ETURNS
object Terminal ()
None not found

139
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetStepupTransformer
Performs a topological search to find the step-up transformer of the machine at the specified
index.
DataObject [Link]([int index,]
[int iBrkMode]
)

A RGUMENTS
index Index of machine (starting from 0 − . . . ).
iBrkMode (optional)
0 (default) All switch status (open,close) are considered
1 Ignore breaker status (jump over open breakers)
2 Ignore all switch status (jump over open switches)

R ETURNS
object step-up transformer
None step-up transformer not found

Info
Prints the control information in the output window. It is the same information that the button
”Info” of the Station Control dialog prints.
int [Link]()

5.2.27 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 [Link]()

R ETURNS
1 on success
0 otherwise, especially if no running arrangement is selected

140
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ] [Link](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

[Link](), [Link](),

GetSplitCal
This function determines the elements that belong to a split. In contrast to [Link]()
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,

141
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

list connectionCubicles,
list elements ] [Link](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 [Link]().
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

[Link]()

GetSplitIndex
This function returns the index of the split that contains passed object.
int [Link](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

[Link]()

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

142
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

• 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 [Link]([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

[Link](), [Link]()

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 [Link](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 [Link]()

143
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link](DataObject ra)

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

GetStepupTransformer

GetStepupTransformer
Performs a topological search to find the step-up transformer of the static VAR system.
DataObject [Link](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

144
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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.29 ElmSym
Overview

CalcEfficiency
Derate
Disconnect
GetAvailableGenPower
GetGroundingImpedance
GetMotorStartingFlag
GetStepupTransformer
IsConnected
Reconnect
ResetDerating

CalcEfficiency
Calculate efficiency for connected storage model at given active power value.
float [Link](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 [Link](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 [Link]()

145
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
Available generation power

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

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

GetMotorStartingFlag
Returns the starting motor condition.
int [Link]()

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 synchronous machine.
DataObject [Link](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 [Link]()

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

147
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link]()

5.2.30 ElmTerm
Overview

GetBusType
GetCalcRelevantCubicles
GetConnectedBrkCubicles
GetConnectedCubicles
GetConnectedMainBuses
GetConnectionInfo
GetEquivalentTerminals
GetMinDistance
GetNextHVBus
GetNodeName
GetSepStationAreas
GetShortestPath
HasCreatedCalBus
IsElectrEquivalent
IsEquivalent
IsInternalNodeInStation
UpdateSubstationTerminals

GetBusType
Gets busbar calculation type.
int [Link]()

R ETURNS
0 No valid calculation (load flow).
1 PQ busbar.
2 PV busbar.
3 Slack busbar.

148
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetCalcRelevantCubicles
This function gets calculation relevant cubicles of this terminal.
list [Link]()

R ETURNS
Set of calculation relevant cubicles.

GetConnectedBrkCubicles
Function gets the set of cubicles connected with the breaker and this terminal.
list [Link]([int ignoreSwitchStates])

A RGUMENTS
ignoreSwitchStates (optional)
Ignore switch status flag 1 or not 0 (=default).

R ETURNS
Set of cubicles.

GetConnectedCubicles
Function gets the set of cubicles connected with this terminal.
list [Link]([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 [Link]([int considerSwitches])

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

R ETURNS
Set of main buses connected to the terminal.

149
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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] [Link]()

A RGUMENTS
closedSwitches
Number of closed switch devices.
allSwitches
Number of total switch devices.
nonSwitchingDevices
Number of non-switch devices.
closedAndNonSwitchingDevices
Number of total closed and non-switch devices (closedSwitches+nonSwitchingDevices).
allDevices
Number of total switch and non-switch devices (allSwitches+nonSwitchingDevices).

connectedNodes
Number of total nodes connected via couplers.
mainNodes
Number of total main nodes.

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

GetEquivalentTerminals
Returns a set of all terminals that are equivalent to current one. Euqivalent means that those
terminals are topologically connected only by

• closed switching devices (ElmCoup, RelFuse) or

• lines of zero length (line droppers).

list [Link]()

R ETURNS
All terminals that are equivalent to current one. Current one is also included so the set is
never empty.

150
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

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 [Link](DataObject term)
[float minDistance,
list path ] [Link](DataObject term,
int considerSwitches,
[list limitToNodes,]
[list elementsToIgnore,]
)

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

R ETURNS
<0 If there is no path between the two terminals
≥0 Distance of shortest path in km

S EE ALSO

[Link]()

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 [Link]()

151
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
Node name as described above. Never empty.

GetSepStationAreas
Function gets all separate areas within the substation linked to this terminal. In this manner,
area is any part between two nodes.
list [Link]([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 network topology
according to given criterion.
float [Link](DataObject term)
[float minDistance,
list path ] [Link](int criterion,
DataObject term,
int considerSwitches,
[list limitToNodes,]
[list elementsToIgnore,]
)

A RGUMENTS
criterion
0 According to line length, same as [Link]()
1 According to node count

152
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

S EE ALSO

[Link]()

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 [Link]()

R ETURNS
1 Valid calculation exists.
0 No valid calculation.

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

• 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 [Link](DataObject terminal,

float maxR,
float maxX
)

153
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

[Link]()

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 ([Link](Term2) -> [Link](Term1)),

• reflexive ([Link](Term1)) and
• transitive ([Link](Term2) and [Link](Term3) -> [Link](Term3));

int [Link](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

[Link]() [Link]()

IsInternalNodeInStation
Function checks if the terminal is an internal node located in a station (ElmSubstat, ElmTrfstat).
int [Link]()

154
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 [Link](int volt,
int phs
)

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

5.2.31 ElmTow
Overview

Update

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

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

5.2.32 ElmTr2
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetZ0pu
GetZpu
IsQuadBooster
NTap

155
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CreateEvent
For the corresponding transformer, a Tap Event (EvtTap) is created for the simulation.
int [Link]([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 ] [Link](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.

156
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 [Link]([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

[Link](), [Link](), [Link]()

GetTapPhi
Gets the tap phase shift in deg of the transformer for given tap position.
float [Link](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 [Link](int itappos,
int onlyTapSide,
int includeNomRatio
)

157
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 ] [Link](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).

158
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

IsQuadBooster
Returns whether transformer is a quadbooster; i.e. checks phase shift angle modulus 180◦ .
int [Link]()

R ETURNS
'1' if quadbooster, else '0'

NTap
Gets the transformer tap position.
int [Link]()

R ETURNS
The tap position.

5.2.33 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 [Link]([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.

159
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

160
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

[Link](), [Link](), [Link]()

GetTapPhi
Gets the tap phase shift in deg of the transformer for given tap position and side.
float [Link](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 [Link](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 [Link]()

161
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 ] [Link](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.

162
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 [Link]()

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 [Link](int bus)

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

R ETURNS
The tap position.

5.2.34 ElmTr4
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetTapZDependentSide
GetZ0pu
GetZpu
IsQuadBooster
NTap

163
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CreateEvent
For the corresponding transformer, a Tap Event (EvtTap) is created for the simulation.
None [Link]([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 ] [Link](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,

164
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 [Link]([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

[Link](), [Link](), [Link]()

GetTapPhi
Gets the tap phase shift in deg of the transformer for given tap position and side.
float [Link](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 [Link](int iSide,
int itappos,
int includeNomRatio
)

165
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 [Link]()

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.

166
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 ] [Link](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 [Link]()

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 [Link](float busIdx)

167
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

R ETURNS
The tap position.

5.2.35 ElmTrain
Overview

SetPosition

SetPosition
Set the position (line and postion in km) of the train
int [Link](DBObject* line, double position)

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

5.2.36 ElmTrb
Overview

GetGroundingImpedance

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

168
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.37 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 ] [Link](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

[Link](), [Link](),

169
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetSplitCal
This function determines the elements that belong to a split. In contrast to [Link]()
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 ] [Link](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 [Link]().
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

[Link]()

GetSplitIndex
This function returns the index of the split that contains passed object.
int [Link](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

170
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

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 [Link]([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

[Link](), [Link]()

5.2.38 ElmTrmult
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetZpu
IsQuadBooster
NTap

171
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CreateEvent
For the corresponding transformer, a Tap Event (EvtTap) is created for the simulation.
None [Link]([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 ] [Link](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.

172
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 [Link]([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

[Link](), [Link](), [Link]()

GetTapPhi
Gets the tap phase shift in deg of the transformer for given tap position and side.
float [Link](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 [Link](int iSide,
int itappos,
int includeNomRatio
)

173
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 ] [Link](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 [Link]()

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

NTap
Gets the transformer tap position.
int [Link]()

174
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The tap position.

5.2.39 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 ] [Link](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.40 ElmVoltreg
Overview

CreateEvent
GetGroundingImpedance
GetZpu
NTap

CreateEvent
For the corresponding voltage regulator, a Tap Event (EvtTap) is created for the simulation.
None [Link]([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

175
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 ] [Link](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 ] [Link](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 [Link](int tap)

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

176
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The tap position.

5.2.41 ElmXnet
Overview

CalcEfficiency
Disconnect
GetGroundingImpedance
GetStepupTransformer
Reconnect

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

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

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 [Link]()

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 ] [Link](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.

177
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 an external grid
DataObject [Link](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).

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 [Link]()

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

5.2.42 ElmZone
Overview

CalculateInterchangeTo
CalculateVoltageLevel
CalculateVoltInterVolt
DefineBoundary
GetAll
GetBranches
GetBuses
GetObjs
SetLoadScaleAbsolute

178
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link](double U)

A RGUMENTS
U for voltage level (in kV)

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 [Link](double Ufrom, double Uto)

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

179
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](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.

GetAll
Returns all objects which belong to this zone.
list [Link]()

R ETURNS
The set of objects.

GetBranches
Returns all branches which belong to this zone.
list [Link]()

R ETURNS
The set of branch objects.

GetBuses
Returns all buses which belong to this zone.
list [Link]()

R ETURNS
The set of objects.

180
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

GetObjs
Returns all objects of the given class which belong to this zone.
list [Link](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 [Link](float Pin)

A RGUMENTS
Pin active power in MW used for the load scaling factor.

5.3 Station Elements

5.3.1 StaCt
Overview

SetPrimaryTap

SetPrimaryTap
Determines the best matching primary tap for the connected branch, so that IN om,Branch ·
mltF actor ≤ IP ri. If no tap satisfies the equation, the largest tap is used.
int [Link]([float mltFactor])

A RGUMENTS
mltFactor (optional)
Multiplication factor (default 1.0)

R ETURNS
0 Correctly set.
1 Error.

181
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]([int direction = 1,]
[int ignoreOpenSwitches = 0]
)

A RGUMENTS
direction (optional)
Specifies the direction in which the network topology is traversed.
1 Traversal to the branch element (default).
0 Traversal to the terminal element.
ignoreOpenSwitches (optional)
Determines whether to pass open switches or to stop at them.
0 The traversal stops in a direction if an open switch is reached (default).
1 Ignore all switch statuses and pass every switch.

R ETURNS
A set of network components that are collected by a topological traversal starting at the
cubicle (StaCubic) where the function is called.

GetBranch
Function gets the branch of this cubicle.
DataObject [Link]()

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 [Link] ([float swtStat])

182
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](int swtStat)

A RGUMENTS
swtStat Consider switch status (1) or not (0).

R ETURNS
Set of elements.

GetNearestBusbars
Function searches for connected and connectable nearest busbars starting at the cubicle.
Search stops at the nearest busbars and out of service elements. Internal and junction nodes,
all types of branch elements and all types of switches - i.e. circuit breakers and disconnectors -
are passed.
Connected busbars are all busbars which are topologically connected to the start cubicle 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] [Link](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

183
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](DataObject nearestBusbar, [int excludeZPUs])

A RGUMENTS
nearestBusbar
Nearest busbar in relation to cubicle.
excludeZPUs (optional)
Whether ZPU (ElmZpu) should be ignored in the search. Default=0.

R ETURNS
Net elements of the path from cubicle to busbar.

IsClosed
Function checks if this cubicle is directly connected with the busbar, considering the switch
status.
int [Link]()

R ETURNS
0 Disconnected cubicle.
1 Connected cubicle.

IsConnected
Function checks if the cubicle is connected to the passed terminal or coupler.
int [Link](DataObject elm,
int swtStat
)

A RGUMENTS
elm Terminal or coupler to check connection with.

swtStat Consider switch status (1) or not (0).

184
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

GetMeaValue
Returns the value for the switch position currently stored in the measurement object.
[int error,
float value] [Link]()

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 StaExtbrk-
[Link]() for details on the status bits.
int [Link]()

185
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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details
on the status bits.
int [Link](int mask)

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtbrk-
[Link]() for details on the status bits.
int [Link](int mask)

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

186
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

ResetStatusBit
Resets specific bits in the status bitfield. See [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link](int value)

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

187
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 [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](int mask)

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

188
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 [Link]() for details on
the status bits.
None [Link](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 [Link](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 [Link](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

189
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

GetMeaValue
Returns the value for command interpreted as floating point value.
[int error,
float value] [Link]()

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 StaExtcmd-
[Link]() for details on the status bits.
int [Link]()

R ETURNS
Status bitfield as an integer value.

190
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details
on the status bits.
int [Link](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 StaExtcmd-
[Link]() for details on the status bits.
int [Link](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 [Link]() for details on the
status bits.
None [Link](int mask, int dbSync)

191
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.
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 [Link]()
for details on the status bits.
None [Link](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 [Link](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
bit6 0x00000040 On Event

bit7 0x00000080 Event Block.

bit8 0x00000100 Alarm Block.

192
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit9 0x00000200 Update Block.

bit10 0x00000400 Control Block.
bit29 0x20000000 Read
bit30 0x40000000 Write
bit31 0x80000000 Neglected by SE

None [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](int status)

193
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 [Link](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 [Link](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

194
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link]()

GetMeaValue
Returns the value stored in the measurement object.
[int error,
float value] [Link]([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.

195
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 StaExtdat-
[Link]() for details on the status bits.
int [Link]()

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details
on the status bits.
int [Link](int mask)

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

196
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtdat-
[Link]() for details on the status bits.
int [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link](float value)

A RGUMENTS
value New value.

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

197
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 [Link](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 [Link]() for details on the status
bits.
None [Link](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)

198
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See [Link]()
for details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](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 [Link](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 [Link](int dbSync)

199
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.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 [Link]()

GetMeaValue
Returns the value for frequency currently stored in the measurement object.
[int error,
float value] [Link]()

A RGUMENTS
value (out)
Value for frequency.

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

200
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details on
the status bits.
int [Link](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 [Link]()
for details on the status bits.
int [Link](int mask)

201
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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link](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

202
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]() for details on the status bits.
None [Link](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 [Link]() for
details on the status bits.
None [Link](int mask)

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.

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 [Link]() for details on the
status bits.
None [Link](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 [Link](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 [Link](int dbSync)

A RGUMENTS
dbSync (optional)
0 Value is copied in memory only
1 Default, copied value is stored on db (persistent)

204
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

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

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.

205
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtfu-
[Link]() for details on the status bits.
int [Link]()

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details
on the status bits.
int [Link](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 StaExtfu-
[Link]() for details on the status bits.
int [Link](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

ResetStatusBit
Resets specific bits in the status bitfield. See [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link](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

207
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](int mask)

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.

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 [Link]() for details on
the status bits.
None [Link](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 [Link](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 [Link](int dbSync)

A RGUMENTS
dbSync (optional)
0 Value is copied in memory only
1 Default, copied value is stored on db (persistent)

209
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

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

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.

210
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 StaEx-
[Link]() for details on the status bits.
int [Link]()

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details on
the status bits.
int [Link](int mask)

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

211
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaEx-
[Link]() for details on the status bits.
int [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link](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

212
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None [Link](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)

213
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetStatusBit
Sets specific bits in the status bitfield. See [Link]() for details on the status bits.
None [Link](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 [Link]() for
details on the status bits.
None [Link](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 [Link]() for details on the
status bits.
None [Link](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 [Link](int dbSync)

A RGUMENTS
dbSync (optional)
0 Value is copied in memory only
1 Default, copied value is stored on db (persistent)

214
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link](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.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 [Link]()

215
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

GetMeaValue
Returns the value for power factor currently stored in the measurement object.
[int error,
float value] [Link]([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 [Link]()
for details on the status bits.
int [Link]()

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

216
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details on
the status bits.
int [Link](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 [Link]()
for details on the status bits.
int [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link](float value)

217
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 [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]() for
details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](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 [Link](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 [Link](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.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 [Link]()

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

220
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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.

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaExtp-
[Link]() for details on the status bits.
int [Link]()

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

221
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details on
the status bits.
int [Link](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 StaExtp-
[Link]() for details on the status bits.
int [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](int mask)

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

222
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetMeaValue
Sets the value stored in the measurement object.
int [Link](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.

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

223
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]() for
details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](int status)

224
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 [Link](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 [Link](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

225
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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 [Link]()

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

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.

226
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

GetStatus
Returns the status flags. Please note, this value is interpreted as a bitfield. See StaEx-
[Link]() for details on the status bits.
int [Link]()

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details on
the status bits.
int [Link](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 StaEx-
[Link]() for details on the status bits.
int [Link](int mask)

227
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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link](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.

228
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 [Link](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 [Link]() for details on the status
bits.
None [Link](int mask, int dbSync)

229
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 [Link]() for
details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](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 [Link](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

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 [Link](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.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 [Link]()

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

R ETURNS
Status bitfield as an integer value.

231
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details on
the status bits.
int [Link](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 [Link]()
for details on the status bits.
int [Link](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 [Link]() for details on the status
bits.
None [Link](int mask, int dbSync)

232
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.
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 [Link]()
for details on the status bits.
None [Link](int mask)

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 [Link](int status, int dbSync)

233
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 [Link]() for details on the status
bits.
None [Link](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 [Link]() for
details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](int status)

A RGUMENTS
status Bitfield for status flags, see above

234
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 [Link](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 [Link](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

235
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl

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

GetMeaValue
Returns the value for tap position and tap info currently stored in the measurement object.
[int error,
float value] [Link]([int type,]
[int useTranslationTable])

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 StaExttap-
[Link]() for details on the status bits.
int [Link]()

R ETURNS
Status bitfield as an integer value.

236
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details
on the status bits.
int [Link](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 StaExttap-
[Link]() for details on the status bits.
int [Link](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 [Link]() for details on the status
bits.
None [Link](int mask, int dbSync)

237
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.
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 [Link]()
for details on the status bits.
None [Link](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 [Link](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

238
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 [Link](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 [Link]() for details on the status
bits.
None [Link](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)

239
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetStatusBitTmp
Sets specific bits in the temporary (in memory) status bitfield. See [Link]()
for details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](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 [Link](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 [Link](int dbSync)

240
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.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 [Link]()

GetMeaValue
Returns the value for voltage currently stored in the measurement object.
[int error,
float value] [Link]([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.

241
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 on success
1 on error, e.g. phase index does not exist

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

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details
on the status bits.
int [Link](int mask)

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

242
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See [Link]()
for details on the status bits.
int [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](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 [Link](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

243
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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 [Link](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 [Link]() for details on the status
bits.
None [Link](int mask, int dbSync)

244
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 [Link]() for
details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](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 [Link](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

245
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 [Link](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.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 [Link]()

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

246
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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)
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 [Link]()
for details on the status bits.
int [Link]()

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 [Link]() for details on the status bits.
int [Link]()

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 [Link]()

247
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

IsStatusBitSet
Checks if specific bit(s) are set in the status bitfield. See [Link]() for details on
the status bits.
int [Link](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 [Link]()
for details on the status bits.
int [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]()
for details on the status bits.
None [Link](int mask)

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

248
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

249
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None [Link](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 [Link]() for details on the status
bits.
None [Link](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 [Link]() for
details on the status bits.
None [Link](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 [Link]() for details on
the status bits.
None [Link](int status)

250
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 [Link](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 [Link](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

251
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 [Link]()

R ETURNS
0 On success
6= 0 On error

S EE ALSO

[Link]()

IsClosed
Returns information about current switch state.
int [Link]()

R ETURNS
1 switch is closed
0 switch is open

S EE ALSO

[Link]()

IsOpen
Returns information about current switch state.
int [Link]()

R ETURNS
1 switch is open
0 switch is closed

S EE ALSO

[Link]()

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 [Link]()

R ETURNS
0 On success
6= 0 On error

252
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

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 [Link](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).

253
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 [Link]()

R ETURNS
0 Ok, module was created.
1 An error occurred.

S EE ALSO

[Link]() [Link]()

DefineDouble
Creates a new floating-point-number parameter for the given type of objects.
int [Link](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.

254
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

[Link]()

DefineDoubleMatrix
Creates a new floating-point-matrix parameter for the given type of objects.
int [Link](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.

255
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 [Link](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

[Link]()

DefineDoubleVector
Creates a new floating-point-number vector parameter for the given type of objects.
int [Link](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.

256
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

[Link]() [Link]()

DefineDoubleVectorPerConnection
Creates a new floating-point-number vector parameter for the given type of objects for every
connection of the object.
int [Link](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

[Link]()

257
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

DefineInteger
Creates a new integer parameter for the given type of objects.
int [Link](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

[Link]()

DefineIntegerPerConnection
Creates a new integer parameter for every connection for the given type of objects.
int [Link](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

258
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

[Link]()

DefineIntegerVector
Creates a new integer vector parameter for the given type of objects.
int [Link](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

[Link]() [Link]()

259
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 [Link](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

[Link]()

DefineObject
Creates a new object parameter for the given type of objects.
int [Link](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

260
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

[Link]()

DefineObjectPerConnection
Creates a new object parameter for every connection for the given type of objects.
int [Link](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

[Link]()

DefineObjectVector
Creates a new object vector parameter for the given type of objects.
int [Link](str class,
str name,
str desc,
DataObject initial,
int size)

261
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

[Link]() [Link]()

DefineObjectVectorPerConnection
Creates a new object vector parameter for the given type of objects for every connection of the
object.
int [Link](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.

262
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

DefineString
Creates a new text parameter for the given type of objects.
int [Link](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

[Link]()

DefineStringPerConnection
Creates a new text parameter for every connection for the given type of objects.
int [Link](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

263
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

[Link]()

DeleteModule
Deletes the module of this add on.
int [Link]()

0 Success. The module is deleted completely.

1 Failure. The module does not exist and can therefore not be deleted.

S EE ALSO

[Link]()

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 [Link]()

R ETURNS
0 Ok, module was finalised.
1 An error occurred, this command is not the one being currently active.

S EE ALSO

[Link]()

GetActiveModule
Gets the key of the module being currently active. An empty string is returned if there is no
active module.
str [Link]()

R ETURNS
The key of the active module. an empty string is returned if there is no active module.

264
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

ModuleExists
Checks if the module for this add-on was already created using the method CreateModule.
int [Link]()

R ETURNS
0 The module was not created yet.
1 The module was already created.

S EE ALSO

[Link]() [Link]() [Link]()

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 [Link]()

R ETURNS
0 Success. This command is set as active module.
1 Failure. This command is already the active module.

S EE ALSO

[Link]() [Link]() [Link]()

5.4.3 ComAmpacity
Overview

ExecuteAmpacityCalc

ExecuteAmpacityCalc
The function executes ampacity calculation with or without the tabular report at the end.
int [Link]([int ireport = 1])

A RGUMENTS
ireport (optional)
Show report or not, default = 1.

265
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 [Link]()

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 [Link](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 [Link](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:

266
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 [Link]()

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 [Link]()

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 [Link]()

R ETURNS
number of errors

267
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.6 ComBoundary
Overview

GetCreatedBoundaries

GetCreatedBoundaries
Gets created boundaries after the command has been executed.
list [Link]()

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 [Link](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

268
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 [Link](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 [Link]([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.

269
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 [Link]([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 = [Link]()

cimdbexp = [Link]("ComCimdbexp")
result = [Link]()
if result == 0:
[Link]("OK")
else:
[Link]("Error: export failed")

5.4.9 ComCimdbimp
Overview

Execute
ImportAndConvert

270
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

Execute
Executes the import.
int [Link]([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 = [Link]()

cimdbimp = [Link]("ComCimdbimp")
[Link]("targetName", "testArchive")
[Link]("fileName", "E:\\test\\[Link]")
result = [Link]()
if result == 0:
[Link]("OK")
else:
[Link]("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 [Link]([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.

271
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 = [Link]()

cimdbimp = [Link]("ComCimdbimp")
[Link]("fileName", "E:\\test\\[Link]")
result = [Link]()
if result == 0:
[Link]("OK")
elif result == 1:
[Link]("Error: import failed")
else:
[Link]("Error: conversion failed")

5.4.10 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 [Link]([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

272
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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 = [Link]()

cimvalidate = [Link]("ComCimvalidate")
error = [Link](0)
if error == 0:
[Link]("OK")
else:
[Link]("Error: validation failed")

GetClassType
Returns the object class type from the selected validation message.
str [Link](int messageIndex)

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 = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
for i in range(nMessages):
classType = [Link](i)
[Link]("%s" % classType)

GetDescriptionText
Returns the description from the selected validation message.
str [Link](int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

273
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
Message description.

E XAMPLE
The following example prints the description text from each validation message.
import powerfactory
app = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
for i in range(nMessages):
descriptionText = [Link](i)
[Link]("%s" % descriptionText)

GetInputObject
Returns the object selected for validation.
DataObject [Link]()

R ETURNS
Pointer to CimArchive, CimModel, or SetSelect.

E XAMPLE
The following example prints the class of object and object selected for validation in the active
project.
import powerfactory
app = [Link]()

cimvalidate = [Link]("ComCimvalidate")
selectedObject = [Link]()
objectClass = [Link]()
[Link]("%s: %s" % (objectClass, selectedObject))

GetModel
This function is deprecated. Please use [Link]() to access to the CIM
model, or CIM object affected by the validation message.
DataObject [Link](int messageIndex)

E XAMPLE
The following example prints the CimModel object for each validation message.
import powerfactory
app = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
for i in range(nMessages):
object = [Link](i)
if [Link]() == "CimModel":

274
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

cimModel = object
else:
cimClassFolder = [Link]()
cimModel = [Link]()
[Link](cimModel)

GetModelId
This function is deprecated. Please use [Link]() to access to the CIM
model, or CIM object affected by the validation message.
str [Link](int messageIndex)

E XAMPLE
The following example prints the ID of the CIM model for each validation message.
import powerfactory
app = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
for i in range(nMessages):
object = [Link](i)
if [Link]() == "CimModel":
modelId = [Link]("resID")
else:
cimClassFolder = [Link]()
model = [Link]()
modelId = [Link]("resID")
[Link](modelId)

GetNumberOfValidationMessages
Returns the number of validation messages generated.
int [Link]()

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 = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
[Link]("Number of validation messages: %d" % nMessages)

275
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetObject
Returns the CimObject object from the selected validation message.
DataObject [Link](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 = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
for i in range(nMessages):
cimObject = [Link](i)
[Link]("%s" % cimObject)

GetObjectId
This function is deprecated. Please use [Link]() to access to the CIM
model, or CIM object affected by the validation message.
str [Link](int messageIndex)

E XAMPLE
The following example prints the object ID for each validation message.
import powerfactory
app = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
for i in range(nMessages):
object = [Link](i);
objectId = [Link]("resID")
[Link](objectId)

GetProfile
Returns the model profile from the selected validation message.
str [Link](int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

276
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
Model profile.

E XAMPLE
The following example prints the profile for each validation message.
import powerfactory
app = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
for i in range(nMessages):
profile = [Link](i)
[Link]("%s" % profile)

GetSeverity
Returns the severity of the selected validation message.
str [Link](int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Message severity.

E XAMPLE
The following example prints the severity for each validation message.
import powerfactory
app = [Link]()

cimvalidate = [Link]("ComCimvalidate")
nMessages = [Link]()
for i in range(nMessages):
severity = [Link](i)
[Link]("%s" % severity)

GetType
This function is deprecated. There is no replacement function offered. Please use ComCimVal-
[Link]() to retrieve the description of the validation message instead.
str [Link](int messageIndex)

277
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.11 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 [Link]()

R ETURNS
0 OK
1 Error: calculation function
2 Error: settings/initialisation/load flow

5.4.12 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 [Link]()

R ETURNS
0 On success.
1 On error.

278
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

CreateRecoveryInformation
Creates recovery information for a contingency. The recovery information can later be retrieved
e.g. via [Link]().
Can only save one contingency at the same time.
int [Link](DataObject resultFileInput)

A RGUMENTS
resultFileInput
Read from this result file.

R ETURNS
0 On success.
1 On error.

GetGeneratorEvent
Gets generator event of a certain time step during recovery.
[Link]() has to be called beforehand to collect the data.
[ DataObject generator,
float changedP,
float changedQ ]
[Link](int currentTimeStep,
int loadEvent)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via [Link]()

switchEvent
Input: Number of generator events for a certain time step are get via ComContin-
[Link]()
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.
[Link]() has to be called beforehand to collect the data.
[ int error,
float interruptedPower,
float newInterruptedPower,
float interruptedCustomers,
float newInterruptedCustomers ]
[Link](float timeOfStageInMinutes)

279
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

R ETURNS
0 On success.
1 On error.

GetInterruptedPowerAndCustomersForTimeStep
Gets recovery information of a contingency.
[Link]() has to be called beforehand to collect the data.
[ float interruptedPower,
float newInterruptedPower,
float interruptedCustomers,
float newInterruptedCustomers ]
[Link](int currentTimeStep)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via [Link]()

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.

280
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetLoadEvent
Gets load event of a certain time step during recovery.
[Link]() has to be called beforehand to collect the data.
[ DataObject load,
float changedP,
float changedQ,
int isTransfer ]
[Link](int currentTimeStep,
int loadEvent)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via [Link]()

switchEvent
Input: Number of load events for a certain time step are get via ComContin-
[Link]()
load (out) Output: Load that is shed or transfered
changedP (out)
Output: Changed active power
changedQ (out)
Output: Changed reactive power
isTransfer (out)
Output: = 0 : is load shedding event. >0 is load transfer event.

GetNumberOfGeneratorEventsForTimeStep
Returns the number of generator events of a certain step during recovery.
[Link]() has to be called beforehand to collect the data.
int [Link]([int currentTimeStep])

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via [Link]()

GetNumberOfLoadEventsForTimeStep
Returns the number of load events of a certain step during recovery.
[Link]() has to be called beforehand to collect the data.
int [Link]([int currentTimeStep])

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via [Link]()

281
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetNumberOfSwitchEventsForTimeStep
Returns the number of switch events of a certain step during recovery.
[Link]() has to be called beforehand to collect the data.
int [Link]([int currentTimeStep])

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via [Link]()

GetNumberOfTimeSteps
Returns the number of time steps during recovery.
[Link]() has to be called beforehand to collect the data.
int [Link]()

GetObj
Gets interrupted element by index (zero based).
DataObject [Link](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.
[Link]() has to be called beforehand to collect the data.
[ DataObject switchToBeActuated,
int isClosed,
int sectionalizingStep ]
[Link](int currentTimeStep,
int switchEvent)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via [Link]()

switchEvent
Input: Number of switch event for a certain time step are get via ComContin-
[Link]()
switchToBeActuated (out)
Output: Switch to be actuated

282
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
[Link]() has to be called beforehand to collect the data.
int [Link](int currentTimeStep)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via [Link]()

GetTotalInterruptedPower
Gets the total interrupted power (in kW) during restoration. [Link]()
has to be called beforehand to collect the data.
float [Link]()

JumpToLastStep
Gets the last trace execution for this contingency.
int [Link]([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 [Link]([float emitMessage])
None [Link](str whichEvents)
None [Link](float emitMessage,
str whichEvents
)
None [Link](str whichEvents,
float emitMessage
)

283
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
0 On success.
1 Error, e.g. Contingency is not in trace.
2 On error.

StopTrace
Stops trace execution for this contingency.
int [Link]([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.13 ComCoordreport
Overview

DevicesToReport
HasResultsForDirectionalBackup
HasResultsForFuse
HasResultsForInstantaneous
HasResultsForNonDirectionalBackup
HasResultsForOverload
HasResultsForOverreach
HasResultsForShortCircuit
HasResultsForZone
MaxZoneNumberFor
ResultForDirectionalBackupVariable
ResultForFuseVariable
ResultForInstantaneousVariable

284
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

ResultForMaxCurrent
ResultForNonDirectionalBackupVariable
ResultForOverloadVariable
ResultForOverreachVariable
ResultForShortCircuitVariable
ResultForZoneVariable
TopologyForDirectionalBackupVariable
TopologyForFuseVariable
TopologyForInstantaneousVariable
TopologyForMaxCurrent
TopologyForNonDirectionalBackupVariable
TopologyForOverloadVariable
TopologyForOverreachVariable
TopologyForShortCircuitVariable
TopologyForZoneVariable
TransferDirectionalBackupResultsTo
TransferNonDirectionalBackupResultsTo
TransferOverreachResultsTo
TransferResultsTo
TransferZoneResultsTo

DevicesToReport
Returns the devices with stored results, i.e. which can be reported.
list [Link]()

R ETURNS
Container with reportable devices.

HasResultsForDirectionalBackup
Checks whether there is a stored directional backup result for the given device.
int [Link](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

[Link](),
[Link](),
[Link]()

HasResultsForFuse
Checks whether there is a stored fuse result for the given device.
int [Link](DataObject device)

285
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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 [Link](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.

S EE ALSO

[Link](),
[Link]()

HasResultsForNonDirectionalBackup
Checks whether there is a stored non-directional backup result for the given device.
int [Link](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

[Link](),
[Link](),
[Link]()

HasResultsForOverload
Checks whether there is a stored overload stage result for the given device.
int [Link](DataObject device)

A RGUMENTS
device Device for which to check.

286
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

[Link](),
[Link]()

HasResultsForOverreach
Checks whether there is a stored overreach zone result for the given device.
int [Link](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.

S EE ALSO

[Link](),
[Link](),
[Link]()

HasResultsForShortCircuit
Checks whether there is a stored short-circuit stage result for the given device.
int [Link](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

[Link](),
[Link]()

HasResultsForZone
Checks whether there is a stored result for the given device and zone number.
int [Link](DataObject device,
int zoneNumber)

287
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

[Link](),
[Link](),
[Link]()

MaxZoneNumberFor
Returns the highest zone number in the stored results for the given device.
int [Link](DataObject device)

A RGUMENTS
device Device for which to retrieve the zone number.

R ETURNS
Highest zone number in the stored results.

ResultForDirectionalBackupVariable
Provides access to the directional backup result for a given device and variable.
[ int error,
float result ] [Link](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.

288
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

[Link](),
[Link](),
[Link]()

ResultForFuseVariable
Provides access to the fuse result for a given device and variable.
[ int error,
float result ] [Link](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.

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

[Link]()

ResultForInstantaneousVariable
Provides access to the instantaneous result for a given device and variable.
[ int error,
float result ] [Link](DataObject device,
str variable)

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

[Link](),
[Link](),
[Link]()

ResultForMaxCurrent
Provides access to the maximum current result for a given device.
[ int error,
float result ] [Link](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.

290
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](),
[Link](),
[Link]()

ResultForNonDirectionalBackupVariable
Provides access to the non-directional backup result for a given device and variable.
[ int error,
float result ] [Link](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

[Link](),
[Link](),
[Link]()

ResultForOverloadVariable
Provides access to the overload result for a given device and variable.
[ int error,
float result ] [Link](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

291
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

[Link](),
[Link](),
[Link]()

ResultForOverreachVariable
Provides access to the overreach result for a given device and variable.
[ int error,
float result ] [Link](DataObject device,
str variable)

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.

292
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](),
[Link](),
[Link]()

ResultForShortCircuitVariable
Provides access to the short-circuit result for a given device and variable.
[ int error,
float result ] [Link](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

[Link](),
[Link](),
[Link]()

ResultForZoneVariable
Provides access to the result for a given device, zone number and variable.
[ int error,
float result ] [Link](DataObject device,
int zoneNumber,
str variable)

293
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.

S EE ALSO

[Link](),
[Link](),
[Link]()

TopologyForDirectionalBackupVariable
Returns the associated directional backup topology for a given device and variable.
list [Link](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.

294
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](),
[Link](),
[Link]()

TopologyForFuseVariable
Returns the associated fuse topology for a given device and variable.
list [Link](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

[Link]()

TopologyForInstantaneousVariable
Returns the associated instantaneous stage topology for a given device and variable.
list [Link](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

[Link](),
[Link](),
[Link]()

TopologyForMaxCurrent
Returns the associated maximum current topology for a given device.
list [Link](DataObject device)

295
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

[Link](),
[Link](),
[Link]()

TopologyForNonDirectionalBackupVariable
Returns the associated non-directional backup topology for a given device and variable.
list [Link](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

[Link](),
[Link](),
[Link]()

TopologyForOverloadVariable
Returns the associated overload stage topology for a given device and variable.
list [Link](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.

296
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](),
[Link](),
[Link]()

TopologyForOverreachVariable
Returns the associated overreach zone topology for a given device and variable.
list [Link](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.

S EE ALSO

[Link](),
[Link](),
[Link]()

TopologyForShortCircuitVariable
Returns the associated short-circuit stage topology for a given device and variable.
list [Link](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.

297
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](),
[Link](),
[Link]()

TopologyForZoneVariable
Returns the associated topology for a given device, zone number and variable.
list [Link](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

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

[Link](),
[Link](),
[Link]()

TransferDirectionalBackupResultsTo
Transfers the results of the directional backup for the given variables to the device.
int [Link](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

298
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

S EE ALSO

[Link](),
[Link](),
[Link]()

TransferNonDirectionalBackupResultsTo
Transfers the results of the non-directional backup for the given variables to the device.
int [Link](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

[Link](),
[Link](),
[Link]()

TransferOverreachResultsTo
Transfers the results of the overreach zone for the given variables to the device.
int [Link](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

299
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

S EE ALSO

[Link](),
[Link](),
[Link]()

TransferResultsTo
Transfers the results for the given variables to one or more devices.
int [Link](DataObject device,
str variables)

int [Link](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
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 [Link](DataObject device,
int zoneNumber,
str variables)

300
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

[Link](),
[Link](),
[Link]()

5.4.14 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 [Link]()

R ETURNS
0 on success, 1 otherwise.

301
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.15 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 [Link]()

5.4.16 ComDpl
Overview

CheckSyntax
Encrypt
Execute
GetExternalObject
GetInputParameterDouble
GetInputParameterInt
GetInputParameterString
IsEncrypted
ResetThirdPartyModule
SetExternalObject
SetInputParameterDouble
SetInputParameterInt
SetInputParameterString
SetThirdPartyModule

CheckSyntax
Checks the syntax and input parameter of the DPL script and all its subscripts.
int [Link]()

R ETURNS
0 On success.
1 On error.

S EE ALSO

[Link]()

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 [Link]([str password = ""],
[int removeObjectHistory = 1],
[int masterCode = 0])

302
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

[Link]()

Execute
Executes the DPL script as subscript.
int [Link]([input parameter])

A RGUMENTS
input parameter (optional)
All input parameter from the ’Basic Options’ page of the ’Edit’ dialog can be given
as arguments. If a parameter is not given then the value from the dialog is used.
The values from the dialog itself are not modified. These can be modified via
• [Link]()
• [Link]()
• [Link]().
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 [Link]() the following values are returned:

0 On a successful execution.
1 An error occurred.
6 User hit the break button.

303
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

GetExternalObject
Gets the external object defined in the ComDpl edit dialog.
[int error,
DataObject value] [Link](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

[Link](), [Link](), [Link](),

[Link]()

GetInputParameterDouble
Gets the double input parameter value defined in the ComDpl edit dialog.
[int error,
float value] [Link](str name)

A RGUMENTS
name Name of the double input parameter.
value (out)
Value of the double input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

[Link](), [Link](), [Link](),

[Link]()

GetInputParameterInt
Gets the integer input parameter value defined in the ComDpl edit dialog.
[int error,
int value ] [Link](str name)

304
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

[Link](), [Link](), [Link](),

[Link]()

GetInputParameterString
Gets the string input parameter value defined in the ComDpl edit dialog.
[int error,
str value ] [Link](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

[Link](), [Link](), [Link](),

[Link]()

IsEncrypted
Returns the encryption state of the script.
int [Link]()

R ETURNS
1 Script is encrypted.
0 Script is not encrypted.

S EE ALSO

[Link]()

305
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

ResetThirdPartyModule
Resets the third party licence. Only possible for non-encrypted scripts. Requires masterkey
licence for third party module currently set.
int [Link]()

R ETURNS
0 On success.
1 On error.

SetExternalObject
Sets the external object defined in the ComDpl edit dialog.
int [Link](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

[Link](), [Link](), [Link](),

[Link]()

SetInputParameterDouble
Sets the double input parameter value defined in the ComDpl edit dialog.
int [Link](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

[Link](), [Link](), [Link](),

[Link]()

306
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetInputParameterInt
Sets the integer input parameter value defined in the ComDpl edit dialog.
int [Link](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

[Link](), [Link](), [Link](),

[Link]()

SetInputParameterString
Sets the string input parameter value defined in the ComDpl edit dialog.
int [Link](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

[Link](), [Link](), [Link](),

[Link]()

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 [Link](str companyCode,
str moduleCode
)

307
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

Execute

Execute
Calculates the short- and long-term flicker according to IEC 61000-4-15.
int [Link]()

R ETURNS
0 OK
1 Error: column not found in file; other internal errors
2 Error: empty input file
3 Error: cannot open file
4 Internal error: matrix empty

5.4.18 ComGenrelinc
Overview

GetCurrentIteration
GetMaxNumIterations

GetCurrentIteration
The command returns the current iteration number of the ’Run Generation Adequacy’ command
(ComGenrel).
int [Link]()

R ETURNS
Returns the current iteration number.

308
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetMaxNumIterations
The command returns the maximume number of iterations specified in the ’Run Generation
Adequacy’ command (ComGenrel).
int [Link]()

R ETURNS
Returns the maximum number of iterations.

5.4.19 ComGridtocim
Overview

AssignCimRdfIds
ConvertAndExport
SetAuthorityUri
SetBoundaries
SetGridsToExport

AssignCimRdfIds
Assigns CIM RDF IDs for all PowerFactory objects in the active project.
int [Link]()

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 = [Link]()

gridtocim = [Link]("ComGridtocim")
result = [Link]()
if result == 0:
[Link]("CIM RDF IDs are successfully assigned.")
elif result == 1:
[Link]("The active project was not found.")
elif result == 2:
[Link]("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 [Link]([int validate])
int [Link](str filePath,
[int validate])

309
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 = [Link]()

gridtocim = [Link]("ComGridtocim")
error = [Link]("e:\[Link]", 1)
if error == 0:
[Link]("OK")
elif error == 1:
[Link]("Error: conversion failed")
else:
[Link]("Error: export failed")

SetAuthorityUri
Sets the authority uri for a specific grid.
None [Link](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 = [Link]()

project = [Link]()
grids = [Link]("*.ElmNet", 1)
gridtocim = [Link]("ComGridtocim")
for grid in grids:
[Link](grid, "testUri")

310
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetBoundaries
Sets ”Fictitious border grid” parameter on the grids.
None [Link](list grids)

A RGUMENTS
grids The grids to be set as boundary.

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 = [Link]()

script = [Link]()
[error, grid] = [Link]("grid")
boundaries = [grid] # create a list of boundary grids
gridtocim = [Link]("ComGridtocim")
[Link](boundaries)

SetGridsToExport
Sets the grids as ”Selected” and clears any previous setting.
None [Link](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 = [Link]()

project = [Link]()
gridsToExport = []
grids = [Link]("*.ElmNet", 1)
for grid in grids:
if [Link]("fictborder") == 0:
[Link](grid)

gridtocim = [Link]("ComGridtocim")
[Link](gridsToExport)

311
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.20 ComHostcap
Overview

CalcMaxHostedPower

CalcMaxHostedPower
The function executes predefined hosting capacty analysis command and returns the max.
hosted power (P, Q) at the given terminal. In addition, object where the violation has occured is
returned.
[int returnValue,
float P,
float Q,
violatedElement ] [Link](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.

5.4.21 ComImport
Overview

GetCreatedObjects
GetModifiedObjects

GetCreatedObjects
Returns the newly created objects after execution of a DGS import.
list [Link]()

R ETURNS
Collection of objects that have been created during DGS import.

312
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetModifiedObjects
Returns the modified objects after execution of a DGS import.
list [Link]()

R ETURNS
Collection of objects that have been modified during DGS import.

5.4.22 ComInc
Overview

CompileDynamicModelTypes
ZeroDerivative

CompileDynamicModelTypes
Compile automatically all relevant dynamic model types.
int [Link]([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.

313
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 [Link]()

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.23 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 [Link]()

R ETURNS
Always return 1.

DoNotResetCalc
The load flow results will not be reset even the load flow calculation fails.
int [Link](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.

314
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 [Link](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 [Link]()

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 [Link]()

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 [Link]()

315
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 [Link]()

R ETURNS
0 Is an AC method.
1 Is a DC method.

PrintCheckResults
Shows the verification report in the output window.
int [Link]()

R ETURNS
Always return 1.

SetOldDistributeLoadMode
Set the old scaling mode in case of Distributed Slack by loads.
None [Link](int iOldMode)

A RGUMENTS
iOldMode The flag showing if the old model is used.
0 Use standard mode.
1 Use old mode.

5.4.24 ComLink
Overview

LoadMicroSCADAFile
ReceiveData
SendData
SentDataStatus
SetOPCReceiveQuality
SetSwitchShcEventMode

316
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

LoadMicroSCADAFile
Reads in a MicroSCADA snapshot file.
int [Link](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 [Link]([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 [Link]([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

317
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SentDataStatus
Outputs status of all items marked for sending to output window.
int [Link]()

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 [Link](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 [Link](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.25 ComMerge
Overview

CheckAssignments
Compare
CompareActive
CompareRecording
ExecuteRecording
ExecuteWithActiveProject
GetCorrespondingObject
GetModification
GetModificationResult
GetModifiedObjects
Merge
PrintComparisonReport
PrintModifications

318
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 [Link]()

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 [Link]()

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 [Link]()

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 [Link]()

319
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 [Link]()

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 [Link]()

GetCorrespondingObject
Searches corresponding object for given object.
DataObject [Link](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.

320
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetModification
Gets kind of modification between corresponding objects of “Base” and “1st” or “2nd”.
int [Link](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 [Link](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 [Link](int modType,
[int modSource]
)

A RGUMENTS
modType
1 get unmodified objects
2 get modified objects

321
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 [Link](int printReport)

A RGUMENTS
printReport
1 print merge report (default)
0 do not print merge report
always set to 0 in paste and split mode

PrintComparisonReport
Prints the modifications of all compared objects as a report to the output window.
None [Link](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 [Link](list objs)
int [Link](DataObject obj)

A RGUMENTS
objs Set of objects for which the modifications are printed.
obj Object for which the modifications are printed.

322
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 [Link]()

SetAutoAssignmentForAll
Sets the assignment of all compared objects automatically.
None [Link](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 [Link](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 [Link]()

323
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 [Link]()

R ETURNS
0 All objects in comparison are equal.
1 Modifications found in comparison.

5.4.26 ComMot
Overview

GetMotorConnections
GetMotorSwitch
GetMotorTerminal

GetMotorConnections
Finds the cables connecting the motor to the switch.
list [Link](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 [Link](DataObject motor)

A RGUMENTS
motor The motor element

R ETURNS
Returns the switch element.

324
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetMotorTerminal
Finds the terminal to which the motor will be connected.
DataObject [Link](DataObject motor)

A RGUMENTS
motor The motor element

R ETURNS
Returns the terminal element.

5.4.27 ComNmink
Overview

AddRef
Clear
GenerateContingenciesForAnalysis
GetAll

AddRef
Adds shortcuts to the objects to the existing selection.
None [Link](DataObject O)
None [Link](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 [Link]()

GenerateContingenciesForAnalysis
Generates Contingencies for Contingency Analysis. Similar to calling ’Execute’ but does not
pop-up the contingency command.
int [Link]()

R ETURNS
0 On success.
1 On error.

325
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetAll
Returns all objects which are of the class 'ClassName'.
list [Link](str className)

A RGUMENTS
className
The object class name.

R ETURNS
The set of objects

5.4.28 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 [Link]()

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 [Link](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.

326
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 [Link](DataObject feeder)

A RGUMENTS
feeder Feeder to derive number of regions(pockets) for.

R ETURNS
Number of regions(pockets) for the feeder.

5.4.29 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 [Link]([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 [Link]([int force])

A RGUMENTS
force (optional)
1 Forces (synchronous) reading and processing of all values (independet
of value changes)

327
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 [Link]([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.30 ComOutage
Overview

ContinueTrace
ExecuteTime
GetObject
RemoveEvents
SetObjs
StartTrace
StopTrace

ContinueTrace
Continue the next step of the trace.
int [Link]()

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

ExecuteTime
Execute contingency (with multiple time phase) for the given time.
int [Link](float time)

A RGUMENTS
time the given time to be executed.

R ETURNS
=0 On success.

328
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 [Link](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 [Link] ([int info])
None [Link] (str type)
None [Link] (int info, str type)
None [Link] (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 [Link](list S)

A RGUMENTS
S the set of objects

R ETURNS
0 On success.
1 On error.

329
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

StartTrace
Start trace all post fault events of this contingency.
int [Link]()

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

StopTrace
To stop the trace.
int [Link]([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.31 ComPfdimport
Overview

GetImportedObjects

GetImportedObjects
Returns the imported objects of last execution of command.
list [Link]()

R ETURNS
Returns the imported objects of the last execution of the command.

330
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.32 ComPrjconnector
Overview

GetSuccesfullyConnectedItems
GetUnsuccesfullyConnectedItems

GetSuccesfullyConnectedItems
Returns a list of elements which were correctly processed in the last run of the command
list [Link]()

GetUnsuccesfullyConnectedItems
Returns a list of elements which were not correctly processed in the last run of the command
list [Link]()

5.4.33 ComProtgraphic
Overview

AddToUpdatePages
ClearUpdatePages

AddToUpdatePages
Adds pages (*.SetVipage) to the user-defined selection of plot pages to update.
None [Link](list pages)

ClearUpdatePages
Clears the user-defined selection of plot pages to update.
None [Link]()

5.4.34 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 [Link](DataObject resultfile)

331
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.35 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] [Link](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

[Link](), [Link](),
[Link](), [Link]()

GetInputParameterDouble
Gets the double input parameter value defined in the ComPython edit dialog.
[int error,
float value] [Link](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.

332
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link](),
[Link](), [Link]()

GetInputParameterInt
Gets the integer input parameter value defined in the ComPython edit dialog.
[int error,
int value ] [Link](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

[Link](), [Link](),
[Link](), [Link]()

GetInputParameterString
Gets the string input parameter value defined in the ComPython edit dialog.
[int error,
str value ] [Link](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

[Link](), [Link](),
[Link](), [Link]()

SetExternalObject
Sets the external object defined in the ComPython edit dialog.
int [Link](str name,
DataObject value
)

333
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

[Link](), [Link](),
[Link](), [Link]()

SetInputParameterDouble
Sets the double input parameter value defined in the ComPython edit dialog.
int [Link](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

[Link](), [Link](),
[Link](), [Link]()

SetInputParameterInt
Sets the integer input parameter value defined in the ComPython edit dialog.
int [Link](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.

334
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link](),
[Link](), [Link]()

SetInputParameterString
Sets the string input parameter value defined in the ComPython edit dialog.
int [Link](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

[Link](), [Link](),
[Link](), [Link]()

5.4.36 ComRed
Overview

LdfEquivalentVerification
ReductionInMemory
ResetReductionInMemory
SimEquivalentVerification

LdfEquivalentVerification
Right after Network Reduction execution, get the verification results of the load flow equivalents.
int [Link]()

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.

335
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 [Link]()

R ETURNS
Returns 0 if successfully executed.

ResetReductionInMemory
Restore the network back to original after reduction in memory.
void [Link]()

SimEquivalentVerification
Right after Network Reduction execution, get the verification results of the dynamic simulation
equivalents.
int [Link]()

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.37 ComRel3
Overview

AnalyseElmRes
ExeEvt
OvlAlleviate
RemoveEvents
RemoveOutages
ValidateConstraints

AnalyseElmRes
Evaluate the results object created by the last calculation.
int [Link]([int error])

A RGUMENTS
error (optional)
0 do not display an error message (default)
1 display error messages in case of errors

336
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

ExeEvt
Executes a given event.
None [Link]([DataObject event])

A RGUMENTS
event The event that shall be executed.

OvlAlleviate
Performs an overload alleviation for given events.
int [Link]([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 [Link]()

RemoveOutages
Removes all contingency definitions (*.ComContingencies) stored inside the reliability com-
mand.
None [Link]([int msg])

A RGUMENTS
msg( optional)
1 Show info message in output window (default value).
0 Do not emit messages.

337
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 [Link](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.38 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 [Link]([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 [Link](int componentNr,
str indice)

338
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.39 ComRelreport
Overview

GetContingencies
GetContributionOfComponent

GetContingencies
Gets all contingencies of reliability for reporting.
list [Link]()

R ETURNS
All contingencies of reliability for reporting.

GetContributionOfComponent
Is described in [Link]().
float [Link](int componentNr,
str indice)

5.4.40 ComReltabreport
Overview

GetContingencies
GetContributionOfComponent

339
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetContingencies
Gets all contingencies of reliability for reporting.
list [Link]()

R ETURNS
All contingencies of reliability for reporting.

GetContributionOfComponent
Is described in [Link]().
float [Link](int componentNr,
str indice)

5.4.41 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 [Link](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.

340
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 [Link](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.42 ComRes
Overview

ExportFullRange
FileNmResNm

ExportFullRange
Executes the export command for the whole data range.
None [Link]()

FileNmResNm
Sets the filename for the data export to the name of the result object being exported (classes:
ElmRes, IntComtrade)
None [Link]()

341
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.43 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 [Link]()
int [Link](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 [Link]()

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

342
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetOverLoadedBranches
Get overloaded branches after a short-circuit calculation.
[int error,
list branches] [Link](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] [Link](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

343
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.44 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 [Link](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 [Link]()

R ETURNS
0 No error occurred, trace is complete.
!=0 An error occurred, calculation was reset.

S EE ALSO

[Link]()

ExecuteInitialStep
Executes the first step of the short circuit trace.
int [Link]()

344
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 [Link]()

R ETURNS
0 No error occurred, step was executed .
!=0 An error occurred, calculation was reset.

S EE ALSO

[Link]()

GetBlockedSwitches
Returns all switches which are currently blocked.
list [Link]()

R ETURNS
All blocked switches.

GetCurrentTimeStep
Returns the current time step of the trace in seconds.
int [Link]()

R ETURNS
The current time step in [s].

GetDeviceSwitches
Returns all switches operated by a protection device.
list [Link](DataObject device)

A RGUMENTS
device Protection device to get the switches for.

R ETURNS
All switches devices operated by the protection device.

345
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetDeviceTime
Returns the time a protection device operated or will operate at.
int [Link](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 [Link]()

R ETURNS
All protection devices which are not started.

GetStartedDevices
Returns all started but not yet tripped protection devices.
list [Link]()

R ETURNS
All started but not yet tripped protection devices.

GetSwitchTime
Returns the time a switch device operated or will operate at.
int [Link](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 [Link]()

346
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 [Link]()

R ETURNS
0 Next step is not available, the trace is completed.
1 A next step is available.

5.4.45 ComSim
Overview

GetSimulationTime
GetTotalWarnA
GetTotalWarnB
GetTotalWarnC
GetViolatedScanModules
LoadSnapshot
SaveSnapshot

GetSimulationTime
Get the actual simulation time if the initial conditions are calculated.
int [Link]()

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 [Link]()

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 [Link]()

347
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 [Link]()

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 [Link]()

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 [Link]([string snapshotFilePath], [int suppressUserMessage])

D EPRECATED N AMES
LoadSimulationState

A RGUMENTS
snapshotFilePath (optional)
The snapshot file to load. If no file is specified, the last snapshot stored in the
memory is used. (default = ”)
suppressUserMessage (optional)
The pop-up window asking for data overwrite is not displayed if this value is set to
1. (default = 0)

R ETURNS
0 Saved simulation state has been loaded.
1 Saved simulation state cannot be loaded.
2 Saved simulation state does not match actual model. Calculation will be reset.

SaveSnapshot
Save the state of a dynamic simulation to memory and to a file.
int [Link](string snapshotFilePath, [int suppressUserMessage])

348
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.46 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 [Link](DataObject O,
[str name]
)

A RGUMENTS
O The ComOutage object
name A name for the outage

R ETURNS
0 On success.

349
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 [Link]()

AddRas
Adds a reference to a given IntRas to the ComSimoutage.
int [Link](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 [Link]()

R ETURNS
0 On success.
1 On error.

CreateFaultCase
Create fault cases from the given elements.
int [Link](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).

350
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 [Link]()

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 [Link]([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

351
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 [Link](int number)

A RGUMENTS
number The number of elements to be found.
elements (out)
The top loaded elements.

352
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 [Link](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 [Link]()

RemoveContingencies
Removes all contingencies from the command. Functionality as ”Remove All” button in dialog.
None [Link]()

RemoveRas
Removes the reference to a given IntRas from the ComSimoutage.
int [Link](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 [Link]()

R ETURNS
0 On success.
1 On error.

353
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetLimits
Sets the recording limits for the Contingency Analysis.
None [Link](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 [Link]()

R ETURNS
0 On success.
1 On error.

5.4.47 ComSvgexport
Overview

SetFileName
SetObject
SetObjects

SetFileName
Sets SVG file for export.
None [Link](str path)

A RGUMENTS
path Path of target SVG file

SetObject
Sets annotation layer or group for export.
None [Link](DataObject obj)

A RGUMENTS
obj Annotation layer (IntGrflayer) or group (IntGrfgroup) to be exported

354
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetObjects
Sets annotation layers and groups for export.
None [Link](set objs)

A RGUMENTS
objs Set of annotation layers (IntGrflayer) and/or groups (IntGrfgroup) to be exported

5.4.48 ComSvgimport
Overview

SetFileName
SetObject

SetFileName
Sets source SVG file for import.
None [Link](str path)

A RGUMENTS
path Path of SVG file to be imported

SetObject
Sets target annotation layer or group for import.
None [Link](DataObject obj)

A RGUMENTS
obj Target annotation layer (IntGrflayer) or group (IntGrfgroup)

5.4.49 ComTablereport
Overview

ExportToExcel
ExportToHTML

355
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

ExportToExcel
Exports the report with its current filter settings and sorting to Excel.
None [Link]([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 [Link]([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)

5.4.50 ComTasks
Overview

AppendCommand
AppendStudyCase
GetCommandsForStudyCase
GetNumberOfCommandsForStudyCase
GetNumberOfStudyCases
GetStudyCases
IsAdditionalResultsFlagSetForCommand
IsCommandIgnored
IsStudyCaseIgnored
RemoveCmdsForStudyCaseRow
RemoveCommand
RemoveStudyCase
RemoveStudyCases
SetAdditionalResultsFlagForCommand
SetIgnoreFlagForCommand
SetIgnoreFlagForStudyCase
SetResultsFolder

356
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

AppendCommand
Appends a command for calculation.
int [Link](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 [Link](DataObject studyCase)

R ETURNS
0 Study case could not be added for calculation.
1 Study case has been successfully added for calculation.

A RGUMENTS
studyCase
Study case to add for calculation.

GetCommandsForStudyCase
Get all selected commands to be processed for a study case from the Task Automation com-
mand.
list [Link](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

357
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

≤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 [Link](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.

GetNumberOfStudyCases
Get number of selected study cases from the Task Automation command.
int [Link]()

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 [Link]()

R ETURNS
Returns ordered set of all selected study cases from the Task Automation command, set is
empty on failure.

358
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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 [Link](int studyCaseRow,
int taskRow)
int [Link](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 [Link](int studyCaseRow,
int taskRow)
int [Link](DataObject command)

A RGUMENTS
studyCaseRow ≤ 0
The row in the study cases table of the command’s study case for which the ignore
flag shall be derived.

taskRow > 0
The row in the commands table for which the ignore flag shall be derived.
command
The command to get the ignore-flag for.

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

359
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

IsStudyCaseIgnored
Returns whether the command processing for a study case will be ignored or not.
int [Link](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 [Link](int studyCaseRow)

R ETURNS
0 Commands could not be removed from calculation.
1 All commands of study case row were successfully removed from calculation.

A RGUMENTS
studyCaseRow> 0
The row in the study case table containing the study case for which all commands
shall be removed.

RemoveCommand
Remove a command from the calculation (for study case row and task row / for all appear-
ances).
int [Link](int studyCaseRow,
int taskRow
)
int [Link](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.

360
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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 [Link](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.

RemoveStudyCases
Removes all study cases from calculation.
None [Link]()

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 [Link](int studyCaseRow,
int taskRow,
int addResVal
)
int [Link](DataObject command,
int addResVal
)

361
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 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 [Link](int studyCaseRow,
int taskRow,
int ignoreVal
)
int [Link](DataObject command,
int ignoreVal
)

A RGUMENTS
studyCaseRow> 0
The row in the study cases table of the command’s study case for which the ignore
flag shall be set.
taskRow> 0
The row in the commands table for which the ignore flag shall be set.

command
Command for which the ignore flag shall be set.
ignoreVal
1 Will set the command to be ignored for calculation.
0 Will set the command to be processed for calculation.

R ETURNS
0 Ignore flag could not be set.
1 Ignore flag has been successfully set.

362
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetIgnoreFlagForStudyCase
Set the flag whether to ignore the processing of commands of a study case for the calculation.
int [Link](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 [Link](DataObject folder, int studyCaseRow)

R ETURNS
0 New folder could not be set as results folder for the given row in the study case
table.
1 Folder was successfully set as resuls folder for given row in the study case table.

A RGUMENTS
folder The new folder to store results in.
studyCaseRow
The row in the study case table containing the study case for which results folder
shall be set.

363
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.51 ComTececo
Overview

UpdateTablesByCalcPeriod

UpdateTablesByCalcPeriod
Update all calculation points with respect to a new start- and end year
int [Link](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.52 ComTececocmp
Overview

AppendStudyCase
CalcDiscountedEstimatedPaybackPeriod
CalcEstimatedPaybackPeriod
CalcInternalRateOfReturn
RemoveStudyCases

AppendStudyCase
Appends a study case to the list of study cases.
int [Link](DataObject studyCase, [int isIgnored])

R ETURNS
0 Study case could not be added for calculation.
1 Study case has been successfully added for calculation.

A RGUMENTS
studyCase
Study case to add for calculation.
isIgnored Sets the flag to ignore the study case to add or not.

364
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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] [Link](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] [Link](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).

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.

365
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

[int error,
float irr] [Link](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 [Link]()

5.4.53 ComTransfer
Overview

GetTransferCalcData
IsLastIterationFeasible

GetTransferCalcData
The function returns the calculated transfer capacity and the total number of iteration after the
transfer capacity command has been executed.
[float transferCapacity,
int totalIterations ] [Link]()

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 [Link]()

R ETURNS
1 Last transfer calculation iteration resulted in a feasible solution.
0 Last transfer calculation iteration did not result in a feasible solution.

366
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.54 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 [Link](int enabled)

A RGUMENTS
enabled
0 disables batch mode, all messages are printed to output window (de-
fault).
1 enables batch mode, only error and warning messages are printed to
output window.

5.4.55 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 [Link]([int cacheIndex])

A RGUMENTS
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

367
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 0n error (e.g. load flow calculation failed).

DeleteCompleteQuickAccess
Deletes all quick access caches.
None [Link]()

ExportAndInitQuickAccess
Performs an UCTE export and fills the quick access cache given by the cache index.
None [Link](int cacheIndex)

A RGUMENTS
cacheIndex
Index of the quick access cache (must be greater than or equals to 0)

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 [Link](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 ] [Link](DataObject branch,
[int cacheIndex])

A RGUMENTS
branch Branch to find the UCTE node names from
nodeNameFrom (out)
UCTE node name of start node

368
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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 [Link](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)

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 [Link](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 [Link]([int cacheIndex])

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

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 [Link]([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 [Link]([int cacheIndex])

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 [Link](list gridsToExport)

A RGUMENTS
gridsToExport
Grids (instances of class ElmNet) to be selected for export. All not contained grids
will be de-selected.

370
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.56 ComWktimp
Overview

GetCreatedObjects
GetModifiedObjects

GetCreatedObjects
Returns the newly created objects after execution of a WKT import.
list [Link]()

R ETURNS
Collection of objects that have been created during WKT import.

GetModifiedObjects
Returns the modified objects after execution of a WKT import.
list [Link]()

R ETURNS
Collection of objects that have been modified during WKT import.

5.4.57 ComWr
Overview

ExportGraphicTab

ExportGraphicTab
Exports the selected graphic tab to the specified file.
int [Link](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.

371
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 [Link](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 [Link]()

R ETURNS
The number of clusters.

372
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 [Link](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 [Link](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 [Link](str page)

A RGUMENTS
page
empty for currently valid calculation
set page (see dialog page name table)

373
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 [Link](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)

374
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

375
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

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

377
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 [Link](int modeNumber,
[int page]
)
int [Link](DataObject obj,
[int page]
)

A RGUMENTS
modeNumber
colouring mode number to be set (for numbers see table listed in [Link]())
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)

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

379
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.3 SetDatabase
Overview

EmptyCache

EmptyCache
Empties characteristics cache for this database connection.
None [Link]()

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 [Link](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

[Link](), [Link](), [Link](),

[Link](), [Link](), [Link](), In-
[Link](), [Link](), [Link]()

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 [Link](str classFilter, [str descriptiveName])

380
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

[Link](), [Link](), [Link](),

[Link](), [Link](), [Link](), In-
[Link](), [Link](), [Link]()

GetConfigurations
Returns all IntAddonvars objects by a given classFilter.
list [Link](str classFilter)
list [Link]()

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

[Link](), [Link](), [Link](),

[Link](), [Link](), [Link](), In-
[Link](), [Link](), [Link]()

RemoveAllConfigurations
Removes all IntAddonvars objects effectively removing all Data Extensions.
None [Link]()

RemoveConfiguration
Removes the IntAddonvars object exactly matching classFilter and descriptive name.
None [Link](str classFilter, [str descriptiveName])

A RGUMENTS
classFilter
The class filter of the IntAddonvars object

381
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
0 On success, no error occurred.
1 Otherwise

Show
Displays the diagram page in the desktop.
int [Link]()

R ETURNS
0 On success, no error occurred.
1 Otherwise

5.5.6 SetDesktop
Overview

AddPage
BeginTabGroup
Close
CloseAllTemporaryTabs
DoAutoScaleX
EndTabGroup
Freeze
GetActivePage
GetCanvasSize
GetPage
GetSplitOrientation
GetTabGroups
IsFrozen
IsOpened
OpenScriptInTab
OpenTextFileInTab
RemovePage

382
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link](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.

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 [Link]() 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 [Link]()

E XAMPLE
The following example demonstrates the usage of this method.
import powerfactory

app = [Link]()

# get currently opened desktop

desktop = [Link]()

[Link]()

383
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

# open/create tabs here

tabGroup = [Link]()

# optionally, perform operations on returned tab group

if tabGroup:
[Link](0)

S EE ALSO

[Link]()

Close
Closes the desktop, if it is currently shown.
int [Link]()

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 [Link]()

DoAutoScaleX
Scales the x-axes of all plots in the desktop which use the x-axis scale defined in the desktop.
None [Link]()

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 [Link]()

R ETURNS
The tab group containing all tabs opened after the last [Link]() call or
NULL/None if no tab group or no tabs were opened.

S EE ALSO

[Link]()

384
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Freeze
Enables the graphical freeze mode, preventing changes to open diagrams.
int [Link]()

R ETURNS
0 on success
1 on error

GetActivePage
Returns the page object of the currently shown page.
DataObject [Link]()

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] [Link]()

A RGUMENTS
width (out)
Pixel width of the canvas. -1 if no graphics page is open.
height (out)
Pixel height of the canvas. -1 if no graphics page is open.

R ETURNS
0 on success: canvas size could be determined
1 on error: no graphics page is open

GetPage
Searches, activates and returns a graphics page in the currently open 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 [Link](str name,
[int create,]
[str class]
)

A RGUMENTS
name Name of the page.
create (optional)
Possible values:

385
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link]()

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

[Link]()

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 [Link]([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.

386
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

IsFrozen
Returns whether the graphical freeze mode is currently enabled.
int [Link]()

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 [Link]()

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 [Link](DataObject sourceObject,
str attribute
)

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

[Link]()

387
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link](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

[Link]()

RemovePage
Removes a graphic page. The page to be removed can be identified either by its name or by its
page object.
int [Link](str pageName)
int [Link](DataObject pageObject)

A RGUMENTS
pageName
Name of graphics page.
pageObject
A graphics page object.

R ETURNS
0 on success
1 on error

SetAdaptX
Sets the Adapt Scale option of the x-scale.
None [Link](int mode,
[float trigger]
)

A RGUMENTS
mode Possible values:
0 off
1 on

388
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link](int mode)

A RGUMENTS
mode Possible values:

0 never
1 after simulation
2 during simulation

SetResults
Sets default results object of desktop.
None [Link](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 [Link]()
None [Link](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

389
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

Sets the current split orientation of the main window, see [Link]() for
details on split orientations.
None [Link](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

[Link]()

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 [Link](float left,
float right,
float bottom,
float top)

SetXVar
Sets x-axis variable. If The default x-axis variable (time) is set if no argument is passed.
None [Link]()
None [Link](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 [Link]()
int [Link](str pageName)
int [Link](DataObject pageObject)

390
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
0 on success
1 on error

WriteWMF
Writes the currently open graphic to a windows metafile file (*.wmf).
Please use the Save File command (ComWr) for writing to other formats like *.pdf, *.png, *.svg,
*.emf or *.bmp.
int [Link](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 [Link]()

R ETURNS
0 on success
1 on error

391
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.7 SetDistrstate
Overview

CalcCluster

CalcCluster
Calculates a load flow with a given load distribution state applied.
int [Link](int clusterIndex,
[int messageOn]
)

A RGUMENTS
clusterIndex
The cluster index. Zero based value, the first cluster has index 0.
messageOn (optional)
Possible values:
0 Do not emit a message in the output window.
1 Emit a message in the output window in case that the function does
not execute properly.

R ETURNS
0 if ok. -1 if load flow of cluster did not converge.

5.5.8 SetFilt
Overview

Get

Get
Returns a container with the filtered objects.
list [Link]()

R ETURNS
The set of filtered objects.

392
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.9 SetLevelvis
Overview

AdaptWidth
Align
ChangeFont
ChangeFrameAndWidth
ChangeLayer
ChangeRefPoints
ChangeWidthVisibilityAndColour
Mark
Reset

AdaptWidth
This function resizes the in the object specified group of text boxes regarding their text contents.
None [Link]()

Align
This function aligns the text within a text box.
None [Link](int iPos)

A RGUMENTS
iPos Alignment position
0 left
1 middle
2 right

ChangeFont
This function sets the font number for the specified group of text boxes.
None [Link](int iFont)

A RGUMENTS
iFont Font number (default fonts range from 0 to 13)

ChangeFrameAndWidth
This method is not available anymore. Please use [Link]()
instead.
None [Link]([int iFrame,]
[int iWidth,]
[int iVisibility,]
[int iColour]
)

393
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

ChangeLayer
This function sets the specified group of text boxes to a given layer.
None [Link](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 [Link](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 [Link]([int iWidth,]
[int iVisibility,]
[int iColour]
)

A RGUMENTS
iWidth Sets the width in number of letters
0..n width
iVisibility Sets the visibility

0 not visible
1 visible
iColour Sets the colour
0..255 colour

394
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Mark
Marks the specified group of text boxes in the currently shown diagram.
None [Link]()

Reset
This function resets the individually modified text box settings.
None [Link](int iMode)

A RGUMENTS
iMode
0 Reset to default (changed reference points are not reset)
1 Only font
2 Shift to original layer (result boxes to layer 'Results', object names to
layer 'Object Names')

5.5.10 SetLvscale
Overview

AddCalcRelevantCoincidenceDefinitions

AddCalcRelevantCoincidenceDefinitions
Adds all calculation relevant coincidence definitions.
None [Link]()

5.5.11 SetParalman
Overview

GetNumSlave
SetNumSlave
SetTransfType

GetNumSlave
To get the number of slaves which is currently configured.
int [Link]()

R ETURNS
the number of slaves which is currently configured.

395
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

SetNumSlave
To configue the number of slaves to be used for parallel computing.
int [Link](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 [Link](int viaFile)

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

396
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

AllBreakers
Returns all breakers in the path definition.
list [Link]()

R ETURNS
The set of breakers.

AllClosedBreakers
Returns all closed breakers in the path definition.
list [Link]()

R ETURNS
The set of closed breakers.

AllOpenBreakers
Returns all open breakers in the path definition.
list [Link]()

R ETURNS
The set of open breakers.

AllProtectionDevices
Returns all protection devices in the path definition for a given direction.
list [Link](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 [Link](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.

397
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
The generated graphic page (GrpPage).

GetAll
Returns all objects in the path definition.
list [Link]()

R ETURNS
The set of objects.

GetBranches
Returns all breanches in the path definition.
list [Link]([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 [Link]()

R ETURNS
The set of busbars and terminals.

GetPathFolder
Returns the default folder for storing path objects.
DataObject [Link]([int create])

398
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

GetFontID
Determines the ID for given font. The font is automatically internally registered if it has not been
used before.
int [Link](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 [Link](int sglOrBlock,
int labelResultOrTitle,
int nodesOrBranches,
string fontName,
int fontSize,
int fontStyle)

399
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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
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 [Link]()

R ETURNS
0 Ok, check did not reveal any problems
1 Not ok, check found some problems. See the output window for details.

400
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link]()

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 [Link](DataObject O)
None [Link](list S)

A RGUMENTS
O An object.
S A set of objects.

All
Returns all objects in the selection.
list [Link]()

401
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

R ETURNS
The set of objects

AllAsm
Returns all asynchronous machines in the selection.
list [Link]()

R ETURNS
The set of objects

AllBars
Returns all busbars and terminals in the selection.
list [Link]()

R ETURNS
The set of objects

AllBreakers
Returns all breakers in the selection.
list [Link]()

R ETURNS
The set of objects

AllClosedBreakers
Returns all closed breakers in the selection.
list [Link]()

R ETURNS
The set of objects

AllElm
Returns all elements (Elm*) in the selection.
list [Link]()

R ETURNS
The set of containing objects

402
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

AllLines
Returns all lines and line routes in the selection.
list [Link]()

R ETURNS
The set of objects

AllLoads
Returns all loads in the selection.
list [Link]()

R ETURNS
The set of objects

AllOpenBreakers
Returns all open breakers in the selection.
list [Link]()

R ETURNS
The set of objects

AllSym
Returns all synchronous machines in the selection.
list [Link]()

R ETURNS
The set of objects

AllTypLne
Returns all line types in the selection.
list [Link]()

R ETURNS
The set of objects

Clear
Clears (deletes) the selection.
None [Link]()

403
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

GetAll
Returns all objects in the selection which are of the class 'ClassName'.
list [Link](str ClassName)

A RGUMENTS
ClassName
The object class name.

R ETURNS
The set of objects

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 [Link]()

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

Closes all tabs in the tab group, effectively closing the complete tab group.
None [Link]()

S EE ALSO

[Link]()

404
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

Closes the specified tab.

None [Link](int tabIndex)

A RGUMENTS
tabIndex The index of the desired tab in the group. The first tab always has index 0.

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 [Link]([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 table 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 table
report objects and are automatically adapted to avoid overwritting existing files.
int [Link](int format,
[str folderPath]
)

405
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

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

Returns the number of tabs in this tab group.

int [Link]()

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 [Link](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 Table 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.

406
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

Returns the title of the tab at the given index.

str [Link](int tabIndex)

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 [Link](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 Table 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 [Link]()

R ETURNS
The state of the group:

0 The group is open.

1 The group is closed.

407
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

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 [Link]()

R ETURNS
The location of the group:

0 The group is floating.

1 The group is docked to the main window.

S EE ALSO

[Link](), [Link]()

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 [Link](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 [Link](DataObject otherTabGroup)

A RGUMENTS
otherTabGroup
The tab group (SetTabgroup) the tabs should be moved to.

408
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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

Moves the specified tab to a new group docked in the main window.
DataObject [Link](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.

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

Moves the specified tab to a new floating group.

DataObject [Link](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 [Link]()

S EE ALSO

[Link](), [Link]()

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 [Link]()

S EE ALSO

[Link](), [Link]()

409
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 [Link]()

R ETURNS
0 No errors found.
1 Errors found.

GetAvailableButtons
Gets buttons available for selected tool bar.
str [Link]()

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 [Link]()

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 [Link]()

R ETURNS
0 No problems found.
1 Configuration was adapted.

410
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 [Link](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
SetTime
SetTimeUTC
Time

Date
Sets date component to current system date.
None [Link]()

S EE ALSO

[Link](), [Link]()

SetTime
Sets the time in the current year. There is no restriction to the values for H, M and S, except
for the fact that negative values are interpreted as zero. Values higher than 24 or 60 will be
processed normally by adding the hours, minutes and seconds into an absolute time, from
which a new hour-of-year, hour-of-day, minutes and seconds are calculated.
None [Link](float H,
[float M,]
[float S]
)

A RGUMENTS
H The hours
M (optional)
The minutes

S (optional)
The seconds

411
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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 [Link](int time)

A RGUMENTS
time UTC time in seconds since 01.01.1970 00:00 GMT

S EE ALSO

[Link](), [Link]()

Time
Sets time component to current system time.
None [Link]()

S EE ALSO

[Link](), [Link]()

5.5.19 SetUser
Overview

GetNumProcesses

GetNumProcesses
This function returns the actual number of processes for parallel computation.
int [Link]()

R ETURNS
The actual number of processes for parallel computation.

5.5.20 SetVipage
Overview

Close
DoAutoScaleX
DoAutoScaleY
GetOrInsertPlot
InsertPlot
MigratePage
SetAdaptX
SetAutoScaleX
SetResults
SetScaleX
SetStyle

412
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

SetTile
SetXVar
Show

Close
Closes the graphic page, if currently shown, and deletes it from the database.
int [Link]()

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 [Link]()

DoAutoScaleY
Scales the y-axes of all plots on the virtual instrument panel automatically.
None [Link]()

GetOrInsertPlot
Get or create a virtual instrument of the virtual instrument panel.
DataObject [Link] (str name,
[str class,]
[int create]
)

D EPRECATED N AMES
GetVI

A RGUMENTS
name Name of virtual instrument

class='VisPlot' (optional)
classname of virtual instrument.
create (optional)
Possible values:
0 do not create new virtual instrument
1 create virtual instrument if it does not exist already

R ETURNS
Virtual instrument

413
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

InsertPlot
Creates a copy of the virtual instrument passed and displays the copy on this panel.
DataObject [Link](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 [Link]() to make it visible.

None [Link]()

R ETURNS
The migrated plot page (GrpPage)

SetAdaptX
Sets the Adapt Scale option of the x-scale.
None [Link](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 [Link](int mode)

414
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

SetResults
Sets default results object of virtual instrument panel.
None [Link](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 [Link]()
None [Link](float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

SetStyle
Sets style of virtual instrument panel. A warning message is issued in the case that a style with
the given name does not exist.
None [Link](str name)

415
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
name Style Name

SetTile
Rearranges the virtual instrument on the panel.
None [Link]([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 [Link]()
None [Link](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 [Link]()

R ETURNS
0 On success, no error occurred.
1 Otherwise

416
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6 Others

5.6.1 BlkDef
Overview

Check
Compile
Encrypt
GetCheckSum
Pack
PackAsMacro
ResetThirdPartyModule
SetThirdPartyModule

Check
Verify the DSL model equations.
int [Link]()

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 [Link]([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 [Link]([int removeObjectHistory])

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.

417
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 On error.

S EE ALSO

[Link]()

GetCheckSum
str [Link]()

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 [Link]()

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 [Link]()

R ETURNS
0 On success.
1 On error.

S EE ALSO

[Link]()

ResetThirdPartyModule
Resets the third party licence. Only possible for non-encrypted, non-compiled blocks. Requires
masterkey licence for third party module currently set.
int [Link]()

418
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]()

R ETURNS
The name of the output from which the signal is connected. In cases of no connection, an
empty string.

GetToSigName
str [Link]()

R ETURNS
The name of the input to which the signal is connected. In cases of no connection, an empty
string.

419
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.3 ChaVecfile
Overview

Update

Update
Reloads the file from disk. Same behaviour like button update.
int [Link]([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 [Link]()

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 = [Link]()

script = [Link]()
[error, archive] = [Link]("archive")
[Link]();

420
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](str parameter, int index)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”[Link]”)
index Index of the parameter

E XAMPLE
This example deletes the ”[Link]” parameter of the CimModel at index 1. The Cim-
Model is selected in the model variable in External objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, model] = [Link]("model")
[Link]("[Link]", 1)

GetAttributeEnumerationType
Returns the enumeration type of the attribute.
str [Link](str attribute)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”[Link]”)

421
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetModelsReferencingThis
Returns all CIM models (CimModel) that reference the calling model.
list [Link]()

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 = [Link]()

script = [Link]()
[error, model] = [Link]("model")
cimModels = [Link]()
for cimModel in cimModels:
[Link]([Link]("[Link]"))

GetParameterCount
Returns the number of parameters (attribute, or association) of given type.
int [Link](str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”[Link]”)

E XAMPLE
This example prints the ”[Link]” attributes for all CIM models from the active project.
import powerfactory
app = [Link]()

project = [Link]()
cimModels = [Link]("*.CimModel", 1)
for cimModel in cimModels :
nProfiles = [Link]("[Link]")
[Link]("Model %s has %d profiles" % (cimModel, nProfiles))
for i in range(nProfiles):
profile = [Link]("[Link]", i)
[Link]("Profile:%d = %s" % (i, profile))

GetParameterNamespace
Returns the namesace of the parameter (attribute, or association).
str [Link](str parameter)

422
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”[Link]”)

E XAMPLE
This example prints the namespace of the ”[Link]” parameter for the CimModel that
is selected in the model variable in External objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, model] = [Link]("model")
namespace = [Link]("[Link]")
[Link](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 [Link](str parameter, [int index])

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”[Link]”)
index Index of the parameter:
0 Default index

E XAMPLE
This example prints the ”[Link]” parameter for a CimModel. The Cim-
Model is selected in the model variable in External objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, model] = [Link]("model")
[Link]([Link]("[Link]"))

HasParameter
Checks whether the CimModel has the parameter (attribute, or association) specified.
int [Link](str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”[Link]”)

423
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
1 if parameter is specified
0 if parameter is not specified

E XAMPLE
This example checks if a selected CimModel contains the ”[Link]” parameter.
The CimModel is selected in the model variable in External objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, model] = [Link]("model")
hasParameter = [Link]("[Link]")
if hasParameter == 1:
[Link]("Parameter exists.")
else:
[Link]("Parameter does not exist.")

RemoveParameter
Removes all occurrences of the parameter (attribute, or association).
None [Link](str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”[Link]”)

E XAMPLE
This example removes the ”[Link]” parameter from all CIM models from the
active project.
import powerfactory
app = [Link]()

project = [Link]()
cimModels = [Link]("*.CimModel", 1)
for cimModel in cimModels :
[Link]("[Link]")

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 [Link](str association,
str value,
[int index])

A RGUMENTS
association
Full-name specifier of the association (e.g. ”[Link]”)

424
5.6. OTHERS CHAPTER 5. OBJECT METHODS

value Value of the association

index Index of the association:
0 Default index

E XAMPLE
This example sets the ”[Link]” parameter at index 1 for a selected CimModel.
The CimModel is selected in the model variable in External Objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, model] = [Link]("model")
dependentOnId = "21df3d4d-3f82-4998-be21-772e3d2d573f"
[Link]("[Link]", 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 [Link](str association,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the association (e.g. ”[Link]”)
value Value of the association
nspace Namespace of the association (e.g. ”md”)

E XAMPLE
This example sets the ”[Link]” parameter for a selected CimModel. The Cim-
Model is selected in the model variable in External objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, model] = [Link]("model")
dependentOnId = "21df3d4d-3f82-4998-be21-772e3d2d573f"
[Link]("[Link]", dependentOnId, "md")

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 [Link](str attribute,
str enumerationType,
str value)

425
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”[Link]”)
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 [Link](str attribute,
str enumerationType,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”[Link]”)
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 [Link](str attribute,
str value,
[int index])

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”[Link]”)
value Value of the attribute
index Index of the attribute:
0 Default index

E XAMPLE
This example sets the ”[Link]” parameter at index 2 for a selected CimModel. The
CimModel is selected in the equipmentModel variable in External objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, equipmentModel] = [Link]("equipmentModel")
equipmentShortCircuit = "[Link]
[Link]("[Link]", equipmentShortCircuit, 2)

426
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](str attribute,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”[Link]”)
value Value of the attribute
nspace Namespace of the attribute (e.g. ”md”)

E XAMPLE
This example sets the ”[Link]” parameter for all CIM models from the
active project.
import powerfactory
app = [Link]()

project = [Link]()
cimModels = [Link]("*.CimModel", 1)
for cimModel in cimModels :
[Link]("[Link]", "mas", "md")

5.6.6 CimObject
Overview

DeleteParameterAtIndex
GetAttributeEnumerationType
GetObjectsReferencingThis
GetObjectsWithSameId
GetParameterCount
GetParameterNamespace
GetParameterValue
GetPfObjects
HasParameter
RemoveParameter
SetAssociationValue
SetAssociationValue
SetAttributeEnumeration
SetAttributeEnumeration
SetAttributeValue
SetAttributeValue

427
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DeleteParameterAtIndex
Removes the parameter (attribute, or association) value at the given index.
None [Link](str parameter, int index)

A RGUMENTS
parameter
Full-name of the attribute, or association (e.g. ”[Link]”)
index Index of the parameter

E XAMPLE
This example removes all ”[Link]” parameters values from all
”TopologicalIsland” CIM objects in the active project.
import powerfactory
app = [Link]()

project = [Link]()
topoNodesParameter = "[Link]"
cimObjects = [Link]("*.CimObject", 1)
for cimObject in cimObjects :
if [Link]("cimClass") == "TopologicalIsland":
nNodes = [Link](topoNodesParameter)
[Link]("TP-island %s has %d TP-nodes" % (cimObject, nNodes))
for i in range(nNodes, -1, -1):
[Link](topoNodesParameter, i)

GetAttributeEnumerationType
Returns the enumeration type of the attribute.
str [Link](str attribute)

A RGUMENTS
attribute Full-name of the attribute (e.g. ”[Link]”)

E XAMPLE
This example prints the enumeration type of the ”[Link]”
attribute of a ”SynchronousMachine” CimObject. The CimObject is selected in the cimObject
variable in External Objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, cimObject] = [Link]("cimObject")
attributeName = "[Link]"
[Link]([Link](attributeName))

428
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 = [Link]()

script = [Link]()
[error, machine] = [Link]("machine")
cimObjects = [Link]()
for cimObject in cimObjects:
[Link](cimObject)

GetObjectsWithSameId
Returns all CIM objects (CimObject) that have the same Resource ID as this object.
list [Link]()

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 = [Link]()

script = [Link]()
[error, machine] = [Link]("machine")
cimObjects = [Link]()
for cimObject in cimObjects:
[Link](cimObject)

GetParameterCount
Returns the number of parameters (attribute, or association) of given type.
int [Link](str parameter)

429
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
parameter
Full-name of the attribute, or association (e.g. ”[Link]”)

E XAMPLE
This example prints the IDs of all ”TopologicalNode” CIM objects from all ”TopologicalIsland”
CIM objects in the active project.
import powerfactory
app = [Link]()

project = [Link]()
topoNodesParameter = "[Link]"
cimObjects = [Link]("*.CimObject", 1)
for cimObject in cimObjects :
if [Link]("cimClass") == "TopologicalIsland":
nNodes = [Link](topoNodesParameter)
[Link]("TP-island %s has %d TP-nodes" % (cimObject, nNodes))
for i in range(nNodes):
nodeId = [Link](topoNodesParameter, i)
[Link]("CIM RDF ID of TP-node %d is: %s" % (i, nodeId))

GetParameterNamespace
Returns the namesace of the parameter (attribute, or association).
str [Link](str parameter)

A RGUMENTS
parameter
Full-name of the attribute, or association (e.g. ”[Link]”)

E XAMPLE
This example prints the namespace of the ”[Link]” parameter of a CimObject.
The CimObject is selected in the acLineSegment variable in External Objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, acLineSegment] = [Link]("acLineSegment")
[Link]([Link]("[Link]"))

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 [Link](str parameter, [int index])

430
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
parameter
Full-name of the attribute, or association (e.g. ”[Link]”)
index Index of the parameter:
0 Default index

E XAMPLE
This example prints the ”[Link]” parameter of a selected CimObject. The
CimObject is selected in the cimObject variable in External Objects.
import powerfactory
app = [Link]()

script = [Link]()
[error, cimObject] = [Link]("cimObject")
[Link]([Link]("[Link]"))

GetPfObjects
Returns all PF objects that have the same Resource ID as this CIM object.
list [Link]()

R ETURNS
PF objects that have the same Resource ID as this CIM object.

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 = [Link]()

script = [Link]()
[error, machine] = [Link]("machine")
pfObjects = [Link]()
for pfObject in pfObjects:
[Link](pfObject)

HasParameter
Checks whether the CimObject has the parameter (attribute, or association) specified.
int [Link](str parameter)

A RGUMENTS
parameter
Full-name of the attribute, or association (e.g. ”[Link]”)

431
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
1 if parameter is specified
0 if parameter is not specified

E XAMPLE
This example checks if a CimObject contains the ”[Link]” parameter. The
CimObject is selected in the cimObject variable in External Objects.
import powerfactory
app = [Link]()
script = [Link]()
[error, cimObject] = [Link]("cimObject")
hasParameter = [Link]("[Link]")
if hasParameter == 1:
[Link]("Parameter exists.")
else:
[Link]("Parameter does not exist.")

RemoveParameter
Removes all occurrences of the parameter (attribute, or association).
None [Link](str parameter)

A RGUMENTS
parameter
Full-name of the attribute, or association (e.g. ”[Link]”)

E XAMPLE
This example removes the ”[Link]” parameter from all
”SynchronousMachine” CIM objects in the active project.
import powerfactory
app = [Link]()

project = [Link]()
cimObjects = [Link]("*.CimObject", 1)
for cimObject in cimObjects :
if [Link]("cimClass") == "SynchronousMachine":
[Link]("[Link]")

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 [Link](str association,
str value,
[int index])

432
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
association
Full-name of the association (e.g. ”[Link]”)
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 [Link](str association,
str value,
str nspace)

A RGUMENTS
attribute Full-name of the association (e.g. ”[Link]”)
value Value of the association
nspace Namespace of the association (e.g. ”cim”)

E XAMPLE
This example adds the missing association ”[Link]” on ”NonConform-
Load” CIM objects in the active project. The association is set to the object defined in the
loadGroup variable in External Objects.
import powerfactory
app = [Link]()

project = [Link]()
script = [Link]()
[error, loadGroup] = [Link]("loadGroup")
loadGroupId = [Link]("resID")
loadGroupParameter = "[Link]"
cimObjects = [Link]("*.CimObject", 1)
for cimObject in cimObjects :
cimClass = [Link]("cimClass")
if cimClass == "NonConformLoad":
# concrete CimObject has the about parameter set to 0
if [Link]("about") == 0:
if [Link](loadGroupParameter) == 0:
[Link](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 [Link](str attribute,
str enumerationType,
str value)

433
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
attribute Full-name of the attribute (e.g. ”[Link]”)
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 ”[Link]” on
”SyncronousMachine” CIM objects in the active project.
import powerfactory
app = [Link]()

parameter = "[Link]"
type = "ShortCircuitRotorKind"
value = "salientPole1"

project = [Link]()
cimObjects = [Link]("*.CimObject", 1)
for cimObject in cimObjects :
cimClass = [Link]("cimClass")
if cimClass == "SynchronousMachine":
# concrete CimObject has the about parameter set to 0
if [Link]("about") == 0:
if [Link](parameter) == 0:
[Link](parameter, type, value)

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 [Link](str attribute,
str enumerationType,
str value,
str nspace)

A RGUMENTS
attribute Full-name of the attribute (e.g. ”[Link]”)
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 ”[Link]” on
”SyncronousMachine” CIM objects in the active project.
import powerfactory
app = [Link]()

434
5.6. OTHERS CHAPTER 5. OBJECT METHODS

parameter = "[Link]"
type = "ShortCircuitRotorKind"
value = "salientPole1"
namespace = "cim"

project = [Link]()
cimObjects = [Link]("*.CimObject", 1)
for cimObject in cimObjects :
if [Link]("cimClass") == "SynchronousMachine":
# concrete CimObject has the about parameter set to 0
if [Link]("about") == 0:
if [Link](parameter) == 0:
[Link](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 [Link](str attribute,
str value,
[int index])

A RGUMENTS
attribute Full-name of the attribute (e.g. ”[Link]”)

value Value of the attribute

index Index of the attribute:
0 Default index

E XAMPLE
This example adds the prefix ”Load ” to the ”[Link]” attribute for all concrete
”NonConformLoad” CIM objects in the active project.
import powerfactory
app = [Link]()

project = [Link]()
cimObjects = [Link]("*.CimObject", 1)
for cimObject in cimObjects :
cimClass = [Link]("cimClass")
if cimClass == "NonConformLoad":
# concrete CimObject has the about parameter set to 0
if [Link]("about") == 0:
oldName = [Link]("[Link]")
newName = "Load_" + oldName
[Link]("[Link]", newName)

435
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](str attribute,
str value,
str nspace)

A RGUMENTS
attribute Full-name of the attribute (e.g. ”[Link]”)
value Value of the attribute

nspace Namespace of the attribute (e.g. ”cim”)

E XAMPLE
This example sets the ”[Link]” attribute to ”false” for all concrete ”NonCon-
formLoad” CIM objects in the active project.
import powerfactory
app = [Link]()

project = [Link]()
cimObjects = [Link]("*.CimObject", 1)
for cimObject in cimObjects :
cimClass = [Link]("cimClass")
if cimClass == "NonConformLoad":
# concrete CimObject has the about parameter set to 0
if [Link]("about") == 0:
[Link]("[Link]", "false", "cim")

5.6.7 GrpPage
Overview

ChangeStyle
DoAutoScale
DoAutoScaleX
DoAutoScaleY
GetOrInsertCurvePlot
GetOrInsertDiscreteBarPlot
GetOrInsertModalAnalysisPlot
GetOrInsertPlot
GetOrInsertVectorPlot
GetOrInsertXYPlot
GetPlot
RemovePage
SetAutoScaleModeX
SetAutoScaleModeY
SetLayoutMode
SetResults
SetScaleTypeX
SetScaleTypeY
SetScaleX
SetScaleY
Show
436
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ChangeStyle
Applies the plot style identified by the given name to all plots on this page.
int [Link](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 [Link]([int axisDimension])

A RGUMENTS
axisDimension (optional)
Limits auto-scaling to one dimension. Possible values:
0 Scale only x-axes.
1 Scale only y-axes.

DoAutoScaleX
Adapts x-axis ranges of all plots on the page such that they show the entire data range.
None [Link]()

DoAutoScaleY
Adapts y-axis ranges of all plots on the page such that they show the entire data range.
None [Link]()

GetOrInsertCurvePlot
Finds a curve plot by name, or creates it if not found.
DataObject [Link](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).

437
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Found or created PltLinebarplot object.

GetOrInsertDiscreteBarPlot
Finds a discrete bar plot by name, or creates it if not found. A discrete bar plot is a PltLinebarplot
whose x-axis mode is set to 'Discrete', i.e., it shows net elements on the x-axis.
DataObject [Link](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.

GetOrInsertModalAnalysisPlot
Finds a modal analysis plot by name, or creates it if not found.
DataObject [Link](str name,
int type,
[int create = 1]
)

A RGUMENTS
name Name of plot.
type Type of modal analysis plot to create:
0 Eigenvalue plot.
1 Mode polar plot.
2 Mode bar 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
PltLinebarplot (eigenvalue plot, mode bar plot) or PltVectorplot (mode polar plot).

438
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetOrInsertPlot
Finds a plot by name, or creates it if not found.
DataObject [Link](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.
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.
14 Biased current differential plot.
20 Network graphic: shows a single 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.

PltLinebarplot Curve plot, XY plot, discrete bar plot, eigenvalue plot, mode bar plot, time-
overcurrent plot.
PltVectorplot Vector plot, mode polar plot.
PltNetgraphic Network graphic.

GetOrInsertVectorPlot
Finds a vector plot by name, or creates it if not found.
DataObject [Link](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).

439
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Found or created PltVectorplot object.

GetOrInsertXYPlot
Finds a XY plot by name, or creates it if not found. A XY plot is a PltLinebarplot whose x-axis
mode is set to 'XY'.
DataObject [Link](str name,
[int create]
)

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.

GetPlot
Returns the plot on this page with the given name.
DataObject [Link](str name)

A RGUMENTS
name Name of the plot to look for.

R ETURNS
Plot object if found, or None otherwise.

RemovePage
Closes the graphic page, if currently shown, and deletes it from the database.
None [Link]()

SetAutoScaleModeX
Defines whether the x-axes on the page should automatically adapt their range on data changes.

None [Link](int mode)

440
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 [Link](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 [Link](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 [Link](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 [Link](int scaleType)

441
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 [Link](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 [Link](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 [Link](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 [Link]()

442
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 [Link](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)

443
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddDoubleMatrix
Adds a new double vector parameter to the Data Extension configuration object.
int [Link](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 [Link](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

444
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 [Link](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 [Link](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

445
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 [Link](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 [Link](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)

446
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddString
Adds a new string parameter to the Data Extension configuration object.
int [Link](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 [Link](str parameterName)

A RGUMENTS
parameterName
The name of the parameter to be removed

RenameClass
Renames the class from the Data Extension configuration.
int [Link](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)

447
5.6. OTHERS CHAPTER 5. OBJECT METHODS

RenameParameter
Renames the given parameter from the Data Extension configuration.
int [Link](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 [Link](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)

448
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 [Link]()

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 [Link](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 [Link](DataObject other)

A RGUMENTS
other The source study case to copy study time from

449
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 [Link]()

R ETURNS
0 On success
1 If an error has occured

S EE ALSO

[Link]()

Deactivate
De-activates the study case.
int [Link]()

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 [Link](int dateTime)

A RGUMENTS
dateTime Seconds since 01.01.1970 00:00:00.

450
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 [Link]()

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 [Link]()

R ETURNS
0 File successfully converted.
1 Error occurred, e.g. file is already in binary format.

451
5.6. OTHERS CHAPTER 5. OBJECT METHODS

FindColumn
Returns the first column matching the variable name.
int [Link](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.
[int row,
float value] [Link](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.
[int row,
float value] [Link](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.

452
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](int index)

A RGUMENTS
index Digital channel index.

R ETURNS
Descriptions for analogue channel in the comtrade info file.

GetColumnValues
Get complete column values.
int [Link](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.
str [Link]([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

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

453
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]()

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).
int [Link]()

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 [Link]()

R ETURNS
Number of descriptions for digital channels in the comtrade info file.

GetNumberOfRows
Returns the number of values per column (rows) stored in result object.
int [Link]()

454
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.
[int error,
DataObject o ] [Link](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 [Link]()

R ETURNS
Headline of signal descriptions

GetUnit
Get the unit of a column.
str [Link]([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.

455
5.6. OTHERS 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.
[int error,
float d ] [Link](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
str [Link]([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.

Load
Loads the data of a result object (IntComtrade) in memory for reading.
None [Link]()

456
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The IntComtrade itself remains
unchanged.
int [Link](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

457
5.6. OTHERS CHAPTER 5. OBJECT METHODS

FindColumn
Returns the first column matching the variable name.
int [Link](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.
[int row,
float value] [Link](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.
[int row,
float value] [Link](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.

458
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](int index)

A RGUMENTS
index Digital channel index.

R ETURNS
Descriptions for analogue channel in the comtrade info file.

GetColumnValues
Get complete column values.
int [Link](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.
str [Link]([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

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

459
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]()

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).
int [Link]()

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 [Link]()

R ETURNS
Number of descriptions for digital channels in the comtrade info file.

GetNumberOfRows
Returns the number of values per column (rows) stored in result object.
int [Link]()

460
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.
[int error,
DataObject o ] [Link](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 [Link]()

R ETURNS
Headline of signal descriptions

GetUnit
Get the unit of a column.
str [Link]([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.

461
5.6. OTHERS 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.
[int error,
float d ] [Link](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
str [Link]([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.

Load
Loads the data of a result object (IntComtradeset) in memory for reading.
None [Link]()

462
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The IntComtradeset itself
remains unchanged.
int [Link](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 [Link](DataObject object)
None [Link](list objects)

A RGUMENTS
obj/objects
Object(s) for which references should be created and added to the dataset object

All
Returns all children of the dataset object.
list [Link]()

R ETURNS
All objects contained in dataset object.

463
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Clear
Deletes all children of the dataset object.
None [Link]()

GetAll
Returns all children of the dataset filtered according to given class name.
list [Link](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 [Link](str filename)

A RGUMENTS
filename Name of export file on disk

R ETURNS
0 On success.
1 On error.

S EE ALSO

[Link]()

Import
Imports the content of selected file into the PowerFactory object. The data is afterwards em-
bedded in the PowerFactory database.
int [Link]()

464
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 On error.

S EE ALSO

[Link]()

Reset
Resets embedded data and reference to an external file.
int [Link]()

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 [Link]()

R ETURNS
0 Success, file was opened
1 Error, file not opened (because of invalid address or security reasons)

S EE ALSO

[Link]()

5.6.14 IntDplmap
Overview

Clear
Contains
First
GetValue
Insert
Next
Remove
Size
Update

Clear
Removes all key/value pairs from the container and resets type information.
None [Link]()

465
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Contains
Checks if a key/value pair with given key is contained in the container.
int [Link](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] [Link]()

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] [Link](int|float|str|DataObject|list key)

A RGUMENTS
key Key of the associated pair in the container to find.
error (optional, out)
1 Key was not found in container.
0 Key was found in the container.

466
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]() 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 [Link] (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] [Link]()

A RGUMENTS
key (out) Key of the associated pair in the container.

value (out)
Value of the associated pair in the container.

467
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link] (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 [Link]()

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 [Link](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

5.6.15 IntDplvec
Overview

Clear
Get
IndexOf
Insert
Remove
Size
Sort

468
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Clear
Removes all elements from the container and resets the typ information.
None [Link]()

Get
Returns the element stored at given position in the container.
int|float|str|DataObject|list [Link](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 [Link](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.

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 [Link](int|float|str|DataObject|list element)
None [Link](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.

469
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Remove
Removes the element stored at given position from the container.
None [Link](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 [Link]()

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 [Link]([int descending,]

[str attribute]
)

A RGUMENTS
descending (optional)
1 Descending sorting order
0 Ascending sorting order (default)
attribute (optional)
For objects only: Attribute according to which the sorting is done (default is full
name)

5.6.16 IntEvt
Overview

CreateCBEvents
RemoveSwitchEvents

470
5.6. OTHERS CHAPTER 5. OBJECT METHODS

CreateCBEvents
Create boundary breaker events for all shc locations which occur simultaneously in this fault
case.
None [Link]([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 [Link]([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.

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 [Link]() for accessing that url.
int [Link](str url)

A RGUMENTS
url url to check

R ETURNS
0 access granted
1 access denied

471
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.18 IntGate
Overview

AddTrigger

AddTrigger
Adds either a condition or a gate to the gate.
list [Link](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 [Link](DataObject layer)

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 [Link]()

R ETURNS
0 On success.
1 An error occurred. See log file for details.

472
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link]()

Export
Exports all objects of a group into svg-file.
None [Link](str path,
[int OpenDialog])

A RGUMENTS
path Full export file path

OpenDialog (optional)
Prompt for export path in dialog
0 Export directly and do not show any dialog (default)
1 Show dialog with path before exporting

Import
Imports svg-file into group object.
None [Link](str path)

A RGUMENTS
path Path of file to be imported.

473
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](int objectType,
[str 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)

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 [Link]() for an example. Composite elements such as
”Polyline with arrow” are not supported.
int [Link](object intDplMap,
bool writeToDB
)

474
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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)

ChangeFont
Sets the font number for the specified group of text boxes.
None [Link](str fontName,
int fontSize,
int fontStyle,
int objectType,
[str symbolName])

475
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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)

476
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 [Link](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 [Link](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

477
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 [Link]() for an
example.
int [Link]()

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 [Link]()

Export
Exports all objects of a layer into svg-file or plain text (.txt), inclusive annotation objects of
contained group objects.
None [Link](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

478
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 [Link]() for an example. For
composite geometries (such as ”Polyline with Arrow”), the first element will be retrieved.
int [Link](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 [Link]()
for an example.
int [Link]()

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 [Link](str path)

A RGUMENTS
path Path of file to be imported. Supported formats: .svg and .txt.

479
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 [Link](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 [Link]() for an example.
int [Link](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 [Link](int mode,
int objectType,
[str symbolName])

480
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 [Link](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

[Link](), [Link](), [Link](

E XAMPLE
import powerfactory
app = [Link]()
script = [Link]()
annotationLayer = [Link]
dplMap = [Link]

[Link]();
[Link]('type','Line');

481
5.6. OTHERS CHAPTER 5. OBJECT METHODS

[Link]('color','{0,255,0}');
[Link]('points','{{10,100},{30,200}}');
[Link]('thickness','1');

[Link](dplMap);

[Link]();
[Link]('type','Polygon');
[Link]('points','{{20,20},{50,20},{50,50},{20,50}}');
[Link]('lineColor','{255,0,0}');
[Link]('lineThickness','1');

[Link](dplMap);

[Link]();
[Link]('type','Line');
[Link]('color','{255,255,0}');
[Link]('points','{{10,100},{30,200}}');
[Link]('thickness','1');

[Link](dplMap);

numElements = [Link]()
[Link](str(annotationLayer) + ': ' + str(numElements) + 'elements')

for i in range(numElements):
ret = [Link](i,dplMap)
[Link]('Attributes of annotation element at index {}:'.format(i));
_,key,value = [Link]()
[Link]('{} -> {}'.format(key,value))
for j in range([Link]()-1):
_,key,value = [Link]()
[Link]('{} -> {}'.format(key,value))

[Link]();
[Link]('type','Polygon');
[Link]('points','{{20,20},{50,20},{50,50},{20,50}}');
[Link]('lineColor','{0,255,0}');
[Link]('lineThickness','1');

[Link](1,dplMap)
[Link](2);

numElements = [Link]()
[Link](str(annotationLayer) + ': ' + str(numElements) + ' elements')

for i in range(numElements):
ret = [Link](i,dplMap)
[Link]('Attributes of annotation element at index {}:'.format(i));
_,key,value = [Link]()
[Link]('{} -> {}'.format(key,value))
for j in range([Link]()-1):
_,key,value = [Link]()
[Link]('{} -> {}'.format(key,value))

482
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.22 IntGrfnet
Overview

Close
SetFontFor
SetLayerVisibility
SetSymbolComponentVisibility
Show

Close
Closes the graphic page that displays this diagram.
int [Link]()

R ETURNS
0 On success, no error occurred.
1 Otherwise

SetFontFor
Sets a font for a specified group of text boxes.
None [Link](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
fontStyle Font style
1 Bold
2 Italic
3 Bold and italic
4 Underline

483
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetLayerVisibility
Sets a layer visible or invisible.
None [Link](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 [Link](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.

Show
Opens a diagram.
int [Link]()

484
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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

[Link]()

Import
Imports icon from a bitmap file.
int [Link](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

[Link]()

485
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 [Link]()

R ETURNS
1 if successful
0 otherwise

Deactivate
Deactivates this library.
int [Link]()

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

486
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ColLbl
Deprecated function to get or set the label of the given column. Please use [Link]()
or [Link]() instead.
str [Link](int column)
str [Link](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 [Link](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

[Link]()

GetColumnLabel
Returns the label of a column.
str [Link](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

[Link](), [Link](), [Link]()

GetColumnLabelIndex
Gets the index of a label in all column labels.
int [Link](str label)

487
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

[Link]()

GetNumberOfColumns
Returns the number of columns in the matrix.
int [Link]()

R ETURNS
The number of columns of the matrix.

D EPRECATED N AMES
NCol, SizeY

S EE ALSO

[Link]()

GetNumberOfRows
Returns the number of rows in the matrix.
int [Link]()

R ETURNS
The number of rows.

D EPRECATED N AMES
NRow, SizeX

S EE ALSO

[Link]()

GetRowLabel
Returns the label of a row.
str [Link](int row)

A RGUMENTS
row Row index (first row has index 1).

R ETURNS
Row label of given row.

488
5.6. OTHERS CHAPTER 5. OBJECT METHODS

D EPRECATED N AMES
RowLbl

S EE ALSO

[Link](), [Link](), [Link]()

GetRowLabelIndex
Gets the index of a label in all row labels.
int [Link](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

[Link]()

Init
Initializes the matrix with given size and values, regardless of the previous size and data.
This operation is performed in memory only. Use [Link]() to save the modified matrix to
database.
int [Link](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

[Link]()

489
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Invert
Inverts the matrix.
This operation is performed in memory only. Use [Link]() to save the modified matrix to
database.
int [Link]()

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 [Link]() to save the modified matrix to
database.
int [Link](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 [Link]() to save the modified matrix to
database.
int [Link](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.

490
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Always 1 and can be ignored.

S EE ALSO

[Link]()

RowLbl
Deprecated function to get or set the label of the given row. Please use [Link]()
or [Link]() instead.
str [Link](int row)
str [Link](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 [Link]()
None [Link](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 [Link]() to save the modified matrix to
database.
int [Link](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.

491
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Always 1 and can be ignored.

S EE ALSO

[Link]()

SetColumnLabel
Sets the label of a column.
This operation is performed in memory only. Use [Link]() to save the modified matrix to
database.
None [Link](int column,
str label
)

A RGUMENTS
column Column index (first column has index 1).
label Label to set.

S EE ALSO

[Link](), [Link](), [Link]()

SetRowLabel
Sets the label of a row.
This operation is performed in memory only. Use [Link]() to save the modified matrix to
database.
str [Link](int row,
str label
)

A RGUMENTS
row Row index (first row has index 1).
label Label to set.

S EE ALSO

[Link](), [Link](), [Link]()

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 [Link](int columnIndex,
[float epsilon = 0.0],
[int storeInDB = 1])

492
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 [Link](str name)

A RGUMENTS
name The variable name to add.

AddVars
Appends the filtered variables to the list of selected variables.
None [Link](str varFilter)

A RGUMENTS
varFilter The filter for variables to add. For example: ’e:*’ to add all parameters of element
to variable selection.

493
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ClearVars
Clears the list of selected variable names.
None [Link]()

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 [Link](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 [Link]()

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 [Link]()

PrintVal
Prints the values of the selected variables to the output window.
None [Link]()

RemoveVar
Removes the variable “name” from the list of selected variable names.
int [Link](str name)

A RGUMENTS
name The variable name.

494
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 [Link]()

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 [Link]()

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

495
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Apply
None [Link]([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 [Link]([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 [Link]([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] [Link]([int emitMsg,]
[DataObject gridfilter,])

496
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 [Link]()

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 [Link]([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

497
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 [Link](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 IntPlot
Overview

SetAdaptY
SetAutoScaleY
SetScaleY

SetAdaptY
Sets the Adapt Scale option of the x-scale.
None [Link](int mode,
[float offset]
)

A RGUMENTS
mode Possible values:
0 off
1 on
offset (optional)
Offset, unused if mode is off or empty

SetAutoScaleY
Sets automatic scaling mode of the y-scale. A warning is issued if an invalid mode is passed to
the function.
None [Link](int mode)

498
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

SetScaleY
Sets y-axis scale limits. A function call without arguments sets the Auto Scale setting to On
without changing the scale itself.
None [Link]()
None [Link](float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.
log (optional)
Possible values:
0 linear
1 logarithmic

5.6.32 IntPrj
Overview

Activate
AddProjectToCombined
AddProjectToRemoteDatabase
Archive
BeginDataExtensionModification
CanAddProjectToRemoteDatabase
CanSubscribeProjectReadOnly
CanSubscribeProjectReadWrite
CopyDataExtensionFrom
CreateVersion
Deactivate
EndDataExtensionModification
GetDerivedProjects
GetExternalReferences
GetGeoCoordinateSystem
GetLatestVersion
GetVersions

499
5.6. OTHERS CHAPTER 5. OBJECT METHODS

HasExternalReferences
LoadData
MergeToBaseProject
Migrate
NormaliseCombined
PackExternalReferences
Purge
PurgeObjectKeys
RemoveProjectFromCombined
Restore
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 [Link]()

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 [Link](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 [Link]()

500
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Archive
Archives the project if the functionality is configured and activated. Does nothing otherwise.
int [Link]()

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 [Link]()

R ETURNS
The SetDataext configuration object in the settings folder for further processing.

S EE ALSO

[Link](), [Link](), [Link](),

[Link](), [Link](), [Link]()

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 [Link]()

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 [Link]()

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 [Link]()

501
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 [Link](object other)

A RGUMENTS
other Project to copy the Data Extension configuration from.

R ETURNS
0 Copied successfully
1 Target project is not active
2 Source object is not a project
3 Error during copying, see Output Window

CreateVersion
Creates a new version of project it was called on.
Optionally allows to pass the version name, the timestamp, a bool for user notification, a bool to
enforce project approval and a description.
DataObject [Link]([str name = "",]
[int timestamp = 0,]
[int notifyUsers = 0,]
[int approvalRequired = 0,]
[str description = ""]
)
DataObject [Link](int notifyUsersAndApprovalRequired,
[str name = "",]
[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:

502
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
0 on success
1 on error

EndDataExtensionModification
Terminates a Data Extension modification previously initiated with BeginDataExtensionModifi-
cation.
This will deactivate the Study Case if the new Data Extension configuration can be applied. In
case of errors the project will be deactivated and rolled back. Omitting the call to EndDataEx-
tensionModification and exiting from the script will discard all changes to the Data Extension
configuration.
None [Link]()

S EE ALSO

[Link]()

GetDerivedProjects
Return a set holding all versions created in the project.
list [Link]()

R ETURNS
Set holding all versions of a project.

503
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetExternalReferences
Fills the given map with objects from this project mapping to its external references.
int [Link](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

[Link](), [Link]()

GetGeoCoordinateSystem
Returns the EPSG code of the geographic coordinate system in which the geo coordinates of
the project’s net elements are stored.
int [Link]()

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 [Link]([int onlyregular])

A RGUMENTS
onlyregular (optional)
1 consider only regular version (default)
0 consider all versions

R ETURNS
Latest version of the project

504
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetVersions
Returns a set containing all versions of the project.
list [Link]()

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 [Link]([int considerGlobal = 1,]
[int considerRemoteVariants = 0]
)
int [Link](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.

R ETURNS
0 No external reference was found.
1 An external reference was found.

S EE ALSO

[Link](), [Link]()

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 [Link]()

505
5.6. OTHERS CHAPTER 5. OBJECT METHODS

MergeToBaseProject
Merges the modifications of a derived project to the base project.
int [Link](int conflictMode)

A RGUMENTS
conflictMode
Assignment in case of modification conflict:

0 Favour none. Diff browser is shown in case of conflicts.

1 Favour base version.
2 Favour derived project.
3 Favour base project.

R ETURNS

0 Merge finished sucessfully.

1 Merge failed (no further information).
2 Merge failed due to failing assignment check.
3 Merge failed due to invalid projects (e.g. no derived project).
4 Merge was canceled by user.
5 Merge completed with errors (see output window).

Migrate
Migrates a project from version V13 to V14. Migration is only executed if project has been
created in build 400 or earlier (and is not yet migrated).
None [Link]([int createCopy])

A RGUMENTS
createCopy (optional)
1 Creates a copy of current project (original copy is maintained) (default)
0 Does an ”in-place” migration of the project (original is overwritten)

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 [Link]()

R ETURNS
0 operation was successful
1 operation was cancelled because the project is active

506
5.6. OTHERS CHAPTER 5. OBJECT METHODS

PackExternalReferences
Packs external references of this project and prints a report to the Output Window.
int [Link]([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

[Link](), [Link]()

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 [Link]()

PurgeObjectKeys
Purges project’s object key table.

R ETURNS
Number of purged records. −1 in case of errors.
int [Link]()

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 [Link](str mappingKey)

A RGUMENTS
mappingKey
The mapping key for the project that should be removed

R ETURNS
0 operation was successful

507
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link](int epsgCode)

A RGUMENTS
epsgCode
EPSG code of the geographic coordinate system to be used for this project. A
value of 0 denotes an unknown coordinate system.

SubscribeProjectReadOnly
Subscribes a project read only if the permission is granted.
Can only be used if the database driver is set to Offline Mode.
None [Link]()

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 [Link]()

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] [Link](float xIn, float yIn,
int sourceEpsg, int destEpsg
)

508
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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] [Link](int destEpsg)

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 [Link]()

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 [Link]()

509
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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

UpdateToMostRecentBaseVersion
Updates a derived project to the most recent version of the base project. This is done by creating
a new derived project from the new version and (optionally) merging the modifications from the
existing derived project into it.
[ int errorCode,
DataObject newDerivedProject ]
[Link](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):

510
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.33 IntPrjfolder
Overview

GetProjectFolderType
IsProjectFolderType

GetProjectFolderType
Returns the type of the project folder stored in attribute “iopt type”.
The following types are currently available (language independent):

• blk - User Defined Models

• cbrat - CB Ratings
• chars - Characteristics

• cstgen - Generator Cost Curves

• effgen - Generator Efficiency Curves
• rnd - Probabilistic Assessment
• cim - CIM Model

• common - Common Mode Failures

• demand - Demand Transfers
• dia - Diagrams
• equip - Equipment Type Library

• fault - Faults
• ras - Remedial Action Schemes
• gen - Generic

• lib - Library
• lvdata - Coincidence Definitions

511
5.6. OTHERS CHAPTER 5. OBJECT METHODS

• 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 - Table Reports
• scen - Operation Scenarios
• scheme - Variations
• script - Scripts
• study - Study Cases
• sw - StationWare
• tariff - Tariffs
• templ - Templates
• therm - Thermal Ratings
• ucc - V-Control-Curves

str [Link]()

R ETURNS
The type of the project folder as string. For possible return values see list above.

S EE ALSO

[Link]()

IsProjectFolderType
This function checks if a project folder is of given type.
int [Link](str type)

A RGUMENTS
type Folder type; for possible type values see [Link]()

R ETURNS
1 true, is of given type
0 false, is not of given type

512
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link]()

5.6.34 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 [Link](float p,
float v,
[float minmax]
)

A RGUMENTS
p the current value of active power in MW or p.u.
v the current value of voltage in p.u.
minmax (optional)
Returns either the maximum or minimum value. Possible values are:

-1 minimum value
1 maximum value. This is the default value

R ETURNS
Returns the minimum/maximum limit. The units might be Mvar or p.u., depending on the
input mode of the capability curve. Also, the limits are calculated for a single machine.

5.6.35 IntRas
Overview

AddEvent
AddTrigger
IsValid

AddEvent
Adds an event to the Remedial Action Scheme.
list [Link](DataObject newEvent)

A RGUMENTS
newEvent
The event that shall be added.

513
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddTrigger
Adds either a condition or a gate to the Remedial Action Scheme.
list [Link](DataObject newTrigger)

A RGUMENTS
newTrigger
The condition or gate that shall be added.

IsValid
Checks if the Remedial Action Scheme is valid.
int [Link](int emitMessage = 0)

A RGUMENTS
emitMessage
Emit messages if not equal to zero.

R ETURNS
0 If invalid.
1 If valid.

5.6.36 IntReport
Overview

AddObject
AddObjects
CreateField
CreateTable
GetFieldCount
GetFieldDataType
GetFieldName
GetObjects
GetParameterValueAsDouble
GetParameterValueAsInteger
GetParameterValueAsString
GetRowCount
GetTableCount
GetTableName
GetValueAsDouble
GetValueAsInteger
GetValueAsObject
GetValueAsString
Reset
SetDefaultValue
SetValue

514
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](). 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 [Link]()), it will not
be added a second time.
None [Link](DataObject objectToAdd)

A RGUMENTS
objectToAdd
The object to be added to the report generation mechanism. Null objects are
ignored.

S EE ALSO

[Link](), [Link]()

AddObjects
Adds the given list of objects to the set of objects that are considered during report creation.
See [Link]() for more details on adding objects.
None [Link](list objectsToAdd)

A RGUMENTS
objectsToAdd
List of objects to be added to the report generation mechanism.

S EE ALSO

[Link](), [Link]()

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
[Link]() method.
int [Link](str tableName, str fieldName, int dataType)

A RGUMENTS
tableName
The name of a table (previously created using [Link]()).
fieldName
The name of the new field, which must satisfy all of the following conditions:
• The name is not empty.

515
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

S EE ALSO

[Link](), [Link](), [Link]()

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 [Link]() method.
Using the [Link]() 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 [Link](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.

516
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetFieldCount
Returns the number of fields in the specified table.
int [Link](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

[Link](), [Link](), [Link]()

GetFieldDataType
Returns the data type (encoded as integer) of the specified field in the specified table.
int [Link](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

[Link](), [Link](), [Link]()

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 [Link]().
[int error, str name] [Link](str tableName, int fieldIndex)

517
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

S EE ALSO

[Link](), [Link](), [Link]()

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
[Link]() for details).
list [Link]()

R ETURNS
A list of all collected objects.

S EE ALSO

[Link](), [Link]()

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] [Link](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.

518
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link]()

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] [Link](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 integer is
not possible.

S EE ALSO

[Link](), [Link]()

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] [Link](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.

519
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link]()

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 [Link](). 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 [Link]() 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 [Link](str tableName)

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

[Link](), [Link]()

GetTableCount
Returns the number of tables that have been created (using [Link]()).
int [Link]()

R ETURNS
The number of tables that have been created (using [Link]()).

S EE ALSO

[Link]()

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 [Link]().
[int error, str name] [Link](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.

520
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

[Link]()

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 [Link]()),
the default value of the field is returned instead (see [Link]()).
This method is intended to be used with double fields only.
[int error, float value] [Link](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

[Link](), [Link](), [Link](), [Link](),

[Link]()

521
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()),
the default value of the field is returned instead (see [Link]()).
This method is intended to be used with integer fields only.
[int error, int value] [Link](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

[Link](), [Link](), [Link](), [Link](),

[Link]()

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-
[Link]()), the null object is returned instead.
This method is intended to be used with object fields only.
[int error, DataObject value] [Link](str tableName, str fieldName,
int position)

A RGUMENTS
tableName
The name of the table.
fieldName
The name of the field.

522
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

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

[Link](), [Link](), [Link](), [Link](),

[Link]()

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 [Link]()),
the default value of the field is returned instead (see [Link]()).
This method is intended to be used with string fields only.
[int error, str value] [Link](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).

523
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link](), [Link](), [Link](), [Link]()

[Link]()

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 [Link]()

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 [Link]() and IntRe-
[Link](), 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 [Link](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

[Link](), [Link]()

524
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 [Link]() and IntRe-
[Link](), 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 [Link]()), 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 [Link]()).
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 [Link]()). The
default value of a field can be changed by calling the method [Link]().
int [Link](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

[Link](), [Link](), [Link]()

525
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.37 IntRunarrange
Overview

GetSwitchStatus

GetSwitchStatus
Determines the status of the given switch in the running arrangement, without assigning or
applying the running arrangement.
int [Link](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.38 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 [Link]()

R ETURNS
0 successfully activated
1 error, e.g. already activate, no project and study case active

526
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 [Link]([int requestUserConfirmation])
int [Link](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 [Link](DataObject configuration)
int [Link](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 [Link]([int saveOrUndo])

527
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 [Link]([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 [Link]()

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] [Link](DataObject obj,
str attribute,
[int fromObject])

A RGUMENTS
value (out)
variable that holds the value after call

528
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link]()

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 [Link](int|float|str|DataObject newvalue,
DataObject obj,
str attribute,
[int toObject = 1]
)

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:

529
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.39 IntScensched
Overview

Activate
Deactivate
DeleteRow
GetScenario
GetStartEndTime
SearchScenario

Activate
Activates a scenario scheduler.
int [Link]()

R ETURNS
0 successfully activated
1 error, e.g. already activate, no project and study case active

Deactivate
Deactivates a scenario scheduler.
int [Link]()

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 [Link](int row, [int numberOfRows])

A RGUMENTS
row row number (begin with 0)
numberOfRows (optional)
number of rows to delete (default = 1)

530
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetScenario
Get the scenario for corresponding time 'iTime'.
DataObject [Link](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 ] [Link](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 [Link](DataObject scenarioObject)

A RGUMENTS
scenarioObject
scenario object

R ETURNS
−1 Scenario not found (not part of scenario scheduler).
≥0 Vector index (row, index of scenario).

531
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.40 IntScheme
Overview

Activate
Consolidate
Deactivate
GetActiveScheduler
NewStage

Activate
Activates a variation and inserts a variation reference in a 'Variation Configuration Folder'stored
in the study case.
int [Link]()

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 [Link]()

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 [Link]()

R ETURNS
0 successfully deactivated
1 error, e.g. already deactivated, no project and study case active

532
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetActiveScheduler
Returns the corresponding active variation scheduler or None if no scheduler is active for this
variation (IntScheme).
DataObject [Link]()

NewStage
Adds a new expansion stage into the variation (name = sname).
int [Link](str name,
int activationTime,
int activate
)

A RGUMENTS
name Name of the new expansion stage.
activationTime
Activation time of the new expansion stage in seconds since 01.01.1970 00:00:00.
activate
1 The actual study time is changed to the parameter iUTCtime and the
varation will be activated. If the variation is a network variation, the
new created expansion stage is used as 'recording 'expansion stage.
If the variation (this) is not active, the variation will be automatically
activated.
0 Expansion stage and/or variation will not be activated.

5.6.41 IntSscheduler
Overview

Activate
Deactivate
Update

Activate
Activates a variation scheduler. An already activated scheduler for same variation will be
deactivated automatically.
int [Link]()

R ETURNS
=0 On success
6= 0 If an error has occurred

533
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Deactivate
Deactivates a variation scheduler.
int [Link]()

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 [Link]()

R ETURNS
=0 On success
6= 0 If an error has occurred

5.6.42 IntSstage
Overview

Activate
CreateStageObject
EnableDiffMode
GetVariation
IsExcluded
PrintModifications
ReadValue
WriteValue

Activate
Activates the expansion stage and sets the 'recording' expansion stage. The study time will be
automatically set to the correponsing time of the stage.
int [Link]([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.

534
5.6. OTHERS CHAPTER 5. OBJECT METHODS

CreateStageObject
Creates a stage object (delta or delete object) inside corresponding IntSstage.
DataObject [Link](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 [Link](int enable)

A RGUMENTS
enable
0 disables the difference/comparison mode
1 enables the difference/comparison mode

GetVariation
Returns variation of expansion stage.
DataObject [Link]()

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 [Link]()

535
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]([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] [Link](DataObject rootObj,
str attributeName)

R ETURNS
=0 On success.
6= 0 Error e.g. wrong data type.

WriteValue
Writes a value for an attribute to an ADD or DELTA object which modifies rootObj (root object).
int [Link](float|str|DataObject value,
DataObject rootObj,
str attributeName)

R ETURNS
=0 On success.
6= 0 Error e.g. wrong data type.

536
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.43 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 [Link]([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 [Link](DataObject applyConfiguration)
int [Link](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

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 [Link]()

537
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]()

R ETURNS
Set of all objects for which operational data are stored in the subset

5.6.44 IntSym
Overview

ConvertGeometriesToMDLString

ConvertGeometriesToMDLString
Converts the internal legacy geometry string to Modelica geometry description language intro-
duced in PowerFactory version 23.
None [Link]()

538
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.45 IntThrating
Overview

GetCriticalTimePhase
GetRating
Resize

GetCriticalTimePhase
This function returns the smallest duration (time-phase) for which the power flow is beyond the
rating.
float [Link](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 [Link](float Loading,
float Duration
)

A RGUMENTS
Loading Element loading, in %.
Duration Duration or time phase for which the loading is considered, in minutes

R ETURNS
Rating in MVA or 0 if not found.

Resize
Resizes the configuration vectors like configTa,condigWind,configSolar,preload or duration
void [Link](int size, str name)

A RGUMENTS
size size of the referenced vector
name reference to the vector (’configTa’,’configWind’,’configSolar’, ’preload’ or ’duration’)

539
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
If the resize is unsuccessful the error message shall be issued.

5.6.46 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 '[Link]
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 [Link]()

R ETURNS
The returned value reports the success of the operation:

0 Success, URL was opened

1 Error, URL was not opened (because of invalid address or security reasons)

5.6.47 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 [Link]()

540
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]()

5.6.48 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 [Link](str name)

A RGUMENTS
name Given name of the user group

R ETURNS
Created user group (IntGroup)

541
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]()

R ETURNS
Set of all available users

GetUsers
Returns a container with all users as they are currently visible in the Data Manager tree.
Note: Only the administrator user is allowed to call this function.
list [Link]()

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 [Link]()

542
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.49 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 [Link](int index)

A RGUMENTS
index Index in vector, one based.

S EE ALSO

[Link]()

Init
Initializes the vector. Resizes the vector and initializes all values to 0.
This operation is performed in memory only. Use [Link]() to save the modified vector to
database.
None [Link](int size)

A RGUMENTS
size The new size of the vector.

Max
Gets the maximum value stored in the vector.
float [Link]()

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 [Link]()

543
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

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 [Link]() to save the modified vector to
database.
None [Link](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.
None [Link]()
None [Link](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 [Link]() to save the modified vector to
database.
None [Link](int index,
float value)

544
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
index Index in vector.
value Value to assign in row index.

S EE ALSO

[Link]()

Size
Returns the size of the vector.
int [Link]()

R ETURNS
The size of the vector.

Sort
Sorts the vector.
This operation is performed in memory only. Use [Link]() to save the modified vector to
database.
None [Link]([int ascending = 0])

A RGUMENTS
ascending
Sort order:

0 Highest value first (descending, default).

1 Smallest value first (ascending).

5.6.50 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 [Link](int index)

A RGUMENTS
index Index in vector, one based.

545
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

[Link]()

Resize
Resizes the vector. Inserted new entries are initialized to None.
This operation is performed in memory only. Use [Link]() to save the modified vector
to database.
None [Link](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 [Link]()
None [Link](int resetCalculation)

A RGUMENTS
resetCalculation (optional)
1 reset calculation results (default)
0 keep calculation results

Search
Search if the object (obj) is part of the vecor and returns the corresponding index of the vector
(one based).
int [Link](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 [Link]() to save the modified vector
to database.

546
5.6. OTHERS CHAPTER 5. OBJECT METHODS

None [Link](int index,

DataObject obj)

A RGUMENTS
index Index in vector.
obj Object to assign in row index.

S EE ALSO

[Link]()

Size
Returns the size of the vector.
int [Link]()

R ETURNS
The size of the vector.

5.6.51 IntVersion
Overview

CreateDerivedProject
GetDerivedProjects
GetHistoricalProject
Rollback

CreateDerivedProject
Creates a derived project from the version.
DataObject [Link](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 [Link]()

547
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
list of derived projects

GetHistoricalProject
Returns historic project within version
DataObject [Link]()

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 [Link]()

R ETURNS
0 on success
1 otherwise

5.6.52 IntViewbookmark
Overview

JumpTo
UpdateFromCurrentView

JumpTo
Opens the referenced diagram (if not already open) and sets the viewing area.
None [Link]()

UpdateFromCurrentView
Updates the bookmark’s diagram and view area from the current drawing window.
None [Link]()

548
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.53 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 [Link]()

SetFont
Sets the font for this axis
None [Link](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.54 PltBiasdiff
Overview

AddCurve
AddCurves
ClearCurves

549
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddCurve
Adds an element to the plot and optionally sets the drawing style.
None [Link](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: [Link]()
lineStyle (optional)
The line style to be used.
lineWidth (optional)
The line width to be used.

AddCurves
Adds elements to the plot.
None [Link](list elements)

A RGUMENTS
elements The protection devices to be added.

ClearCurves
Removes all elements from the plot.
None [Link]()

5.6.55 PltComplexdata
Overview

AddVector
ChangeColourPalette
ClearVectors

AddVector
Appends a vector to the plot.
None [Link](DataObject element,
string complexVariable)

A RGUMENTS
element Element to display

550
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link]()

5.6.56 PltDataseries
Overview

AddCurve
AddXYCurve
ChangeColourPalette
ClearCurves
GetDataSource
GetIntCalcres
RemoveCurve

AddCurve
Appends a curve to the plot.
None [Link](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.

551
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddXYCurve
Appends a curve to a XY plot.
None [Link](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.

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 [Link](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 [Link]()

GetDataSource
Returns the data source that is used for the curve with given index.
DataObject [Link](int curveIndex)

552
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
All Calculated Result objects (IntCalcres) stored inside the data series.

RemoveCurve
Removes a single curve from the plot.
None [Link](int curveIndex)

A RGUMENTS
int curveIndex
curve index in table, must be ≥ 0

5.6.57 PltLegend
Overview

SetFont

SetFont
Sets the font for this axis
None [Link](str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
fontName
Font name
fontSize Font size
fontStyle Font style
1 Bold
2 Italic

553
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

ChangeStyle
Applies the plot style identified by the given name to this plot.
None [Link](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 [Link]([int axisDimension])

A RGUMENTS
axisDimension (optional)
Limits auto-scaling to one dimension. Possible values:
0 scale only x-axes
1 scale only y-axes

554
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScaleX
Adapts the plot’s x-axes ranges such that they show the entire data range.
None [Link]()

DoAutoScaleY
Adapts the plot’s y-axes ranges such that they show the entire data range.
None [Link]()

GetAxisX
Returns one of the plot’s x-axes.
DataObject [Link]([int axisIndex])

A RGUMENTS
axisIndex=0 (optional)
Determines which x-axis should be returned:
0 main x-axis
1 second x-axis (will be created if not yet present)

R ETURNS
PltAxis object

GetAxisY
Returns one of the plot’s y-axes.
DataObject [Link]([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 [Link]()

555
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Data series object (PltDataseries)

GetDataSource
Returns the plot’s data source object.
DataObject [Link]()

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 [Link]()

R ETURNS
Legend object (PltLegend)

GetTitleObject
Returns the plot’s title object (PltTitle).
DataObject [Link]()

R ETURNS
Title object (PltTitle)

SetAutoScaleModeX
Defines whether the plot should automatically adapt its main x-axis range on data changes.
None [Link](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

556
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAutoScaleModeY
Defines whether the plot should automatically adapt its main y-axis range on data changes.
None [Link](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 [Link](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

SetAxisSharingLevelY
Defines whether the plot has its own y-axis or should share its y-axis across the page or the
entire desktop.
None [Link](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 [Link](int scaleType)

557
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic

SetScaleTypeY
Set the scale type of the plot’s main y-axis.
None [Link](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 [Link](float min,
float max
)

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets the scale of the plot’s main y-axis.
None [Link](float min,
float max
)

A RGUMENTS
min Minimum of y-scale.

max Maximum of y-scale.

558
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.59 PltOvercurrent
Overview

AddCurve
AddCurves
ClearCurves
IsSubCurveVisible
SetSubCurveVisible

AddCurve
Adds an element to the plot and optionally sets the drawing style.
None [Link](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: [Link]()
lineStyle (optional)
The line style to be used.
lineWidth (optional)
The line width to be used.

AddCurves
Adds elements to the plot.
None [Link](list elements)

A RGUMENTS
elements The protection devices or net elements to be added.

ClearCurves
Removes all elements from the plot.
None [Link]()

IsSubCurveVisible
Returns whether a sub curve of a curve is shown.
int [Link](int curveIndex, int subCurveType)

559
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

SetSubCurveVisible
Sets the visibility of a sub curve for one or all curves in the plot.
None [Link](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.60 PltTitle
Overview

SetFont

560
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetFont
Sets the font for this axis
None [Link](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.61 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 [Link](str styleName)

A RGUMENTS
styleName
Name of the style template to apply

R ETURNS
0 on success
1 on error

561
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScale
Adapts the plot’s axes ranges such that they show the entire data range.
None [Link]()

GetAxisX
Returns the plot’s x-axis.
DataObject [Link]()

R ETURNS
PltAxis object

GetAxisY
Returns the plot’s y-aies.
DataObject [Link]()

R ETURNS
PltAxis object

GetComplexData
Returns the plot’s complex data definition object (PltComplexdata).
DataObject [Link]()

R ETURNS
Complex data definition object (PltComplexdata)

GetLegend
Returns the plot’s legend object (PltLegend).
DataObject [Link]()

R ETURNS
Legend object (PltLegend)

GetTitleObject
Returns the plot’s title object (PltTitle).
DataObject [Link]()

R ETURNS
Title object (PltTitle)

562
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAutoScaleModeX
Defines whether the plot should automatically adapt its main x-axis range on data changes.
None [Link](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 [Link](int mode)

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 [Link](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 [Link](float min,
float max
)

A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.

563
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.62 RelChar
Overview

SetCurve

SetCurve
Assign a tripping curve by name. The curve must be defined in the associated type object.
int [Link](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.63 RelToc
Overview

SetCurve

SetCurve
Assign a tripping curve by name. The curve must be defined in the associated type object.
int [Link](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.64 RelZpol
Overview

AssumeCompensationFactor
AssumeReRl
AssumeXeXl

564
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AssumeCompensationFactor
Triggers a calculation of the complex compensation factor and stores the result.
int [Link]()

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 [Link]()

R ETURNS
0 The compensation factor was successfully calculated.
1 An error occurred (e.g. conencted branch was not found).

AssumeXeXl
Triggers a calculation of the imaginary part of the decoupled compensation factor and stores
the result.
int [Link]()

R ETURNS
0 The compensation factor was successfully calculated.
1 An error occurred (e.g. conencted branch was not found).

5.6.65 ScnFreq
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float [Link](int vIdx)

A RGUMENTS
vIdx vIdx > 0

565
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
The number of violations.

GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float [Link](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 [Link](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 [Link](int vIdx)

A RGUMENTS
vIdx vIdx > 0

566
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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.66 ScnFrt
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float [Link](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 [Link]()

R ETURNS
The number of violations.

567
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetValue
Returns the ith value, given by vIdx, which causes the violation.
float [Link](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 [Link](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 [Link](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 [Link](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’.

568
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.67 ScnSpeed
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float [Link](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 [Link]()

R ETURNS
The number of violations.

GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float [Link](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 [Link](int vIdx)

569
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 [Link](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 [Link](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.68 ScnSync
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

570
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float [Link](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 [Link]()

R ETURNS
The number of violations.

GetValue
Returns the ith value, given by vIdx, which causes the violation.
float [Link](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 [Link](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”.

571
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetViolatedElement
Returns the element of the ith violation, given by vIdx.
DataObject [Link](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 [Link](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 ScnVar
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float [Link](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’.

572
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetNumberOfViolations
Returns the number of violations.
int [Link]()

R ETURNS
The number of violations.

GetValue
Returns the ith value, given by vIdx, which causes the violation.
float [Link](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 [Link](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 [Link](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.

573
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetViolationTime
Returns the time (in seconds) of the ith violation, given by vIdx.
float [Link](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 ScnVolt
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float [Link](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 [Link]()

R ETURNS
The number of violations.

GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float [Link](int vIdx)

574
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](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 [Link](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 [Link](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’.

575
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.71 StoMaint
Overview

SetElms

SetElms
Sets the maintenance elements.
None [Link](DataObject singleElement)
None [Link](list multipleElements)

A RGUMENTS
singleElement
single Element for Maintenance
multipleElements
multiple Elements for Maintenance

5.6.72 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 [Link]([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.

576
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.

5.6.73 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 [Link](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 [Link](float ratio)

A RGUMENTS
ratio Ratio to remove.

R ETURNS
0 Ratio was removed.
1 An error occurred.

577
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link](int index)

A RGUMENTS
index Index to remove.

R ETURNS
0 Index was removed.
1 An error occurred.

5.6.74 TypLne
Overview

IsCable

IsCable
Checks if the line type is a cable type.
int [Link]()

R ETURNS
1 Type is a cable
0 Type is not a cable

5.6.75 TypMdl
Overview

Check
Compile
Pack

Check
Checks the model for errors e.g during parsing of interpreted model, during loading of compiled
model.
int [Link]()

R ETURNS
0 TypMdl is OK.
1 Error during parsing of interpreted model.
2 Error during loading of compiled model.

578
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Compile
Compile the model.
int [Link]([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)

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 [Link]()

R ETURNS
0 On success.
1 On error.

5.6.76 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 [Link]([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

579
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

R ETURNS
0 On success.
1 On error.

S EE ALSO

[Link]()

IsEncrypted
Returns the encryption state of the type.
int [Link]()

R ETURNS
1 Type is encrypted.
0 Type is not encrypted.

S EE ALSO

[Link]()

ResetThirdPartyModule
Resets the third party licence. Only possible for non-encrypted models. Requires masterkey
licence for third party module currently set.
int [Link]()

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 [Link](str companyCode,
str moduleCode
)

580
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.77 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 ] [Link]()

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.

581
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.78 VisBdia
Overview

AddObjs
AddResObjs
Clear
SetScaleY
SetXVariable
SetYVariable

AddObjs
Adds objects to elements column in table 'Bars'.
None [Link](list elements)

A RGUMENTS
elements Elements to add in table.

AddResObjs
Adds objects to elements column in table 'Bars' (similar to AddObjs). Additionally a result file is
assigned to all rows added in the 'Result File' column.
None [Link](DataObject resultFileObj,
list elements
)

A RGUMENTS
resultFileObj
The result file to assign. Must be an object of class ElmRes.

elements Elements to add in table.

Clear
Removes all elements from plot by erasing all rows from the table named 'Bars'.
None [Link]()

SetScaleY
Sets y-axis scale limits.
None [Link](float min,
float max,
[int log]
)

582
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

SetXVariable
Set the x-axis Variable of the Distortion Analysis Diagram
int [Link](str variable)

A RGUMENTS
variable x-axis variable to [Link] of variable must not exceed 37 characters.

R ETURNS
0 if ok, 1 if variable length exceeds 37 characters,

SetYVariable
Set the y-axis variable of the Distortion Analysis Diagram
int [Link](str variable)

A RGUMENTS
variable y-axis variable to [Link] of variable must not exceed 37 characters.

R ETURNS
0 if ok, 1 if variable length exceeds 37 characters,

5.6.79 VisDraw
Overview

AddRelay
AddRelays
CentreOrigin
Clear
DoAutoScaleOnAll
DoAutoScaleOnCharacteristics
DoAutoScaleOnImpedances
DoAutoScaleX
DoAutoScaleY

583
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None [Link](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 [Link](list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

CentreOrigin
Centre the origin of the plot
None [Link]()

Clear
Removes all protection devices from the plot.
None [Link]()

DoAutoScaleOnAll
Scales the plot automatically under consideration of relay characteristics, simulation curves and
short circuit arrows. The function works for local scales only.
int [Link]()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

584
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScaleOnCharacteristics
Scales the plot automatically under consideration of relay characteristics. Same as button
named Characteristics. The function works for local scales only.
int [Link]()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

DoAutoScaleOnImpedances
Scales the plot automatically under consideration of branch impedances. Same as button
named Impedances. The function works for local scales only.
int [Link]()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

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 [Link]()

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 [Link]()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

585
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.80 VisHrm
Overview

Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
GetScaleObjX
GetScaleObjY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc
SetDefScaleX
SetDefScaleY

Clear
Removes all curves by clearing table named 'Curves'.
None [Link]()

DoAutoScaleX
Scales x-axis automatically.
int [Link]()

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scale is not local

DoAutoScaleY
Scales y-axis automatically.
int [Link]()

R ETURNS
0 Ok, call to DoAutoScaleY() was successfull
1 Failed, because the y-scale is not local

GetDataSource
Get data source for curve with index
DataObject [Link](int curveIndex)

A RGUMENTS
int curveIndex
Possible values:
<0 invalid
≥0 curve index in table

586
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
DataObject Data source
None No data source found

GetScaleObjX
Gets the object used for scaling the x-axis.
DataObject [Link]()

R ETURNS
this object In case that 'Use local Axis' is set to 'Local'.
the virtual instrument panel In case that 'Use local axis' is set to 'Current Page'.
the desktop In case that 'Use local axis' is set to 'Desktop'.

GetScaleObjY
Gets the object used for scaling the y-axis.
DataObject [Link]()

R ETURNS
this object In case that 'Use local Axis' is enabled.
the plot type In case that 'Use local axis' is disabled.

SetAutoScaleX
Sets Auto Scale setting of the x-scale. The scale is automatic set to local, in case that the
waveform plot is using the scale of the desktop or the virtual instrument panel.
None [Link](int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation

SetAutoScaleY
Sets Auto Scale setting of the y-scale. The scale is automatic set to local, in case that the
waveform plot is using the scale of the plot type.
None [Link](int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation

587
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetCrvDesc
Sets the user defined description of a curve.
None [Link](int curveIndex, str curveDescription)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set

SetDefScaleX
Sets the x-scale to be used to the desktop.
None [Link]()

SetDefScaleY
Sets the y-scale to be used to the plot type.
None [Link]()

5.6.81 VisMagndiffplt
Overview

AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY
Refresh

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None [Link](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.

588
5.6. OTHERS CHAPTER 5. OBJECT METHODS

width (optional)
The line width to be used.

AddRelays
Adds relays to the plot.
None [Link](list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

Clear
Removes all protection devices from the plot.
None [Link]()

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 [Link]()

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 [Link]()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

Refresh
Refreshes the plot by attempting to automatically scale both axes.
None [Link]()

589
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.82 VisOcplot
Overview

AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY
Refresh

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None [Link](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 [Link](list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

Clear
Removes all protection devices from the plot.
None [Link]()

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 [Link]()

590
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 [Link]()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

Refresh
Refreshes the plot by attempting to automatically scale both axes.
None [Link]()

5.6.83 VisPath
Overview

Clear
DoAutoScaleX
DoAutoScaleY
SetAdaptX
SetAdaptY
SetScaleX
SetScaleY

Clear
Removes all curves by clearing table named 'Variables' on page 'Curves'.
None [Link]()

DoAutoScaleX
Scales x-axis automatically.
int [Link]()

R ETURNS
Always 0

591
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScaleY
Scales y-axis automatically.
int [Link]()

R ETURNS
Always 0

SetAdaptX
Sets the Adapt Scale option of the x-scale.
None [Link](int mode)

A RGUMENTS
mode Possible values:
0 off
1 on

SetAdaptY
Sets the Adapt Scale option of the x-scale.
None [Link](int mode)

A RGUMENTS
mode Possible values:
0 off
1 on

SetScaleX
Sets x-axis scale.
None [Link](float min,
float max
)

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets y-axis scale limits.
None [Link](float min,
float max,
[int log]
)

592
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.
log (optional)
Possible values:

0 linear
1 logarithmic

5.6.84 VisPcompdiffplt
Overview

AddRelay
AddRelays
CentreOrigin
Clear
DoAutoScaleX
DoAutoScaleY

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None [Link](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 [Link](list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

593
5.6. OTHERS CHAPTER 5. OBJECT METHODS

CentreOrigin
Centre the origin of the plot
None [Link]()

Clear
Removes all protection devices from the plot.
None [Link]()

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 [Link]()

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 [Link]()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

5.6.85 VisPlot
Overview

AddResVars
AddVars
Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
GetIntCalcres
GetScaleObjX
GetScaleObjY
SetAdaptX
SetAdaptY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc

594
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetDefScaleX
SetDefScaleY
SetScaleX
SetScaleY
SetXVar

AddResVars
Appends variables to the plot. Variables which are already in the plot are not added.
None [Link](DataObject elmRes,
DataObject element,
str varname
)

A RGUMENTS
elmRes Result object, classname ElmRes.
elememt Element to add.
varname Variable name.

AddVars
Appends variables to the plot. Variables which are already in the plot are not added.
None [Link](DataObject element,
str varname
)

A RGUMENTS
elememt Element to add.
varname Variable name.

Clear
Removes all curves from plot.
None [Link]()

DoAutoScaleX
Scales x-axis automatically.
int [Link]()

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scale is not local

595
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScaleY
Scales y-axis automatically.
int [Link]()

R ETURNS
0 Ok, call to DoAutoScaleY() was successfull
1 Failed, because the y-scale is not local

GetDataSource
Get data source for curve with index
DataObject [Link](int curveIndex)

A RGUMENTS
int curveIndex
Possible values:
<0 invalid
≥0 curve index in table

R ETURNS
DataObject Data source
None No data source found

GetIntCalcres
Gets all user Calculated Result objects (IntCalcres) stored inside plot
list [Link]()

R ETURNS
All Calculated Result objects (IntCalcres) stored inside plot.

GetScaleObjX
Gets the object used for scaling the x-axis.
DataObject [Link]()

R ETURNS
this object In case that 'Use local Axis' is set to 'Local'.
the virtual instrument panel In case that 'Use local axis' is set to 'Current Page'.
the desktop In case that 'Use local axis' is set to 'Desktop'.

GetScaleObjY
Gets the object used for scaling the y-axis.
DataObject [Link]()

596
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
this object In case that 'Use local Axis' is enabled.
the plot type In case that 'Use local axis' is disabled.

SetAdaptX
Sets the Adapt Scale option of the local x-scale.
None [Link](int mode,
[float trigger]
)

A RGUMENTS
mode Possible values:
0 off
1 on
trigger (optional)
Trigger value, unused if mode is off or empty

SetAdaptY
Sets the Adapt Scale option of the local y-scale.
None [Link](int mode,
[float offset]
)

A RGUMENTS
mode Possible values:
0 off
1 on
offset (optional)
Offset value, unused if mode is off or empty

SetAutoScaleX
Sets Auto Scale setting of the x-scale. The scale is automatic set to local, in case that the plot
is using the scale of the desktop or the virtual instrument panel.
None [Link](int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

597
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAutoScaleY
Sets Auto Scale setting of the y-scale. The scale is automatic set to local, in case that the plot
is using the scale of the plot type.
None [Link](int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

SetCrvDesc
Sets the user defined description of a curve.
None [Link](int curveIndex,
str curveDescription
)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set.

SetDefScaleX
Sets the x-scale to be used to the desktop.
None [Link]()

SetDefScaleY
Sets the y-scale to be used to the plot type.
None [Link]()

SetScaleX
Sets the local x-axis scale. A function call without arguments sets the Auto Scale setting to On
without changing the scale itself.
None [Link]()
None [Link](float min,
float max,
[int log]
)

598
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

SetScaleY
Sets the local y-axis scale. A function call without arguments sets the Auto Scale setting to On
without changing the scale itself.
None [Link]()
None [Link](float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

SetXVar
Sets the local x-axis variable. If The default x-axis variable (time) is set if no argument is
passed.
None [Link]()
None [Link](DataObject obj,
str varname
)

A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj

599
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.86 VisPlot2
Overview

AddResVars
AddVars
Clear
DoAutoScaleX
DoAutoScaleY2
DoAutoScaleY
GetDataSource
GetScaleObjX
GetScaleObjY
SetAdaptX
SetAdaptY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc
SetDefScaleX
SetDefScaleY
SetScaleX
SetScaleY
SetXVar
ShowY2

AddResVars
Appends variables to the plot. Variables which are already in the plot are not added.
None [Link](DataObject elmRes,
DataObject element,
str varname,
[int y2 = 1]
)

A RGUMENTS
elmRes Result object, classanme ElmRes
elememt Element to add
varname Variable name
y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

AddVars
Appends variables to the plot. Variables which are already in the plot are not added.
None [Link](DataObject element,
str varname,
[int y2 = 1]
)

600
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
elememt Element to add
varname Variable name
y2 (optional)
Possible values:

1 y1-axis, default value

2 y2 axis

Clear
Removes variables from plot
None [Link]([int y2])

A RGUMENTS
y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

DoAutoScaleX
Scales x-axis automatically.
int [Link]()

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scale is not local

DoAutoScaleY2
Scales y2-axis automatically.
int VisPlot2.DoAutoScaleY2()

R ETURNS
0 Ok, call to DoAutoScaleY() was successfull
1 Failed, because the y-scale is not local

DoAutoScaleY
Scales y1-axis automatically.
int [Link]()

601
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Ok, call to DoAutoScaleY() was successfull
1 Failed, because the y-scale is not local

GetDataSource
Get data source for curve with index
DataObject [Link](int curveIndex, int yaxis)

A RGUMENTS
int curveIndex
Possible values:
<0 invalid
≥0 curve index in table

int yaxis Possible values:

1 y1 axis
2 y2 axis

R ETURNS
DataObject Data source
None No data source found

GetScaleObjX
Gets the object used for scaling the x-axis.
DataObject [Link]()

R ETURNS
this object In case that 'Use local Axis' is set to 'Local'.
the virtual instrument panel In case that 'Use local axis' is set to 'Current Page'.
the desktop In case that 'Use local axis' is set to 'Desktop'.

GetScaleObjY
Returns used object defining y-scale. The returned object is either the plot itself or the plot type
(IntPlot).
DataObject [Link] ([int y2])

R ETURNS
this object In case that 'Use local Axis' is enabled.
the plot type In case that 'Use local axis' is disabled.

602
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAdaptX
Sets the Adapt Scale option of the local x-scale.
None [Link](int mode,
[float trigger]
)

A RGUMENTS
mode Possible values:
0 off
1 on
trigger (optional)
Trigger value, unused if mode is off or empty

SetAdaptY
Sets the Adapt Scale option of the local y-scale.
None [Link](int mode,
[float offset,]
[int y2]
)

A RGUMENTS
mode Possible values:
0 off
1 on
offset (optional)
Offset value, unused if mode is off or empty
y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

SetAutoScaleX
Sets Auto Scale setting of the x-scale. The scale is automatic set to local, in case that the plot
is using the scale of the desktop or the virtual instrument panel.
None [Link](int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

603
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAutoScaleY
Sets automatic scaling mode of the y-scale. The axis given in the second argument is automat-
ically set to local.
None [Link] (int mode,
[int y2]
)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation
y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

SetCrvDesc
Sets the user defined description of a curve.
None [Link](int curveIndex, str curveDescription)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set

SetDefScaleX
Sets the x-scale to be used to the desktop.
None [Link]()

SetDefScaleY
Sets the y-scale to be used to the plot type.
None [Link]([int y2])

A RGUMENTS
y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

604
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetScaleX
Sets the local x-axis scale. A function call without arguments sets the Auto Scale setting to On
without changing the scale itself.
None [Link]()
None [Link](float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

SetScaleY
Sets scale of y-axis. Calling the function without any argument sets the Auto Scale option for
the y axis (both share the same setting) to On.
None [Link]()
None [Link](float min,
float max,
[int log,]
[int Y2]
)

A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

605
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetXVar
Sets the local x-axis variable. If The default x-axis variable (time) is set if no argument is
passed.
None [Link]()
None [Link](DataObject obj,
str varname
)

A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj

ShowY2
Enables or disables the y2 axis.
None VisPlot2.ShowY2([int show])

A RGUMENTS
show (optional)
Possible values:

0 hide y2 axis
1 show y2 axis (default)

5.6.87 VisPlottz
Overview

AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None [Link](DataObject relay,
[float colour,]
[float style,]
[float width])

A RGUMENTS
relay The protection device to be added.
colour (optional)
The colour to be used.

606
5.6. OTHERS CHAPTER 5. OBJECT METHODS

style (optional)
The line style to be used.

width (optional)
The line width to be used.

AddRelays
Adds relays to the plot.
None [Link](list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

Clear
Removes all protection devices from the plot.
None [Link]()

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 [Link]()

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 [Link]()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

607
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.88 VisVec
Overview

CentreOrigin

CentreOrigin
Centre the origin of the plot
None [Link]()

5.6.89 VisVecres
Overview

CentreOrigin

CentreOrigin
Centre the origin of the plot
None [Link]()

5.6.90 VisXyplot
Overview

Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
SetCrvDescX
SetCrvDescY

Clear
Removes all curves from plot.
None [Link]()

DoAutoScaleX
Scales all used x-axes automatically.
int [Link]()

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scales are not local

608
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScaleY
Scales all used y-axes automatically.
int [Link]()

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scales are not local

GetDataSource
Get data source for curve with index
DataObject [Link](int curveIndex)

A RGUMENTS
int curveIndex
Possible values:
<0 invalid
≥0 curve index in table

R ETURNS
DataObject Data source
None No data source found

SetCrvDescX
Sets the user defined description of a curve for the x-variable.
None [Link](int curveIndex, str curveDescription)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set

SetCrvDescY
Sets the user defined description of a curve for the y-variable.
None [Link](int curveIndex, str curveDescription)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set

609
Index

version IntAddonvars, 444

Module Functions, 2 AddEvent
IntRas, 513
Activate AddInteger
ElmNet, 115 IntAddonvars, 445
IntCase, 449 AddIntegerVector
IntLibrary, 486 IntAddonvars, 445
IntPrj, 500 AddObject
IntScenario, 526 IntAddonvars, 446
IntScensched, 530 IntReport, 515
IntScheme, 532 AddObjects
IntSscheduler, 533 IntReport, 515
IntSstage, 534 AddObjectVector
SetTabgroup, 404 IntAddonvars, 446
ActivateProject AddObjs
Application Methods, 6 VisBdia, 582
AdaptWidth AddPage
IntGrflayer, 474 SetDesktop, 383
SetLevelvis, 393 AddProjectToCombined
AddAnnotationElement IntPrj, 500
IntGrflayer, 474 AddProjectToRemoteDatabase
AddCalcRelevantCoincidenceDefinitions IntPrj, 500
SetLvscale, 395 AddRas
AddCntcy ComSimoutage, 350
ComSimoutage, 349 AddRatio
AddConfiguration TypCtcore, 577
SetDataext, 380 AddRef
AddContingencies ComNmink, 325
ComSimoutage, 350 IntDataset, 463
AddCopy SetSelect, 401
General Object Methods, 56 AddRelay
AddCubicle VisDraw, 584
ElmBoundary, 92 VisMagndiffplt, 588
AddCurve VisOcplot, 590
PltBiasdiff, 550 VisPcompdiffplt, 593
PltDataseries, 551 VisPlottz, 606
PltOvercurrent, 559 AddRelays
AddCurves VisDraw, 584
PltBiasdiff, 550 VisMagndiffplt, 589
PltOvercurrent, 559 VisOcplot, 590
AddDouble VisPcompdiffplt, 593
IntAddonvars, 443 VisPlottz, 607
AddDoubleMatrix AddResObjs
IntAddonvars, 444 VisBdia, 582
AddDoubleVector AddResVars

610
INDEX INDEX

VisPlot, 595 ComTasks, 357

VisPlot2, 600 AppendStudyCase
AddString ComTasks, 357
IntAddonvars, 447 ComTececocmp, 364
AddToUpdatePages Application Methods, 4
ComProtgraphic, 331 ActivateProject, 6
AddTrigger ClearRecycleBin, 6
IntGate, 472 CommitTransaction, 6
IntRas, 514 ConvertGeometryStringToMDL, 6
AddVar CreateFaultCase, 7
IntMon, 493 CreateProject, 7
AddVariable DecodeColour, 8
ElmRes, 125 DefineTransferAttributes, 8
AddVars DeleteUntouchedObjects, 8
ElmRes, 125 EncodeColour, 9
IntMon, 493 ExecuteCmd, 9
VisPlot, 595 GetActiveCalculationStr, 9
VisPlot2, 600 GetActiveNetworkVariations, 10
AddVector GetActiveProject, 10
PltComplexdata, 550 GetActiveScenario, 10
AddXYCurve GetActiveScenarioScheduler, 11
PltDataseries, 552 GetActiveStages, 11
Align GetActiveStudyCase, 11
IntGrflayer, 475 GetAllUsers, 11
SetLevelvis, 393 GetAttributeDescription, 12
All GetAttributeUnit, 12
IntDataset, 463 GetBorderCubicles, 13
SetSelect, 401 GetBrowserSelection, 13
AllAsm GetCalcRelevantObjects, 13
SetSelect, 402 GetClassDescription, 14
AllBars GetClassId, 14
SetSelect, 402 GetCurrentDiagram, 15
AllBreakers GetCurrentScript, 15
SetPath, 397 GetCurrentSelection, 15
SetSelect, 402 GetCurrentUser, 15
AllClosedBreakers GetCurrentZoomScaleLevel, 15
SetPath, 397 GetDataFolder, 16
SetSelect, 402 GetDesktop, 16
AllElm GetDiagramSelection, 16
SetSelect, 402 GetFlowOrientation, 17
AllLines GetFromStudyCase, 17
SetSelect, 403 GetGlobalLibrary, 17
AllLoads GetInterfaceVersion, 18
SetSelect, 403 GetLanguage, 18
AllOpenBreakers GetLocalLibrary, 18
SetPath, 397 GetMem, 19
SetSelect, 403 GetProjectFolder, 19
AllProtectionDevices GetRecordingStage, 19
SetPath, 397 GetSettings, 19
AllSym GetSummaryGrid, 20
SetSelect, 403 GetTouchedObjects, 20
AllTypLne GetTouchingExpansionStages, 20
SetSelect, 403 GetTouchingStageObjects, 21
AnalyseElmRes GetTouchingVariations, 21
ComRel3, 336 GetUserManager, 21
AppendCommand GetUserSettings, 22

611
INDEX INDEX

Hide, 22 IntScenario, 527

ImportDz, 22 IntSubset, 537
ImportSnapshot, 23 ApplyAll
IsAttributeModeInternal, 23 IntOutage, 496
IsLdfValid, 23 ApplyAndResetRA
IsNAN, 23 ElmSubstat, 140
IsRmsValid, 24 ApplyNetworkState
IsScenarioAttribute, 24 IntCase, 449
IsShcValid, 24 ApplySelective
IsSimValid, 24 IntScenario, 527
IsWriteCacheEnabled, 25 IntSubset, 537
LicenceHasModule, 25 ApplyStudyTime
LoadProfile, 26 IntCase, 449
MarkInGraphics, 27 Archive
OutputFlexibleData, 27 IntPrj, 501
PostCommand, 27 AreDistParamsPossible
PrepForUntouchedDelete, 28 ElmLne, 107
Rebuild, 28 AssignCimRdfIds
ReloadProfile, 28 ComGridtocim, 309
ResetCalculation, 28 AssumeCompensationFactor
ResGetData, 29 RelZpol, 565
ResGetDescription, 29 AssumeReRl
ResGetFirstValidObject, 29 RelZpol, 565
ResGetFirstValidObjectVariable, 29 AssumeXeXl
ResGetFirstValidVariable, 29 RelZpol, 565
ResGetIndex, 30
ResGetMax, 30 BeginDataExtensionModification
ResGetMin, 30 IntPrj, 501
ResGetNextValidObject, 30 BeginTabGroup
ResGetNextValidObjectVariable, 30 SetDesktop, 383
ResGetNextValidVariable, 31 BlkDef, 417
ResGetObject, 31 CalculateCheckSum, 418
ResGetUnit, 31 Check, 417
ResGetValueCount, 31 Compile, 417
ResGetVariable, 31 Encrypt, 417
ResGetVariableCount, 31 GetCheckSum, 418
ResLoadData, 31 Pack, 418
ResReleaseData, 32 PackAsMacro, 418
ResSortToVariable, 32 ResetThirdPartyModule, 418
SaveAsScenario, 32 SetThirdPartyModule, 419
SearchObjectByForeignKey, 32 BlkSig, 419
SearchObjectsByCimId, 32 GetFromSigName, 419
SelectToolbox, 33 GetToSigName, 419
SetAttributeModeInternal, 33 BlockSwitch
SetInterfaceVersion, 34 ComShctrace, 344
SetShowAllUsers, 34 BuildNodeNames
SetWriteCacheEnabled, 34 ComUcteexp, 367
Show, 35
SplitLine, 35 CalcAggrVarsInRadFeed
StatFileGetXrange, 36 ElmFeeder, 98
StatFileResetXrange, 36 CalcCluster
StatFileSetXrange, 36 SetCluster, 372
WriteChangesToDb, 36 SetDistrstate, 392
Apply CalcContributions
ElmBmu, 91 ComRelpost, 338
IntOutage, 496 CalcDiscountedEstimatedPaybackPeriod

612
INDEX INDEX

ComTececocmp, 365 IntGrflayer, 477

CalcEfficiency SetLevelvis, 394
ElmAsm, 84 ChangeStyle
ElmGenstat, 102 GrpPage, 437
ElmPvsys, 117 PltLinebarplot, 554
ElmSym, 145 PltVectorplot, 561
ElmXnet, 177 ChangeWidthVisibilityAndColour
CalcElParams IntGrflayer, 477
TypAsmo, 576 SetLevelvis, 394
CalcEstimatedPaybackPeriod ChaVecfile, 420
ComTececocmp, 365 Update, 420
CalcInternalRateOfReturn Check
ComTececocmp, 365 BlkDef, 417
CalcMaxHostedPower ComAuditlog, 267
ComHostcap, 312 IntOutage, 496
CalcShiftedReversedBoundary SetScenario, 400
ElmBoundary, 92 SetTboxconfig, 410
CalculateCheckSum TypMdl, 578
BlkDef, 418 CheckAll
CalculateInterchangeTo IntOutage, 496
ElmArea, 81 CheckAnnotationString
ElmNet, 115 IntGrflayer, 478
ElmZone, 179 CheckAssignments
CalculateMaxFaultCurrents ComMerge, 319
ElmRelay, 120 CheckBbPath
CalculateVoltageLevel ElmBbone, 89
ElmArea, 81 CheckConsistency
ElmNet, 115 IntNndata, 495
ElmZone, 179 IntNnet, 495
CalculateVoltInterVolt CheckControllers
ElmArea, 82 ComLdf, 314
ElmNet, 116 CheckRanges
ElmZone, 179 ElmRelay, 120
CanAddProjectToRemoteDatabase CheckSyntax
IntPrj, 501 ComDpl, 302
CanSubscribeProjectReadOnly CheckUrl
IntPrj, 501 IntExtaccess, 471
CanSubscribeProjectReadWrite CimArchive, 420
IntPrj, 501 ConvertToBusBranch, 420
CentreOrigin CimModel, 421
VisDraw, 584 DeleteParameterAtIndex, 421
VisPcompdiffplt, 594 GetAttributeEnumerationType, 421
VisVec, 608 GetModelsReferencingThis, 422
VisVecres, 608 GetParameterCount, 422
ChangeColourPalette GetParameterNamespace, 422
PltComplexdata, 551 GetParameterValue, 423
PltDataseries, 552 HasParameter, 423
ChangeFont RemoveParameter, 424
IntGrflayer, 475 SetAssociationValue, 424, 425
SetLevelvis, 393 SetAttributeEnumeration, 425, 426
ChangeFrameAndWidth SetAttributeValue, 426, 427
SetLevelvis, 393 CimObject, 427
ChangeLayer DeleteParameterAtIndex, 428
IntGrflayer, 476 GetAttributeEnumerationType, 428
SetLevelvis, 394 GetObjectsReferencingThis, 429
ChangeRefPoints GetObjectsWithSameId, 429

613
INDEX INDEX

GetParameterCount, 429 SetTabgroup, 404

GetParameterNamespace, 430 SetVipage, 413
GetParameterValue, 430 StaSwitch, 252
GetPfObjects, 431 CloseAllTemporaryTabs
HasParameter, 431 SetDesktop, 384
RemoveParameter, 432 CloseTab
SetAssociationValue, 432, 433 SetTabgroup, 405
SetAttributeEnumeration, 433, 434 CloseTableReports
SetAttributeValue, 435, 436 Dialogue Boxes Functions, 38
Clear ColLbl
ComNmink, 325 IntMat, 487
ElmBoundary, 92 ComAddlabel, 253
ElmRes, 126 Execute, 253
IntDataset, 464 ComAddon, 254
IntDplmap, 465 CreateModule, 254
IntDplvec, 469 DefineDouble, 254
IntSubset, 537 DefineDoubleMatrix, 255
Output Window Methods, 53 DefineDoublePerConnection, 256
SetSelect, 403 DefineDoubleVector, 256
VisBdia, 582 DefineDoubleVectorPerConnection, 257
VisDraw, 584 DefineInteger, 258
VisHrm, 586 DefineIntegerPerConnection, 258
VisMagndiffplt, 589 DefineIntegerVector, 259
VisOcplot, 590 DefineIntegerVectorPerConnection, 260
VisPath, 591 DefineObject, 260
VisPcompdiffplt, 594 DefineObjectPerConnection, 261
VisPlot, 595 DefineObjectVector, 261
VisPlot2, 601 DefineObjectVectorPerConnection, 262
VisPlottz, 607 DefineString, 263
VisXyplot, 608 DefineStringPerConnection, 263
ClearCont DeleteModule, 264
ComSimoutage, 350 FinaliseModule, 264
ClearCurves GetActiveModule, 264
PltBiasdiff, 550 ModuleExists, 265
PltDataseries, 552 SetActiveModule, 265
PltOvercurrent, 559 ComAmpacity, 265
ClearData ExecuteAmpacityCalc, 265
IntGrfgroup, 473 ComArcreport, 266
IntGrflayer, 478 GetLocationsToReport, 266
ClearOutputWindow GetUnitFor, 266
Output Window Functions, 50 GetValueFor, 266
ClearRecycleBin IsDguv, 267
Application Methods, 6 IsEpri, 267
ClearUpdatePages ComAuditlog, 267
ComProtgraphic, 331 Check, 267
ClearVars ComBoundary, 268
IntMon, 494 GetCreatedBoundaries, 268
ClearVectors ComCapo, 268
PltComplexdata, 551 ConnectShuntToBus, 268
Close LossCostAtBusTech, 269
ElmCoup, 95 TotalLossCost, 269
ElmGndswt, 105 ComCimdbexp, 270
ElmRes, 128 Execute, 270
IntGrfnet, 483 ComCimdbimp, 270
SetDeskpage, 382 Execute, 271
SetDesktop, 384 ImportAndConvert, 271

614
INDEX INDEX

ComCimvalidate, 272 ResultForZoneVariable, 293

Execute, 272 TopologyForDirectionalBackupVariable, 294
GetClassType, 273 TopologyForFuseVariable, 295
GetDescriptionText, 273 TopologyForInstantaneousVariable, 295
GetInputObject, 274 TopologyForMaxCurrent, 295
GetModel, 274 TopologyForNonDirectionalBackupVariable,
GetModelId, 275 296
GetNumberOfValidationMessages, 275 TopologyForOverloadVariable, 296
GetObject, 276 TopologyForOverreachVariable, 297
GetObjectId, 276 TopologyForShortCircuitVariable, 297
GetProfile, 276 TopologyForZoneVariable, 298
GetSeverity, 277 TransferDirectionalBackupResultsTo, 298
GetType, 277 TransferNonDirectionalBackupResultsTo, 299
ComConreq, 278 TransferOverreachResultsTo, 299
Execute, 278 TransferResultsTo, 300
ComContingency, 278 TransferZoneResultsTo, 300
ContinueTrace, 278 ComCosim, 301
CreateRecoveryInformation, 279 PartitionNetwork, 301
GetGeneratorEvent, 279 ComDllmanager, 302
GetInterruptedPowerAndCustomersForStage, Report, 302
279 ComDpl, 302
GetInterruptedPowerAndCustomersForTimeStep,CheckSyntax, 302
280 Encrypt, 302
GetLoadEvent, 281 Execute, 303
GetNumberOfGeneratorEventsForTimeStep, GetExternalObject, 304
281 GetInputParameterDouble, 304
GetNumberOfLoadEventsForTimeStep, 281 GetInputParameterInt, 304
GetNumberOfSwitchEventsForTimeStep, 282 GetInputParameterString, 305
GetNumberOfTimeSteps, 282 IsEncrypted, 305
GetObj, 282 ResetThirdPartyModule, 306
GetSwitchEvent, 282 SetExternalObject, 306
GetTimeOfStepInSeconds, 283 SetInputParameterDouble, 306
GetTotalInterruptedPower, 283 SetInputParameterInt, 307
JumpToLastStep, 283 SetInputParameterString, 307
RemoveEvents, 283 SetThirdPartyModule, 307
StartTrace, 284 ComFlickermeter, 308
StopTrace, 284 Execute, 308
ComCoordreport, 284 ComGenrelinc, 308
DevicesToReport, 285 GetCurrentIteration, 308
HasResultsForDirectionalBackup, 285 GetMaxNumIterations, 309
HasResultsForFuse, 285 ComGridtocim, 309
HasResultsForInstantaneous, 286 AssignCimRdfIds, 309
HasResultsForNonDirectionalBackup, 286 ConvertAndExport, 309
HasResultsForOverload, 286 SetAuthorityUri, 310
HasResultsForOverreach, 287 SetBoundaries, 311
HasResultsForShortCircuit, 287 SetGridsToExport, 311
HasResultsForZone, 287 ComHostcap, 312
MaxZoneNumberFor, 288 CalcMaxHostedPower, 312
ResultForDirectionalBackupVariable, 288 ComImport, 312
ResultForFuseVariable, 289 GetCreatedObjects, 312
ResultForInstantaneousVariable, 289 GetModifiedObjects, 313
ResultForMaxCurrent, 290 ComInc, 313
ResultForNonDirectionalBackupVariable, 291 CompileDynamicModelTypes, 313
ResultForOverloadVariable, 291 ZeroDerivative, 314
ResultForOverreachVariable, 292 ComLdf, 314
ResultForShortCircuitVariable, 293 CheckControllers, 314

615
INDEX INDEX

DoNotResetCalc, 314 ContinueTrace, 328

EstimateOutage, 315 ExecuteTime, 328
Execute, 315 GetObject, 329
IsAC, 315 RemoveEvents, 329
IsBalanced, 315 SetObjs, 329
IsDC, 316 StartTrace, 330
PrintCheckResults, 316 StopTrace, 330
SetOldDistributeLoadMode, 316 Compare
ComLink, 316 ComMerge, 319
LoadMicroSCADAFile, 317 CompareActive
ReceiveData, 317 ComMerge, 319
SendData, 317 CompareRecording
SentDataStatus, 318 ComMerge, 319
SetOPCReceiveQuality, 318 ComPfdimport, 330
SetSwitchShcEventMode, 318 GetImportedObjects, 330
Commands Methods, 253 Compile
Execute, 253 BlkDef, 417
ComMerge, 318 TypMdl, 579
CheckAssignments, 319 CompileDynamicModelTypes
Compare, 319 ComInc, 313
CompareActive, 319 ComPrjconnector, 331
CompareRecording, 319 GetSuccesfullyConnectedItems, 331
ExecuteRecording, 320 GetUnsuccesfullyConnectedItems, 331
ExecuteWithActiveProject, 320 ComProtgraphic, 331
GetCorrespondingObject, 320 AddToUpdatePages, 331
GetModification, 321 ClearUpdatePages, 331
GetModificationResult, 321 ComPvcurves, 331
GetModifiedObjects, 321 FindCriticalBus, 331
Merge, 322 ComPython, 332
PrintComparisonReport, 322 GetExternalObject, 332
PrintModifications, 322 GetInputParameterDouble, 332
Reset, 323 GetInputParameterInt, 333
SetAutoAssignmentForAll, 323 GetInputParameterString, 333
SetObjectsToCompare, 323 SetExternalObject, 333
ShowBrowser, 323 SetInputParameterDouble, 334
WereModificationsFound, 324 SetInputParameterInt, 334
CommitTransaction SetInputParameterString, 335
Application Methods, 6 ComRed, 335
ComMot, 324 LdfEquivalentVerification, 335
GetMotorConnections, 324 ReductionInMemory, 336
GetMotorSwitch, 324 ResetReductionInMemory, 336
GetMotorTerminal, 325 SimEquivalentVerification, 336
ComNmink, 325 ComRel3, 336
AddRef, 325 AnalyseElmRes, 336
Clear, 325 ExeEvt, 337
GenerateContingenciesForAnalysis, 325 OvlAlleviate, 337
GetAll, 326 RemoveEvents, 337
ComOmr, 326 RemoveOutages, 337
GetFeeders, 326 ValidateConstraints, 338
GetOMR, 326 ComRelpost, 338
GetRegionCount, 327 CalcContributions, 338
ComOpc, 327 GetContributionOfComponent, 338
GetCertificatePath, 327 ComRelreport, 339
ReceiveData, 327 GetContingencies, 339
SendData, 328 GetContributionOfComponent, 339
ComOutage, 328 ComReltabreport, 339

616
INDEX INDEX

GetContingencies, 340 SetObjects, 355

GetContributionOfComponent, 340 ComSvgimport, 355
ComReport, 340 SetFileName, 355
ExecuteWithCustomSelection, 340 SetObject, 355
SetParameter, 341 ComTablereport, 355
ComRes, 341 ExportToExcel, 356
ExportFullRange, 341 ExportToHTML, 356
FileNmResNm, 341 ComTasks, 356
ComShc, 342 AppendCommand, 357
ExecuteRXSweep, 342 AppendStudyCase, 357
GetFaultType, 342 GetCommandsForStudyCase, 357
GetOverLoadedBranches, 343 GetNumberOfCommandsForStudyCase, 358
GetOverLoadedBuses, 343 GetNumberOfStudyCases, 358
ComShctrace, 344 GetStudyCases, 358
BlockSwitch, 344 IsAdditionalResultsFlagSetForCommand, 359
ExecuteAllSteps, 344 IsCommandIgnored, 359
ExecuteInitialStep, 344 IsStudyCaseIgnored, 360
ExecuteNextStep, 345 RemoveCmdsForStudyCaseRow, 360
GetBlockedSwitches, 345 RemoveCommand, 360
GetCurrentTimeStep, 345 RemoveStudyCase, 361
GetDeviceSwitches, 345 RemoveStudyCases, 361
GetDeviceTime, 346 SetAdditionalResultsFlagForCommand, 361
GetNonStartedDevices, 346 SetIgnoreFlagForCommand, 362
GetStartedDevices, 346 SetIgnoreFlagForStudyCase, 363
GetSwitchTime, 346 SetResultsFolder, 363
GetTrippedDevices, 346 ComTececo, 364
NextStepAvailable, 347 UpdateTablesByCalcPeriod, 364
ComSim, 347 ComTececocmp, 364
GetSimulationTime, 347 AppendStudyCase, 364
GetTotalWarnA, 347 CalcDiscountedEstimatedPaybackPeriod, 365
GetTotalWarnB, 347 CalcEstimatedPaybackPeriod, 365
GetTotalWarnC, 348 CalcInternalRateOfReturn, 365
GetViolatedScanModules, 348 RemoveStudyCases, 366
LoadSimulationState, 348 ComTransfer, 366
LoadSnapshot, 348 GetTransferCalcData, 366
SaveSimulationState, 348 IsLastIterationFeasible, 366
SaveSnapshot, 348 ComUcte, 367
ComSimoutage, 349 SetBatchMode, 367
AddCntcy, 349 ComUcteexp, 367
AddContingencies, 350 BuildNodeNames, 367
AddRas, 350 DeleteCompleteQuickAccess, 368
ClearCont, 350 ExportAndInitQuickAccess, 368
CreateFaultCase, 350 GetConnectedBranches, 368
Execute, 351 GetFromToNodeNames, 368
ExecuteAndCheck, 351 GetOrderCode, 369
GetNTopLoadedElms, 352 GetUcteNodeName, 369
MarkRegions, 353 InitQuickAccess, 369
RemoveAllRas, 353 QuickAccessAvailable, 370
RemoveContingencies, 353 ResetQuickAccess, 370
RemoveRas, 353 SetGridSelection, 370
Reset, 353 ComWktimp, 371
SetLimits, 354 GetCreatedObjects, 371
Update, 354 GetModifiedObjects, 371
ComSvgexport, 354 ComWr, 371
SetFileName, 354 ExportGraphicTab, 371
SetObject, 354 ConnectShuntToBus

617
INDEX INDEX

ComCapo, 268 ElmLne, 108

Consolidate CreateField
IntCase, 450 IntReport, 515
IntScheme, 532 CreateGroup
Contains IntUserman, 541
IntDplmap, 466 CreateModule
ContinueTrace ComAddon, 254
ComContingency, 278 CreateObject
ComOutage, 328 General Object Methods, 57
ConvertAndExport CreateProject
ComGridtocim, 309 Application Methods, 7
ConvertGeometriesToMDLString CreateRecoveryInformation
IntSym, 538 ComContingency, 279
ConvertGeometryStringToMDL CreateStageObject
Application Methods, 6 IntSstage, 535
ConvertToASCIIFormat CreateTable
IntComtrade, 451 IntReport, 516
ConvertToBinaryFormat CreateTimeOvercurrentPlot
IntComtrade, 451 SetPath, 398
ConvertToBusBranch CreateUser
CimArchive, 420 IntUserman, 542
CopyData CreateVersion
General Object Methods, 57 IntPrj, 502
CopyDataExtensionFrom CreateVI
IntPrj, 502 SetVipage, 414
CopyExtMeaStatusToStatusTmp
StaExtbrkmea, 185 Date/Time Functions, 38
StaExtcmdmea, 190 GetStudyTimeObject, 38
StaExtdatmea, 195 Date
StaExtfmea, 200 SetTime, 411
StaExtfuelmea, 205 Deactivate
StaExtimea, 210 ElmNet, 116
StaExtpfmea, 215 IntCase, 450
StaExtpmea, 220 IntLibrary, 486
StaExtqmea, 226 IntPrj, 503
StaExtsmea, 231 IntScenario, 527
StaExttapmea, 236 IntScensched, 530
StaExtv3mea, 241 IntScheme, 532
StaExtvmea, 246 IntSscheduler, 534
Create DecodeColour
SetPath, 397 Application Methods, 8
CreateCBEvents Default
IntEvt, 471 SetScenario, 401
CreateDerivedProject DefineBoundary
IntVersion, 547 ElmArea, 82
CreateEvent ElmNet, 116
ElmTr2, 156 ElmZone, 180
ElmTr3, 159 DefineDouble
ElmTr4, 164 ComAddon, 254
ElmTrmult, 172 DefineDoubleMatrix
ElmVoltreg, 175 ComAddon, 255
StaExtdatmea, 195 DefineDoublePerConnection
CreateFaultCase ComAddon, 256
Application Methods, 7 DefineDoubleVector
ComSimoutage, 350 ComAddon, 256
CreateFeederWithRoutes DefineDoubleVectorPerConnection

618
INDEX INDEX

ComAddon, 257 DoAutoScale

DefineInteger GrpPage, 437
ComAddon, 258 PltAxis, 549
DefineIntegerPerConnection PltLinebarplot, 554
ComAddon, 258 PltVectorplot, 562
DefineIntegerVector DoAutoScaleOnAll
ComAddon, 259 VisDraw, 584
DefineIntegerVectorPerConnection DoAutoScaleOnCharacteristics
ComAddon, 260 VisDraw, 585
DefineObject DoAutoScaleOnImpedances
ComAddon, 260 VisDraw, 585
DefineObjectPerConnection DoAutoScaleX
ComAddon, 261 GrpPage, 437
DefineObjectVector PltLinebarplot, 555
ComAddon, 261 SetDesktop, 384
DefineObjectVectorPerConnection SetVipage, 413
ComAddon, 262 VisDraw, 585
DefineString VisHrm, 586
ComAddon, 263 VisMagndiffplt, 589
DefineStringPerConnection VisOcplot, 590
ComAddon, 263 VisPath, 591
DefineTransferAttributes VisPcompdiffplt, 594
Application Methods, 8 VisPlot, 595
Delete VisPlot2, 601
General Object Methods, 57 VisPlottz, 607
DeleteCompleteQuickAccess VisXyplot, 608
ComUcteexp, 368 DoAutoScaleY2
DeleteModule VisPlot2, 601
ComAddon, 264 DoAutoScaleY
DeleteParameterAtIndex GrpPage, 437
CimModel, 421 PltLinebarplot, 555
CimObject, 428 SetVipage, 413
DeleteRow VisDraw, 585
IntScensched, 530 VisHrm, 586
DeleteUntouchedObjects VisMagndiffplt, 589
Application Methods, 8 VisOcplot, 591
Derate VisPath, 592
ElmGenstat, 102 VisPcompdiffplt, 594
ElmPvsys, 117 VisPlot, 596
ElmSym, 145 VisPlot2, 601
DevicesToReport VisPlottz, 607
ComCoordreport, 285 VisXyplot, 609
Dialogue Boxes Functions, 38 DoNotResetCalc
CloseTableReports, 38 ComLdf, 314
GetTableReports, 38
ShowModalBrowser, 39 EchoOff
ShowModalSelectBrowser, 39 Environment Functions, 41
ShowModelessBrowser, 40 EchoOn
UpdateTableReports, 40 Environment Functions, 41
DiscardChanges ElmArea, 81
IntScenario, 528 CalculateInterchangeTo, 81
Disconnect CalculateVoltageLevel, 81
ElmGenstat, 103 CalculateVoltInterVolt, 82
ElmPvsys, 117 DefineBoundary, 82
ElmSym, 145 GetAll, 83
ElmXnet, 177 GetBranches, 83

619
INDEX INDEX

GetBuses, 83 CalcAggrVarsInRadFeed, 98
GetObjs, 83 GetAll, 99
ElmAsm, 84 GetBranches, 99
CalcEfficiency, 84 GetBuses, 99
GetAvailableGenPower, 84 GetNodesBranches, 100
GetElecTorque, 85 GetObjs, 100
GetGroundingImpedance, 85 ElmFile, 101
GetMechTorque, 85 LoadFile, 101
GetMotorStartingFlag, 86 SaveFile, 101
GetStepupTransformer, 86 ElmFilter, 101
IsPQ, 86 GetGroundingImpedance, 101
ElmAsmsc, 87 ElmGenstat, 102
GetAvailableGenPower, 87 CalcEfficiency, 102
GetGroundingImpedance, 87 Derate, 102
GetStepupTransformer, 88 Disconnect, 103
ElmBbone, 88 GetAvailableGenPower, 103
CheckBbPath, 89 GetGroundingImpedance, 103
GetBbOrder, 89 GetStepupTransformer, 104
GetCompleteBbPath, 89 IsConnected, 104
GetFOR, 90 Reconnect, 104
GetMeanCs, 90 ResetDerating, 105
GetMinCs, 90 ElmGndswt, 105
GetTieOpenPoint, 90 Close, 105
GetTotLength, 91 GetGroundingImpedance, 105
HasGnrlMod, 91 IsClosed, 106
ElmBmu, 91 IsOpen, 106
Apply, 91 Open, 106
Update, 91 ElmLne, 107
ElmBoundary, 92 AreDistParamsPossible, 107
AddCubicle, 92 CreateFeederWithRoutes, 108
CalcShiftedReversedBoundary, 92 FitParams, 108
Clear, 92 GetIthr, 108
GetInterior, 93 GetType, 109
IsSplitting, 93 GetY0m, 109
Resize, 93 GetY1m, 109
Update, 93 GetZ0m, 110
ElmBranch, 94 GetZ1m, 110
Update, 94 GetZmatDist, 111
ElmCabsys, 94 HasRoutes, 111
FitParams, 94 HasRoutesOrSec, 111
GetLineCable, 94 IsCable, 111
Update, 95 IsNetCoupling, 112
ElmComp, 95 MeasureLength, 112
slotupd, 95 SetDetailed, 112
SlotUpdate, 95 ElmLnesec, 113
ElmCoup, 95 IsCable, 113
Close, 95 ElmMdl, 113
GetRemoteBreakers, 96 ExportToClipboard, 113
IsBreaker, 96 ExportToFile, 113
IsClosed, 96 ElmNec, 114
IsOpen, 97 GetGroundingImpedance, 114
Open, 97 ElmNet, 114
ElmDsl, 97 Activate, 115
ExportToClipboard, 97 CalculateInterchangeTo, 115
ExportToFile, 98 CalculateVoltageLevel, 115
ElmFeeder, 98 CalculateVoltInterVolt, 116

620
INDEX INDEX

Deactivate, 116 GetUnit, 135

DefineBoundary, 116 GetValue, 135
ElmPvsys, 117 GetVariable, 136
CalcEfficiency, 117 Init, 136
Derate, 117 InitialiseWriting, 136
Disconnect, 117 Load, 137
GetAvailableGenPower, 118 NCol, 133
GetGroundingImpedance, 118 NRow, 133
IsConnected, 119 Release, 137
Reconnect, 119 SetAsDefault, 137
ResetDerating, 119 SetObj, 137
ElmRelay, 119 SetSubElmResKey, 137
CalculateMaxFaultCurrents, 120 SizeX, 133
CheckRanges, 120 SizeY, 133
GetCalcRX, 120 SortAccordingToColumn, 138
GetMaxFdetectCalcI, 120 Write, 138
GetSlot, 121 WriteDraw, 138
GetUnom, 121 ElmShnt, 138
IsStarted, 121 GetGroundingImpedance, 138
SetImpedance, 122 ElmStactrl, 139
SetMaxI, 123 GetControlledHVNode, 139
SetMaxIearth, 123 GetControlledLVNode, 139
SetMinI, 123 GetStepupTransformer, 140
SetMinIearth, 123 Info, 140
SetOutOfService, 123 ElmSubstat, 140
SetTime, 124 ApplyAndResetRA, 140
slotupd, 124 GetSplit, 141
SlotUpdate, 124 GetSplitCal, 141
ElmRes, 125 GetSplitIndex, 142
AddVariable, 125 GetSuppliedElements, 142
AddVars, 125 OverwriteRA, 143
Clear, 126 ResetRA, 143
Close, 128 SaveAsRA, 144
ExecuteLoadingCommand, 126 SetRA, 144
FindColumn, 126 ElmSvs, 144
FindMaxInColumn, 127 GetStepupTransformer, 144
FindMaxOfVariableInRow, 127 ElmSym, 145
FindMinInColumn, 127 CalcEfficiency, 145
FindMinOfVariableInRow, 128 Derate, 145
FinishWriting, 128 Disconnect, 145
Flush, 128 GetAvailableGenPower, 146
GetColumnValues, 129 GetGroundingImpedance, 146
GetDescription, 129 GetMotorStartingFlag, 147
GetFirstValidObject, 129 GetStepupTransformer, 147
GetFirstValidObjectVariable, 130 IsConnected, 147
GetFirstValidVariable, 131 Reconnect, 148
GetNextValidObject, 131 ResetDerating, 148
GetNextValidObjectVariable, 132 ElmTerm, 148
GetNextValidVariable, 133 GetBusType, 148
GetNumberOfColumns, 133 GetCalcRelevantCubicles, 149
GetNumberOfRows, 133 GetConnectedBrkCubicles, 149
GetObj, 133 GetConnectedCubicles, 149
GetObject, 134 GetConnectedMainBuses, 149
GetObjectValue, 134 GetConnectionInfo, 150
GetRelCase, 134 GetEquivalentTerminals, 150
GetSubElmRes, 135 GetMinDistance, 151

621
INDEX INDEX

GetNextHVBus, 151 GetTapPhi, 173

GetNodeName, 152 GetTapRatio, 173
GetSepStationAreas, 152 GetZpu, 174
GetShortestPath, 152 IsQuadBooster, 174
HasCreatedCalBus, 153 NTap, 174
IsElectrEquivalent, 153 ElmVac, 175
IsEquivalent, 154 GetGroundingImpedance, 175
IsInternalNodeInStation, 154 ElmVoltreg, 175
UpdateSubstationTerminals, 155 CreateEvent, 175
ElmTow, 155 GetGroundingImpedance, 176
Update, 155 GetZpu, 176
ElmTr2, 155 NTap, 176
CreateEvent, 156 ElmXnet, 177
GetGroundingImpedance, 156 CalcEfficiency, 177
GetSuppliedElements, 156 Disconnect, 177
GetTapPhi, 157 GetGroundingImpedance, 177
GetTapRatio, 157 GetStepupTransformer, 178
GetZ0pu, 158 Reconnect, 178
GetZpu, 158 ElmZone, 178
IsQuadBooster, 159 CalculateInterchangeTo, 179
NTap, 159 CalculateVoltageLevel, 179
ElmTr3, 159 CalculateVoltInterVolt, 179
CreateEvent, 159 DefineBoundary, 180
GetGroundingImpedance, 160 GetAll, 180
GetSuppliedElements, 160 GetBranches, 180
GetTapPhi, 161 GetBuses, 180
GetTapRatio, 161 GetObjs, 181
GetTapZDependentSide, 161 SetLoadScaleAbsolute, 181
GetZ0pu, 162 EmptyCache
GetZpu, 162 SetDatabase, 380
IsQuadBooster, 163 EnableDiffMode
NTap, 163 IntSstage, 535
ElmTr4, 163 EncodeColour
CreateEvent, 164 Application Methods, 9
GetGroundingImpedance, 164 Encrypt
GetSuppliedElements, 164 BlkDef, 417
GetTapPhi, 165 ComDpl, 302
GetTapRatio, 165 TypQdsl, 579
GetTapZDependentSide, 166 EndDataExtensionModification
GetZ0pu, 166 IntPrj, 503
GetZpu, 167 EndTabGroup
IsQuadBooster, 167 SetDesktop, 384
NTap, 167 Energize
ElmTrain, 168 General Object Methods, 58
SetPosition, 168 Environment Functions, 40
ElmTrb, 168 EchoOff, 41
GetGroundingImpedance, 168 EchoOn, 41
ElmTrfstat, 169 IsAutomaticCalculationResetEnabled, 41
GetSplit, 169 IsFinalEchoOnEnabled, 41
GetSplitCal, 170 SetAutomaticCalculationResetEnabled, 42
GetSplitIndex, 170 SetEnableUserBreak, 44
GetSuppliedElements, 171 SetFinalEchoOnEnabled, 42
ElmTrmult, 171 SetGraphicUpdate, 42
CreateEvent, 172 SetGuiUpdateEnabled, 43
GetGroundingImpedance, 172 SetProgressBarUpdatesEnabled, 43
GetSuppliedElements, 172 SetRescheduleFlag, 43

622
INDEX INDEX

SetUserBreakEnabled, 44 ElmDsl, 97
EstimateOutage ElmMdl, 113
ComLdf, 315 ExportToExcel
Execute ComTablereport, 356
ComAddlabel, 253 ExportToFile
ComCimdbexp, 270 ElmDsl, 98
ComCimdbimp, 271 ElmMdl, 113
ComCimvalidate, 272 ExportToHTML
ComConreq, 278 ComTablereport, 356
ComDpl, 303 ExportToVec
ComFlickermeter, 308 IntGrflayer, 479
ComLdf, 315
Commands Methods, 253 File System Functions, 37
ComSimoutage, 351 GetInstallationDirectory, 37
ExecuteAllSteps GetInstallDir, 37
ComShctrace, 344 GetTempDir, 37
ExecuteAmpacityCalc GetTemporaryDirectory, 37
ComAmpacity, 265 GetWorkingDir, 37
ExecuteAndCheck GetWorkspaceDirectory, 37
ComSimoutage, 351 FileNmResNm
ExecuteCmd ComRes, 341
Application Methods, 9 FinaliseModule
ExecuteInitialStep ComAddon, 264
ComShctrace, 344 FindColumn
ExecuteLoadingCommand ElmRes, 126
ElmRes, 126 IntComtrade, 452
ExecuteNextStep IntComtradeset, 458
ComShctrace, 345 FindCriticalBus
ExecuteRecording ComPvcurves, 331
ComMerge, 320 FindMaxInColumn
ExecuteRXSweep ElmRes, 127
ComShc, 342 IntComtrade, 452
ExecuteTime IntComtradeset, 458
ComOutage, 328 FindMaxOfVariableInRow
ExecuteWithActiveProject ElmRes, 127
ComMerge, 320 FindMinInColumn
ExecuteWithCustomSelection ElmRes, 127
ComReport, 340 IntComtrade, 452
ExeEvt IntComtradeset, 458
ComRel3, 337 FindMinOfVariableInRow
Export ElmRes, 128
IntDocument, 464 FinishWriting
IntGrfgroup, 473 ElmRes, 128
IntGrflayer, 478 First
IntIcon, 485 IntDplmap, 466
ExportAllReportDocuments FitParams
SetTabgroup, 405 ElmCabsys, 94
ExportAllTableReports ElmLne, 108
SetTabgroup, 405 Flush
ExportAndInitQuickAccess ElmRes, 128
ComUcteexp, 368 Output Window Methods, 53
ExportFullRange FlushOutputWindow
ComRes, 341 Output Window Functions, 50
ExportGraphicTab Freeze
ComWr, 371 SetDesktop, 385
ExportToClipboard General Object Methods, 55

623
INDEX INDEX

AddCopy, 56 ReportUnusedObjects, 77
CopyData, 57 SearchObject, 77
CreateObject, 57 SetAttribute, 77
Delete, 57 SetAttributeLength, 78
Energize, 58 SetAttributes, 78
GetAttribute, 58 SetAttributeShape, 78
GetAttributeDescription, 59 ShowEditDialog, 79
GetAttributeLength, 59 ShowModalSelectTree, 79
GetAttributes, 59 SwitchOff, 79
GetAttributeShape, 60 SwitchOn, 80
GetAttributeType, 60 WriteChangesToDb, 81
GetAttributeUnit, 60 GenerateContingenciesForAnalysis
GetChildren, 61 ComNmink, 325
GetClassName, 61 Get
GetCombinedProjectSource, 62 IntDplvec, 469
GetConnectedElements, 62 IntMat, 487
GetConnectionCount, 62 IntVec, 543
GetContents, 63 IntVecobj, 545
GetControlledNode, 63 SetFilt, 392
GetCubicle, 63 GetActiveCalculationStr
GetFullName, 64 Application Methods, 9
GetImpedance, 64 GetActiveModule
GetInom, 65 ComAddon, 264
GetNode, 65 GetActiveNetworkVariations
GetOperator, 66 Application Methods, 10
GetOwner, 66 GetActivePage
GetParent, 66 SetDesktop, 385
GetReferences, 66 GetActiveProject
GetRegion, 67 Application Methods, 10
GetSupplyingSubstations, 67 GetActiveScenario
GetSupplyingTransformers, 68 Application Methods, 10
GetSupplyingTrfstations, 68 GetActiveScenarioScheduler
GetSystemGrounding, 68 Application Methods, 11
GetUnom, 68 GetActiveScheduler
GetZeroImpedance, 69 IntScheme, 533
HasAttribute, 69 GetActiveStages
HasReferences, 70 Application Methods, 11
HasResults, 70 GetActiveStudyCase
IsCalcRelevant, 70 Application Methods, 11
IsDeleted, 71 GetAlarmColouringMode
IsEarthed, 71 SetColscheme, 373
IsEnergized, 71 GetAll
IsHidden, 71 ComNmink, 326
IsInFeeder, 72 ElmArea, 83
IsNetworkDataFolder, 72 ElmFeeder, 99
IsNode, 73 ElmZone, 180
IsObjectActive, 73 IntDataset, 464
IsObjectModifiedByVariation, 73 SetPath, 398
Isolate, 74 SetSelect, 404
IsOutOfService, 74 StaCubic, 182
IsReducible, 75 GetAllUsers
IsShortCircuited, 75 Application Methods, 11
MarkInGraphics, 75 GetAnalogueDescriptions
Move, 76 IntComtrade, 453
PasteCopy, 76 IntComtradeset, 459
PurgeUnusedObjects, 77 GetAnnotationElement

624
INDEX INDEX

IntGrflayer, 479 ElmZone, 180

GetApplication SetPath, 398
Module Functions, 2 GetBusType
GetApplicationExt ElmTerm, 148
Module Functions, 3 GetCalcRelevantCubicles
GetAttribute ElmTerm, 149
General Object Methods, 58 GetCalcRelevantObjects
GetAttributeDescription Application Methods, 13
Application Methods, 12 GetCalcRX
General Object Methods, 59 ElmRelay, 120
GetAttributeEnumerationType GetCanvasSize
CimModel, 421 SetDesktop, 385
CimObject, 428 GetCertificatePath
GetAttributeLength ComOpc, 327
General Object Methods, 59 GetCheckSum
GetAttributes BlkDef, 418
General Object Methods, 59 GetChildren
GetAttributeShape General Object Methods, 61
General Object Methods, 60 GetClassDescription
GetAttributeType Application Methods, 14
General Object Methods, 60 GetClassId
GetAttributeUnit Application Methods, 14
Application Methods, 12 GetClassName
General Object Methods, 60 General Object Methods, 61
GetAvailableButtons GetClassType
SetTboxconfig, 410 ComCimvalidate, 273
GetAvailableGenPower GetColouringMode
ElmAsm, 84 SetColscheme, 373
ElmAsmsc, 87 GetColumnLabel
ElmGenstat, 103 IntMat, 487
ElmPvsys, 118 GetColumnLabelIndex
ElmSym, 146 IntMat, 487
GetAxisX GetColumnValues
PltLinebarplot, 555 ElmRes, 129
PltVectorplot, 562 IntComtrade, 453
GetAxisY IntComtradeset, 459
PltLinebarplot, 555 GetCombinedProjectSource
PltVectorplot, 562 General Object Methods, 62
GetBbOrder GetCommandsForStudyCase
ElmBbone, 89 ComTasks, 357
GetBlockedSwitches GetCompleteBbPath
ComShctrace, 345 ElmBbone, 89
GetBorderCubicles GetComplexData
Application Methods, 13 PltVectorplot, 562
GetBranch GetConfiguration
StaCubic, 182 IntSubset, 538
GetBranches SetDataext, 380
ElmArea, 83 GetConfigurations
ElmFeeder, 99 SetDataext, 381
ElmZone, 180 GetConnectedBranches
SetPath, 398 ComUcteexp, 368
GetBrowserSelection GetConnectedBrkCubicles
Application Methods, 13 ElmTerm, 149
GetBuses GetConnectedCubicles
ElmArea, 83 ElmTerm, 149
ElmFeeder, 99 GetConnectedElements

625
INDEX INDEX

General Object Methods, 62 PltLinebarplot, 555

GetConnectedMainBuses GetDataSource
ElmTerm, 149 PltDataseries, 552
GetConnectedMajorNodes PltLinebarplot, 556
StaCubic, 182 VisHrm, 586
GetConnectionCount VisPlot, 596
General Object Methods, 62 VisPlot2, 602
GetConnectionInfo VisXyplot, 609
ElmTerm, 150 GetDerivedProjects
GetConnections IntPrj, 503
StaCubic, 183 IntVersion, 547
GetContent GetDescription
Output Window Methods, 53 ElmRes, 129
GetContents IntComtrade, 453
General Object Methods, 63 IntComtradeset, 459
GetContingencies GetDescriptionText
ComRelreport, 339 ComCimvalidate, 273
ComReltabreport, 340 GetDesktop
GetContributionOfComponent Application Methods, 16
ComRelpost, 338 GetDeviceSwitches
ComRelreport, 339 ComShctrace, 345
ComReltabreport, 340 GetDeviceTime
GetControlledHVNode ComShctrace, 346
ElmStactrl, 139 GetDiagramSelection
GetControlledLVNode Application Methods, 16
ElmStactrl, 139 GetDigitalDescriptions
GetControlledNode IntComtrade, 454
General Object Methods, 63 IntComtradeset, 460
GetCorrespondingObject GetDisplayedButtons
ComMerge, 320 SetTboxconfig, 410
GetCreatedBoundaries GetElecTorque
ComBoundary, 268 ElmAsm, 85
GetCreatedObjects GetEnergisingColouringMode
ComImport, 312 SetColscheme, 373
ComWktimp, 371 GetEquivalentTerminals
GetCriticalTimePhase ElmTerm, 150
IntThrating, 539 GetExternalObject
GetCubicle ComDpl, 304
General Object Methods, 63 ComPython, 332
GetCurrentDiagram GetExternalReferences
Application Methods, 15 IntPrj, 504
GetCurrentIteration GetFaultType
ComGenrelinc, 308 ComShc, 342
GetCurrentScript GetFeeders
Application Methods, 15 ComOmr, 326
GetCurrentSelection GetFieldCount
Application Methods, 15 IntReport, 517
GetCurrentTimeStep GetFieldDataType
ComShctrace, 345 IntReport, 517
GetCurrentUser GetFieldName
Application Methods, 15 IntReport, 517
GetCurrentZoomScaleLevel GetFirstValidObject
Application Methods, 15 ElmRes, 129
GetDataFolder GetFirstValidObjectVariable
Application Methods, 16 ElmRes, 130
GetDataSeries GetFirstValidVariable

626
INDEX INDEX

ElmRes, 131 ComPython, 333

GetFlowOrientation GetInputParameterString
Application Methods, 17 ComDpl, 305
GetFontID ComPython, 333
SetPrj, 399 GetInstallationDirectory
GetFOR File System Functions, 37
ElmBbone, 90 GetInstallDir
GetFromSigName File System Functions, 37
BlkSig, 419 GetIntCalcres
GetFromStudyCase PltDataseries, 553
Application Methods, 17 VisPlot, 596
GetFromToNodeNames GetInterfaceVersion
ComUcteexp, 368 Application Methods, 18
GetFullName GetInterior
General Object Methods, 64 ElmBoundary, 93
GetGeneratorEvent GetInterruptedPowerAndCustomersForStage
ComContingency, 279 ComContingency, 279
GetGeoCoordinateSystem GetInterruptedPowerAndCustomersForTimeStep
IntPrj, 504 ComContingency, 280
GetGlobalLibrary GetIthr
Application Methods, 17 ElmLne, 108
GetGroundingImpedance GetLanguage
ElmAsm, 85 Application Methods, 18
ElmAsmsc, 87 GetLatestVersion
ElmFilter, 101 IntPrj, 504
ElmGenstat, 103 GetLegend
ElmGndswt, 105 PltLinebarplot, 556
ElmNec, 114 PltVectorplot, 562
ElmPvsys, 118 GetLimit
ElmShnt, 138 ScnFreq, 565
ElmSym, 146 ScnFrt, 567
ElmTr2, 156 ScnSpeed, 569
ElmTr3, 160 ScnSync, 571
ElmTr4, 164 ScnVar, 572
ElmTrb, 168 ScnVolt, 574
ElmTrmult, 172 GetLineCable
ElmVac, 175 ElmCabsys, 94
ElmVoltreg, 176 GetLoadEvent
ElmXnet, 177 ComContingency, 281
GetGroups GetLocalLibrary
IntUserman, 542 Application Methods, 18
GetHistoricalProject GetLocationsToReport
IntVersion, 548 ComArcreport, 266
GetImpedance GetMaxFdetectCalcI
General Object Methods, 64 ElmRelay, 120
GetImportedObjects GetMaxNumIterations
ComPfdimport, 330 ComGenrelinc, 309
GetInom GetMeanCs
General Object Methods, 65 ElmBbone, 90
GetInputObject GetMeaValue
ComCimvalidate, 274 StaExtbrkmea, 185
GetInputParameterDouble StaExtcmdmea, 190
ComDpl, 304 StaExtdatmea, 195
ComPython, 332 StaExtfmea, 200
GetInputParameterInt StaExtfuelmea, 205
ComDpl, 304 StaExtimea, 210

627
INDEX INDEX

StaExtpfmea, 216 ComSimoutage, 352

StaExtpmea, 220 GetNumberOfAnalogueSignalDescriptions
StaExtqmea, 226 IntComtrade, 454
StaExttapmea, 236 IntComtradeset, 460
StaExtv3mea, 241 GetNumberOfAnnotationElements
StaExtvmea, 246 IntGrflayer, 479
GetMechTorque GetNumberOfClusters
ElmAsm, 85 SetCluster, 372
GetMem GetNumberOfColumns
Application Methods, 19 ElmRes, 133
GetMinCs IntComtrade, 454
ElmBbone, 90 IntComtradeset, 460
GetMinDistance IntMat, 488
ElmTerm, 151 GetNumberOfCommandsForStudyCase
GetModel ComTasks, 358
ComCimvalidate, 274 GetNumberOfDigitalSignalDescriptions
GetModelId IntComtrade, 454
ComCimvalidate, 275 IntComtradeset, 460
GetModelsReferencingThis GetNumberOfGeneratorEventsForTimeStep
CimModel, 422 ComContingency, 281
GetModification GetNumberOfLoadEventsForTimeStep
ComMerge, 321 ComContingency, 281
GetModificationResult GetNumberOfRows
ComMerge, 321 ElmRes, 133
GetModifiedObjects IntComtrade, 454
ComImport, 313 IntComtradeset, 460
ComMerge, 321 IntMat, 488
ComWktimp, 371 GetNumberOfStudyCases
GetMotorConnections ComTasks, 358
ComMot, 324 GetNumberOfSwitchEventsForTimeStep
GetMotorStartingFlag ComContingency, 282
ElmAsm, 86 GetNumberOfTimeSteps
ElmSym, 147 ComContingency, 282
GetMotorSwitch GetNumberOfValidationMessages
ComMot, 324 ComCimvalidate, 275
GetMotorTerminal GetNumberOfViolations
ComMot, 325 ScnFreq, 566
GetNearestBusbars ScnFrt, 567
StaCubic, 183 ScnSpeed, 569
GetNextHVBus ScnSync, 571
ElmTerm, 151 ScnVar, 573
GetNextValidObject ScnVolt, 574
ElmRes, 131 GetNumProcesses
GetNextValidObjectVariable SetUser, 412
ElmRes, 132 GetNumSlave
GetNextValidVariable SetParalman, 395
ElmRes, 133 GetObj
GetNode ComContingency, 282
General Object Methods, 65 ElmRes, 133
GetNodeName GetObject
ElmTerm, 152 ComCimvalidate, 276
GetNodesBranches ComOutage, 329
ElmFeeder, 100 ElmRes, 134
GetNonStartedDevices GetObjectId
ComShctrace, 346 ComCimvalidate, 276
GetNTopLoadedElms GetObjects

628
INDEX INDEX

IntReport, 518 IntReport, 518

IntScenario, 528 GetParameterValueAsInteger
IntSubset, 538 IntReport, 519
GetObjectsReferencingThis GetParameterValueAsString
CimObject, 429 IntReport, 519
GetObjectsWithSameId GetParent
CimObject, 429 General Object Methods, 66
GetObjectValue GetPathFolder
ElmRes, 134 SetPath, 398
IntComtrade, 455 GetPathToNearestBusbar
IntComtradeset, 461 StaCubic, 184
GetObjs GetPfObjects
ElmArea, 83 CimObject, 431
ElmFeeder, 100 GetPlot
ElmZone, 181 GrpPage, 440
GetOMR GetProfile
ComOmr, 326 ComCimvalidate, 276
GetOperationValue GetProjectFolder
IntScenario, 528 Application Methods, 19
GetOperator GetProjectFolderType
General Object Methods, 66 IntPrjfolder, 511
GetOrderCode GetQlim
ComUcteexp, 369 IntQlim, 513
GetOrInsertCurvePlot GetRandomNumber
GrpPage, 437 Mathematical Functions, 45
GetOrInsertDiscreteBarPlot GetRandomNumberEx
GrpPage, 438 Mathematical Functions, 45
GetOrInsertModalAnalysisPlot GetRating
GrpPage, 438 IntThrating, 539
GetOrInsertPlot GetRecordingStage
GrpPage, 439 Application Methods, 19
SetVipage, 413 GetReferences
GetOrInsertVectorPlot General Object Methods, 66
GrpPage, 439 GetRegion
GetOrInsertXYPlot General Object Methods, 67
GrpPage, 440 GetRegionCount
GetOutputWindow ComOmr, 327
Output Window Functions, 51 GetRelCase
GetOverLoadedBranches ElmRes, 134
ComShc, 343 GetRemoteBreakers
GetOverLoadedBuses ElmCoup, 96
ComShc, 343 GetRowCount
GetOwner IntReport, 520
General Object Methods, 66 GetRowLabel
GetPage IntMat, 488
SetDesktop, 385 GetRowLabelIndex
GetParameterCount IntMat, 489
CimModel, 422 GetScaleObjX
CimObject, 429 VisHrm, 587
GetParameterNamespace VisPlot, 596
CimModel, 422 VisPlot2, 602
CimObject, 430 GetScaleObjY
GetParameterValue VisHrm, 587
CimModel, 423 VisPlot, 596
CimObject, 430 VisPlot2, 602
GetParameterValueAsDouble GetScenario

629
INDEX INDEX

IntScensched, 531 StaExtqmea, 227

GetScheme StaExtsmea, 232
IntSstage, 535 StaExttapmea, 237
GetSepStationAreas StaExtv3mea, 242
ElmTerm, 152 StaExtvmea, 247
GetSettings GetStepupTransformer
Application Methods, 19 ElmAsm, 86
GetSeverity ElmAsmsc, 88
ComCimvalidate, 277 ElmGenstat, 104
GetShortestPath ElmStactrl, 140
ElmTerm, 152 ElmSvs, 144
GetSignalHeader ElmSym, 147
IntComtrade, 455 ElmXnet, 178
IntComtradeset, 461 GetStudyCases
GetSimulationTime ComTasks, 358
ComSim, 347 GetStudyTimeObject
GetSlot Date/Time Functions, 38
ElmRelay, 121 GetSubElmRes
GetSplit ElmRes, 135
ElmSubstat, 141 GetSuccesfullyConnectedItems
ElmTrfstat, 169 ComPrjconnector, 331
GetSplitCal GetSummaryGrid
ElmSubstat, 141 Application Methods, 20
ElmTrfstat, 170 GetSuppliedElements
GetSplitIndex ElmSubstat, 142
ElmSubstat, 142 ElmTr2, 156
ElmTrfstat, 170 ElmTr3, 160
GetSplitOrientation ElmTr4, 164
SetDesktop, 386 ElmTrfstat, 171
GetStartedDevices ElmTrmult, 172
ComShctrace, 346 GetSupplyingSubstations
GetStartEndTime General Object Methods, 67
IntScensched, 531 GetSupplyingTransformers
GetStatus General Object Methods, 68
StaExtbrkmea, 185 GetSupplyingTrfstations
StaExtcmdmea, 190 General Object Methods, 68
StaExtdatmea, 196 GetSwitchEvent
StaExtfmea, 201 ComContingency, 282
StaExtfuelmea, 206 GetSwitchStatus
StaExtimea, 211 IntRunarrange, 526
StaExtpfmea, 216 GetSwitchTime
StaExtpmea, 221 ComShctrace, 346
StaExtqmea, 227 GetSystemGrounding
StaExtsmea, 231 General Object Methods, 68
StaExttapmea, 236 GetTabCount
StaExtv3mea, 242 SetTabgroup, 406
StaExtvmea, 247 GetTabGroups
GetStatusTmp SetDesktop, 386
StaExtbrkmea, 186 GetTableCount
StaExtcmdmea, 191 IntReport, 520
StaExtdatmea, 196 GetTableName
StaExtfmea, 201 IntReport, 520
StaExtfuelmea, 206 GetTableReports
StaExtimea, 211 Dialogue Boxes Functions, 38
StaExtpfmea, 216 GetTabObject
StaExtpmea, 221 SetTabgroup, 406

630
INDEX INDEX

GetTabTitle ComUcteexp, 369

SetTabgroup, 407 GetUnit
GetTabType ElmRes, 135
SetTabgroup, 407 IntComtrade, 455
GetTapPhi IntComtradeset, 461
ElmTr2, 157 GetUnitFor
ElmTr3, 161 ComArcreport, 266
ElmTr4, 165 GetUnom
ElmTrmult, 173 ElmRelay, 121
GetTapRatio General Object Methods, 68
ElmTr2, 157 GetUnsuccesfullyConnectedItems
ElmTr3, 161 ComPrjconnector, 331
ElmTr4, 165 GetUserManager
ElmTrmult, 173 Application Methods, 21
GetTapZDependentSide GetUsers
ElmTr3, 161 IntUserman, 542
ElmTr4, 166 GetUserSettings
GetTempDir Application Methods, 22
File System Functions, 37 GetValue
GetTemporaryDirectory ElmRes, 135
File System Functions, 37 IntComtrade, 456
GetTieOpenPoint IntComtradeset, 462
ElmBbone, 90 IntDplmap, 466
GetTimeOfStepInSeconds ScnFreq, 566
ComContingency, 283 ScnFrt, 568
GetTitleObject ScnSpeed, 569
PltLinebarplot, 556 ScnSync, 571
PltVectorplot, 562 ScnVar, 573
GetToSigName ScnVolt, 574
BlkSig, 419 GetValueAsDouble
GetTotalInterruptedPower IntReport, 521
ComContingency, 283 GetValueAsInteger
GetTotalWarnA IntReport, 522
ComSim, 347 GetValueAsObject
GetTotalWarnB IntReport, 522
ComSim, 347 GetValueAsString
GetTotalWarnC IntReport, 523
ComSim, 348 GetValueFor
GetTotLength ComArcreport, 266
ElmBbone, 91 GetVar
GetTouchedObjects IntMon, 494
Application Methods, 20 GetVariable
GetTouchingExpansionStages ElmRes, 136
Application Methods, 20 IntComtrade, 456
GetTouchingStageObjects IntComtradeset, 462
Application Methods, 21 ScnFreq, 566
GetTouchingVariations ScnFrt, 568
Application Methods, 21 ScnSpeed, 569
GetTransferCalcData ScnSync, 571
ComTransfer, 366 ScnVar, 573
GetTrippedDevices ScnVolt, 575
ComShctrace, 346 GetVariation
GetType IntSstage, 535
ComCimvalidate, 277 GetVersions
ElmLne, 109 IntPrj, 505
GetUcteNodeName GetViolatedElement

631
INDEX INDEX

ScnFreq, 566 SetAutoScaleModeX, 440

ScnFrt, 568 SetAutoScaleModeY, 441
ScnSpeed, 570 SetLayoutMode, 441
ScnSync, 572 SetResults, 441
ScnVar, 573 SetScaleTypeX, 441
ScnVolt, 575 SetScaleTypeY, 442
GetViolatedScanModules SetScaleX, 442
ComSim, 348 SetScaleY, 442
GetViolationTime Show, 442
ScnFreq, 567
ScnFrt, 568 HasAttribute
ScnSpeed, 570 General Object Methods, 69
ScnSync, 572 HasCreatedCalBus
ScnVar, 574 ElmTerm, 153
ScnVolt, 575 HasExternalReferences
GetWorkingDir IntPrj, 505
File System Functions, 37 HasGnrlMod
GetWorkspaceDirectory ElmBbone, 91
File System Functions, 37 HasParameter
GetY0m CimModel, 423
ElmLne, 109 CimObject, 431
GetY1m HasReferences
ElmLne, 109 General Object Methods, 70
GetZ0m HasResults
ElmLne, 110 General Object Methods, 70
GetZ0pu HasResultsForDirectionalBackup
ElmTr2, 158 ComCoordreport, 285
ElmTr3, 162 HasResultsForFuse
ElmTr4, 166 ComCoordreport, 285
GetZ1m HasResultsForInstantaneous
ElmLne, 110 ComCoordreport, 286
GetZeroImpedance HasResultsForNonDirectionalBackup
General Object Methods, 69 ComCoordreport, 286
GetZeroSequenceHVLVT HasResultsForOverload
TypTr2, 581 ComCoordreport, 286
GetZmatDist HasResultsForOverreach
ElmLne, 111 ComCoordreport, 287
GetZpu HasResultsForShortCircuit
ElmTr2, 158 ComCoordreport, 287
ElmTr3, 162 HasResultsForZone
ElmTr4, 167 ComCoordreport, 287
ElmTrmult, 174 HasRoutes
ElmVoltreg, 176 ElmLne, 111
GrpPage, 436 HasRoutesOrSec
ChangeStyle, 437 ElmLne, 111
DoAutoScale, 437 Hide
DoAutoScaleX, 437 Application Methods, 22
DoAutoScaleY, 437
GetOrInsertCurvePlot, 437 Import
GetOrInsertDiscreteBarPlot, 438 IntDocument, 464
GetOrInsertModalAnalysisPlot, 438 IntGrfgroup, 473
GetOrInsertPlot, 439 IntGrflayer, 479
GetOrInsertVectorPlot, 439 IntIcon, 485
GetOrInsertXYPlot, 440 ImportAndConvert
GetPlot, 440 ComCimdbimp, 271
RemovePage, 440 ImportDz

632
INDEX INDEX

Application Methods, 22 IntComtrade, 451

ImportFromVec ConvertToASCIIFormat, 451
IntGrflayer, 480 ConvertToBinaryFormat, 451
ImportSnapshot FindColumn, 452
Application Methods, 23 FindMaxInColumn, 452
IndexOf FindMinInColumn, 452
IntDplvec, 469 GetAnalogueDescriptions, 453
Info GetColumnValues, 453
ElmStactrl, 140 GetDescription, 453
Init GetDigitalDescriptions, 454
ElmRes, 136 GetNumberOfAnalogueSignalDescriptions,
IntMat, 489 454
IntVec, 543 GetNumberOfColumns, 454
InitialiseWriting GetNumberOfDigitalSignalDescriptions, 454
ElmRes, 136 GetNumberOfRows, 454
InitQuickAccess GetObjectValue, 455
ComUcteexp, 369 GetSignalHeader, 455
InitTmp GetUnit, 455
StaExtbrkmea, 186 GetValue, 456
StaExtcmdmea, 191 GetVariable, 456
StaExtdatmea, 196 Load, 456
StaExtfmea, 201 NCol, 454
StaExtfuelmea, 206 NRow, 454
StaExtimea, 211 Release, 457
StaExtpfmea, 216 SizeX, 454
StaExtpmea, 221 SizeY, 454
StaExtqmea, 227 SortAccordingToColumn, 457
StaExtsmea, 232 IntComtradeset, 457
StaExttapmea, 237 FindColumn, 458
StaExtv3mea, 242 FindMaxInColumn, 458
StaExtvmea, 247 FindMinInColumn, 458
Insert GetAnalogueDescriptions, 459
IntDplmap, 467 GetColumnValues, 459
IntDplvec, 469 GetDescription, 459
InsertPlot GetDigitalDescriptions, 460
SetVipage, 414 GetNumberOfAnalogueSignalDescriptions,
IntAddonvars, 443 460
AddDouble, 443 GetNumberOfColumns, 460
AddDoubleMatrix, 444 GetNumberOfDigitalSignalDescriptions, 460
AddDoubleVector, 444 GetNumberOfRows, 460
AddInteger, 445 GetObjectValue, 461
AddIntegerVector, 445 GetSignalHeader, 461
AddObject, 446 GetUnit, 461
AddObjectVector, 446 GetValue, 462
AddString, 447 GetVariable, 462
RemoveParameter, 447 Load, 462
RenameClass, 447 NCol, 460
RenameParameter, 448 NRow, 460
SetConstraint, 448 Release, 463
IntCase, 449 SizeX, 460
Activate, 449 SizeY, 460
ApplyNetworkState, 449 SortAccordingToColumn, 463
ApplyStudyTime, 449 IntDataset, 463
Consolidate, 450 AddRef, 463
Deactivate, 450 All, 463
SetStudyTime, 450 Clear, 464

633
INDEX INDEX

GetAll, 464 RemoveAnnotationElement, 480

IntDocument, 464 Reset, 480
Export, 464 UpdateAnnotationElement, 481
Import, 464 IntGrfnet, 483
Reset, 465 Close, 483
View, 465 SetFontFor, 483
IntDplmap, 465 SetLayerVisibility, 484
Clear, 465 SetSymbolComponentVisibility, 484
Contains, 466 Show, 484
First, 466 IntIcon, 485
GetValue, 466 Export, 485
Insert, 467 Import, 485
Next, 467 IntLibrary, 486
Remove, 468 Activate, 486
Size, 468 Deactivate, 486
Update, 468 IntMat, 486
IntDplvec, 468 ColLbl, 487
Clear, 469 Get, 487
Get, 469 GetColumnLabel, 487
IndexOf, 469 GetColumnLabelIndex, 487
Insert, 469 GetNumberOfColumns, 488
Remove, 470 GetNumberOfRows, 488
Size, 470 GetRowLabel, 488
Sort, 470 GetRowLabelIndex, 489
IntEvt, 470 Init, 489
CreateCBEvents, 471 Invert, 490
RemoveSwitchEvents, 471 Multiply, 490
IntExtaccess, 471 NCol, 488
CheckUrl, 471 NRow, 488
IntGate, 472 Resize, 490
AddTrigger, 472 RowLbl, 488, 491
IntGrf, 472 Save, 491
MoveToLayer, 472 Set, 491
Orthogonalise, 472 SetColumnLabel, 492
SnapToGrid, 473 SetRowLabel, 492
IntGrfgroup, 473 SizeX, 488
ClearData, 473 SizeY, 488
Export, 473 SortToColum, 492
Import, 473 SortToColumn, 492
IntGrflayer, 474 IntMon, 493
AdaptWidth, 474 AddVar, 493
AddAnnotationElement, 474 AddVars, 493
Align, 475 ClearVars, 494
ChangeFont, 475 GetVar, 494
ChangeLayer, 476 NVars, 494
ChangeRefPoints, 477 PrintAllVal, 494
ChangeWidthVisibilityAndColour, 477 PrintVal, 494
CheckAnnotationString, 478 RemoveVar, 494
ClearData, 478 IntNndata, 495
Export, 478 CheckConsistency, 495
ExportToVec, 479 IntNnet, 495
GetAnnotationElement, 479 CheckConsistency, 495
GetNumberOfAnnotationElements, 479 IntOutage, 495
Import, 479 Apply, 496
ImportFromVec, 480 ApplyAll, 496
Mark, 480 Check, 496

634
INDEX INDEX

CheckAll, 496 IsValid, 514

IsInStudyTime, 497 IntReport, 514
IsInStudytime, 497 AddObject, 515
ResetAll, 497 AddObjects, 515
IntPlannedout, 498 CreateField, 515
SetRecurrence, 498 CreateTable, 516
IntPlot, 498 GetFieldCount, 517
SetAdaptY, 498 GetFieldDataType, 517
SetAutoScaleY, 498 GetFieldName, 517
SetScaleY, 499 GetObjects, 518
IntPrj, 499 GetParameterValueAsDouble, 518
Activate, 500 GetParameterValueAsInteger, 519
AddProjectToCombined, 500 GetParameterValueAsString, 519
AddProjectToRemoteDatabase, 500 GetRowCount, 520
Archive, 501 GetTableCount, 520
BeginDataExtensionModification, 501 GetTableName, 520
CanAddProjectToRemoteDatabase, 501 GetValueAsDouble, 521
CanSubscribeProjectReadOnly, 501 GetValueAsInteger, 522
CanSubscribeProjectReadWrite, 501 GetValueAsObject, 522
CopyDataExtensionFrom, 502 GetValueAsString, 523
CreateVersion, 502 Reset, 524
Deactivate, 503 SetDefaultValue, 524
EndDataExtensionModification, 503 SetValue, 525
GetDerivedProjects, 503 IntRunarrange, 526
GetExternalReferences, 504 GetSwitchStatus, 526
GetGeoCoordinateSystem, 504 IntScenario, 526
GetLatestVersion, 504 Activate, 526
GetVersions, 505 Apply, 527
HasExternalReferences, 505 ApplySelective, 527
LoadData, 505 Deactivate, 527
MergeToBaseProject, 506 DiscardChanges, 528
Migrate, 506 GetObjects, 528
NormaliseCombined, 506 GetOperationValue, 528
PackExternalReferences, 507 ReleaseMemory, 529
Purge, 507 Save, 529
PurgeObjectKeys, 507 SetOperationValue, 529
RemoveProjectFromCombined, 507 IntScensched, 530
Restore, 508 Activate, 530
SetGeoCoordinateSystem, 508 Deactivate, 530
SubscribeProjectReadOnly, 508 DeleteRow, 530
SubscribeProjectReadWrite, 508 GetScenario, 531
TransformGeoCoordinates, 508 GetStartEndTime, 531
TransformToGeographicCoordinateSystem, SearchScenario, 531
509 IntScheme, 532
UnsubscribeProject, 509 Activate, 532
UpdateStatistics, 509 Consolidate, 532
UpdateToDefaultStructure, 510 Deactivate, 532
UpdateToMostRecentBaseVersion, 510 GetActiveScheduler, 533
IntPrjfolder, 511 NewStage, 533
GetProjectFolderType, 511 IntSscheduler, 533
IsProjectFolderType, 512 Activate, 533
IntQlim, 513 Deactivate, 534
GetQlim, 513 Update, 534
IntRas, 513 IntSstage, 534
AddEvent, 513 Activate, 534
AddTrigger, 514 CreateStageObject, 535

635
INDEX INDEX

EnableDiffMode, 535 UpdateFromCurrentView, 548

GetScheme, 535 Invert
GetVariation, 535 IntMat, 490
IsExcluded, 535 InvertMatrix
PrintModifications, 536 Mathematical Functions, 46
ReadValue, 536 IsAC
WriteValue, 536 ComLdf, 315
IntSubset, 537 IsAdditionalResultsFlagSetForCommand
Apply, 537 ComTasks, 359
ApplySelective, 537 IsAttributeModeInternal
Clear, 537 Application Methods, 23
GetConfiguration, 538 IsAutomaticCalculationResetEnabled
GetObjects, 538 Environment Functions, 41
IntSym, 538 IsBalanced
ConvertGeometriesToMDLString, 538 ComLdf, 315
IntThrating, 539 IsBreaker
GetCriticalTimePhase, 539 ElmCoup, 96
GetRating, 539 IsCable
Resize, 539 ElmLne, 111
IntUrl, 540 ElmLnesec, 113
View, 540 TypLne, 578
IntUser, 540 IsCalcRelevant
Purge, 540 General Object Methods, 70
SetPassword, 541 IsClosed
TerminateSession, 541 ElmCoup, 96
IntUserman, 541 ElmGndswt, 106
CreateGroup, 541 SetTabgroup, 407
CreateUser, 542 StaCubic, 184
GetGroups, 542 StaSwitch, 252
GetUsers, 542 IsCommandIgnored
UpdateGroups, 542 ComTasks, 359
IntVec, 543 IsConnected
Get, 543 ElmGenstat, 104
Init, 543 ElmPvsys, 119
Max, 543 ElmSym, 147
Mean, 543 StaCubic, 184
Min, 544 IsDC
Resize, 544 ComLdf, 316
Save, 544 IsDeleted
Set, 544 General Object Methods, 71
Size, 545 IsDguv
Sort, 545 ComArcreport, 267
IntVecobj, 545 IsEarthed
Get, 545 General Object Methods, 71
Resize, 546 IsElectrEquivalent
Save, 546 ElmTerm, 153
Search, 546 IsEncrypted
Set, 546 ComDpl, 305
Size, 547 TypQdsl, 580
IntVersion, 547 IsEnergized
CreateDerivedProject, 547 General Object Methods, 71
GetDerivedProjects, 547 IsEpri
GetHistoricalProject, 548 ComArcreport, 267
Rollback, 548 IsEquivalent
IntViewbookmark, 548 ElmTerm, 154
JumpTo, 548 IsExcluded

636
INDEX INDEX

IntSstage, 535 IsScenarioAttribute

IsFinalEchoOnEnabled Application Methods, 24
Environment Functions, 41 IsShcValid
IsFrozen Application Methods, 24
SetDesktop, 387 IsShortCircuited
IsHidden General Object Methods, 75
General Object Methods, 71 IsSimValid
IsInFeeder Application Methods, 24
General Object Methods, 72 IsSplitting
IsInMainWindow ElmBoundary, 93
SetTabgroup, 408 IsStarted
IsInStudyTime ElmRelay, 121
IntOutage, 497 IsStatusBitSet
IsInStudytime StaExtbrkmea, 186
IntOutage, 497 StaExtcmdmea, 191
IsInternalNodeInStation StaExtdatmea, 196
ElmTerm, 154 StaExtfmea, 201
IsLastIterationFeasible StaExtfuelmea, 206
ComTransfer, 366 StaExtimea, 211
IsLdfValid StaExtpfmea, 217
Application Methods, 23 StaExtpmea, 222
IsNAN StaExtqmea, 227
Application Methods, 23 StaExtsmea, 232
IsNetCoupling StaExttapmea, 237
ElmLne, 112 StaExtv3mea, 242
IsNetworkDataFolder StaExtvmea, 248
General Object Methods, 72 IsStatusBitSetTmp
IsNode StaExtbrkmea, 186
General Object Methods, 73 StaExtcmdmea, 191
IsObjectActive StaExtdatmea, 197
General Object Methods, 73 StaExtfmea, 201
IsObjectModifiedByVariation StaExtfuelmea, 206
General Object Methods, 73 StaExtimea, 212
Isolate StaExtpfmea, 217
General Object Methods, 74 StaExtpmea, 222
IsOpen StaExtqmea, 227
ElmCoup, 97 StaExtsmea, 232
ElmGndswt, 106 StaExttapmea, 237
StaSwitch, 252 StaExtv3mea, 243
IsOpened StaExtvmea, 248
SetDesktop, 387 IsStudyCaseIgnored
IsOutOfService ComTasks, 360
General Object Methods, 74 IsSubCurveVisible
IsPQ PltOvercurrent, 559
ElmAsm, 86 IsValid
IsProjectFolderType IntRas, 514
IntPrjfolder, 512 IsWriteCacheEnabled
IsQuadBooster Application Methods, 25
ElmTr2, 159
ElmTr3, 163 JumpTo
ElmTr4, 167 IntViewbookmark, 548
ElmTrmult, 174 JumpToLastStep
IsReducible ComContingency, 283
General Object Methods, 75
IsRmsValid LdfEquivalentVerification
Application Methods, 24 ComRed, 335

637
INDEX INDEX

LicenceHasModule MigratePage
Application Methods, 25 SetVipage, 414
Load Min
ElmRes, 137 IntVec, 544
IntComtrade, 456 Module Functions, 2
IntComtradeset, 462 version , 2
LoadData GetApplication, 2
IntPrj, 505 GetApplicationExt, 3
LoadFile ModuleExists
ElmFile, 101 ComAddon, 265
LoadMicroSCADAFile Move
ComLink, 317 General Object Methods, 76
LoadProfile MoveTab
Application Methods, 26 SetTabgroup, 408
LoadSimulationState MoveTabs
ComSim, 348 SetTabgroup, 408
LoadSnapshot MoveTabToMainWindow
ComSim, 348 SetTabgroup, 409
LossCostAtBusTech MoveTabToNewFloatingGroup
ComCapo, 269 SetTabgroup, 409
MoveToLayer
Mark IntGrf, 472
IntGrflayer, 480 MoveToMainWindow
SetLevelvis, 395 SetTabgroup, 409
MarkInGraphics MoveToNewFloatingWindow
Application Methods, 27 SetTabgroup, 409
General Object Methods, 75 Multiply
MarkRegions IntMat, 490
ComSimoutage, 353
Mathematical Functions, 44 NCol
GetRandomNumber, 45 ElmRes, 133
GetRandomNumberEx, 45 IntComtrade, 454
InvertMatrix, 46 IntComtradeset, 460
RndExp, 46 IntMat, 488
RndGetMethod, 47 Network Elements Methods, 81
RndGetSeed, 47 NewStage
RndNormal, 47 IntScheme, 533
RndSetup, 48 Next
RndUnifInt, 49 IntDplmap, 467
RndUnifReal, 49 NextStepAvailable
RndWeibull, 49 ComShctrace, 347
SetRandomSeed, 50 NormaliseCombined
Max IntPrj, 506
IntVec, 543 NRow
MaxZoneNumberFor ElmRes, 133
ComCoordreport, 288 IntComtrade, 454
Mean IntComtradeset, 460
IntVec, 543 IntMat, 488
MeasureLength NTap
ElmLne, 112 ElmTr2, 159
Merge ElmTr3, 163
ComMerge, 322 ElmTr4, 167
MergeToBaseProject ElmTrmult, 174
IntPrj, 506 ElmVoltreg, 176
Migrate NVars
IntPrj, 506 IntMon, 494

638
INDEX INDEX

Object Methods, 55 ClearVectors, 551

Open PltDataseries, 551
ElmCoup, 97 AddCurve, 551
ElmGndswt, 106 AddXYCurve, 552
StaSwitch, 252 ChangeColourPalette, 552
OpenScriptInTab ClearCurves, 552
SetDesktop, 387 GetDataSource, 552
OpenTextFileInTab GetIntCalcres, 553
SetDesktop, 388 RemoveCurve, 553
Orthogonalise PltLegend, 553
IntGrf, 472 SetFont, 553
Other Objects Methods, 417 PltLinebarplot, 554
Output Window Functions, 50 ChangeStyle, 554
ClearOutputWindow, 50 DoAutoScale, 554
FlushOutputWindow, 50 DoAutoScaleX, 555
GetOutputWindow, 51 DoAutoScaleY, 555
PrintError, 51 GetAxisX, 555
PrintInfo, 51 GetAxisY, 555
PrintPlain, 51 GetDataSeries, 555
PrintWarn, 51 GetDataSource, 556
SetOutputWindowState, 51 GetLegend, 556
Output Window Methods, 53 GetTitleObject, 556
Clear, 53 SetAutoScaleModeX, 556
Flush, 53 SetAutoScaleModeY, 557
GetContent, 53 SetAxisSharingLevelX, 557
Print, 54 SetAxisSharingLevelY, 557
Save, 54 SetScaleTypeX, 557
SetState, 54 SetScaleTypeY, 558
OutputFlexibleData SetScaleX, 558
Application Methods, 27 SetScaleY, 558
OverwriteRA PltOvercurrent, 559
ElmSubstat, 143 AddCurve, 559
OvlAlleviate AddCurves, 559
ComRel3, 337 ClearCurves, 559
IsSubCurveVisible, 559
Pack SetSubCurveVisible, 560
BlkDef, 418 PltTitle, 560
TypMdl, 579 SetFont, 561
PackAsMacro PltVectorplot, 561
BlkDef, 418 ChangeStyle, 561
PackExternalReferences DoAutoScale, 562
IntPrj, 507 GetAxisX, 562
PartitionNetwork GetAxisY, 562
ComCosim, 301 GetComplexData, 562
PasteCopy GetLegend, 562
General Object Methods, 76 GetTitleObject, 562
PltAxis, 549 SetAutoScaleModeX, 563
DoAutoScale, 549 SetAutoScaleModeY, 563
SetFont, 549 SetScaleX, 563
PltBiasdiff, 549 SetScaleY, 563
AddCurve, 550 PostCommand
AddCurves, 550 Application Methods, 27
ClearCurves, 550 PrepForUntouchedDelete
PltComplexdata, 550 Application Methods, 28
AddVector, 550 Print
ChangeColourPalette, 551 Output Window Methods, 54

639
INDEX INDEX

SetScenario, 401 IntScenario, 529

PrintAllVal ReloadProfile
IntMon, 494 Application Methods, 28
PrintCheckResults RelToc, 564
ComLdf, 316 SetCurve, 564
PrintComparisonReport RelZpol, 564
ComMerge, 322 AssumeCompensationFactor, 565
PrintError AssumeReRl, 565
Output Window Functions, 51 AssumeXeXl, 565
PrintInfo Remove
Output Window Functions, 51 IntDplmap, 468
PrintModifications IntDplvec, 470
ComMerge, 322 RemoveAllConfigurations
IntSstage, 536 SetDataext, 381
PrintPlain RemoveAllRas
Output Window Functions, 51 ComSimoutage, 353
PrintVal RemoveAnnotationElement
IntMon, 494 IntGrflayer, 480
PrintWarn RemoveCmdsForStudyCaseRow
Output Window Functions, 51 ComTasks, 360
Purge RemoveCommand
IntPrj, 507 ComTasks, 360
IntUser, 540 RemoveConfiguration
SetTboxconfig, 410 SetDataext, 381
PurgeObjectKeys RemoveContingencies
IntPrj, 507 ComSimoutage, 353
PurgeUnusedObjects RemoveCurve
General Object Methods, 77 PltDataseries, 553
RemoveEvents
QuickAccessAvailable ComContingency, 283
ComUcteexp, 370 ComOutage, 329
ComRel3, 337
ReadValue RemoveOutages
IntSstage, 536 ComRel3, 337
Rebuild RemovePage
Application Methods, 28 GrpPage, 440
ReceiveData SetDesktop, 388
ComLink, 317 RemoveParameter
ComOpc, 327 CimModel, 424
Reconnect CimObject, 432
ElmGenstat, 104 IntAddonvars, 447
ElmPvsys, 119 RemoveProjectFromCombined
ElmSym, 148 IntPrj, 507
ElmXnet, 178 RemoveRas
ReductionInMemory ComSimoutage, 353
ComRed, 336 RemoveRatio
Refresh TypCtcore, 577
VisMagndiffplt, 589 RemoveRatioByIndex
VisOcplot, 591 TypCtcore, 578
RelChar, 564 RemoveStudyCase
SetCurve, 564 ComTasks, 361
Release RemoveStudyCases
ElmRes, 137 ComTasks, 361
IntComtrade, 457 ComTececocmp, 366
IntComtradeset, 463 RemoveSwitchEvents
ReleaseMemory IntEvt, 471

640
INDEX INDEX

RemoveVar StaExttapmea, 238

IntMon, 494 StaExtv3mea, 243
RenameClass StaExtvmea, 248
IntAddonvars, 447 ResetThirdPartyModule
RenameParameter BlkDef, 418
IntAddonvars, 448 ComDpl, 306
Report TypQdsl, 580
ComDllmanager, 302 ResGetData
ReportUnusedObjects Application Methods, 29
General Object Methods, 77 ResGetDescription
Reset Application Methods, 29
ComMerge, 323 ResGetFirstValidObject
ComSimoutage, 353 Application Methods, 29
IntDocument, 465 ResGetFirstValidObjectVariable
IntGrflayer, 480 Application Methods, 29
IntReport, 524 ResGetFirstValidVariable
SetLevelvis, 395 Application Methods, 29
ResetAll ResGetIndex
IntOutage, 497 Application Methods, 30
ResetCalculation ResGetMax
Application Methods, 28 Application Methods, 30
ResetDerating ResGetMin
ElmGenstat, 105 Application Methods, 30
ElmPvsys, 119 ResGetNextValidObject
ElmSym, 148 Application Methods, 30
ResetQuickAccess ResGetNextValidObjectVariable
ComUcteexp, 370 Application Methods, 30
ResetRA ResGetNextValidVariable
ElmSubstat, 143 Application Methods, 31
ResetReductionInMemory ResGetObject
ComRed, 336 Application Methods, 31
ResetStatusBit ResGetUnit
StaExtbrkmea, 187 Application Methods, 31
StaExtcmdmea, 191 ResGetValueCount
StaExtdatmea, 197 Application Methods, 31
StaExtfmea, 202 ResGetVariable
StaExtfuelmea, 207 Application Methods, 31
StaExtimea, 212 ResGetVariableCount
StaExtpfmea, 217 Application Methods, 31
StaExtpmea, 222 Resize
StaExtqmea, 228 ElmBoundary, 93
StaExtsmea, 232 IntMat, 490
StaExttapmea, 237 IntThrating, 539
StaExtv3mea, 243 IntVec, 544
StaExtvmea, 248 IntVecobj, 546
ResetStatusBitTmp ResLoadData
StaExtbrkmea, 187 Application Methods, 31
StaExtcmdmea, 192 ResReleaseData
StaExtdatmea, 197 Application Methods, 32
StaExtfmea, 202 ResSortToVariable
StaExtfuelmea, 207 Application Methods, 32
StaExtimea, 212 Restore
StaExtpfmea, 217 IntPrj, 508
StaExtpmea, 222 ResultForDirectionalBackupVariable
StaExtqmea, 228 ComCoordreport, 288
StaExtsmea, 233 ResultForFuseVariable

641
INDEX INDEX

ComCoordreport, 289 GetVariable, 566

ResultForInstantaneousVariable GetViolatedElement, 566
ComCoordreport, 289 GetViolationTime, 567
ResultForMaxCurrent ScnFrt, 567
ComCoordreport, 290 GetLimit, 567
ResultForNonDirectionalBackupVariable GetNumberOfViolations, 567
ComCoordreport, 291 GetValue, 568
ResultForOverloadVariable GetVariable, 568
ComCoordreport, 291 GetViolatedElement, 568
ResultForOverreachVariable GetViolationTime, 568
ComCoordreport, 292 ScnSpeed, 569
ResultForShortCircuitVariable GetLimit, 569
ComCoordreport, 293 GetNumberOfViolations, 569
ResultForZoneVariable GetValue, 569
ComCoordreport, 293 GetVariable, 569
RndExp GetViolatedElement, 570
Mathematical Functions, 46 GetViolationTime, 570
RndGetMethod ScnSync, 570
Mathematical Functions, 47 GetLimit, 571
RndGetSeed GetNumberOfViolations, 571
Mathematical Functions, 47 GetValue, 571
RndNormal GetVariable, 571
Mathematical Functions, 47 GetViolatedElement, 572
RndSetup GetViolationTime, 572
Mathematical Functions, 48 ScnVar, 572
RndUnifInt GetLimit, 572
Mathematical Functions, 49 GetNumberOfViolations, 573
RndUnifReal GetValue, 573
Mathematical Functions, 49 GetVariable, 573
RndWeibull GetViolatedElement, 573
Mathematical Functions, 49 GetViolationTime, 574
Rollback ScnVolt, 574
IntVersion, 548 GetLimit, 574
RowLbl GetNumberOfViolations, 574
IntMat, 488, 491 GetValue, 574
GetVariable, 575
Save GetViolatedElement, 575
IntMat, 491 GetViolationTime, 575
IntScenario, 529 Search
IntVec, 544 IntVecobj, 546
IntVecobj, 546 SearchObject
Output Window Methods, 54 General Object Methods, 77
SaveAsRA SearchObjectByForeignKey
ElmSubstat, 144 Application Methods, 32
SaveAsScenario SearchObjectsByCimId
Application Methods, 32 Application Methods, 32
SaveFile SearchScenario
ElmFile, 101 IntScensched, 531
SaveSimulationState SelectToolbox
ComSim, 348 Application Methods, 33
SaveSnapshot SendData
ComSim, 348 ComLink, 317
ScnFreq, 565 ComOpc, 328
GetLimit, 565 SentDataStatus
GetNumberOfViolations, 566 ComLink, 318
GetValue, 566 Set

642
INDEX INDEX

IntMat, 491 VisHrm, 587

IntVec, 544 VisPlot, 597
IntVecobj, 546 VisPlot2, 603
SetActiveModule SetAutoScaleY
ComAddon, 265 IntPlot, 498
SetAdaptX VisHrm, 587
SetDesktop, 388 VisPlot, 598
SetVipage, 414 VisPlot2, 604
VisPath, 592 SetAxisSharingLevelX
VisPlot, 597 PltLinebarplot, 557
VisPlot2, 603 SetAxisSharingLevelY
SetAdaptY PltLinebarplot, 557
IntPlot, 498 SetBatchMode
VisPath, 592 ComUcte, 367
VisPlot, 597 SetBoundaries
VisPlot2, 603 ComGridtocim, 311
SetAdditionalResultsFlagForCommand SetCluster, 372
ComTasks, 361 CalcCluster, 372
SetAsDefault GetNumberOfClusters, 372
ElmRes, 137 SetColouring
SetAssociationValue SetColscheme, 374
CimModel, 424, 425 SetColscheme, 373
CimObject, 432, 433 GetAlarmColouringMode, 373
SetAttribute GetColouringMode, 373
General Object Methods, 77 GetEnergisingColouringMode, 373
SetAttributeEnumeration SetColouring, 374
CimModel, 425, 426 SetFilter, 378
CimObject, 433, 434 SetColumnLabel
SetAttributeLength IntMat, 492
General Object Methods, 78 SetConstraint
SetAttributeModeInternal IntAddonvars, 448
Application Methods, 33 SetCrvDesc
SetAttributes VisHrm, 588
General Object Methods, 78 VisPlot, 598
SetAttributeShape VisPlot2, 604
General Object Methods, 78 SetCrvDescX
SetAttributeValue VisXyplot, 609
CimModel, 426, 427 SetCrvDescY
CimObject, 435, 436 VisXyplot, 609
SetAuthorityUri SetCurve
ComGridtocim, 310 RelChar, 564
SetAutoAssignmentForAll RelToc, 564
ComMerge, 323 SetDatabase, 380
SetAutomaticCalculationResetEnabled EmptyCache, 380
Environment Functions, 42 SetDataext, 380
SetAutoScaleModeX AddConfiguration, 380
GrpPage, 440 GetConfiguration, 380
PltLinebarplot, 556 GetConfigurations, 381
PltVectorplot, 563 RemoveAllConfigurations, 381
SetAutoScaleModeY RemoveConfiguration, 381
GrpPage, 441 SetDefaultValue
PltLinebarplot, 557 IntReport, 524
PltVectorplot, 563 SetDefScaleX
SetAutoScaleX VisHrm, 588
SetDesktop, 389 VisPlot, 598
SetVipage, 414 VisPlot2, 604

643
INDEX INDEX

SetDefScaleY SetFinalEchoOnEnabled
VisHrm, 588 Environment Functions, 42
VisPlot, 598 SetFont
VisPlot2, 604 PltAxis, 549
SetDeskpage, 382 PltLegend, 553
Close, 382 PltTitle, 561
Show, 382 SetFontFor
SetDesktop, 382 IntGrfnet, 483
AddPage, 383 SetPrj, 399
BeginTabGroup, 383 SetGeoCoordinateSystem
Close, 384 IntPrj, 508
CloseAllTemporaryTabs, 384 SetGraphicUpdate
DoAutoScaleX, 384 Environment Functions, 42
EndTabGroup, 384 SetGridSelection
Freeze, 385 ComUcteexp, 370
GetActivePage, 385 SetGridsToExport
GetCanvasSize, 385 ComGridtocim, 311
GetPage, 385 SetGuiUpdateEnabled
GetSplitOrientation, 386 Environment Functions, 43
GetTabGroups, 386 SetIgnoreFlagForCommand
IsFrozen, 387 ComTasks, 362
IsOpened, 387 SetIgnoreFlagForStudyCase
OpenScriptInTab, 387 ComTasks, 363
OpenTextFileInTab, 388 SetImpedance
RemovePage, 388 ElmRelay, 122
SetAdaptX, 388 SetInputParameterDouble
SetAutoScaleX, 389 ComDpl, 306
SetResults, 389 ComPython, 334
SetScaleX, 389 SetInputParameterInt
SetSplitOrientation, 390 ComDpl, 307
SetViewArea, 390 ComPython, 334
SetXVar, 390 SetInputParameterString
Show, 390 ComDpl, 307
Unfreeze, 391 ComPython, 335
WriteWMF, 391 SetInterfaceVersion
ZoomAll, 391 Application Methods, 34
SetDetailed SetLayerVisibility
ElmLne, 112 IntGrfnet, 484
SetDisplayedButtons SetLayoutMode
SetTboxconfig, 411 GrpPage, 441
SetDistrstate, 392 SetLevelvis, 393
CalcCluster, 392 AdaptWidth, 393
SetElms Align, 393
StoMaint, 576 ChangeFont, 393
SetEnableUserBreak ChangeFrameAndWidth, 393
Environment Functions, 44 ChangeLayer, 394
SetExternalObject ChangeRefPoints, 394
ComDpl, 306 ChangeWidthVisibilityAndColour, 394
ComPython, 333 Mark, 395
SetFileName Reset, 395
ComSvgexport, 354 SetLimits
ComSvgimport, 355 ComSimoutage, 354
SetFilt, 392 SetLoadScaleAbsolute
Get, 392 ElmZone, 181
SetFilter SetLvscale, 395
SetColscheme, 378 AddCalcRelevantCoincidenceDefinitions, 395

644
INDEX INDEX

SetMaxI AllProtectionDevices, 397

ElmRelay, 123 Create, 397
SetMaxIearth CreateTimeOvercurrentPlot, 398
ElmRelay, 123 GetAll, 398
SetMeaValue GetBranches, 398
StaExtbrkmea, 187 GetBuses, 398
StaExtcmdmea, 192 GetPathFolder, 398
StaExtdatmea, 197 SetPosition
StaExtfmea, 202 ElmTrain, 168
StaExtfuelmea, 207 SetPrimaryTap
StaExtimea, 212 StaCt, 181
StaExtpfmea, 217 SetPrj, 399
StaExtpmea, 223 GetFontID, 399
StaExtqmea, 228 SetFontFor, 399
StaExttapmea, 238 SetProgressBarUpdatesEnabled
StaExtv3mea, 243 Environment Functions, 43
StaExtvmea, 249 SetRA
SetMinI ElmSubstat, 144
ElmRelay, 123 SetRandomSeed
SetMinIearth Mathematical Functions, 50
ElmRelay, 123 SetRecurrence
SetNumSlave IntPlannedout, 498
SetParalman, 396 SetRescheduleFlag
SetObj Environment Functions, 43
ElmRes, 137 SetResults
SetObject GrpPage, 441
ComSvgexport, 354 SetDesktop, 389
ComSvgimport, 355 SetVipage, 415
SetObjects SetResultsFolder
ComSvgexport, 355 ComTasks, 363
SetObjectsToCompare SetRowLabel
ComMerge, 323 IntMat, 492
SetObjs SetScaleTypeX
ComOutage, 329 GrpPage, 441
SetOldDistributeLoadMode PltLinebarplot, 557
ComLdf, 316 SetScaleTypeY
SetOPCReceiveQuality GrpPage, 442
ComLink, 318 PltLinebarplot, 558
SetOperationValue SetScaleX
IntScenario, 529 GrpPage, 442
SetOutOfService PltLinebarplot, 558
ElmRelay, 123 PltVectorplot, 563
SetOutputWindowState SetDesktop, 389
Output Window Functions, 51 SetVipage, 415
SetParalman, 395 VisPath, 592
GetNumSlave, 395 VisPlot, 598
SetNumSlave, 396 VisPlot2, 605
SetTransfType, 396 SetScaleY
SetParameter GrpPage, 442
ComReport, 341 IntPlot, 499
SetPassword PltLinebarplot, 558
IntUser, 541 PltVectorplot, 563
SetPath, 396 VisBdia, 582
AllBreakers, 397 VisPath, 592
AllClosedBreakers, 397 VisPlot, 599
AllOpenBreakers, 397 VisPlot2, 605

645
INDEX INDEX

SetScenario, 400 StaExtdatmea, 199

Check, 400 StaExtfmea, 203
Default, 401 StaExtfuelmea, 208
Print, 401 StaExtimea, 214
SetSelect, 401 StaExtpfmea, 219
AddRef, 401 StaExtpmea, 224
All, 401 StaExtqmea, 230
AllAsm, 402 StaExtsmea, 234
AllBars, 402 StaExttapmea, 240
AllBreakers, 402 StaExtv3mea, 245
AllClosedBreakers, 402 StaExtvmea, 250
AllElm, 402 SetStatusTmp
AllLines, 403 StaExtbrkmea, 189
AllLoads, 403 StaExtcmdmea, 193
AllOpenBreakers, 403 StaExtdatmea, 199
AllSym, 403 StaExtfmea, 204
AllTypLne, 403 StaExtfuelmea, 209
Clear, 403 StaExtimea, 214
GetAll, 404 StaExtpfmea, 219
SetShowAllUsers StaExtpmea, 224
Application Methods, 34 StaExtqmea, 230
SetSplitOrientation StaExtsmea, 234
SetDesktop, 390 StaExttapmea, 240
SetState StaExtv3mea, 245
Output Window Methods, 54 StaExtvmea, 250
SetStatus SetStudyTime
StaExtbrkmea, 187 IntCase, 450
StaExtcmdmea, 192 SetStyle
StaExtdatmea, 198 SetVipage, 415
StaExtfmea, 202 SetSubCurveVisible
StaExtfuelmea, 207 PltOvercurrent, 560
StaExtimea, 213 SetSubElmResKey
StaExtpfmea, 218 ElmRes, 137
StaExtpmea, 223 SetSwitchShcEventMode
StaExtqmea, 229 ComLink, 318
StaExtsmea, 233 SetSymbolComponentVisibility
StaExttapmea, 239 IntGrfnet, 484
StaExtv3mea, 244 SetTabgroup, 404
StaExtvmea, 249 Activate, 404
SetStatusBit Close, 404
StaExtbrkmea, 188 CloseTab, 405
StaExtcmdmea, 193 ExportAllReportDocuments, 405
StaExtdatmea, 198 ExportAllTableReports, 405
StaExtfmea, 203 GetTabCount, 406
StaExtfuelmea, 208 GetTabObject, 406
StaExtimea, 214 GetTabTitle, 407
StaExtpfmea, 218 GetTabType, 407
StaExtpmea, 224 IsClosed, 407
StaExtqmea, 229 IsInMainWindow, 408
StaExtsmea, 234 MoveTab, 408
StaExttapmea, 239 MoveTabs, 408
StaExtv3mea, 244 MoveTabToMainWindow, 409
StaExtvmea, 250 MoveTabToNewFloatingGroup, 409
SetStatusBitTmp MoveToMainWindow, 409
StaExtbrkmea, 188 MoveToNewFloatingWindow, 409
StaExtcmdmea, 193 SetTboxconfig, 410

646
INDEX INDEX

Check, 410 VisBdia, 583

GetAvailableButtons, 410 Show
GetDisplayedButtons, 410 Application Methods, 35
Purge, 410 GrpPage, 442
SetDisplayedButtons, 411 IntGrfnet, 484
SetThirdPartyModule SetDeskpage, 382
BlkDef, 419 SetDesktop, 390
ComDpl, 307 SetVipage, 416
TypQdsl, 580 ShowBrowser
SetTile ComMerge, 323
SetVipage, 416 ShowEditDialog
SetTime, 411 General Object Methods, 79
Date, 411 ShowModalBrowser
ElmRelay, 124 Dialogue Boxes Functions, 39
SetTime, 411 ShowModalSelectBrowser
SetTimeUTC, 412 Dialogue Boxes Functions, 39
Time, 412 ShowModalSelectTree
SetTimeUTC General Object Methods, 79
SetTime, 412 ShowModelessBrowser
Settings Methods, 372 Dialogue Boxes Functions, 40
SetTransfType ShowY2
SetParalman, 396 VisPlot2, 606
SetUser, 412 SimEquivalentVerification
GetNumProcesses, 412 ComRed, 336
SetUserBreakEnabled Size
Environment Functions, 44 IntDplmap, 468
SetValue IntDplvec, 470
IntReport, 525 IntVec, 545
SetViewArea IntVecobj, 547
SetDesktop, 390 SizeX
SetVipage, 412 ElmRes, 133
Close, 413 IntComtrade, 454
CreateVI, 414 IntComtradeset, 460
DoAutoScaleX, 413 IntMat, 488
DoAutoScaleY, 413 SizeY
GetOrInsertPlot, 413 ElmRes, 133
InsertPlot, 414 IntComtrade, 454
MigratePage, 414 IntComtradeset, 460
SetAdaptX, 414 IntMat, 488
SetAutoScaleX, 414 slotupd
SetResults, 415 ElmComp, 95
SetScaleX, 415 ElmRelay, 124
SetStyle, 415 SlotUpdate
SetTile, 416 ElmComp, 95
SetXVar, 416 ElmRelay, 124
Show, 416 SnapToGrid
SetWriteCacheEnabled IntGrf, 473
Application Methods, 34 Sort
SetXVar IntDplvec, 470
SetDesktop, 390 IntVec, 545
SetVipage, 416 SortAccordingToColumn
VisPlot, 599 ElmRes, 138
VisPlot2, 606 IntComtrade, 457
SetXVariable IntComtradeset, 463
VisBdia, 583 SortToColum
SetYVariable IntMat, 492

647
INDEX INDEX

SortToColumn IsStatusBitSet, 196

IntMat, 492 IsStatusBitSetTmp, 197
SplitLine ResetStatusBit, 197
Application Methods, 35 ResetStatusBitTmp, 197
StaCt, 181 SetMeaValue, 197
SetPrimaryTap, 181 SetStatus, 198
StaCubic, 182 SetStatusBit, 198
GetAll, 182 SetStatusBitTmp, 199
GetBranch, 182 SetStatusTmp, 199
GetConnectedMajorNodes, 182 UpdateControl, 199
GetConnections, 183 UpdateCtrl, 199
GetNearestBusbars, 183 StaExtfmea, 200
GetPathToNearestBusbar, 184 CopyExtMeaStatusToStatusTmp, 200
IsClosed, 184 GetMeaValue, 200
IsConnected, 184 GetStatus, 201
StaExtbrkmea, 185 GetStatusTmp, 201
CopyExtMeaStatusToStatusTmp, 185 InitTmp, 201
GetMeaValue, 185 IsStatusBitSet, 201
GetStatus, 185 IsStatusBitSetTmp, 201
GetStatusTmp, 186 ResetStatusBit, 202
InitTmp, 186 ResetStatusBitTmp, 202
IsStatusBitSet, 186 SetMeaValue, 202
IsStatusBitSetTmp, 186 SetStatus, 202
ResetStatusBit, 187 SetStatusBit, 203
ResetStatusBitTmp, 187 SetStatusBitTmp, 203
SetMeaValue, 187 SetStatusTmp, 204
SetStatus, 187 UpdateControl, 204
SetStatusBit, 188 UpdateCtrl, 204
SetStatusBitTmp, 188 StaExtfuelmea, 205
SetStatusTmp, 189 CopyExtMeaStatusToStatusTmp, 205
UpdateControl, 189 GetMeaValue, 205
UpdateCtrl, 189 GetStatus, 206
StaExtcmdmea, 190 GetStatusTmp, 206
CopyExtMeaStatusToStatusTmp, 190 InitTmp, 206
GetMeaValue, 190 IsStatusBitSet, 206
GetStatus, 190 IsStatusBitSetTmp, 206
GetStatusTmp, 191 ResetStatusBit, 207
InitTmp, 191 ResetStatusBitTmp, 207
IsStatusBitSet, 191 SetMeaValue, 207
IsStatusBitSetTmp, 191 SetStatus, 207
ResetStatusBit, 191 SetStatusBit, 208
ResetStatusBitTmp, 192 SetStatusBitTmp, 208
SetMeaValue, 192 SetStatusTmp, 209
SetStatus, 192 UpdateControl, 209
SetStatusBit, 193 UpdateCtrl, 209
SetStatusBitTmp, 193 StaExtimea, 210
SetStatusTmp, 193 CopyExtMeaStatusToStatusTmp, 210
UpdateControl, 194 GetMeaValue, 210
UpdateCtrl, 194 GetStatus, 211
StaExtdatmea, 195 GetStatusTmp, 211
CopyExtMeaStatusToStatusTmp, 195 InitTmp, 211
CreateEvent, 195 IsStatusBitSet, 211
GetMeaValue, 195 IsStatusBitSetTmp, 212
GetStatus, 196 ResetStatusBit, 212
GetStatusTmp, 196 ResetStatusBitTmp, 212
InitTmp, 196 SetMeaValue, 212

648
INDEX INDEX

SetStatus, 213 UpdateCtrl, 231

SetStatusBit, 214 StaExtsmea, 231
SetStatusBitTmp, 214 CopyExtMeaStatusToStatusTmp, 231
SetStatusTmp, 214 GetStatus, 231
UpdateControl, 214 GetStatusTmp, 232
UpdateCtrl, 215 InitTmp, 232
StaExtpfmea, 215 IsStatusBitSet, 232
CopyExtMeaStatusToStatusTmp, 215 IsStatusBitSetTmp, 232
GetMeaValue, 216 ResetStatusBit, 232
GetStatus, 216 ResetStatusBitTmp, 233
GetStatusTmp, 216 SetStatus, 233
InitTmp, 216 SetStatusBit, 234
IsStatusBitSet, 217 SetStatusBitTmp, 234
IsStatusBitSetTmp, 217 SetStatusTmp, 234
ResetStatusBit, 217 UpdateControl, 235
ResetStatusBitTmp, 217 UpdateCtrl, 235
SetMeaValue, 217 StaExttapmea, 235
SetStatus, 218 CopyExtMeaStatusToStatusTmp, 236
SetStatusBit, 218 GetMeaValue, 236
SetStatusBitTmp, 219 GetStatus, 236
SetStatusTmp, 219 GetStatusTmp, 237
UpdateControl, 219 InitTmp, 237
UpdateCtrl, 220 IsStatusBitSet, 237
StaExtpmea, 220 IsStatusBitSetTmp, 237
CopyExtMeaStatusToStatusTmp, 220 ResetStatusBit, 237
GetMeaValue, 220 ResetStatusBitTmp, 238
GetStatus, 221 SetMeaValue, 238
GetStatusTmp, 221 SetStatus, 239
InitTmp, 221 SetStatusBit, 239
IsStatusBitSet, 222 SetStatusBitTmp, 240
IsStatusBitSetTmp, 222 SetStatusTmp, 240
ResetStatusBit, 222 UpdateControl, 240
ResetStatusBitTmp, 222 UpdateCtrl, 240
SetMeaValue, 223 StaExtv3mea, 241
SetStatus, 223 CopyExtMeaStatusToStatusTmp, 241
SetStatusBit, 224 GetMeaValue, 241
SetStatusBitTmp, 224 GetStatus, 242
SetStatusTmp, 224 GetStatusTmp, 242
UpdateControl, 225 InitTmp, 242
UpdateCtrl, 225 IsStatusBitSet, 242
StaExtqmea, 226 IsStatusBitSetTmp, 243
CopyExtMeaStatusToStatusTmp, 226 ResetStatusBit, 243
GetMeaValue, 226 ResetStatusBitTmp, 243
GetStatus, 227 SetMeaValue, 243
GetStatusTmp, 227 SetStatus, 244
InitTmp, 227 SetStatusBit, 244
IsStatusBitSet, 227 SetStatusBitTmp, 245
IsStatusBitSetTmp, 227 SetStatusTmp, 245
ResetStatusBit, 228 UpdateControl, 245
ResetStatusBitTmp, 228 UpdateCtrl, 246
SetMeaValue, 228 StaExtvmea, 246
SetStatus, 229 CopyExtMeaStatusToStatusTmp, 246
SetStatusBit, 229 GetMeaValue, 246
SetStatusBitTmp, 230 GetStatus, 247
SetStatusTmp, 230 GetStatusTmp, 247
UpdateControl, 230 InitTmp, 247

649
INDEX INDEX

IsStatusBitSet, 248 TopologyForOverreachVariable

IsStatusBitSetTmp, 248 ComCoordreport, 297
ResetStatusBit, 248 TopologyForShortCircuitVariable
ResetStatusBitTmp, 248 ComCoordreport, 297
SetMeaValue, 249 TopologyForZoneVariable
SetStatus, 249 ComCoordreport, 298
SetStatusBit, 250 TotalLossCost
SetStatusBitTmp, 250 ComCapo, 269
SetStatusTmp, 250 TransferDirectionalBackupResultsTo
UpdateControl, 251 ComCoordreport, 298
UpdateCtrl, 251 TransferNonDirectionalBackupResultsTo
StartTrace ComCoordreport, 299
ComContingency, 284 TransferOverreachResultsTo
ComOutage, 330 ComCoordreport, 299
StaSwitch, 251 TransferResultsTo
Close, 252 ComCoordreport, 300
IsClosed, 252 TransferZoneResultsTo
IsOpen, 252 ComCoordreport, 300
Open, 252 TransformGeoCoordinates
StatFileGetXrange IntPrj, 508
Application Methods, 36 TransformToGeographicCoordinateSystem
StatFileResetXrange IntPrj, 509
Application Methods, 36 TypAsmo, 576
StatFileSetXrange CalcElParams, 576
Application Methods, 36 TypCtcore, 577
Station Elements Methods, 181 AddRatio, 577
StoMaint, 576 RemoveRatio, 577
SetElms, 576 RemoveRatioByIndex, 578
StopTrace TypLne, 578
ComContingency, 284 IsCable, 578
ComOutage, 330 TypMdl, 578
SubscribeProjectReadOnly Check, 578
IntPrj, 508 Compile, 579
SubscribeProjectReadWrite Pack, 579
IntPrj, 508 TypQdsl, 579
SwitchOff Encrypt, 579
General Object Methods, 79 IsEncrypted, 580
SwitchOn ResetThirdPartyModule, 580
General Object Methods, 80 SetThirdPartyModule, 580
TypTr2, 581
TerminateSession GetZeroSequenceHVLVT, 581
IntUser, 541
Time Unfreeze
SetTime, 412 SetDesktop, 391
TopologyForDirectionalBackupVariable UnsubscribeProject
ComCoordreport, 294 IntPrj, 509
TopologyForFuseVariable Update
ComCoordreport, 295 ChaVecfile, 420
TopologyForInstantaneousVariable ComSimoutage, 354
ComCoordreport, 295 ElmBmu, 91
TopologyForMaxCurrent ElmBoundary, 93
ComCoordreport, 295 ElmBranch, 94
TopologyForNonDirectionalBackupVariable ElmCabsys, 95
ComCoordreport, 296 ElmTow, 155
TopologyForOverloadVariable IntDplmap, 468
ComCoordreport, 296 IntSscheduler, 534

650
INDEX INDEX

UpdateAnnotationElement SetScaleY, 582

IntGrflayer, 481 SetXVariable, 583
UpdateControl SetYVariable, 583
StaExtbrkmea, 189 VisDraw, 583
StaExtcmdmea, 194 AddRelay, 584
StaExtdatmea, 199 AddRelays, 584
StaExtfmea, 204 CentreOrigin, 584
StaExtfuelmea, 209 Clear, 584
StaExtimea, 214 DoAutoScaleOnAll, 584
StaExtpfmea, 219 DoAutoScaleOnCharacteristics, 585
StaExtpmea, 225 DoAutoScaleOnImpedances, 585
StaExtqmea, 230 DoAutoScaleX, 585
StaExtsmea, 235 DoAutoScaleY, 585
StaExttapmea, 240 VisHrm, 586
StaExtv3mea, 245 Clear, 586
StaExtvmea, 251 DoAutoScaleX, 586
UpdateCtrl DoAutoScaleY, 586
StaExtbrkmea, 189 GetDataSource, 586
StaExtcmdmea, 194 GetScaleObjX, 587
StaExtdatmea, 199 GetScaleObjY, 587
StaExtfmea, 204 SetAutoScaleX, 587
StaExtfuelmea, 209 SetAutoScaleY, 587
StaExtimea, 215 SetCrvDesc, 588
StaExtpfmea, 220 SetDefScaleX, 588
StaExtpmea, 225 SetDefScaleY, 588
StaExtqmea, 231 VisMagndiffplt, 588
StaExtsmea, 235 AddRelay, 588
StaExttapmea, 240 AddRelays, 589
StaExtv3mea, 246 Clear, 589
StaExtvmea, 251 DoAutoScaleX, 589
UpdateFromCurrentView DoAutoScaleY, 589
IntViewbookmark, 548 Refresh, 589
UpdateGroups VisOcplot, 590
IntUserman, 542 AddRelay, 590
UpdateStatistics AddRelays, 590
IntPrj, 509 Clear, 590
UpdateSubstationTerminals DoAutoScaleX, 590
ElmTerm, 155 DoAutoScaleY, 591
UpdateTableReports Refresh, 591
Dialogue Boxes Functions, 40 VisPath, 591
UpdateTablesByCalcPeriod Clear, 591
ComTececo, 364 DoAutoScaleX, 591
UpdateToDefaultStructure DoAutoScaleY, 592
IntPrj, 510 SetAdaptX, 592
UpdateToMostRecentBaseVersion SetAdaptY, 592
IntPrj, 510 SetScaleX, 592
SetScaleY, 592
ValidateConstraints VisPcompdiffplt, 593
ComRel3, 338 AddRelay, 593
View AddRelays, 593
IntDocument, 465 CentreOrigin, 594
IntUrl, 540 Clear, 594
VisBdia, 582 DoAutoScaleX, 594
AddObjs, 582 DoAutoScaleY, 594
AddResObjs, 582 VisPlot2, 600
Clear, 582 AddResVars, 600

651
INDEX INDEX

AddVars, 600 WereModificationsFound

Clear, 601 ComMerge, 324
DoAutoScaleX, 601 Write
DoAutoScaleY, 601 ElmRes, 138
DoAutoScaleY2, 601 WriteChangesToDb
GetDataSource, 602 Application Methods, 36
GetScaleObjX, 602 General Object Methods, 81
GetScaleObjY, 602 WriteDraw
SetAdaptX, 603 ElmRes, 138
SetAdaptY, 603 WriteValue
SetAutoScaleX, 603 IntSstage, 536
SetAutoScaleY, 604 WriteWMF
SetCrvDesc, 604 SetDesktop, 391
SetDefScaleX, 604
SetDefScaleY, 604 ZeroDerivative
SetScaleX, 605 ComInc, 314
SetScaleY, 605 ZoomAll
SetXVar, 606 SetDesktop, 391
ShowY2, 606
VisPlot, 594
AddResVars, 595
AddVars, 595
Clear, 595
DoAutoScaleX, 595
DoAutoScaleY, 596
GetDataSource, 596
GetIntCalcres, 596
GetScaleObjX, 596
GetScaleObjY, 596
SetAdaptX, 597
SetAdaptY, 597
SetAutoScaleX, 597
SetAutoScaleY, 598
SetCrvDesc, 598
SetDefScaleX, 598
SetDefScaleY, 598
SetScaleX, 598
SetScaleY, 599
SetXVar, 599
VisPlottz, 606
AddRelay, 606
AddRelays, 607
Clear, 607
DoAutoScaleX, 607
DoAutoScaleY, 607
VisVec, 608
CentreOrigin, 608
VisVecres, 608
CentreOrigin, 608
VisXyplot, 608
Clear, 608
DoAutoScaleX, 608
DoAutoScaleY, 609
GetDataSource, 609
SetCrvDescX, 609
SetCrvDescY, 609

652