PowerFactory 2022

Python Function Reference

F2022

POWER SYSTEM SOLUTIONS

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

Please visit our homepage at:

https://www.digsilent.de

Copyright © 2022 DIgSILENT GmbH

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

May 31, 2022

Revision 6
CONTENTS CONTENTS

Contents

1 General Description 1

2 PowerFactory Module 2

3 Application Methods 4
3.1 File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
3.2 Date/Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.3 Dialogue Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.4 Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.5 Mathematics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.6 Output Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4 Output Window 50

5 Object Methods 52
5.1 General Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
5.2 Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
5.2.1 ElmArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
5.2.2 ElmAsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
5.2.3 ElmAsmsc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
5.2.4 ElmBbone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
5.2.5 ElmBmu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
5.2.6 ElmBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
5.2.7 ElmBranch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
5.2.8 ElmCabsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
5.2.9 ElmComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
5.2.10 ElmCoup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
5.2.11 ElmDsl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
5.2.12 ElmFeeder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
5.2.13 ElmFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
5.2.14 ElmFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
5.2.15 ElmGenstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

2
CONTENTS CONTENTS

5.2.16 ElmGndswt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

5.2.17 ElmLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.2.18 ElmLnesec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.2.19 ElmMdl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.2.20 ElmNec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
5.2.21 ElmNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
5.2.22 ElmPvsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
5.2.23 ElmRelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5.2.24 ElmRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
5.2.25 ElmShnt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
5.2.26 ElmStactrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
5.2.27 ElmSubstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
5.2.28 ElmSvs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
5.2.29 ElmSym . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
5.2.30 ElmTerm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
5.2.31 ElmTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
5.2.32 ElmTr3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.2.33 ElmTr4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
5.2.34 ElmTrain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
5.2.35 ElmTrb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
5.2.36 ElmTrfstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
5.2.37 ElmVac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
5.2.38 ElmVoltreg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
5.2.39 ElmXnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
5.2.40 ElmZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
5.3 Station Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
5.3.1 StaCt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
5.3.2 StaCubic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
5.3.3 StaExtbrkmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
5.3.4 StaExtcmdmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
5.3.5 StaExtdatmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
5.3.6 StaExtfmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
5.3.7 StaExtfuelmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
5.3.8 StaExtimea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
5.3.9 StaExtpfmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.3.10 StaExtpmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
5.3.11 StaExtqmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
5.3.12 StaExtsmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
5.3.13 StaExttapmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
5.3.14 StaExtv3mea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

3
CONTENTS CONTENTS

5.3.15 StaExtvmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

5.3.16 StaSwitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
5.4 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
5.4.1 ComAddlabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
5.4.2 ComAddon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
5.4.3 ComAmpacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
5.4.4 ComAuditlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
5.4.5 ComBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
5.4.6 ComCapo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
5.4.7 ComCimdbexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
5.4.8 ComCimdbimp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
5.4.9 ComCimvalidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
5.4.10 ComConreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
5.4.11 ComContingency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
5.4.12 ComCoordreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
5.4.13 ComDllmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5.4.14 ComDpl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5.4.15 ComFlickermeter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
5.4.16 ComGenrelinc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
5.4.17 ComGridtocim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
5.4.18 ComHostcap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
5.4.19 ComImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
5.4.20 ComInc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
5.4.21 ComLdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
5.4.22 ComLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
5.4.23 ComMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
5.4.24 ComMot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
5.4.25 ComNmink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
5.4.26 ComOmr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
5.4.27 ComOpc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
5.4.28 ComOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
5.4.29 ComPfdimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
5.4.30 ComPrjconnector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
5.4.31 ComProtgraphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
5.4.32 ComPvcurves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
5.4.33 ComPython . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
5.4.34 ComRed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
5.4.35 ComRel3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
5.4.36 ComRelpost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
5.4.37 ComRelreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

4
CONTENTS CONTENTS

5.4.38 ComRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

5.4.39 ComShc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
5.4.40 ComShctrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
5.4.41 ComSim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
5.4.42 ComSimoutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
5.4.43 ComSvgexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
5.4.44 ComSvgimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
5.4.45 ComTasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
5.4.46 ComTececo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
5.4.47 ComTececocmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
5.4.48 ComTransfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
5.4.49 ComUcte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
5.4.50 ComUcteexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
5.4.51 ComWktimp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
5.5.1 SetCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
5.5.2 SetColscheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
5.5.3 SetDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
5.5.4 SetDataext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
5.5.5 SetDeskpage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
5.5.6 SetDesktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
5.5.7 SetDistrstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
5.5.8 SetFilt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
5.5.9 SetLevelvis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
5.5.10 SetParalman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
5.5.11 SetPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
5.5.12 SetPrj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
5.5.13 SetScenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
5.5.14 SetSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
5.5.15 SetTboxconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
5.5.16 SetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
5.5.17 SetUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
5.5.18 SetVipage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
5.6 Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
5.6.1 BlkDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
5.6.2 BlkSig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
5.6.3 ChaVecfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
5.6.4 CimModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
5.6.5 CimObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
5.6.6 GrpPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

5
CONTENTS CONTENTS

5.6.7 IntAddonvars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

5.6.8 IntCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
5.6.9 IntComtrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
5.6.10 IntComtradeset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
5.6.11 IntDataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
5.6.12 IntDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
5.6.13 IntDplmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
5.6.14 IntDplvec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
5.6.15 IntEvt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
5.6.16 IntExtaccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
5.6.17 IntGate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
5.6.18 IntGrf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
5.6.19 IntGrfgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
5.6.20 IntGrflayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
5.6.21 IntGrfnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
5.6.22 IntIcon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
5.6.23 IntLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
5.6.24 IntMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
5.6.25 IntMon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
5.6.26 IntOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
5.6.27 IntPlannedout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
5.6.28 IntPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
5.6.29 IntPrj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
5.6.30 IntPrjfolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
5.6.31 IntQlim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
5.6.32 IntRas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
5.6.33 IntRunarrange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
5.6.34 IntScenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
5.6.35 IntScensched . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
5.6.36 IntScheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
5.6.37 IntSscheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
5.6.38 IntSstage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
5.6.39 IntSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
5.6.40 IntThrating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
5.6.41 IntUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
5.6.42 IntUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
5.6.43 IntUserman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
5.6.44 IntVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
5.6.45 IntVecobj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
5.6.46 IntVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

6
CONTENTS CONTENTS

5.6.47 IntViewbookmark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488

5.6.48 PltAxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
5.6.49 PltComplexdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
5.6.50 PltDataseries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
5.6.51 PltLegend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
5.6.52 PltLinebarplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
5.6.53 PltTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
5.6.54 PltVectorplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
5.6.55 RelChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
5.6.56 RelToc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
5.6.57 RelZpol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
5.6.58 ScnFreq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
5.6.59 ScnFrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
5.6.60 ScnSpeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
5.6.61 ScnSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
5.6.62 ScnVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
5.6.63 ScnVolt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
5.6.64 StoMaint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
5.6.65 TypAsmo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
5.6.66 TypCtcore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
5.6.67 TypLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
5.6.68 TypMdl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
5.6.69 TypQdsl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
5.6.70 TypTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
5.6.71 VisBdia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
5.6.72 VisDraw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
5.6.73 VisHrm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
5.6.74 VisMagndiffplt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
5.6.75 VisOcplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
5.6.76 VisPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
5.6.77 VisPcompdiffplt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
5.6.78 VisPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
5.6.79 VisPlot2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
5.6.80 VisPlottz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
5.6.81 VisVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
5.6.82 VisVecres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
5.6.83 VisXyplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544

Index 547

7
 CHAPTER 1. GENERAL DESCRIPTION

1 General Description

This reference manual describes the syntax of all available functions and methods provided
by the PowerFactory module. The used Python interface version is 2 (new in PowerFactory
2016). For syntax of the Python interface version 1 (PowerFactory 15.x) please use the DPL
reference with the extended return values.
Please refer to the PowerFactory User Manual for general information about Python as script-
ing language and its usage.

1
 CHAPTER 2. POWERFACTORY MODULE

2 PowerFactory Module

Overview

version
GetApplication
GetApplicationExt

version
Holds the version of PowerFactory e.g. ”17.0.9” for PowerFactory 2017 SP7.
powerfactory.__version__

GetApplication
Creates a powerfactory.Application object and returns it. When the Python script is started from
external PowerFactory will be started. Please hold the created application object as long as
you use PowerFactory from Python and do not call this function twice.
Application powerfactory.GetApplication([str username = None,]
[str password = None,]
[str commandLineArguments = None])

A RGUMENTS
username (optional)
Name of the user to log in to PowerFactory (default None). None enforces the
default behaviour as if PowerFactory was started via shortcut.
password (optional)
The password for the user which should be logged in (default None). None omits
the password.
commandLineArguments (optional)
Additional command line options (default None). These need to be specified in
the same way as if PowerFactory was started via a command shell. None omits
the command line arguments.

R ETURNS
Application object on success, otherwise None.

S EE ALSO

GetApplicationExt()

2
 CHAPTER 2. POWERFACTORY MODULE

GetApplicationExt
Same as powerfactory.GetApplication() but throwing an exception with an error code when
PowerFactory was not able to start. Furthermore if PowerFactory exits due to an error, power-
factory.ExitError can be caught in an Python script for doing clean-up. A detailed description of
all error codes can be found in the Error Codes documentation.
When PowerFactory was started by a Python script from external and the application object
is deleted then PowerFactory is terminated but the current process keeps running. In this
situation it is not possible to start PowerFactory again in the same process.
Application powerfactory.GetApplicationExt([str username = None,]
[str password = None,]
[str commandLineArguments = None])

R ETURNS
Application object on success. In the error case an exception with a detailed error code is
thrown.

E XAMPLE
The following example starts PowerFactory from external and handles initialisation errors:
import sys;
sys.path.append(r"C:\Program Files\DIgSILENT\PowerFactory 2017\python\3.6")

import powerfactory

try:
app = powerfactory.GetApplicationExt()
# ... some calculations ...
except powerfactory.ExitError as error:
print(error)
print('error.code = %d' % error.code)

S EE ALSO

GetApplication()

3
 CHAPTER 3. APPLICATION METHODS

3 Application Methods

Overview

ActivateProject
ClearRecycleBin
CommitTransaction
CreateFaultCase
CreateProject
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
GetDiagramSelection
GetFlowOrientation
GetFromStudyCase
GetGlobalLibrary
GetGraphicsBoard
GetInterfaceVersion
GetLanguage
GetLocalLibrary
GetMem
GetProjectFolder
GetRecordingStage

4
 CHAPTER 3. APPLICATION METHODS

GetSettings
GetSummaryGrid
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
SelectToolbox
SetAttributeModeInternal
SetInterfaceVersion
SetShowAllUsers
SetWriteCacheEnabled
Show
SplitLine
StatFileGetXrange
StatFileResetXrange
StatFileSetXrange
WriteChangesToDb

5
 CHAPTER 3. APPLICATION METHODS

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

A RGUMENTS
name Name (”Project”), full qualified name (”Project.IntPrj”) or full qualified path (”\User\Project.IntPrj”)
of a project.

R ETURNS
0 on success and 1 if project can not be found or activated.

ClearRecycleBin
Clears the recylce bin of currently logged in user.
None Application.ClearRecycleBin()

CommitTransaction
Writes pending changes to database.
While a script is running none of the changes are written to the database unless the script
terminates. PowerFactory can be forced to write all pending changes to the database using
this function.
None Application.CommitTransaction()

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

A RGUMENTS
elms Selected elements to create fault cases.
mode How the fault cases are created:
0 Single fault case containing all elements.
1 n-1 (multiple cases).
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.
1 Create switch events.
folder (optional)
Folder in which the fault case is stored.

6
 CHAPTER 3. APPLICATION METHODS

R ETURNS
0 On success.
1 On error.

CreateProject
Creates a new Project inside the parent object. The default project stored in the Configura-
tion/Default folder will be copied and if it contains any Study Cases the first will be used instead
of creating a new one. If desired, a new grid can also be created. Returns the newly created
project.
DataObject Application.CreateProject(str projectName,
str gridName,
[DataObject parent])
DataObject Application.CreateProject(str projectName,
[DataObject parent])

A RGUMENTS
projectName
Name of the new project. Leave empty to open up the IntPrj dialog and let the
user enter a name.
gridName
Name of the grid that‘s created for the new project. Use an empty string to open
up the ElmNet dialog and let the user enter a name.
Leave out this argument completely to not create a grid.
parent The parent for the new project. Can be omitted to use the currently logged on user
as default.

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

A RGUMENTS
encodedColour
Colour value given in PowerFactory’s internal colour representation, as read from
any colour attribute.
red (out) Red colour channel. Range [0,255].
green (out)
Green colour channel. Range [0,255].
blue (out) Blue colour channel. Range [0,255].
alpha (out)
Colour transparency. Range [0,255], with 0 being fully transparent and 255 being
fully opaque.

7
 CHAPTER 3. APPLICATION METHODS

DefineTransferAttributes
Defines for a given classname the attributes for blockwise access via DataObject.GetAttributes()
and DataObject.SetAttributes().
None Application.DefineTransferAttributes(str classname,
str attributes
)

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

S EE ALSO

DataObject.GetAttributes(), DataObject.SetAttributes()

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

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

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

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

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

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

8
 CHAPTER 3. APPLICATION METHODS

ExecuteCmd
Executes given command string as it would be executed if typed directly into the Input Window.
Current script will continue after the command has been executed.
This function is mainly intended for testing purpose and should be used by experienced users
only.
None Application.ExecuteCmd(str command)

A RGUMENTS
command
The command string

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

R ETURNS
None basic
Load Flow ldf
AC Load Flow Sensitivities acsens
AC Contingency Analysis accont
DC Load Flow dcldf
DC Load Flow Sensitivities dcsens
DC Contingency Analysis dccont
VDE/IEC Short-Circuit shc
Complete Short-Circuit shcfull
ANSI Short-Circuit shcansi
IEC 61363 shc61363
RMS-Simulation rms
Modal Analysis modal
EMT-Simulation emt
Harmonics/Power Quality harm
Frequency Sweep fsweep
Optimal Power Flow opf
DC Optimal Power Flow dcopf
DC OPF with Contingencies dccontopf
State Estimation est
Reliability rel
General Adequacy genrel
Tie Open Point Opt. topo
Motor Starting Calculation motstart
Arc Flash Calculation arcflash
Optimal Capacitor Placement optcapo
Voltage Plan Optimization mvplan
Backbone Calculation backbone
Optimal RCS Placement optrcs

9
 CHAPTER 3. APPLICATION METHODS

GetActiveNetworkVariations
Returns all active variations for the 'Network Data' folder.
list Application.GetActiveNetworkVariations()

R ETURNS
Returns currently active IntScheme objects. Set is empty in case of no scheme being
currently active.

GetActiveProject
This function returns the currently active project.
DataObject Application.GetActiveProject()

R ETURNS
Returns currently active IntPrj object or None in case of no project being currently active.

GetActiveScenario
Returns the currently active scenario. None is returned if there is no active scenario.
DataObject Application.GetActiveScenario()

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

GetActiveScenarioScheduler
Returns currently active scenario scheduler.
DataObject Application.GetActiveScenarioScheduler()

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

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

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

10
 CHAPTER 3. APPLICATION METHODS

R ETURNS
Returns currently active IntSstage objects. Set is empty in case of no stages being currently
active.

GetActiveStudyCase
Returns the active Study Case. None is returned if there is no active study case.
DataObject Application.GetActiveStudyCase()

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

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

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

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

R ETURNS
Returns a container with all known users.

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

A RGUMENTS
classname
Name of a class.
name Name of an attribute.
short 0 Return long attribute description (default).
1 Return short attribute description.

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

11
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.GetAttributeUnit()

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

A RGUMENTS
classname
Name of a class.
name Name of an attribute.

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

S EE ALSO

Application.GetAttributeDescription()

GetBorderCubicles
This function returns the border cubicles of the parent station of passed element topologically
reachable from that element.
A cubicle (StaCubic) is considered to be a border cubicle if it resides inside the station

• and points to an element that sits outside the station

• or to a branch element that is connected to a terminal outside the station.

list Application.GetBorderCubicles(DataObject element)

A RGUMENTS
element Element from which the search for border cubicles starts

R ETURNS
A set, containing border cubicles StaCubic. If the element does not reside in any substation
or no border cubicles exist, the set is empty.

GetBrowserSelection
Returns all objects marked in the “on top” Data Manager (Browser, right side). In comparison to
Application.GetCurrentSelection() this is independently of how the script is executed.
list Application.GetBrowserSelection()

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

12
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.GetCurrentSelection(), Application.GetDiagramSelection()

GetCalcRelevantObjects
Returns all currently calculation relevant objects, i.e. the objects which are used by the calcula-
tions.
The set of objects depends on active study case, active grid(s) and variation(s).
In contrast to DataObject.IsCalcRelevant() it does not return objects of the active study case
e.g. simulation events (Evt*).
list Application.GetCalcRelevantObjects([str nameFilter,]
[int includeOutOfService = 1,]
[int topoElementsOnly = 0,]
[int bAcSchemes = 0])

A RGUMENTS
nameFilter (optional)
(Class) name filter. Wildcards are supported. Multiple filters to be separated by
comma ’,’. Must not contain a backslash ’\’.
If omitted, all objects are returned (corresponds to ’*.*’).
Examples for valid filter strings:
• ’ElmTerm’
• ’A*.ElmTerm’
• ’*.ElmLod,*.ElmSym’
includeOutOfService (optional)
Flag whether to include out of service objects. Default is 1 (=included).

topoElementsOnly (optional)
Flag to filter for topology relevant objects only. Default is 0 (=all objects).
bAcSchemes (optional)
Flag to include hidden objects in active schemes. Default is 0 (=not included).

R ETURNS
The currently calculation relevant objects, according to the given arguments. The order of
the set is undefined.

S EE ALSO

DataObject.IsCalcRelevant()

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

A RGUMENTS
name Name of a PowerFactory class

13
 CHAPTER 3. APPLICATION METHODS

R ETURNS
Returns the description of a valid PowerFactory class, otherwise an empty string.

GetClassId
Returns a class identifier number.
Each class name corresponds to one unique number. The mapping of class name might
be different for different build numbers of PowerFactory , but it is guaranteed that it will not
changed while an Api instance exists. (Do not keep these numbers static, get them dynamically
in your code using this method).
int Application.GetClassId(str className)

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

0 Class name invalid.

>0 Class id of valid class name.

GetCurrentDiagram
This function offers access to the current diagram object (IntGrfnet).
DataObject Application.GetCurrentDiagram()

GetCurrentScript
Returns the current script (ComPython).
DataObject Application.GetCurrentScript()

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

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

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

S EE ALSO

Application.GetBrowserSelection(), Application.GetDiagramSelection()

14
 CHAPTER 3. APPLICATION METHODS

GetCurrentUser
Returns the PowerFactory user of current session.
DataObject Application.GetCurrentUser()

R ETURNS
Returns an IntUser object, never None.

GetCurrentZoomScaleLevel
Returns the zoom or scale level of the currently active diagram. If the active diagram is geo-
graphic, then the scale level is returned, otherwise the zoom level is returned.
int Application.GetCurrentZoomScale()

R ETURNS
Zoom or scale level of the active diagram as integer.

• For geographic diagrams the scale level is returned. E.g. returns 50000 if 1:50000 is in
the zoom/ratio combo box
• For all other diagrams the zoom level is returned. E.g. returns 150 if 150

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

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

A RGUMENTS
classname
Classname of the elements:
ElmBmu
ElmArea
ElmZone
ElmRoute
ElmOwner
ElmOperator
ElmFeeder
ElmCircuit
ElmBoundary
IntScales
iCreate(optional)
0 The folder is searched and returned if found. If the folder does not
exist, None is returned.
1 The folder is created if it does not exist. The found or created folder is
returned.

15
 CHAPTER 3. APPLICATION METHODS

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

S EE ALSO

DataObject.IsNetworkDataFolder()

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

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

S EE ALSO

Application.GetCurrentSelection(), Application.GetBrowserSelection()

GetFlowOrientation
This function returns the flow orientation setting of the active project.
int Application.GetFlowOrientation()

R ETURNS
-1 No project is active
0 Flow orientation of active project is “MIXED MODE”
1 Flow orientation of active project is “LOAD ORIENTED”
2 Flow orientation of active project is “GENERATOR ORIENTED”

GetFromStudyCase
Returns the first found object of class “className” from the currently active study case. The
object is created when no object of the given name and/or class was found.
For commands the returned instance corresponds to the one that is used if opened via the main
menue load-flow, short-circuit, transient simulation, etc.,
DataObject Application.GetFromStudyCase(str className)

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

R ETURNS
The found or created object.

16
 CHAPTER 3. APPLICATION METHODS

GetGlobalLibrary
Returns the global library for object-types of class “ClassName”. ClassName may be omitted,
in which case the complete global library folder is returned.
DataObject Application.GetGlobalLibrary([str ClassName])

A RGUMENTS
ClassName (optional)
The classname of the objects for which the library folder is sought

R ETURNS
The libary folder

S EE ALSO

Application.GetLocalLibrary()

GetGraphicsBoard
Returns the currently active Graphics Board.
DataObject Application.GetGraphicsBoard()

R ETURNS
The graphics board object

GetInterfaceVersion
Returns the currently set interface version.
It holds the value set with SetInterfaceVersion() or the interface version from the current script
(parameter ’interfaceVersion’) if the python script is executed from within PowerFactory.
Have a look into the PowerFactor user manual to get more informations about the interface
version of a script.
int Application.GetInterfaceVersion()

R ETURNS
The currently set interface version or 0 if PowerFactory is started from external and SetInter-
faceVersion() is not called.

GetLanguage
Returns a string for the current program language setting.
str Application.GetLanguage()

R ETURNS
en English
de German
es Spanish
fr French

17
 CHAPTER 3. APPLICATION METHODS

ru Russian
cn Simplified Chinese
tr Turkish

GetLocalLibrary
Returns the local library for object-types of class “ClassName”. ClassName may be omitted, in
which case the complete local library folder is returned.
DataObject Application.GetLocalLibrary([str ClassName])

A RGUMENTS
ClassName (optional)
The classname of the objects for which the library folder is sought

R ETURNS
The libary folder

S EE ALSO

Application.GetGlobalLibrary()

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

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

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

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

A RGUMENTS
type Type of the corresponding project folder. See IntPrjfolder.GetProjectFolderType()
for a list of possible values.
create Optional, default=0. Determines whether folder shall be created if it does not exist
(1=create, 0=don’t create).

18
 CHAPTER 3. APPLICATION METHODS

R ETURNS
An IntPrjFolder object. If no project is currently active or project folder of this type does not
exist and ’create’ is not given as 0, None is returned.

GetRecordingStage
Returns the currently active recording scheme stage.
DataObject Application.GetRecordingStage()

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

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

A RGUMENTS
key
Key Return type Description
username string Name of logged-in user
installationdir string Fully qualified path of installation directory of PowerFac-
tory
workingdir string Fully qualified path of working directory of PowerFactory
tempdir string Fully qualified path of temporary directory used by PowerFac-
tory
sessionid integer ID of current session
db driver string Name of used database driver
logfile string Path of current log file

R ETURNS
Value of settings as string

GetSummaryGrid
Returns the summary grid in the currently active Study Case. The summary grid is the combi-
nation of all active grids in the study case.
DataObject Application.GetSummaryGrid()

R ETURNS
A ElmNet object, or a 'None ' object when no grids are active

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

19
 CHAPTER 3. APPLICATION METHODS

R ETURNS
The user manager object

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

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

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

Hide
Hides the PowerFactory application window.
None Application.Hide()

S EE ALSO

Application.Show()

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

A RGUMENTS
target Target object for imported data.

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

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

20
 CHAPTER 3. APPLICATION METHODS

ImportSnapshot
Imports a Snapshot DZS file.
[int errorCode,
list importedObjects ] Application.ImportSnapshot(str dzsFilePath)

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

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

IsAttributeModeInternal
Returns whether the attribute values are accessed as internally stored.
int Application.IsAttributeModeInternal()

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

S EE ALSO

Application.SetAttributeModeInternal()

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

R ETURNS
0 if no load-flow results are available

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

A RGUMENTS
value Double value to check.

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

R ETURNS
0 if no RMS simulation results are available

IsScenarioAttribute
Checks if a given attribute of a given class is recorded in scenario. It does not check whether a
concrete instance is recorded at all. The check is just performed against the scenario configu-
ration and is independent of a concrete scenario.
int Application.IsScenarioAttribute(str classname, str attributename)

A RGUMENTS
classname
Name of a PowerFactory class

attributename
Name of an attribute of given class

R ETURNS
1 If attribute is scenario relevant according to current scenario configuration
0 If attribute is not scenario relevant

IsShcValid
Checks to see if the last short-circuit results are still valid and available.
int Application.IsShcValid()

R ETURNS
0 if no short-circuit results are available

IsSimValid
Checks to see if the last simulation results are still valid and available.
int Application.IsSimValid()

R ETURNS
0 if no simulation results are available

22
 CHAPTER 3. APPLICATION METHODS

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

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

S EE ALSO

Application.SetWriteCacheEnabled(), Application.WriteChangesToDb()

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

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

23
 CHAPTER 3. APPLICATION METHODS

• opc - OPC Interface

• opfact - OPF (Economic Dispatch)
• opfreact - OPF (Reactive Power Optimisation)
• outagePlan - Outage Planning
• 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 Application.LicenceHasModule(string module)

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

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

LoadProfile
Activates a profile for current user. This corresponds to the select profile action via main menu
“TOOLS-Profiles”.
int Application.LoadProfile(str profileName)

A RGUMENTS
profileName
Name of profile to be loaded.

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

24
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.ReloadProfile()

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

Marks all objects in the diagram in which the elements are found by hatch crossing them.
None Application.MarkInGraphics(list objects,
[int searchOpenedDiagramsOnly = 0])

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

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

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

PostCommand
Adds a command as string to the command pipe of the “input window”. The posted command
string will be executed after the currently running script has finished.
None Application.PostCommand(str commandString)
None Application.PostCommand(DataObject command)

25
 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
Application.DeleteUntouchedObjects().
void Application.PrepForUntouchedDelete(DataObject grid)
void Application.PrepForUntouchedDelete(list grids)

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

A RGUMENTS
iMode (optional)
0 Draws graphic objects only
1 (default) Reads graphic objects (IntGrf) from database and draws
2 For single line diagrams: Reads graphic objects (IntGrf) from database,
re-calculates intersections and draws.
For plot pages: Adjust view to page format and re-create plots.

ReloadProfile
Reloads currently selected user profile. (See main menue “TOOLS-Profiles”)
None Application.ReloadProfile()

S EE ALSO

Application.LoadProfile()

ResetCalculation
Resets all calculations and deletes all calculation results.
Results that have been written to result objects (for display in graphs) will not be destroyed. All
results that are visible in the single line diagrams, however, will be destroyed.
None Application.ResetCalculation()

26
 CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.IsAutomaticCalculationResetEnabled(), Application.SetAutomaticCalculationResetEnabled()

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

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

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

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

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

27
 CHAPTER 3. APPLICATION METHODS

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

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

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

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

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

28
 CHAPTER 3. APPLICATION METHODS

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

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

ResGetUnit
This function is deprecated. Please use ElmRes.GetUnit() or IntComtrade.GetUnit() instead.
str Application.ResGetUnit(DataObject resultObject,
int col)

ResGetValueCount
This function is deprecated. Please use ElmRes.GetNumberOfRows() or
IntComtrade.GetNumberOfRows() instead.
int Application.ResGetValueCount(DataObject resultObject,
[int col])

ResGetVariable
This function is deprecated. Please use ElmRes.GetVariable() or IntComtrade.GetVariable()
instead.
str Application.ResGetVariable(DataObject resultObject,
int col)

ResGetVariableCount
This function is deprecated. Please use ElmRes.GetNumberOfColumns() or
IntComtrade.GetNumberOfColumns() instead.
int Application.ResGetVariableCount(DataObject resultObject)

ResLoadData
This function is deprecated. Please use ElmRes.Load() or IntComtrade.Load() instead.
None Application.ResLoadData(DataObject resultObject)

29
 CHAPTER 3. APPLICATION METHODS

ResReleaseData
This function is deprecated. Please use ElmRes.Release() or IntComtrade.Release() instead.
None Application.ResReleaseData(DataObject resultObject)

ResSortToVariable
This function is deprecated. Please use ElmRes.SortAccordingToColumn() or
IntComtrade.SortAccordingToColumn() instead.
int Application.ResSortToVariable(DataObject resultObject,
int col)

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

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

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

SearchObjectByForeignKey
Searches for an object by foreign key within an active project.
DataObject Application.SearchObjectByForeignKey(str foreignKey)

A RGUMENTS
foreignKey
Foreign key

R ETURNS
Object if found, otherwise None.

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

30
 CHAPTER 3. APPLICATION METHODS

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 Application.SetAttributeModeInternal(int internalMode)

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

S EE ALSO

Application.IsAttributeModeInternal()

SetInterfaceVersion
Sets the current interface version. Only values which can be set to the python script parameter
’interfaceVersion’ are allowed. Setting the interface version does not affect the parameter
’interfaceVersion’ of the current script.
Have a look into the PowerFactor user manual to get more informations about the interface
version of a script.
int Application.SetInterfaceVersion(int version)

A RGUMENTS
version interface version to be set

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

SetShowAllUsers
Enables or disables the filtering of all available users in data manager. All users are only
visualised in data manager when enabled.
int Application.SetShowAllUsers(int enabled)

31
 CHAPTER 3. APPLICATION METHODS

A RGUMENTS
enabled
0 Disabled, only Demo, Public Area Users and current user are shown
1 Enabled, all available users are listed

R ETURNS
Returns previous setting.

1 If enabled before.
0 If disabled before.

SetWriteCacheEnabled
This function intends to optimize performances or disable the value consistency check of at-
tributes. In order to modify objects in PowerFactory , those must be set in a special edit mode
before any value can be changed. Switching back and forth between edit mode and stored
mode is time consuming; enabling the write cache flag will set objects in edit mode and they will
not be switched back until Application.WriteChangesToDb() is called.
Another purpose of this function is to disable the value consistency check executed whenever
an attribute is set. Note: Enabling the write cache delays the value consistency check until
Application.WriteChangesToDb() is called or the write cache is disabled. This might be required
when dependent attributes are set where the object is temporarily left in an invalid state until all
attributes are set. In DPL please use SetConsistencyCheck() for the same purpose.
None Application.SetWriteCacheEnabled(int enabled)

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

S EE ALSO

Application.IsWriteCacheEnabled(), Application.WriteChangesToDb()

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

S EE ALSO

Application.Hide()

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

32
 CHAPTER 3. APPLICATION METHODS

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

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

1 Create switch on first connection side.
int iCreateSwitchSide1 (optional)

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

1 Create switch on second connection side.

R ETURNS
Inserted terminal
0 = error

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

A RGUMENTS
min (out) First point in time considered in statistics.
max (out) Last point in time considered in statistics.

R ETURNS
0 If time range of statistic result file was found.
1 On errors (There is no statistic result file).

StatFileResetXrange
Reset the user defined x-range of the statistic result file. The complete x-range will be consid-
ered in the statistic results after calling this function.
None Application.StatFileResetXrange()

StatFileSetXrange
Sets the user defined x-range of the statistic result file. The statistic results consider only the
given time range.
None Application.StatFileSetXrange(float min,
float max)

33
3.1. FILE SYSTEM CHAPTER 3. APPLICATION METHODS

A RGUMENTS
min First point in time to be considered in statistics.
max Last point in time to be considered in statistics.

WriteChangesToDb
This function combined with Application.SetWriteCacheEnabled() is meant to optimize perfor-
mances. If the write cache flag is enabled all objects remain in edit mode until WriteChangesToDb()
is called and all the modifications made to the objects are saved into the database.
None Application.WriteChangesToDb()

S EE ALSO

Application.SetWriteCacheEnabled(), Application.IsWriteCacheEnabled()

3.1 File System

Overview

GetInstallationDirectory
GetTemporaryDirectory
GetWorkspaceDirectory

GetInstallationDirectory
Returns the installation directory of PowerFactory .
str Application.GetInstallationDirectory()

R ETURNS
Full path to installation directory of current PowerFactory .

D EPRECATED N AMES
GetInstallDir

S EE ALSO

Application.GetTemporaryDirectory(), Application.GetWorkspaceDirectory()

GetTemporaryDirectory
Returns the temporary directory of used by PowerFactory .
str Application.GetTemporaryDirectory()

R ETURNS
Full path to a directory where temporary data can be stored. This directory is also used by
PowerFactory to store temporary data.

D EPRECATED N AMES
GetTempDir

34
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS

S EE ALSO

Application.GetWorkspaceDirectory(), Application.GetInstallationDirectory()

GetWorkspaceDirectory
Returns the workspace directory of PowerFactory .
str Application.GetWorkspaceDirectory()

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

D EPRECATED N AMES
GetWorkingDir

S EE ALSO

Application.GetTemporaryDirectory(), Application.GetInstallationDirectory()

3.2 Date/Time
Overview

GetStudyTimeObject

GetStudyTimeObject
Returns the date and time object (SetTime) from the study case. This is the object being used
by the characteristics, scenarios, ...

R ETURNS
SetTime or None.

3.3 Dialogue Boxes

Overview

CloseTableReports
GetTableReports
ShowModalBrowser
ShowModalSelectBrowser
ShowModelessBrowser
UpdateTableReports

35
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS

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

Closes all open table reports.

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

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

Returns all open table reports.

list Application.GetTableReports()

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

Opens a modal browser window and lists all given objects.

None Application.ShowModalBrowser(list objects,
[int detailMode = 0,]
[str title = '',]
[str page = ''])

A RGUMENTS
objects Objects to be listed. The listing is in detailed mode, if only one kind of objects (e.g.
only ElmTerm) is contained.

detailMode (optional)
0 Show browser in normal mode (default).
1 Show browser in detail mode.
title (optional)
String for user defined window title. The default window title is shown when no or
an empty string is given.
page (optional)
Name of page to be shown in browser e.g. 'Flexible Data' (only in detailed mode).
The default page is shown when no or an empty string is given.

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

Opens a modal browser window and lists all given objects. The user can make a selection from
the list.
list Application.ShowModalSelectBrowser(list objects,
[str title,]
[str classFilter,]
[str page = ''])

36
3.3. DIALOGUE BOXES CHAPTER 3. APPLICATION METHODS

A RGUMENTS
objects Objects to be listed. The listing is in detailed mode, if only one kind of objects (e.g.
only ElmTerm) is contained.
title (optional)
String for user defined window title. The default window title is shown when no or
an empty string is given.
classFilter (optional)
Class name filter. If set, only objects matching that filter will be listed in the dialog
e.g. ’Elm*’, ’ElmTr?’ or ’ElmTr2,ElmTr3’.
page (optional)
Name of page to be shown in browser e.g. 'Flexible Data' (only in detailed mode).
The default page is shown when no or an empty string is given.

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

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

Opens a modeless browser window and lists all given objects.

None Application.ShowModelessBrowser(list objects,
[int detailMode = 0,]
[str title = '',]
[str page = ''])

A RGUMENTS
objects Objects to be listed. The listing is in detailed mode, if only one kind of objects (e.g.
only ElmTerm) is contained.
detailMode (optional)
0 Show browser in normal mode (default).
1 Show browser in detail mode.

title (optional)
String for user defined window title. The default window title is shown when no or
an empty string is given.
page (optional)
Name of page to be shown in browser e.g. 'Flexible Data' (only in detailed mode).
The default page is shown when no or an empty string is given.

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

Updates all open table reports.

None Application.UpdateTableReports()

37
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS

3.4 Environment
Overview

EchoOff
EchoOn
IsAutomaticCalculationResetEnabled
IsFinalEchoOnEnabled
SetAutomaticCalculationResetEnabled
SetFinalEchoOnEnabled
SetGraphicUpdate
SetGuiUpdateEnabled
SetProgressBarUpdatesEnabled
SetUserBreakEnabled

EchoOff
Freezes (de-activates) the user-interface. For each EchoOff(), an EchoOn() should be called.
An EchoOn() is automatically executed at the end of the execution of a ComDpl or ComPython.
This could be changed with Application.SetFinalEchoOnEnabled().
None Application.EchoOff()

S EE ALSO

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

EchoOn
Re-activates the user interface. For more informations see Application.EchoOff().
None Application.EchoOn()

S EE ALSO

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

IsAutomaticCalculationResetEnabled
Returns whether the automatic calculation reset while setting attributes is enabled. See Appli-
cation.SetAutomaticCalculationResetEnabled() for more informations.
int Application.IsAutomaticCalculationResetEnabled()

S EE ALSO

Application.SetAutomaticCalculationResetEnabled(), Application.ResetCalculation()

IsFinalEchoOnEnabled
Returns whether the automatic Application.EchoOn() at the end of each ComDpl or ComPython
is enabled.
int Application.IsFinalEchoOnEnabled();

38
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS

R ETURNS
1 Final Application.EchoOn() is enabled.
0 Final Application.EchoOn() is disabled.

S EE ALSO

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

SetAutomaticCalculationResetEnabled
Enables or disables the automatic calculation reset while setting attributes.
In Python/API the automatic calculation reset is by default enabled. Thus changing an object
attribute could lead to a calculation reset, e.g. changing the scaling factor of a load, but do not
have to, e.g. renaming an object.
Even if the automatic calculation reset is disabled, changing the ”outserv” attribute of an arbitrary
network element or the ”on off” attribute of a switch device resets automatically the current
calculation.
When the calculation is reset the load-flow will be calculated with a flat start. Thus switching
the automatic calculation reset off can be helpful e.g. when calculating a load-flow without a flat
start. On the other side it could lead to wrong results e.g. doing short-circuit calculations after
changing the short-circuit-location of a branch without calling Application.ResetCalculation().
None Application.SetAutomaticCalculationResetEnabled(int enabled)

S EE ALSO

Application.IsAutomaticCalculationResetEnabled(), Application.ResetCalculation()

SetFinalEchoOnEnabled
Enables or disables the automatic Application.EchoOn() at the end of each ComDpl or ComPython.

None Application.SetFinalEchoOnEnabled(int enabled);

A RGUMENTS
enabled
1 Enables the final Application.EchoOn().
0 Disables the final Application.EchoOn().

S EE ALSO

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

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

A RGUMENTS
enabled

39
3.4. ENVIRONMENT CHAPTER 3. APPLICATION METHODS

0 disabled (graphic will not be updated automatically)

1 enabled

SetGuiUpdateEnabled
Enables or disables updates of the graphical user interface (e.g. application window) while the
script is running.
This can be useful to get maximum execution performance. However, the user interface might
look frozen and becomes not responsive.
Please note that the progress bar, which is located in the status bar of the application window,
is not affected by this. Updates of the progress bar can be enabled or disabled separately by
invoking Application.SetProgressBarUpdatesEnabled().
The updates will automatically be re-enabled after termination of the script. In case of sub-
scripts, the restore is done at termination of main script.
int Application.SetGuiUpdateEnabled(int enabled)

A RGUMENTS
enabled
0 Disables GUI updates.
1 Enables GUI updates.

R ETURNS
Previous state before the function was called

0 GUI updates were disabled before.

1 GUI updates were enabled before.

D EPRECATED N AMES
SetRescheduleFlag

S EE ALSO

Application.SetProgressBarUpdatesEnabled(), Application.SetGraphicUpdate()

SetProgressBarUpdatesEnabled
Enables or disables updates of the progress bar (located in the status bar of the application
window) while the script is running. Other components of the status bar are not affected.
If a script executes a high number of small, fast commands that report progress (noticable by
the progress bar repeatedly and quickly filling up), disabling progress bar updates can provide
an immense performance boost.
The updates will automatically be re-enabled after termination of the script. In case of sub-
scripts, the restore is done at termination of main script.
int Application.SetProgressBarUpdatesEnabled(int enabled)

A RGUMENTS
enabled
0 Disables progress bar updates.
1 Enables progress bar updates.

40
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

R ETURNS
Previous state before the function was called

0 Progress bar updates were disabled before.

1 Progress bar updates were enabled before.

S EE ALSO

Application.SetGuiUpdateEnabled(), Application.SetGraphicUpdate()

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

None Application.SetUserBreakEnabled(int enabled)

A RGUMENTS
enabled
0 Disables “Break” button.
1 Enable “Break” button.

D EPRECATED N AMES
SetEnableUserBreak

3.5 Mathematics
Overview

GetRandomNumber
GetRandomNumberEx
InvertMatrix
RndExp
RndGetMethod
RndGetSeed
RndNormal
RndSetup
RndUnifInt
RndUnifReal
RndWeibull
SetRandomSeed

41
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

GetRandomNumber
This method is marked as deprecated since PowerFactory 2017. Please use Application.RndUnifReal()
instead.
Draws a uniformly distributed random number. Uses the ’global random number generator’. If
x1 and x2 are omitted, the distribution will be uniform in the interval [0, 1]. If only x1 is given, the
distribution is uniform in [0, x1] and with both x1 and x2, the distribution is uniform in [x1, x2].
float Application.GetRandomNumber([float x1,]
[float x2])

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

R ETURNS
A uniformly distributed random number

GetRandomNumberEx
This method is marked as deprecated since PowerFactory 2017. Please use Application.RndUnifReal(),
Application.RndNormal() or Application.RndWeibull() instead.
Draws a random number according to a specific probability distribution. Uses the ’global random
number generator’.
float Application.GetRandomNumberEx(int distribution,
[float p1,]
[float p2])

A RGUMENTS
distribution
0 uniform distribution
1 normal distribution
2 weibull distribution
else returns 0.0
p1 (optional)
distribution = 0 (uniform), argument p2 is also given: min
distribution = 0 (uniform), argument p2 is not given: max (min is as-
sumed to be 0).
distribution = 1 (normal) : mean
distribution = 2 (weibull) : scale

p2 (optional)
distribution = 0 (uniform) : max
distribution = 1 (normal) : stddev
distribution = 2 (weibull) : weibull

42
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

R ETURNS
double Newly drawn random number from the specified distribution.
0.0 On failure e.g. non-supported mode.

InvertMatrix
This routine calculates the inverse matrix by the Gauss-Jordan method. It uses scaled partial
pivoting preceeded by column equilibration of the input matrix. The routine can be called in two
different versions:

• Real Inversion: Only one matrix, realP art, is provided as an input to the function. Then,
realP art is inverted and the result, realP art−1 , is stored into the input matrix realP art on
success.
• Complex Inversion: Two matrices, realP art and imaginaryP art, are provided as inputs
to this function. Then, a complex matrix C is formed, with entries
C(i,j) = A(i,j) + j · imaginaryP art(i,j).
The complex matrix C is inverted and, on success, the resulting real part of C −1 is written
to realP art whereas the resulting imaginary part of C −1 is written to imaginaryP art.
Please note that realP art and imaginaryP art must have the same dimensions.

int Application.InvertMatrix(DataObject realPart,

[DataObject imaginaryPart])

A RGUMENTS
realPart If imaginaryPart is not set, realpart is the matrix to invert on input. In case of
success, it will be overwritten by the inverted input matrix. If imaginaryPart is set,
it holds the real part of the complex matrix to invert on input and is overwritten by
the real part of the inverted complex matrix on output.
imaginaryPart
If this is set, it should hold the imaginary part of the matrix to invert on input and
is overwritten by the imaginary part of the inverted matrix on output.

R ETURNS
1 Matrix inversion failed. The provided input matrix is singular.
0 Matrix inversion was successful. Resulting inverted matrix returned in input ma-
trix/matrices.

RndExp
Returns a random number distributed according to exponential distribution with given rate. See
the example given in the DPL description of Application.RndSetup().
float RndExp(float rate, [int rngNum])

A RGUMENTS
rate Rate of exponetial distribution.
rngNum (optional)
Number of the random number generator.
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.

43
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

R ETURNS
double Random number

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

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

R ETURNS
string Name of the used method

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

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

R ETURNS
int Used seed

RndNormal
Returns a random number distributed according to normal distribution with given mean and
standard deviation. See the example given in the DPL description of Application.RndSetup().
float RndNormal(float mean, float stddev, [int rngNum])

A RGUMENTS
mean Mean of normal distribution.
stddev Standard deviation of normal distribution.
rngNum (optional)
Number of the random number generator.
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.

44
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 RndSetup(int seedAutomatic, [int seed], [int rngType], [int rngNum])

A RGUMENTS
seedAutomatic
Seed the random number generator automatically
0 Do not seed automatically.
1 Seed automatically.

seed (optional)
Seed for the random number generator. (default: 0) Note, that for the Additive
Lagged Fibonacci generator, only the seeds 0,...,9 are supported.
rngType (optional)
Type of random number generator

0 Mersenne Twister (recommended) (default).

1 Linear Congruential.
2 Additive Lagged Fibonacci.
rngNum (optional)
Number of random number generator to be used
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.

45
3.5. MATHEMATICS CHAPTER 3. APPLICATION METHODS

RndUnifInt
Returns a random number distributed according to uniform distribution on the set of numbers
{min, . . . , max}. See the example given in the DPL description of Application.RndSetup().
int RndUnifInt(int min, int max, [int rngNum])

A RGUMENTS
min Smallest possible number
max Largest possible number
rngNum (optional)
Number of the random number generator.
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.

R ETURNS
int Random number

RndUnifReal
Returns a random number distributed according to uniform distribution on the intervall [min,max].
See the example given in the DPL description of Application.RndSetup().
float RndUnifReal(float min, float max, [int rngNum])

A RGUMENTS
min Lower endpoint of interval [min, max]
max Upper endpoint of interval [min, max]
rngNum (optional)
Number of the random number generator.
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.

R ETURNS
double Random number

RndWeibull
Returns a random number distributed according to Weibull distribution with given shape and
scale parameters. See the example given in the DPL description of Application.RndSetup().
float RndWeibull(float shape, float scale, [int rngNum])

A RGUMENTS
shape Shape parameter of Weibull distribution.
scale Scale parameter of Weibull distribution.
rngNum (optional)
Number of the random number generator.
0 (default) ’Global random number generator’.
1, 2, ... Other random number generators accessible via this number.

46
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 Application.RndSetup()
instead.
Initializes the ’global random number generator’ as Additive Lagged Fibonacci random number
generator. Sets the seed for the random number generator. One out of 10 predefined initializa-
tion seeds can be selected.
None Application.SetRandomSeed(int seed)

A RGUMENTS
seed seed 0..9

3.6 Output Window

Overview

ClearOutputWindow
FlushOutputWindow
GetOutputWindow
PrintError
PrintInfo
PrintPlain
PrintWarn
SetOutputWindowState

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

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

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

47
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS

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

R ETURNS
An instance of the class OutputWindow.

E XAMPLE
import powerfactory
app = powerfactory.GetApplication()
outputWindow = app.GetOutputWindow()
outputWindow.Print(powerfactory.OutputWindow.MessageType.Plain, "Hello World!")

PrintError
Prints a message as error into the PowerFactory Output Window. See OutputWindow.Print()
for more informations.
None Application.PrintError(str message)

PrintInfo
Prints a message as information into the PowerFactory Output Window. See OutputWin-
dow.Print() for more informations.
None Application.PrintInfo(str message)

PrintPlain
Prints a message as normal text into the PowerFactory Output Window. See OutputWin-
dow.Print() for more informations.
None Application.PrintPlain(str message)

PrintWarn
Prints a message as warning into the PowerFactory Output Window. See OutputWindow.Print()
for more informations.
None Application.PrintWarn(str message)

SetOutputWindowState
Changes the display state of the output window.
None Application.SetOutputWindowState(int newState)

48
3.6. OUTPUT WINDOW CHAPTER 3. APPLICATION METHODS

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

49
 CHAPTER 4. OUTPUT WINDOW

4 Output Window

Overview

Clear
Flush
GetContent
Print
Save
SetState

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

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

GetContent
Returns the content (unfiltered or filtered) of the output window.
[str] OutputWindow.GetContent()
[str] OutputWindow.GetContent(OutputWindow.MessageType filter)

A RGUMENTS
filter (optional)
If given, then only text from messages of this type will be returned.

R ETURNS
List of texts of output window messages (unfiltered or filtered).

S EE ALSO

OutputWindow.Print()

50
 CHAPTER 4. OUTPUT WINDOW

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

A RGUMENTS
type Type of message to print:
OutputWindow.MessageType.Plain Normal text.
OutputWindow.MessageType.Info Information.
OutputWindow.MessageType.Warn Warning.
OutputWindow.MessageType.Error Error.
The message is printed as normal text if no message type is given.

message Message to print.

E XAMPLE
import powerfactory
app = powerfactory.GetApplication()
outputWindow = app.GetOutputWindow()
outputWindow.Print(powerfactory.OutputWindow.MessageType.Plain, "Hello World!")

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

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

SetState
Changes the display state of the output window.
None OutputWindow.SetState(int newState)

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

51
 CHAPTER 5. OBJECT METHODS

5 Object Methods

5.1 General Methods

Overview

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

52
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

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

A RGUMENTS
objectToCopy
Object to copy.
objectNameParts (optional)
Parts of the name of the new copy which will be concatenated to the object name.

53
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

objectsToCopy
Set of objects to copy.

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

S EE ALSO

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

ContainsNonAsciiCharacters
Checks whether an object contains texts attributes with non-ASCII characters.
int DataObject.ContainsNonAsciiCharacters()

R ETURNS
Returns 1 if the object contains at least one non-ASCII characters. Otherwise 0.

CopyData
Copies all parameters except for loc name and containers from one object to another.
None DataObject.CopyData(DataObject source)

A RGUMENTS
source Object from which parameters are to be copied

R ETURNS
0 ok
1 error

CreateObject
Creates a new object of given class and name in the target object. The object name will be
concatenated by the given object name parts. The target object must be able to store an object
of the given class in its content otherwise the currently running script will stop with an error.
DataObject DataObject.CreateObject(str className,
[int|str objectNamePart0,]
[...]
)

A RGUMENTS
className
The class name of the object to create.
objectNameParts (optional)
Parts of the name of the object to create (without classname) which will be con-
catenated to the object name.

54
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
object Newly created object.
None When no object was created.

Delete
Deletes the object from the database. The object is not destroyed but moved to the recycle bin.
int DataObject.Delete()

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

S EE ALSO

DataObject.CreateObject()

Energize
Performs an “energize” action on the network element. This corresponds to removing earthings
from current region (if any) followed by a “switch on” action on the element.
The action is identical to that in the context menue.
[int error,
list changedSwitches] DataObject.Energize([int resetRA])

A RGUMENTS
changedSwitches (optional, out)
All switches whose switching state was changed by the action are filled into this
set.
resetRA (optional)
Determines whether an active running arrangement that would prevent switching
action should be deactivated or not.
1 All running arrangements that cause blocking of relevant switches are
applied and reset automatically before the switching is performed.
0 (default) Active running arrangements are not reset. Blocked switches
will cause the switching action to fail.

R ETURNS
Information about the success of the action:

0 Action was successful.

1 Action failed.

S EE ALSO

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

55
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

A RGUMENTS
name Name of an attribute.

R ETURNS
Value of an attribute name in its current unit (like in the edit dialog seen). An
exception is thrown for invalid attribute names.

S EE ALSO

DataObject.SetAttribute(), DataObject.GetAttributeType()

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

A RGUMENTS
name Name of an attribute.

short 0 Return long attribute description (default).

1 Return short attribute description.

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

S EE ALSO

DataObject.GetAttributeType(), DataObject.GetAttributeUnit()

GetAttributeLength
Returns the length of a vector or matrix attribute. The length of a matrix attribute is the number
of rows.
int DataObject.GetAttributeLength(str name)

A RGUMENTS
name Name of an attribute.

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

56
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

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

GetAttributes
Gets the values of the transfer attributes defined via Application.DefineTransferAttributes().
list DataObject.GetAttributes()

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

S EE ALSO

DataObject.SetAttributes(), Application.DefineTransferAttributes()

GetAttributeShape
Returns the shape of an attribute. The shape is a list of the form [number of rows, number of
colums].
[int rows,
int columns ] DataObject.GetAttributeShape(str name)

A RGUMENTS
name Name of an attribute.

R ETURNS
[≥ 0, ≥ 0 ] Shape of a valid vector or matrix attribute.
[0, 0 ] All other valid attributes.
[−1, 0 ] For invalid attribute names.

S EE ALSO

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

GetAttributeType
Returns the type of an attribute.
The following attribute types exist:
AttributeType.INVALID Attribute does not exist.
AttributeType.INTEGER Integer attribute.
AttributeType.INTEGER VEC Integer vector attribute.
AttributeType.DOUBLE Double attribute.
AttributeType.DOUBLE VEC Double vector attribute.
AttributeType.DOUBLE MAT Double matrix attribute.
AttributeType.OBJECT Data object attribute.
AttributeType.OBJECT VEC Data object vector attribute.
AttributeType.STRING String attribute.
AttributeType.STRING VEC String vector attribute.
AttributeType.INTEGER64 64-bit integer attribute.
AttributeType.INTEGER64 VEC 64-bit integer vector attribute.

57
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

AttributeType DataObject.GetAttributeType(str name)

A RGUMENTS
name Name of an attribute.

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

S EE ALSO

DataObject.GetAttribute(), DataObject.SetAttribute()

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

A RGUMENTS
name Name of an attribute.

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

S EE ALSO

DataObject.GetAttributeType(), DataObject.GetAttributeDescription()

GetChildren
This function returns the objects that are stored within the object the function was called on.
In contrast to DataObject.GetContents() this function gives access to objects that are currently
hidden due to scheme management.
list DataObject.GetChildren(int hiddenMode,
[str filter,]
[int subfolders])

A RGUMENTS
hiddenMode
Determines how hidden objects are handled.
0 Hidden objects are ignored. Only nonhidden objects are returned.
1 Hidden objects and nonhidden objects are returned.
2 Only hidden objects are returned. Nonhidden objects are ignored.
filter (optional)
Name filter, possibly containing '*' and '?' characters.
subfolder (optional)
Determines if children of subfolders are returned.
0 Only direct children are returned, children of subfolders are ignored
(Default).
1 Also children of subfolders are returned.

58
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
Objects that are stored in the called object.

S EE ALSO

DataObject.GetContents()

GetClassName
Returns the class name of the object.
str DataObject.GetClassName()

R ETURNS
The class name of the object.

GetCombinedProjectSource
For an object in a combined project return the intermediate folder where the object is contained,
indicating the original source project.
DataObject DataObject.GetCombinedProjectSource()

R ETURNS
The intermediate folder for that object or nothing when not applicable.

GetConnectedElements
Returns the set of connected elements. Only electrically connected elements are returned when
the conditions of all switches are regarded. Possible connections will also be returned when rBrk
and/or rDis is zero, in the case of open breakers and/or disconnectors. The default values are
(0,0,0).
list DataObject.GetConnectedElements([int rBrk],
[int rDis],
[int rOut])

A RGUMENTS
rBrk (optional)
if 1, regards position of breakers
rDis (optional)
if 1, regards position of disconnectors
rOut (optional)
if 1, regards in-service or out-of-service status

R ETURNS
The set of connected elements.

GetConnectionCount
Returns the number of electrical connections.

59
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

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

R ETURNS
The number of electrical connections.

GetContents
Returns the objects that are stored in the object and whose name matches the argument name.
No object is returned if the object's container is empty, or if the object is not capable of storing
objects. The argument name may contain the complete name and classname, or parts of the
name with wildcard and class name.
list DataObject.GetContents([str Name,]
[int recursive])

A RGUMENTS
Name (optional)
loc name.class name, name possibly contains wildcards: '*' and '?' characters
recursive (optional)
1 All contained objects will be added recursively.
0 (default) Only direct children of current object will be collected.

R ETURNS
Objects that are stored in the object.

GetControlledNode
Returns the target terminal and the resulting target voltage for generators and other voltage
regulating units.
[DataObject node,
float targetVoltage] DataObject.GetControlledNode(int bus,
[int check])

A RGUMENTS
bus)
-1 currently controlled bus
0 HV bus
1 MV/ LV bus
2 LV bus
targetVoltage (out)
The target voltage of the voltage regulating unit in pu.
check (optional)
0 (default) Do not check if the control mode is set to voltage control.
1 Only return the controlled node if the control mode is set to voltage
control.

60
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
Controlled node, None if no controlled terminal exists (or not voltage controlled if check=1)

GetCubicle
Returns the cubicle of an object at the connection with index n, or None if there is no cubicle
inside the object.
DataObject DataObject.GetCubicle(int side)

A RGUMENTS
side The connection number.

R ETURNS
The cubicle object or None.

GetFullName
Returns the full name of the object as a string.
str DataObject.GetFullName([int type])

A RGUMENTS
type(optional)
Is used to determine the format of the returned full name:

not given
No special formatting.
=0
The full name (complete database path including the name and class name)
of the object. It becomes a clickable link if printed to the output window.
> 0 (but less or equal to 190)
Formatted exactly to this length and also clickable if printed to the output
window.

R ETURNS
The fullname (complete database path including the name and class name) of the object.

GetImpedance
Returns the positive sequence impedance of an element referred to a given voltage.
[int error,
float real,
float imag] DataObject.GetImpedance(float refVoltage,
[int i3Trf])

A RGUMENTS
real (out) Real part of the impedance in Ohm.
imag (out)
Imaginary part of the impedance in Ohm.

61
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

refVoltage
Reference voltage for the impedance in kV.

i3Trf (optional)
When used with an ElmTr3
0 Return the HV-MV impedance.
1 Return the HV-LV impedance.
2 Return the MV-LV impedance.

R ETURNS
1 An error occurred.
0 Otherwise.

S EE ALSO

object.GetZeroImpedance()

GetInom
Returns the nominal current of the object at given bus index.
float DataObject.GetInom([int busIndex = 0],
[int inclChar = 0])

A RGUMENTS
busIndex (optional)
Bus index, default value is 0.
inclChar (optional)
option to consider thermal rating objects and values modified by characteristics
on the (de-)rating factor.
0 Not considering thermal rating objects or values modified by charac-
teristics on the (de-)rating factor (default).
1 Considering thermal rating objects and values modified by character-
istics on the (de-)rating factor.
2 Considering thermal rating objects but not values modified by charac-
teristics on the (de-)rating factor.

R ETURNS
The nominal current at bus index.

S EE ALSO

DataObject.GetUnom()

GetNode
Returns the node connected to the object at specified bus index.
DataObject DataObject.GetNode(int busIndex,
[int considerSwitches = 0])

62
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

A RGUMENTS
busIndex Bus index.
considerSwitches (optional)
0 Ignore the status of the switches (default).
1 Consider the status of the switches.

R ETURNS
object Connected node object at specified bus index.
None If no node at bus index is found.

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

R ETURNS
Object of class ElmOperator determined according to following rules

• If operator is set in current object instance (attribute “pOperator”) this operator object is
retured.
• Else the operator inherited from its parent is used (recursively applied).
• None if none if its parents have an operator set.

GetOwner
Returns the elements’s owner (ElmOwner ).
DataObject DataObject.GetOwner()

R ETURNS
Object of class ElmOwner determined according to following rules

• If owner is set in current object instance (attribute “pOwner”) this owner object is retured.
• Else the owner inherited from its parent is used (recursively applied).
• None if none if its parents have an operator set.

GetParent
Returns the parent folder object (same as parameter ’fold id’).
DataObject DataObject.GetParent()

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

63
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

DataObject.GetContents()

GetReferences
Returns a set containing all objects with references to the object the method was called on. By
default, references from IntSubset objects or hidden objects are ignored.
list DataObject.GetReferences([str filter = '*',]
[int includeSubsets = 0,]
[int includeHiddenObjects = 0])

A RGUMENTS
filter (optional)
Object filter to get only objects whose name matches this filter string, e.g. '*.ElmLne'.
(default: ’*’)
includeSubsets (optional)
Forces references from IntSubset objects to be evaluated. These are normally not
included for performance reasons. (default: 0)

includeHiddenObjects (optional)
Include also hidden objects. By default they are not included. In contrast hidden
objects are always included in the ’Reference List’ output of the data browser.
(default: 0)

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

S EE ALSO

DataObject.GetReferences()

GetRegion
All network components are internally associated with an artificial region. A region consists of
topologically connected elements. This means, two elements elm1 and elm2 are topologically
connected ⇔ elm1.GetRegion() == elm2.GetRegion().
A region is simply identified by a number that can be access via this function.
int DataObject.GetRegion()

R ETURNS
Region index >0. A value of ‘-1’ means status is unknown for that element (normally for not
topology relevant elements).

GetSupplyingSubstations
Returns the closest supplying substation(s) for a network component.
“Closest” means that there is no other supplying element of same type in topological path
between network component and the supplying component(s) returned by this function.
list DataObject.GetSupplyingSubstations()

64
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

S EE ALSO

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

ElmTrfstat.GetSuppliedElements(), DataObject.GetSupplyingTransformers(), DataObject.GetSupplyingTrfstations

GetSupplyingTransformers
Returns the closest supplying transformer(s) for a network component. “Closest” means that
there is no other supplying element of same type in topological path between network compo-
nent and the supplying component(s) returned by this function.
list DataObject.GetSupplyingTransformers()

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

S EE ALSO

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

ElmTrfstat.GetSuppliedElements(), DataObject.GetSupplyingSubstations(), DataObject.GetSupplyingTrfstations()

GetSupplyingTrfstations
Returns the closest supplying transformer station(s) for a network component.
“Closest” means that there is no other supplying element of same type in topological path
between network component and the supplying component(s) returned by this function.
list DataObject.GetSupplyingTrfstations()

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

S EE ALSO

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

ElmTrfstat.GetSuppliedElements(), DataObject.GetSupplyingTransformers(), DataObject.GetSupplyingSubstation

GetSystemGrounding
Returns the grounding type employed in the grounding area of the grid the object belongs to.
The grounding area is defined by network components separating the zero sequence system
(e.g. star-delta transformers).
int DataObject.GetSystemGrounding()

R ETURNS
-1 grounding type can not be determined
0 system is solidly grounded
1 system is compensated
2 system is isolated

65
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

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

R ETURNS
The nominal voltage at bus index.

S EE ALSO

DataObject.GetInom()

GetZeroImpedance
Returns the zero sequence impedance of an element referred to a given voltage.
[int error,
float real,
float imag] DataObject.GetZeroImpedance(float refVoltage,
[int i3Trf])

A RGUMENTS
real (out) Real part of the impedance in Ohm.
imag (out)
Imaginary part of the impedance in Ohm.

refVoltage
Reference voltage for the impedance in kV.
i3Trf (optional)
When used with an ElmTr3

0 Return the HV-MV impedance.

1 Return the HV-LV impedance.
2 Return the MV-LV impedance.

R ETURNS
1 An error occurred.
0 Otherwise.

S EE ALSO

object.GetImpedance()

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

66
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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.

S EE ALSO

DataObject.GetAttribute(), DataObject.SetAttribute()

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

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

S EE ALSO

DataObject.GetReferences()

HasResults
Checks if the object has calculated result parameters.
int DataObject.HasResults([int ibus])

A RGUMENTS
ibus (optional)
Bus index

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

>= 0 Checks if 'm:xxxx:bus ' quantities exist for bus index=ibus
2 Hidden objects are returned

R ETURNS
0 no results available
1 results exist

IsCalcRelevant
Returns whether the object is relevant for calculation.
In contrast to Application.GetCalcRelevantObjects() it also returns 1 for objects in the active
study case e.g. simulation events (Evt*).
int DataObject.IsCalcRelevant()

67
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

S EE ALSO

Application.GetCalcRelevantObjects()

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

R ETURNS
1 Object is already deleted.
0 Object is not deleted.

IsEarthed
Checks if a network component is topologically connected to any earthed component. Earthing
components are terminals / busbars (ElmTerm) with attribute ‘iEarth’ = 1 and all closed ground-
ing switches (ElmGndswt). An energized component is never considered to be earthed.
int DataObject.IsEarthed()

R ETURNS
1 Component is earthed (connected to an earthing component)
0 Component is not earthed

IsEnergized
Checks if a network component is energized. A component is considered to be energized, if it is
topologically connected to a generator. All other elements are considered to be deenergized.
int DataObject.IsEnergized()

R ETURNS
1 Component is energized
0 Component is deenergized
-1 Component has no energizing status (status unknown)

IsHidden
Checks whether an object is hidden with respect to currently activated variation. An object is
hidden if it is

• deleted in currently active variation or

• added in a variation that is currently not active

int DataObject.IsHidden()

68
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

IsInFeeder
Checks if the object is part of the given feeder. A network element is considered being part of a
feeder if a topological path from the feeder definition to the element exists.
This function is based on load flow calculation results. Therefore, it can only be used after such
a calculation has been successfully executed and as long as the results are available.
int DataObject.IsInFeeder(DataObject Feeder,
[int OptNested=0])

A RGUMENTS
Feeder The Feeder definition object ElmFeeder
OptNested (optional
0 Nested feeders are not considered.
1 Nested feeders are considered.

R ETURNS
1 If “Feeder” is a feeder definition and the object is part of that feeder.
0 Otherwise

S EE ALSO

ElmFeeder.GetAll()

IsNetworkDataFolder
Checks whether given object is a special folder within a project that stores specific data ele-
ments. Each project can not have more than one instance per folder type.
The following folder types are distinguished (PowerFactory class names):

IntArea stores ElmArea objects

IntBbone stores ElmBbone and SetBbone objects
IntBmu stores ElmBmu objects
IntBoundary stores ElmBoundary objects
IntCircuit stores ElmCircuit objects
IntFeeder stores ElmFeeder objects
IntMeteostat stores ElmMeteostat objects
IntOperator stores ElmOperator objects
IntOwner stores ElmOwner objects
IntPath stores SetPath objects
IntRoute stores ElmRoute objects
IntScales stores Tri* objects
int DataObject.IsNetworkDataFolder()

69
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

S EE ALSO

Application.GetDataFolder()

IsNode
Indicates wtheter an object is a node (terminal or busbar).
int DataObject.IsNode()

R ETURNS
1 Object is a node.
0 Otherwise.

IsObjectActive
Check if an object is active for specific time.
int DataObject.IsObjectActive(int time)

A RGUMENTS
time Time in seconds since 01.01.1970 00:00:00.

R ETURNS
0 Object is not active (hidden or deleted).
1 Object is active.

IsObjectModifiedByVariation
Check if an object is active for specific time.
int DataObject.IsObjectModifiedByVariation(int considerADD, int considerDEL, int considerDELTA)

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

70
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] DataObject.Isolate([int resetRA,]
[int isolateCBs])

A RGUMENTS
changedSwitches (optional, out)
All switches whose switching state was changed by the action are filled into this
set
resetRA (optional)
Determines whether an active running arrangement that would prevent switching
action should be deactivated or not.
1 All running arrangements that cause blocking of relevant switches are
applied and reset automatically before the switching is performed.
0 (default) Active running arrangements are not reset. Blocked switches
will cause the switching action to fail
isolateCBs (optional)
Determines if, in addition, circuit breakers should be isolated by opening its adja-
cent disconnectors (if not given, default will be taken from project settings)
0 No additional opening of disconnectors
1 Also open disconnectors adjacent to switched circuit breakers)

R ETURNS
Information about the success of the action:

0 Action was successful

1 Action failed

S EE ALSO

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

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

71
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
0 When the object is in service.
1 When the object is out of service.

IsReducible
Checks if object can be reduced during network reduction.
int DataObject.IsReducible()

R ETURNS
0 object can never be reduced.
1 object can be reduced (e.g. switch, zero-length lines)
2 in principle the object can be reduced, but not now (e.g. switch that is set to be
detailed)

IsShortCircuited
Returns whether an element is short-circuited or not.
int DataObject.IsShortCircuited()

R ETURNS
0 No short-circuit found.
1 Element is short-circuited.

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

Marks the object in the diagram in which the element is found by hatch crossing it. By default
all the currently opened diagrams are searched for the element to mark beginning with the
diagram shown. The first diagram in which the element is found will be opened and the element
is marked.
Alternatively the search can be extended to all existing diagrams by passing 1 as parameter. If
the element exists in more than one diagram the user can select from a list of diagrams which
diagram shall be opened.
None DataObject.MarkInGraphics([int searchAllDiagramsAndSelect = 0])

A RGUMENTS
searchAllDiagramsAndSelect (optional)
Search can be extended to all diagrams, not only the ones which are currently
shown on the desktop.

0 Only search in currently opened diagrams and open the first diagram
in which the element was found. (default)
1 Searching all diagrams, not only the ones which are currently shown
on the desktop. If there is more than one occurrence the user will be
prompted which diagrams shall be opened.

72
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

R ETURNS
A diagram in which the element is drawn is opened and the element is marked.

Move
Moves an object or a set of objects to this folder.
int DataObject.Move(DataObject objectToMove)
int DataObject.Move(list objectsToMove)

A RGUMENTS
objectToMove
Object to move.
objectToMove
Set of objects to move.

R ETURNS
0 On success.
1 On error.

S EE ALSO

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

PasteCopy
Pastes a copy of a single object or a set of objects to this object (= target object) using the
merge tool when source object(s) and target object are inside different projects (equivalent to a
manual copy&paste operation).
[int error,
DataObject newObject] DataObject.PasteCopy(DataObject objectToCopy,
[int resetMissingReferences = 0])
int DataObject.PasteCopy(list objectsToCopy)

A RGUMENTS
objectToCopy
Object to be copied.
objectsToCopy
Set of objects to copy.
newObject (out)
The new object copy of objectToCopy is assigned on success.
resetMissingReferences (optional)
Determines how to handle missing references.
0 No action is taken, the operation is cancelled with an error (default).
1 Missing references are automatically reset.

R ETURNS
0 Object(s) successfully copied.
1 Error.

73
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

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

PurgeUnusedObjects
The function deletes the following child objects:

1. All 'hidden' objects without corresponding ”Add” object. These objects are only deleted, if
the condition is fulfilled for all child objects (hidden without corresponding 'Add' object).
2. All internal expansion stage objects with invalid target object (target object reference is
missing).

It’s crucial that there is no study case active when executing the function.
None DataObject.PurgeUnusedObjects()

S EE ALSO

DataObject.ReportUnusedObjects()

ReplaceNonAsciiCharacters
Replaces all non-ASCII characters in all text attributes by similar ASCII characters. Emits a
warning if a charcter can not replaced, because no replacement character was defined.
int DataObject.ReplaceNonAsciiCharacters(DataObject map,
str defaultReplacementCharacter)

A RGUMENTS
map IntMat object with two columns: the first column contains the codes of the non-
ASCII character, the second column contains the code of the ASCII character.
defaultReplacementCharacter
String containing one ASCII character. If map does not contain a replacement for
a non-ASCII character, it is replaced by defaultReplacementCharacter.

R ETURNS
Returns 1 when the function was executed successfully.

ReportNonAsciiCharacters
Reports all text attributes of this objects containing non-ASCII characters in the output window.
None DataObject.ReportNonAsciiCharacters()

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

74
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

DataObject.PurgeUnusedObjects()

SearchObject
Searches for an object with a full name, such as
'rootfolder.class\subfolder.class\...\locname.class '.
DataObject DataObject.SearchObject(str name)

A RGUMENTS
name string to search

R ETURNS
Returns the searched object.

S EE ALSO

DataObject.GetFullName()

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

A RGUMENTS
name Name of an attribute.
value Value to be set in its current unit (like in the edit dialog seen). An exception is
thrown for invalid attribute names.

S EE ALSO

DataObject.GetAttribute(), DataObject.GetAttributeType()

SetAttributeLength
Sets the length of a vector or matrix attribute. The length of a matrix attribute is the number of
rows.
int DataObject.SetAttributeLength(str name, int length)

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

R ETURNS
0 On success.
1 On error.

75
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

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

SetAttributes
Sets the values of the transfer attributes defined via Application.DefineTransferAttributes().
None DataObject.SetAttributes(list values)

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

S EE ALSO

Application.DefineTransferAttributes(), DataObject.GetAttributes()

SetAttributeShape
Sets the shape of a matrix or vector attribute. The shape is a list of the form [number of rows,
number of colums]. Number of colums has to be 0 for vectors.
int DataObject.SetAttributeShape(str name, list(int, int) shape)

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

R ETURNS
0 On success.
1 On error.

S EE ALSO

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

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

Opens the edit dialogue of the object. Command objects (such as ComLdf ) will have their
“Execute” button disabled. The execution of the running script will be halted until the edit
dialogue is closed again.
Editing of command objects (ComDPL, ComPython) is not supported.
int DataObject.ShowEditDialog()

R ETURNS
1 Edit dialogue was cancelled by the user.
0 Otherwise.

76
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

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

Shows a modal window with the database object tree of the object on which the function is
called on.
DataObject DataObject.ShowModalSelectTree([str title,]
[str filter])

A RGUMENTS
title (optional)
Title of the dialog. If omitted, a default title will be used.

filter (optional)
Classname filter e.g. 'ElmLne' or 'Com*'. If set, a selection is only accepted if the
classname of the selected object matches that filter.

R ETURNS
DataObject Selected object.
None No object selcted e.g. 'Cancel' clicked.

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

A RGUMENTS
changedSwitches (optional, out)
All switches whose switching state was changed by the action are filled into this
set

resetRA (optional)
Determines whether an active running arrangement that would prevent switching
action should be deactivated or not.
1 All running arrangements that cause blocking of relevant switches are
applied and reset automatically before the switching is performed.
0 (default) Active running arrangements are not reset. Blocked switches
will cause the switching action to fail
simulateOnly (optional)
Can be used to get the switches that would be changed. No switching is performed
if set to ‘1’. (default is ’0’)

R ETURNS
Information about the success of the action:

0 Action was successful

1 Action failed

77
5.1. GENERAL METHODS CHAPTER 5. OBJECT METHODS

S EE ALSO

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

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

A RGUMENTS
changedSwitches (optional, out)
All switches whose switching state was changed by the action are filled into this
set
resetRA (optional)
Determines whether an active running arrangement that would prevent switching
action should be deactivated or not.

1 All running arrangements that cause blocking of relevant switches are

applied and reset automatically before the switching is performed.
0 (default) Active running arrangements are not reset. Blocked switches
will cause the switching action to fail
simulateOnly (optional)
Can be used to get the switches that would be changed. No switching is performed
if set to ‘1’. (default is ’0’)

R ETURNS
Iinformation about the success of the action:

0 Action was successful

1 Action failed

S EE ALSO

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

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

78
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2 Network Elements

5.2.1 ElmArea
Overview

CalculateInterchangeTo
DefineBoundary
GetAll
GetBranches
GetBuses
GetObjs

CalculateInterchangeTo
Calculates interchange power to the given area (calculated quantities are: Pinter, Qinter, Pex-
port, Qexport, Pimort, Qimport). Prior the calculation the valid load flow calculation is required.
int ElmArea.CalculateInterchangeTo(DataObject area)

A RGUMENTS
area Area to which the interchange is calculated

R ETURNS
<0 Calculation error (i.e. no valid load flow, empty area...)
0 No interchange power to the given area
1 Interchange power calculated

DefineBoundary
Defines boundary with this area as interior part. Resulting cubicles of boundary are busbar-
oriented towards the area.
DataObject ElmArea.DefineBoundary(int shift)

A RGUMENTS
shift Elements outside the area that are within a distance of shift many elements to
a boundary cubicle of the area are added to the interior part of the resulting
boundary

R ETURNS
The defined boundary is returned in case of success. Otherwise NULL, if an error appeared
in the definition of the boundary.

GetAll
Returns all objects which belong to this area.
list ElmArea.GetAll()

79
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The set of contained objects.

GetBranches
Returns all branches which belong to this area.
list ElmArea.GetBranches()

R ETURNS
The set of branch objects.

GetBuses
Returns all buses which belong to this area.
list ElmArea.GetBuses()

R ETURNS
The set of objects.

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

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

R ETURNS
The set of objects.

5.2.2 ElmAsm
Overview

CalcEfficiency
GetAvailableGenPower
GetElecTorque
GetGroundingImpedance
GetMechTorque
GetMotorStartingFlag
GetStepupTransformer
IsPQ

80
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

GetAvailableGenPower
Returns the available power that can be dispatched from the generator, for the particular study
time.
For the case of conventional generators (no wind generation selected), the available power is
equal to the nominal power specified.
For wind generators, the available power will depend on the wind model specified:

• No Wind Model: No available power.

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

For motors, the available power is zero.

float ElmAsm.GetAvailableGenPower()

R ETURNS
Available generation power

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

81
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

addZImag (optional)
additional impedance (imaginary part) in p.u.

R ETURNS
Returns the calculated electrical torque.

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

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

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

GetMechTorque
Calculates the electrical torque for a given speed and voltage.
float ElmAsm.GetMechTorque(float speed,
float uReal
)

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

R ETURNS
Returns the calculated mechanical torque.

82
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetMotorStartingFlag
Returns the starting motor condition.
int ElmAsm.GetMotorStartingFlag()

R ETURNS
Returns the motor starting condition. Possible values are:

-1 in the process of being calculated

0 not calculated
1 successful start
2 unsuccessful start

GetStepupTransformer
Performs a topological search to find the step-up transformer of the asynchronous machine.
DataObject ElmAsm.GetStepupTransformer(float Voltage,
int swStatus
)

A RGUMENTS
hvVoltage
voltage level at which the search will stop

ignSwtStatus
consideration of switch status. Possible values are:
0 consider all switch status
1 ignore breaker status
2 ignore all switch status

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

IsPQ
Informs whether or not it is a ”PQ” machine (constant Q control mode).
int ElmAsm.IsPQ()

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

5.2.3 ElmAsmsc
Overview

GetAvailableGenPower
GetGroundingImpedance
GetStepupTransformer
83
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 ElmAsmsc.GetAvailableGenPower()

R ETURNS
Available generation power

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

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

reactance (out)
Imaginary part of the grounding impedance in Ohm.

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

84
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetStepupTransformer
Performs a topological search to find the step-up transformer of the asynchronous machine.
DataObject ElmAsmsc.GetStepupTransformer(float Voltage,
int swStatus
)

A RGUMENTS
hvVoltage
voltage level at which the search will stop
ignSwtStatus
consideration of switch status. Possible values are:

0 consider all switch status

1 ignore breaker status
2 ignore all switch status

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

5.2.4 ElmBbone
Overview

CheckBbPath
GetBbOrder
GetCompleteBbPath
GetFOR
GetMeanCs
GetMinCs
GetTieOpenPoint
GetTotLength
HasGnrlMod

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

a Terminals determining backbone path are still directly connected.

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

A RGUMENTS
outputMsg
1 Output resulting messages of check function.
0 Only check, no output of messages.

85
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Backbone is valid.
1 Backbone is invalid because of one or more of the above listed reasons.

GetBbOrder
Get order of backbone object, determined by backbone calculation according to the selected
criterion.
int ElmBbone.GetBbOrder()

R ETURNS
The order of the backbone object. The smaller the returned value, the better the backbone
according to chosen criterion. The order 1 is returned for the best backbone.

GetCompleteBbPath
Get the complete (ordered) path containing all terminals and connecting elements of the back-
bone.
list ElmBbone.GetCompleteBbPath(int iReverse,
[int iStopAtTieOpen = 0])

A RGUMENTS
AllElmsOnBb (out)
Ordered path containing all terminals and connecting elements of the backbone.
iReverse
0 Return ordered path from start feeder to end feeder
1 Return ordered path from end feeder to start feeder
iStopAtTieOpen
0 return complete path
1 only return part of path in start feeder (iReverse=0) / in end feeder
(iReverse=1)

GetFOR
Get aggregated forced outage rate (FOR) of all elements on the path of the backbone.
float ElmBbone.GetFOR()

R ETURNS
The aggregated forced outage rate (FOR) of all elements on the path of the backbone [in
1/a].

GetMeanCs
Get mean cross section value of all elements on the path of the backbone. Every cross section
value is weighted with the relative length corresponding to the total length of the backbone.
float ElmBbone.GetMeanCs()

86
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The mean cross section of the elements on the backbone path [in mm2].

GetMinCs
Get minimum cross section value of all elements on the path of the backbone. Optional: a set
with all elements on the backbone path featuring this cross section may be returned.
[float minCs,
set ElmsMinCs] ElmBbone.ElmBoundary.IsSplitting()

A RGUMENTS
ElmsMinCs
Elements on the backbone path featuring minimum cross section value.

R ETURNS
The minimum cross section of all elements on the backbone path [in mm2].

GetTieOpenPoint
Search and obtain the first open switching device (ElmCoup, StaSwitch) on the backbone path
(starting from the infeeding point of the starting feeder).
DataObject ElmBbone.GetTieOpenPoint()

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

GetTotLength
Get total lenth of all elements on the path of the backbone.
float ElmBbone.GetTotLength()

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

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

R ETURNS
1 ElmBbone has a calculation model,
0 no calculation model available.

87
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.5 ElmBmu
Overview

Apply
Update

Apply
Applies the power dispatch. Depending on the selected 'Distribution Mode ' this is done by a
built-in algorithm based on 'Merit Order' or by a user-defined DPL script that is stored in the
contents of the virtual power plant object.
int ElmBmu.Apply()

R ETURNS
0 on success, no error occurred
1 error during dispatch by virtual power plant. Please note, a value of 1 is also
returned in case the power plant is current set out-of-service.

Update
Updates the list of machines in the tables: 'Dispatchable Machines' and 'Non-dispatchable
(fixed) Machines'.
None ElmBmu.Update()

5.2.6 ElmBoundary
Overview

AddCubicle
CalcShiftedReversedBoundary
Clear
GetInterior
IsSplitting
Resize
Update

AddCubicle
Adds a given cubicle with given orientation to an existing boundary. The cubicle is added only if
it is not already contained within the boundary.
int ElmBoundary.AddCubicle(DataObject cubicle,
int orientation
)

R ETURNS
0 cubicle was successfully added
1 cubicle was not added because it is already contained (including given orienta-
tion)

88
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

CalcShiftedReversedBoundary
Defines boundary where exterior and interior part of this boundary are exchanged. Resulting
boundary cubicles are branch-oriented.
[int error,
DataObject boundary] ElmBoundary.CalcShiftedReversedBoundary(float shift)

A RGUMENTS
shift Elements that are within a distance of shift many elements to a boundary cubicle
of this boundary are added to the exterior part of the resulting boundary.
boundary (out)
Defined boundary.

R ETURNS
0 Successful call, boundary defined.
1 Error during determination of boundary cubicles.

Clear
Removes all boundary cubicles from an existing boundary.
None ElmBoundary.Clear()

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

R ETURNS
Returns the set of interior elements.

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

A RGUMENTS
notSplittingCubicles (optional, out)
All cubicles that prevent the boundary from being splitting are filled into this set.

R ETURNS
0 not splitting boundary
1 splitting boundary

89
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

Resize
Resizes the boundary cubicle vector or the cubicle orientation vector. It is strongly advised that
the size of both vectors must be the same.
None ElmBoundary.Resize(float size,
str name
)

A RGUMENTS
size size of the referenced vector (number of cubicles)
name reference to the vector (’iorient’ or ’cubicles’)

R ETURNS
If the resize is unsuccessful the error message shall be issued.

Update
Updates cached information (such as topological interiour). Required when boundary definition
was changed via DPL or Python.
None ElmBoundary.Update()

5.2.7 ElmBranch
Overview

Update

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

5.2.8 ElmCabsys
Overview

FitParams
GetLineCable
Update

FitParams
Calculates distributed parameters for cable system elements. Whether this function calculates
constant parameters or frequency dependent parameters depends on the user setting of the
parameter 'i model' in the ElmCabsys dialog. The settings are as follows: i model=0: constant
parameters; i model=1: frequency dependent parameters.
int ElmCabsys.FitParams()

90
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 on success
1 on error

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

A RGUMENTS
line Index of line.

R ETURNS
cable type On success.
None On error.

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

R ETURNS
1 On success.
0 On error.

5.2.9 ElmComp
Overview

SlotUpdate

SlotUpdate
Performs a slot update for the composite model, to try to reassign each model found in the
composite model contents to the corresponding slot.
None ElmComp.SlotUpdate()

D EPRECATED N AMES
Slotupd

91
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.10 ElmCoup
Overview

Close
GetRemoteBreakers
IsBreaker
IsClosed
IsOpen
Open

Close
Closes the switch by changing its status to ’close’. This action will fail if the status is currently
determined by an active running arrangement.
int ElmCoup.Close()

R ETURNS
0 On success
6= 0 On error

S EE ALSO

ElmCoup.Open()

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

• switches of type circuit breaker

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

If the search reaches a busbar while only reducible components have been passed (see DataOb-
ject.IsReducible()) it stops and returns the connected busbar (no breaker found). In case of
non-redubicle components have been passed, the search continues until next circuit breaker is
found. Only breakers with given breaker state are returned.
[list remoteBreakers,
list foundBreakers,
list foundBusbars ] ElmCoup.GetRemoteBreakers(int desiredBreakerState)

A RGUMENTS
desiredBreakerState
Only breakers with given status are collected.
-1 Return all remote circuit breakers
1 Return all closed remoted circuit breakers
0 Return all opened remoted circuit breakers
foundBreakers (out)
The list of the remote circuit breakers

92
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

foundBusbars (optional, out)

The list of the local bus bars

IsBreaker
Checks if type of current switch is ’circuit-breaker’.
int ElmCoup.IsBreaker()

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

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

R ETURNS
1 switch is closed
0 switch is open

S EE ALSO

ElmCoup.IsOpen()

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

R ETURNS
1 switch is open
0 switch is closed

S EE ALSO

ElmCoup.IsClosed()

Open
Opens the switch by changing its status to ’open’. This action will fail if the status is currently
determined by an active running arrangement.
int ElmCoup.Open()

R ETURNS
0 On success
6= 0 On error

93
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

ElmCoup.Close()

5.2.11 ElmDsl
Overview

ExportToClipboard
ExportToFile

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

A RGUMENTS
colSeparator (optional)
Separator between the columns (default: tab character).

useLocalHeader (optional)
Use the localised version of the header. Possible values are:
1 Yes (default).
0 No (use English language header).

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

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

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

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

94
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.12 ElmFeeder
Overview

CalcAggrVarsInRadFeed
GetAll
GetBranches
GetBuses
GetNodesBranches
GetObjs

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

A RGUMENTS
lookForRoot (optional)
Calculates the variables from the deepest root. Possible values are:
0 Start from this feeder
1 (default) Find the deepest root.
considerNested (optional)
Calculates the variables also for any nested subfeeders. Possible values are:
0 Ignore any nested feeders
1 (default) Consider nested feeders.

R ETURNS
Returns whether or not the aggregated variables were calculated. Possible values are:

0 error during calculation

1 calculated correctly

GetAll
Returns a set with all objects belonging to this feeder.
list ElmFeeder.GetAll([int iNested])

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

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

95
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

DataObject.IsInFeeder()

GetBranches
Returns a set with all branch elements belonging to this feeder.
list ElmFeeder.GetBranches([int iNested])

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

R ETURNS
The set of bus and branch elements in feeder.

GetBuses
Returns a set with all buses belonging to this feeder.
list ElmFeeder.GetBuses([int iNested])

A RGUMENTS
iNested (optional)
Affects the collection of objects in case of nested feeders:

0 Only the objects of this feeder will be returned.

1 (default) All elements including those of nested feeders will be re-
turned.

R ETURNS
The set of bus elements in feeder.

GetNodesBranches
Returns a set with all buses and branches belonging to this feeder.
list ElmFeeder.GetNodesBranches([int iNested])

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

96
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The set of bus and branch elements in feeder.

GetObjs
Returns a set with all objects of class 'ClassName' which belong to this feeder.
list ElmFeeder.GetObjs(str ClassName,
[int iNested])

A RGUMENTS
iNested (optional)
Affects the collection of objects in case of nested feeders:

0 Only the objects of this feeder will be returned.

1 (default) All elements including those of nested feeders will be re-
turned.

R ETURNS
The set of feeder objects.

5.2.13 ElmFile
Overview

LoadFile
SaveFile

LoadFile
(Re)Loads the file into a buffer.
int ElmFile.LoadFile([int loadComplete = 1])

A RGUMENTS
loadComplete (optional)
0 Removes all points in the future simulation time and adds all points
from the file (including the current interpolated value).
1 Clears the buffer and reloads the complete file (default).

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

SaveFile
Saves the buffer and overwrites the file.
int ElmFile.SaveFile()

97
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ] ElmFilter.GetGroundingImpedance(int busIdx)

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

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

5.2.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 ElmGenstat.CalcEfficiency(float activePowerMW)

98
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

Derate
Derates the value of the Max. Active Power Rating according to the specified value given in
MW.
The following formula is used: P max uc = P max uc − ”Deratingvalue”.
None ElmGenstat.Derate(float deratingP)

A RGUMENTS
deratingP Derating value

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

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

GetAvailableGenPower
Returns the available power that can be dispatched from the generator, for the particular study
time.
For the case of conventional generators (no wind generation selected), the available power is
equal to the nominal power specified.
For wind generators, the available power will depend on the wind model specified:

• No Wind Model: No available power.

• Stochastic Wind Model: Given the specified mean wind speed, the available power is
calculated from the Power Curve. If the units of the Power Curve are in MW, the returned
value is directly the available power. In the other hand, if the units are in PU, the returned
value is multiplied by the nominal power of the generator to return the available power.
• Time Series Characteristics of Active Power Contribution: The available power is the
average of the power values (in MW) obtained from all the specified time characteristics
for the current study time.
• 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

99
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

units of the Power Curve are in MW, the returned value is directly the power value. In the
other hand, if the units are in PU, the returned value is multiplied by the nominal power of
the generator to return the power value.

For motors, the available power is zero.

float ElmGenstat.GetAvailableGenPower()

R ETURNS
Available generation power

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

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

reactance (out)
Imaginary part of the grounding impedance in Ohm.

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

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

A RGUMENTS
voltage voltage level at which the search will stop
swStatus consideration of switch status. Possible values are:
0 consider all switch status
1 ignore breaker status
2 ignore all switch status

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

100
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

IsConnected
Checks if generator is topologically connected to any busbar.
int ElmGenstat.IsConnected()

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

Reconnect
Connects a static generator by closing all switches (breakers and isolators) up to the first breaker
on the HV side of a transformer. The topological search to find all the switches, stops at any
busbar.
int ElmGenstat.Reconnect()

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

ResetDerating
Resets the derating value, setting the Max. Active Power Rating according to the rating factor.
The following formula is used: P max uc = pmaxratf ∗ P n ∗ ngnum.
None ElmGenstat.ResetDerating()

5.2.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 ElmGndswt.Close()

R ETURNS
1, always

S EE ALSO

ElmGndswt.Open()

101
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ] ElmGndswt.GetGroundingImpedance(int busIdx)

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

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

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

R ETURNS
1 switch is closed
0 switch is open

S EE ALSO

ElmGndswt.IsOpen()

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

R ETURNS
1 switch is open
0 switch is closed

S EE ALSO

ElmGndswt.IsClosed()

Open
Opens the switch by changing its status to ’open’.
int ElmGndswt.Open()

102
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0, always

S EE ALSO

ElmGndswt.Close()

5.2.17 ElmLne
Overview

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

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

ElmLne No routes, no sections

TypTow only 1 circuit x 3 phases

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

TypCabsys only 1 circuit x 3 phases

int ElmLne.AreDistParamsPossible()

R ETURNS
The returned value are:

0 All conditions fulfilled

1 Line contains routes
2 Line contains sections
3 Line has no type
4 TypTow/TypCabsys does not fulfil conditions for distributed paramters
5 TypLne does not fulfil conditions for distributed parameters
6 Short-circuit flag is set (EMT or RMS simulations)

103
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

7 TypLne/TypTow: B0 and B1 = 0
8 Error, no condition state could be determined

CreateFeederWithRoutes
Creates a new feeder in the line by splitting the line into 2 routes and inserting a terminal.
int ElmLne.CreateFeederWithRoutes(float dis,
float rem,
DataObject O)
int ElmLne.CreateFeederWithRoutes(float dis,
float rem,
DataObject O,
[int sw0,]
[int sw1])

A RGUMENTS
dis Inserting operation occurs after this distance
rem Remaining distance, percentage of distance ’dis’
O Branch object that is to be connected at the inserted terminal
sw0 If set to (1), switch is inserted on the first side
sw1 If set to (1), switch is inserted on the second side

R ETURNS
0 Success, feeders created
1 Error

FitParams
Calculates distributed parameters of the line element. Whether this function calculates constant
parameters or frequency dependent parameters depends on the user setting of the parameter
'i model' in the ElmLne dialogue. The settings are as follows: i model=0: constant parameters;
i model=1: frequency dependent parameters.
int ElmLne.FitParams([int isRMSModel = 0,]
[int modify = 1])

A RGUMENTS
isRMSModel

modify

R ETURNS
0 Success
1 Error

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

104
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns rated short-time current value

GetType
Returns the line type object.
DataObject ElmLne.GetType()

R ETURNS
The TypLne object if exists or None

GetY0m
The function returns the zero-sequence mutual coupling admittance (G0m, B0m) in Ohm of the
line and input argument line (object Lne2). When Lne2 = line, the function returns the zero-
sequence self admittance.
[int error,
float G0m,
float B0m ] ElmLne.GetY0m(DataObject Lne2)

A RGUMENTS
Lne2 Line element
G0m (out)
Resulting G0m value
B0m (out)
Resulting B0m value

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

GetY1m
The function returns the positive-sequence mutual coupling admittance (G1m, B1m) in Ohm
of the line and input argument line (object Lne2). When Lne2 = line, the function returns the
positive-sequence self admittance.
[int error,
float G1m,
float B1m ] ElmLne.GetY1m (DataObject Lne2)

A RGUMENTS
Lne2 Line element
G1m (out)
Resulting G1m value
B1m (out)
Resulting B1m value

105
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

106
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 ElmLne.GetZmatDist(float frequency,
int exact,
DataObject matrix)

A RGUMENTS
frequency
Frequency for which the calculation is carried out
exact 0: Approximated solution, 1: Exact solution for ‘frequency’

matrix Impedance matrix to be filled with the impedance amplitudes

R ETURNS
The returned value reports if the impedance matrix acquired:

1 Error, no matrix acquired

0 Success, matrix acquired

HasRoutes
Checks if the line is subdivided into routes.
int ElmLne.HasRoutes()

R ETURNS
0 When the line is a single line
1 When the line is subdivided into routes

HasRoutesOrSec
Checks if the line is subdivided into routes or sections.
int ElmLne.HasRoutesOrSec()

R ETURNS
0 When the line is a single line
1 When the line is subdivided into routes
2 When the line is subdivided into sections

IsCable
Checks if this line is a cable.
int ElmLne.IsCable()

107
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 ElmLne.IsNetCoupling()

R ETURNS
The returned value reports if the line is a coupler:

1 The line is a coupler (connects two grids)

0 The line is not a coupler

MeasureLength
Measures the length of this line using the active diagram. For graphical measurement the active
diagram needs to have a scaling factor. Geographic diagrams by default have a scaling factor.
If iUseGraphic = 1, the line length is determined directly from the positions given in (latitude/lon-
gitude) considering the earth as a perfect sphere. In this case no graphic needs to be open.
float ElmLne.MeasureLength([int iUseGraphic])

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

1 Use displayed diagram for calculation (default)

0 Calculate distance without diagram

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

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

108
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.18 ElmLnesec
Overview

IsCable

IsCable
Checks if this line section is a cable.
int ElmLnesec.IsCable()

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

5.2.19 ElmMdl
Overview

ExportToClipboard
ExportToFile

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

A RGUMENTS
colSeparator (optional)
Separator between the columns (default: tab character).
useLocalHeader (optional)
Use the localised version of the header. Possible values are:

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

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

109
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 ] ElmNec.GetGroundingImpedance(int busIdx)

A RGUMENTS
busIdx Bus index where the grounding should be determined.
resistance (out)
Real part of the grounding impedance in Ohm.
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
Deactivate
DefineBoundary

110
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 ElmNet.Activate()

R ETURNS
0 on success
1 on error

CalculateInterchangeTo
This function calculates the power flow from current grid to a connected grid. The values are
stored in current grid in the following attributes (values from the previous load flow calculation
are overwritten):

- Pinter: Active Power Flow

- Qinter: Reactive Power Flow
- ExportP: Export Active Power Flow
- ExportQ: Export Reactive Power Flow
- ImportP: Import Active Power Flow
- ImportQ: Import Reactive Power Flow
int ElmNet.CalculateInterchangeTo(DataObject net)

A RGUMENTS
net Connected grid

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

Deactivate
Removes a grid from the active study case.Can only be applied if there are is no currently active
calculation.
int ElmNet.Deactivate()

R ETURNS
0 on success
1 on error

DefineBoundary
Defines boundary with this grid as interior part. Resulting cubicles of boundary are busbar-
oriented towards the grid.
DataObject ElmNet.DefineBoundary(int shift)

111
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
shift Elements outside the grid that are within a distance of shift many elements to
a boundary cubicle of the grid are added to the interior part of the resulting
boundary

R ETURNS
The defined boundary is returned in case of success. Otherwise NULL, if an error appeared
in the definition of the boundary.

5.2.22 ElmPvsys
Overview

CalcEfficiency
Derate
Disconnect
GetAvailableGenPower
GetGroundingImpedance
IsConnected
Reconnect
ResetDerating

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

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

Derate
Derates the value of the Max. Active Power Rating according to the specified value given in
MW.
The following formula is used: P max uc = P max uc − ”Deratingvalue”.
None ElmPvsys.Derate(float deratingP)

A RGUMENTS
deratingP Derating value

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

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

R ETURNS
Available generation power

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

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

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

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

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

Reconnect
Connects a PV system by closing all switches (breakers and isolators) up to the first breaker
on the HV side of a transformer. The topological search to find all the switches, stops at any
busbar.
int ElmPvsys.Reconnect()

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

ResetDerating
Resets the derating value, setting the Max. Active Power Rating according to the rating factor.
The following formula is used: P max uc = pmaxratf ∗ P n ∗ ngnum.
None ElmPvsys.ResetDerating()

5.2.23 ElmRelay
Overview

CheckRanges
GetCalcRX
GetMaxFdetectCalcI
GetSlot
GetUnom
IsStarted
SetImpedance
SetMaxI
SetMaxIearth
SetMinI
SetMinIearth
SetOutOfService
SetTime
SlotUpdate
114
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

R ETURNS
0 All settings are valid.
1 At least one setting was forced into range.
-1 An error occurred.

GetCalcRX
Gets the calculated impedance from the polarising unit.
[int error,
float real,
float imag ] ElmRelay.GetCalcRX(int inSec,
int unit)

A RGUMENTS
inSec
0 Get the value in pri. Ohm.
1 Get the value in sec. Ohm.
unit
0 Get the value from Phase-Phase or Multifunctional polarizing.
1 Get the value from Phase-Earth or Multifunctional polarizing.
2 Get the value from Multifunctional polarizing
real (out) Real part of the impedance in Ohm.
imag (out)
Imaginary part of the impedance in Ohm.

R ETURNS
0 No error occurred, the output is valid.
1 An error occurred, the output is invalid.

GetMaxFdetectCalcI
Get the current measured by the starting unit.
[int error,
float Iabs ] ElmRelay.GetMaxFdetectCalcI(int earth,
int unit
)

A RGUMENTS
Iabs (out) The measured current in A
earth
0 Get the phase current.

115
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

1 Get the earth current.

unit
0 Get the current in pri. A.
1 Get the current in sec. A.

R ETURNS
0 No error, output is valid.
1 An error occurred, the output is invalid.

GetSlot
Returns the element in the slot with the given name.
DataObject ElmRelay.GetSlot(str name,
[int iShowErr]
)

A RGUMENTS
name Exact name of the slot to search for (no wildcards).
iShowErr (optional)
0 Do not show error messages.
1 Show error messages if a slot is not found or empty.

R ETURNS
The object in the slot or None.

GetUnom
Returns the nominal voltage of the local bus of the relay.
float ElmRelay.GetUnom()

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

IsStarted
Checks if the starting unit detected a fault.
int ElmRelay.IsStarted()

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

116
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

SetImpedance
Sets the the given impedance to the distance blocks matching the criteria.
int ElmRelay.SetImpedance(float real,
float imag,
int inSec,
int zone,
int unit
)
int ElmRelay.SetImpedance(float real,
float imag,
float lineAngle,
float Rarc,
int inSec,
int zone,
int unit
)

A RGUMENTS
real Real part of the impedance in Ohm.
imag Imaginary part of the impedance in Ohm.
inSec
0 The values are in pri. Ohm.
1 The values are in sec. Ohm.
zone Set the impedance for elments with this zone number.
unit
0 Set the impedance for Phase - Phase or Multifunctional elements.
1 Set the impedance for Phase - Earth or Multifunctional elements.
2 Set the impedance for Multifunctional elements.

A RGUMENTS
real Real part of the impedance in Ohm.
imag Imaginary part of the impedance in Ohm.
lineAngle The line angle in deg.
Rarc The arc resistance in Ohm.
inSec
0 The values are in pri. Ohm.
1 The values are in sec. Ohm.
zone Set the impedance for elments with this zone number.
unit
0 Set the impedance for Phase - Phase or Multifunctional elements.
1 Set the impedance for Phase - Earth or Multifunctional elements.
2 Set the impedance for Multifunctional elements.

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

117
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

SetMaxI
Sets the “Max. Phase Fault Current” of the relay to the currently measured value.
None ElmRelay.SetMaxI()

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

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

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

SetOutOfService
Sets the “Out of Service” flag of elements contained in the relay.
int ElmRelay.SetOutOfService(int outServ,
int type,
int zone,
int unit
)

A RGUMENTS
outServ
0 Set elements in service.
1 Set Elements out of service.
type
1 Set the flag for overcurrent elements.
2 Set the flag for distance elements.

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

118
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

SetTime
Sets the tripping time for elements contained in the relay.
int ElmRelay.SetTime(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 ElmRelay.SlotUpdate()

D EPRECATED N AMES
slotupd

119
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.24 ElmRes
Overview

AddVariable
Clear
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 ElmRes.AddVariable(DataObject element,
str varname)

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

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

120
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

D EPRECATED N AMES
AddVars

Clear
Clears all data (calculation results) written to the result file. The Variable definitions stored in
the contents of ElmRes are not modified.
int ElmRes.Clear()

R ETURNS
Always 0 and can be ignored.

FindColumn
Returns the index of the first header column matching the given object and/or variable name.
int ElmRes.FindColumn(DataObject obj,
[str varName]
)
int ElmRes.FindColumn(DataObject obj,
[int startCol]
)
int ElmRes.FindColumn(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

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

FindMaxInColumn
Find the maximum value of the variable in the given column.
[int row,
float value] ElmRes.FindMaxInColumn(int column)

A RGUMENTS
column The column index.
value (optional, out)
The maximum value found. The value is 0. in case that the maximum value was
not found.

121
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
<0 The maximum value of column was not found.
≥0 The row with the maximum value of the column.

FindMaxOfVariableInRow
Find the maximum value for the given row and variable.
[int col,
float maxValue] ElmRes.FindMaxOfVariableInRow(str variable,
int row)

A RGUMENTS
variable The variable name

variable The row

maxValue (optional)
The corresponding maximum value.

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

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

A RGUMENTS
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] ElmRes.FindMinOfVariableInRow(str variable,
int row)

122
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
variable The variable name
variable The row
minValue (optional, out)
The corresponding minimum value.

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

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

D EPRECATED N AMES
Close

S EE ALSO

ElmRes.InitialiseWriting(), ElmRes.Write(), ElmRes.WriteDraw()

Flush
This function is required in scripts which perform both file writing and reading operations. While
writing to a results object (ElmRes), a small portion of this data is buffered in memory. This
is required for performance reasons. Therefore, all data must be written to the disk before
attempting to read the file. 'Flush' copies all data buffered in memory to the disk. After calling
'Flush'all data is available to be read from the file.
int ElmRes.Flush()

GetColumnValues
Get complete column values.
int ElmRes.GetColumnValues(DataObject dataVector,
int column)

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

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

123
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetDescription
Get the description of a column.
str ElmRes.GetDescription([int column],
[int short]
)

A RGUMENTS
column (optional)
The column index. The description name of the default variable is returned if the
parameter is nor passed to the function.
short (optional)
0 long desc. (default)
1 short description

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

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

A RGUMENTS
row Result file row
classNames (optional)
Comma separated list of class names for valid objects. The next object of one
of the given classes is searched. If not set all objects are considered as valid
(default).
variableName (optional)
Name of the limiting variable. The searched object must have this variable. If not
set variables are not considered (default).

limit (optional)
Limiting value for the variable.
limitOperator (optional)
Operator for checking the limiting value:

0 all values are valid (default)

1 valid values must be < limit

124
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ElmRes.GetFirstValidObjectVariable([str variableNames])

A RGUMENTS
variableNames (optional)
Comma separated list of valid variable names. The next column with one of
the given variables is searched. If empty all variables of the current object are
considered as valid (default).

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

GetFirstValidVariable
Gets the index of the column for the first valid variable in the given line. Starts at the beginning
of the given line and sets the internal iterator of the result file to the found position.
int ElmRes.GetFirstValidVariable(int row,
[str variableNames]
)

125
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

A RGUMENTS
row Result file row
classNames (optional)
Comma separated list of class names for valid objects. The next object of one
of the given classes is searched. If not set all objects are considered as valid
(default).
variableName (optional)
Name of the limiting variable. The searched object must have this variable. If not
set variables are not considered (default).
limit (optional)
Limiting value for the variable.
limitOperator (optional)
Operator for checking the limiting value:
0 all values are valid (default)
1 valid values must be < limit
2 valid values must be ≤ limit
3 valid values must be > limit
4 valid values must be ≥ limit
limit2 (optional)
Second limiting value for the variable.
limitOperator2 (optional)
Operator for checking the second limiting value:

126
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

<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 ElmRes.GetNextValidObjectVariable([str variableNames])

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

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

GetNextValidVariable
Gets the index of the column for the next valid variable in the given line. Starts at the internal
iterator of the given line and sets the internal iterator of the result file to the found position.
int ElmRes.GetNextValidVariable([str variableNames])

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

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

127
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetNumberOfColumns
Returns the number of variables (columns) in result file excluding the default variable (e.g. time
for time domain simulation).
int ElmRes.GetNumberOfColumns()

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

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

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

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

A RGUMENTS
index index of the object.

R ETURNS
The object found or None.

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

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

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

GetObjectValue
Returns a value from a result object for row iX of curve col.
[int error,
DataObject o ] ElmRes.GetObjectValue(int iX,
[int col])

128
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ElmRes.GetRelCase(int caseNumber)

A RGUMENTS
caseNumber
The reliability case number

R ETURNS
Returns the contingency of case number. None is returned if there is no corresponding
contingency.

GetSubElmRes
Get sub-result file stored inside this.
DataObject ElmRes.GetSubElmRes(int value)
DataObject ElmRes.GetSubElmRes(DataObject obj)

A RGUMENTS
value The cnttime to look for
obj The pResElm to look for

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

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

129
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

GetValue
Returns a value from a result object for row iX of curve col.
[int error,
float d ] ElmRes.GetValue(int iX,
[int col])

A RGUMENTS
d (out) The value retrieved from the data.
iX The row.
col (optional)
The curve number, which equals the variable or column number, first column value
(time,index, etc.) is returned when omitted.

R ETURNS
0 when ok
1 when iX out of bound
2 when col out of bound
3 when invalid value is returned from a sparse file. Sparse files are written e.g.
by the contingency analysis, the value is invalid in case that it was not written,
because it was below the recording limit. Result files created using DPL/Python
are always full and will not return invalid values.

GetVariable
Get variable name of column
str ElmRes.GetVariable([int column])

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

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

130
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

InitialiseWriting
Opens the result object for writing. This function must be called before writing data for result
files not stored in the script object. If arguments are passed to the function they specify the
variable name, unit... of the default variable (e.g. to be used by plots as x-axis).
int ElmRes.InitialiseWriting()
int ElmRes.InitialiseWriting(str variableName,
str unit,
str description,
[str shortDescription]
)

A RGUMENTS
variableName
The variable name for the default variable (e.g. “distance”)
unit The unit (e.g. “km”)

description
The description of the variable (e.g. “Distance from infeed”)
shortDescription
The short description (e.g. “Dist. Infeed”)

R ETURNS
Always 0 and can be ignored

D EPRECATED N AMES
Init

S EE ALSO

ElmRes.FinishWriting(), ElmRes.Write(), ElmRes.WriteDraw()

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

Release
Releases the data loaded to memory. This function should be used whenever several result
objects are processed in a loop. Data is always released from memory automatically after
execution of the current script.
None ElmRes.Release()

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

131
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

SetObj
Adds an object to the objects assigned to the result file
int ElmRes.SetObj(DataObject element)

A RGUMENTS
element Element to store in result file

R ETURNS
The index which can be used to retrieve the object from the results file. The index is < 0 if
no results are recorded for the given object (e.g. a contingency in reliability calculation). The
index is ≥ if variables are recorded for the object.

SetSubElmResKey
Assigns a value or an object to the according ElmRes parameter.
None ElmRes.SetSubElmResKey(int value)
None ElmRes.SetSubElmResKey(DataObject obj)

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

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The ElmRes itself remains
unchanged.
int ElmRes.SortAccordingToColumn(int column)

A RGUMENTS
col The column number.

R ETURNS
0 The function executed correctly, the data was sorted correctly according to the
given column.
1 The column with index column does not exist.

Write
Writes the current results to the result object.
int ElmRes.Write([float defaultValue])

R ETURNS
0 on success

132
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

ElmRes.WriteDraw(), ElmRes.InitialiseWriting(), ElmRes.FinishWriting()

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

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 ] ElmShnt.GetGroundingImpedance(int busIdx)

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

resistance (out)
Real part of the grounding impedance in Ohm.
reactance (out)
Imaginary part of the grounding impedance in Ohm.

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

5.2.26 ElmStactrl
Overview

GetControlledHVNode
GetControlledLVNode
GetStepupTransformer
Info

133
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetControlledHVNode
Returns the corresponding voltage controlled HV node for the machine at the specified index.
Switch status are always considered.
DataObject ElmStactrl.GetControlledHVNode([int index = 0])

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

R ETURNS
object Busbar/Terminal ()
None not found

GetControlledLVNode
Returns the corresponding voltage controlled LV node for the machine at specified index. Switch
status are always considered.
DataObject ElmStactrl.GetControlledLVNode(int index)

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

R ETURNS
object Terminal ()
None not found

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

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

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

134
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

5.2.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 ElmSubstat.ApplyAndResetRA()

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

GetSplit
A split of a station is a group of topologically connected elements. Such a group is called split
if all contained components are energized and there is at least one busbar (terminal of usage
'busbar') contained or it has connections to at least two main components (= all components
except switch devices and terminals).
These splits are ordered according to the count of nodes contained and according to their
priority. So each split becomes a unique index.
The function GetSplit offers access to the elements contained in a split. By calling GetSplit with
an index from 0 to n, the elements belonging to the corresponding split are filled into given sets
and returned.
[int error
list mainNodes,
list connectionCubicles,
list allElements ] ElmSubstat.GetSplit(int index)

A RGUMENTS
index Index of the split used to access the elements of the corresponding split. Value
must be ≥ 0.

135
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

mainNodes (out)
Terminals of same usage considered to form the most important nodes for that
group. In most cases, this is the group of contained busbars.
connectionCubicles (optional, out)
All cubicles (of terminals inside the station) that point to an element that sits out-
side the station or to an element that is connected to a terminal outside the station
are filled into the set connectionCubicles. (The connection element (branch) can
be accessed by calling GetBranch() on each of these cubicles. The terminals
of these cubicles (parents) must not necessarily be contained in any split. They
could also be separated by a disconnecting component.)
allElements(optional, out)
All elements (class Elm*) of the split that have no connection to elements outside
the station are filled into this set.

R ETURNS
0 success, split of that index exists and is returned.
1 indicates that there exists no split with given index. (Moreover, this means that
there is no split with index n greater than this value.)

S EE ALSO

ElmSubstat.GetSplitCal(), ElmSubstat.GetSplitIndex(),

GetSplitCal
This function determines the elements that belong to a split. In contrast to ElmSubstat.GetSplit()
it is based on calculation instead of pure edit object topology. This means the returned nodes
correspond to the calculation nodes, the interconnecting cubicles are those connecting nodes
of different splits.
Note: As this function relies on calculation nodes it can only be executed after a calculation has
been performed (e.g. load flow calculation).
[int error,
list nodes,
list connectionCubicles,
list elements ] ElmSubstat.GetSplitCal(int index)

A RGUMENTS
index Index of the split used to access the elements of the corresponding split. Refers
to same split as index in ElmSubstat.GetSplit().
Value must be ≥ 0.
nodes (out)
A set that is filled with terminals. There is one terminal returned for each calcula-
tion node in the split.
connectionCubicles (optional, out)
This set is filled with all cubicles that point from a calculation node of current split
to another calculation node that does not belong to that split. The connecting
element can be accessed by calling GetBranch() on such a cubicle.
elements (optional, out)
This set is filled with network elements that are connected to a calculation node of
current split and have exactly one connection, i.e. these elements are completely
contained in the split.

136
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
0 success, split of that index exists and is returned.
1 indicates that there exists no split with given index. (Moreover, this means that
there is no split with index n greater than this value.)

S EE ALSO

ElmSubstat.GetSplit()

GetSplitIndex
This function returns the index of the split that contains passed object.
int ElmSubstat.GetSplitIndex(DataObject o)

A RGUMENTS
o Object for which the split index is to be determined.

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

S EE ALSO

ElmSubstat.GetSplit()

GetSuppliedElements
Returns the network components that are supplied by the transformer (located in the station). A
network component is considered to be supplied by a transformer if a topological path from the
transformer to the component exists. A valid topological path in this sense is a path that starts
at the transformer’s HV side in direction of transformer (not in direction of HV connected node)
and stops at

• network components that are out of calculation,

• network components that are not active (e.g. hidden or those of currently inactive grids),
• open switches,
• connections leading to a higher voltage level.

Generally, all network components of such a path are considered to be supplied by the trans-
former.
Exceptions are components that are out of calculation or in-active. Those components are never
considered to be supplied by any transformer. A transformer is never considered to supply itself.
Composite components such as ElmBranch, ElmSubstat, ElmTrfstat are considered to be sup-
plied by a transformer if all energized components inside that composite are supplied by the
transformer.
list ElmSubstat.GetSuppliedElements([int inclNested])

A RGUMENTS
inclNested (optional)
0 Do not include components that are supplied by nested supplying sta-
tions
1 (default) Include components that are supplied by nested stations

137
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements()

OverwriteRA
This function overwrites switch statuses stored in an existing running arrangement with actual
switch statuses of the substation. This is only possible if the substation has no running arrange-
ment selected and given running arrangement is valid for substation the method was called
on.
int ElmSubstat.OverwriteRA(DataObject ra)

A RGUMENTS
ra Given running arrangement

R ETURNS
1 If given running arrangement was successfully overwritten;
0 otherwise

ResetRA
This function resets the running arrangement selection for the substation it was called on.
None ElmSubstat.ResetRA()

SaveAsRA
When called on a substation that has no running arrangement selected, a new running ar-
rangement is created and all switch statuses of all running arrangement relevant switches (for
that substation) are saved in it. The running arrangement is stored in project folder ”Running
Arrangement” and its name is set to given locname. The new running arrangement is not
selected automatically.
(No new running arrangement is created if this method is called on a substation that has
currently a running arrangement selected).
DataObject ElmSubstat.SaveAsRA(str locname)

A RGUMENTS
locname Name of the new running arrangement (if name is already used, an increment
(postfix) is added to make it unique).

R ETURNS
Newly created 'IntRunarrange' object on success, otherwise None.

SetRA
This function sets the running arrangement selection for the substation it was called on. The
switch statuses are now determined by the values stored in the running arrangement.
int ElmSubstat.SetRA(DataObject ra)

138
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
ra running arrangement that is valid for the substation

R ETURNS
1 If given running arrangement was successfully set;
0 otherwise (e.g. given ra is not valid for that substation)

5.2.28 ElmSvs
Overview

GetStepupTransformer

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

A RGUMENTS
voltage voltage level at which the search will stop
swStatus consideration of switch status. Possible values are:
0 consider all switch status
1 ignore breaker status
2 ignore all switch status

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

5.2.29 ElmSym
Overview

CalcEfficiency
Derate
Disconnect
GetAvailableGenPower
GetGroundingImpedance
GetMotorStartingFlag
GetStepupTransformer
IsConnected
Reconnect
ResetDerating

139
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

A RGUMENTS
activePowerMW
Active power value to calculate efficiency for.

R ETURNS
Returns the resulting efficiency in p.u.

Derate
Derates the value of the Max. Active Power Rating according to the specified value given in
MW.
The following formula is used: P max uc = P max uc − ”Deratingvalue”.
None ElmSym.Derate(float deratingP)

A RGUMENTS
deratingP Derating value

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

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

GetAvailableGenPower
Returns the available power that can be dispatched from the generator, for the particular study
time.
For the case of conventional generators (no wind generation selected), the available power is
equal to the nominal power specified.
For wind generators, the available power will depend on the wind model specified:

• No Wind Model: No available power.

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

140
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

For motors, the available power is zero.

float ElmSym.GetAvailableGenPower()

R ETURNS
Available generation power

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

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

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

GetMotorStartingFlag
Returns the starting motor condition.
int ElmSym.GetMotorStartingFlag()

R ETURNS
Returns the motor starting condition. Possible values are:

-1 in the process of being calculated

0 not calculated
1 successful start
2 unsuccessful start

141
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

A RGUMENTS
voltage voltage level at which the search will stop
swStatus consideration of switch status. Possible values are:
0 consider all switch status
1 ignore breaker status
2 ignore all switch status

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

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

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

Reconnect
Connects a synchronous machine by closing all switches (breakers and isolators) up to the first
breaker on the HV side of a transformer. The topological search to find all the switches, stops
at any busbar.
int ElmSym.Reconnect()

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

ResetDerating
Resets the derating value, setting the Max. Active Power Rating according to the rating factor.
The following formula is used: P max uc = pmaxratf ∗ P n ∗ ngnum.
None ElmSym.ResetDerating()

142
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

GetCalcRelevantCubicles
This function gets calculation relevant cubicles of this terminal.
list ElmTerm.GetCalcRelevantCubicles()

R ETURNS
Set of calculation relevant cubicles.

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

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

143
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Set of cubicles.

GetConnectedCubicles
Function gets the set of cubicles connected with this terminal.
list ElmTerm.GetConnectedCubicles([int ignoreSwitchStates])

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

R ETURNS
Set of cubicles.

GetConnectedMainBuses
Function gets the set of connected main buses.
list ElmTerm.GetConnectedMainBuses([int considerSwitches])

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

R ETURNS
Set of main buses connected to the terminal.

GetConnectionInfo
Gets connection information of this terminal. Requires valid load flow calculation. Input argu-
ments are filled with the value after function call.
[int error,
float closedSwitches,
float allSwitches,
float nonSwitchingDevices,
float closedAndNonSwitchingDevices,
float allDevices,
float connectedNodes,
float mainNodes] ElmTerm.GetConnectionInfo()

A RGUMENTS
closedSwitches
Number of closed switch devices.

allSwitches
Number of total switch devices.
nonSwitchingDevices
Number of non-switch devices.

144
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

allDevices
Number of total switch and non-switch devices (allSwitches+nonSwitchingDevices).
connectedNodes
Number of total nodes connected via couplers.

mainNodes
Number of total main nodes.

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

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

• closed switching devices (ElmCoup, RelFuse) or

• lines of zero length (line droppers).

list ElmTerm.GetEquivalentTerminals()

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

S EE ALSO

ElmTerm.IsEquivalent()

GetMinDistance
This function determines the shortest path between the terminal the function was called on and
the terminal that was passed as first argument. The distance is determined on network topology
regarding the length of the traversed component (i.e. only lines have an influence on distance).
float ElmTerm.GetMinDistance(DataObject term)
[float minDistance,
list path ] ElmTerm.GetMinDistance(DataObject term,
int considerSwitches,
[list limitToNodes,]
[list elementsToIgnore,]
)

A RGUMENTS
term Terminal to which the shortest path is determined.
considerSwitches (optional)
0 Traverse all components, ignore switch states
1 Do not traverse open switch devices (default)

145
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

path (optional, out)

If given, all components of the found shortest path are put into this set.
limitToNodes(optional)
If given, the shortest path is searched only within this set of nodes. Please note,
when limiting search to a given set of nodes, the start and end terminals (for which
the distance is determined) must be part of this set (otherwise distance =-1).
elementsToIgnore(optional)
If given, these objects (e.g. nodes) are ignored in the search and not traversed
(=considered as not existing).

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

S EE ALSO

ElmTerm.GetShortestPath()

GetNextHVBus
This function returns the nearest connected busbar that has a higher voltage level. To detect
this bus, a breadth-first search on the net topology is executed. The traversal stops on each
element that is out of service and on each opened switch device. The criterion for higher voltage
level is passing a transformer to HV side. No junction nor internal nodes shall be considered.
Two winding transfomers with equal voltage on both sides are ignored (simply passed by the
search).
DataObject ElmTerm.GetNextHVBus()

R ETURNS
object First busbar found.
None If no busbar was found.

GetNodeName
For terminals inside a station, this function returns a unique name for the split the terminal is
located in. The name is built on first five characters of the station‘s short name plus the split
index separated by an underscore. E.g. “USTAT 1”.
For terminals inside a branch (ElmBranch) the returned name is just a concatenation of the
branch name and the terminal‘s name.
For all other terminals not inside a branch or a station the node name corresponds to the
terminal‘s name.
str ElmTerm.GetNodeName()

R ETURNS
Node name as described above. Never empty.

GetSepStationAreas
Function gets all separate areas within the substation linked to this terminal. In this manner,
area is any part between two nodes.

146
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

list ElmTerm.GetSepStationAreas([int considerSwitches])

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

R ETURNS
Set of all separate areas in this substation.

GetShortestPath
This function determines the shortest path between the terminal the function was called on and
the terminal that was passed as argument. The shortest path is determined on network topology
according to given criterion.
float ElmTerm.GetShortestPath(DataObject term)
[float minDistance,
list path ] ElmTerm.GetShortestPath(int criterion,
DataObject term,
int considerSwitches,
[list limitToNodes,]
[list elementsToIgnore,]
)

A RGUMENTS
criterion
0 According to line length, same as ElmTerm.GetMinDistance()
1 According to node count
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

ElmTerm.GetMinDistance()

147
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

HasCreatedCalBus
This function checks if the valid calculation exists for this terminal (i.e. load flow). If it exists,
then the calculation parameters could be retrieved.
int ElmTerm.HasCreatedCalBus()

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

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

• closed switching devices (ElmCoup, RelFuse) or

• lines of zero length (line droppers) or
• branch components whose impedance is below given thresholds (R ≤ maxR and X ≤
maxX)

int ElmTerm.IsElectrEquivalent(DataObject terminal,

float maxR,
float maxX
)

A RGUMENTS
terminal Terminal to which the 'method called terminal' is connected to.
maxR Given threshold for the resistance of branch elements (must be given in Ohm).
maxX Given threshold for the reactance of branch elements (must be given in Ohm).

R ETURNS
1 If terminal on which the method was called is electrical equivalent to terminal that
was passed as argument
0 Otherwise

S EE ALSO

ElmTerm.IsEquivalent()

IsEquivalent
Function checks if two terminals are topologically connected only by

• closed switching devices (ElmCoup, RelFuse) or

• lines of zero length (line droppers).

IsEquivalent defines a relation that is

• symmetric (Term1.IsEquivalent(Term2) -> Term2.IsEquivalent(Term1)),

148
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

• reflexive (Term1.IsEquivalent(Term1)) and

• transitive (Term1.IsEquivalent(Term2) and Term2.IsEquivalent(Term3) -> Term1.IsEquivalent(Term3));

int ElmTerm.IsEquivalent(DataObject terminal)

A RGUMENTS
terminal Terminal (object of class ElmTerm) that is checked to be equivalent to the terminal
on which the function was called on. Passing None is not allowed and will result
in a scripting error.

R ETURNS
1 If terminal on which the method was called is connected to terminal that was
passed as argument only by closed switching devices or by lines of zero length
0 Otherwise (terminals are not connected or connected by other components than
switching devices / lines of zero length)

S EE ALSO

ElmTerm.GetEquivalentTerminals() ElmTerm.IsElectrEquivalent()

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

R ETURNS
1 Terminal is a node of usage ‘internal’ and is located in a station.
0 Not internal node or not in a station, or both.

UpdateSubstationTerminals
Updates all nodes within the substation to the new voltage and/or phase technology. Applicable
for all busbars and junction nodes. The highest voltage is taken as the leading one.
None ElmTerm.UpdateSubstationTerminals(int volt,
int phs
)

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

149
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.31 ElmTr2
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetZ0pu
GetZpu
IsQuadBooster
NTap

CreateEvent
For the corresponding transformer, a Tap Event (EvtTap) is created for the simulation.
int ElmTr2.CreateEvent([int tapAction,]
[int tapPos]
)

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

R ETURNS
0 on success

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

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

resistance (out)
Real part of the grounding impedance in Ohm.
reactance (out)
Imaginary part of the grounding impedance in Ohm.

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

150
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

A RGUMENTS
inclNested (optional)
0 Only include components which are directly supplied by the transformer
(not nested components)
1 Include nested components and components that are directly supplied
by the transformer (default)

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

S EE ALSO

ElmTr3.GetSuppliedElements(), ElmSubstat.GetSuppliedElements(), ElmTrfstat.GetSuppliedElements()

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

A RGUMENTS
itappos Tap position
inclPhaseShift
1 = Includes the vector group phase shift, 0 = consider only the tap phase shift

151
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns the tap phase shift angle of the transformer for given tap position

GetTapRatio
Gets the voltage ratio of the transformer for given tap position.
float ElmTr2.GetTapRatio(int itappos,
int onlyTapSide,
int includeNomRatio
)

A RGUMENTS
itappos Tap position
onlyTapSide
1 = ratio only for given side., 0 = total ratio
includeNomRatio
1 = Includes nominal ratio of the transformer, 0 = consider only tap ratio

R ETURNS
Returns the voltage ratio of the transformer for given tap position

GetZ0pu
Gets the zero-sequence impedance in p.u. of the transformer for the specified tap position. If
the tap position is out of the tap changer range, the respective min. or max. position will be
used.
[float r0pu,
float x0pu ] ElmTr2.GetZ0pu(int itappos,
int systembase)

A RGUMENTS
itappos Tap position
r0pu (out)
Resistance in p.u.
x0pu (out)
Reactance in p.u.
systembase
0 p.u. is based on rated power.
1 p.u. is based on system base (e.g. 100MVA).

GetZpu
Gets the impedance in p.u. of the transformer for the specified tap position. If the tap position is
out of the tap changer range, the respective min. or max. position will be used.
[float rpu,
float xpu ] ElmTr2.GetZpu(int itappos,
int systembase)

152
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

R ETURNS
The tap position.

5.2.32 ElmTr3
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetTapZDependentSide
GetZ0pu
GetZpu
IsQuadBooster
NTap

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

153
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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 ] ElmTr3.GetGroundingImpedance(int busIdx)

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

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

GetSuppliedElements
Returns the network components that are supplied by the transformer.
A transformer is treated as supplying if it is located in a station. Transformers outside stations
are not supplying in this sense.
A network component is considered to be supplied by a transformer if a topological path from
the transformer to the component exists. A valid topological path in this sense is a path that
starts at the transformer's HV side in direction of transformer (not in direction of HV connected
node) and stops at

• network components that are out of calculation,

• network components that are not active (e.g. hidden or those of currently inactive grids),
• open switches,
• connections leading to a higher voltage level.

Generally all network components of such a path are considered to be supplied by the trans-
former. Exceptions are components that are out of calculation or in-active. Those components
are never considered to be supplied by any transformer.
A transformer is never considered to supply itself.
Composite components such as ElmBranch, ElmSubstat, ElmTrfstat are considered to be sup-
plied by a transformer if all energized components inside that composite are supplied by the
transformer.

154
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

list ElmTr3.GetSuppliedElements([int inclNested])

A RGUMENTS
inclNested (optional)
0 Only include components which are directly supplied by the transformer
(not nested components)
1 Include nested components and components that are directly supplied
by the transformer (default)

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

S EE ALSO

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

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

A RGUMENTS
iSide for tap at side (0=Hv, 1=Mv, 2=Lv)
itappos Tap position for corresponding side
inclPhaseShift
1 = Includes the vector group phase shift, 0 = consider only the tap phase shift

R ETURNS
Returns the tap phase shift angle of the transformer for given tap position and side

GetTapRatio
Gets the voltage ratio of the transformer for given tap position and side.
float ElmTr2.GetTapRatio(int iSide,
int itappos,
int includeNomRatio
)

A RGUMENTS
iSide for tap at side (0=Hv, 1=Mv, 2=Lv)
itappos Tap position at corresponding side

includeNomRatio
1 = Includes nominal ratio of the transformer, 0 = consider only tap ratio

155
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Returns the voltage ratio of the transformer for given tap position and side

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

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

GetZ0pu
Gets the zero-sequence impedance in p.u. of the transformer for the specified tap position. If
the tap position is out of the tap changer range, the respective min. or max. position will be
used.
[float r0pu,
float x0pu ] ElmTr3.GetZ0pu(int itappos,
int iSide,
int systembase)

A RGUMENTS
itappos Tap position of the z-dependent tap
iSide
0 Get the HV-MV impedance.
1 Get the MV-LV impedance.
2 Get the LV-HV impedance.
r0pu (out)
Resistance in p.u.
x0pu (out)
Reactance in p.u.
systembase
0 p.u. is based on rated power.
1 p.u. is based on system base (e.g. 100MVA).

GetZpu
Gets the impedance in p.u. of the transformer for the specified tap position. If the tap position is
out of the tap changer range, the respective min. or max. position will be used.
[float rpu,
float xpu ] ElmTr3.GetZpu(int itappos,
int iSide,
int systembase)

156
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

systembase
0 p.u. is based on rated power.
1 p.u. is based on system base (e.g. 100MVA).

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

R ETURNS
'1' if the transformer phase shift angle modulus 180◦ does not equal 0 at any of the sides LV,
MV, HV, else '0'

NTap
Gets the transformer tap position of a given bus.
int ElmTr3.NTap(int bus)

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

R ETURNS
The tap position.

5.2.33 ElmTr4
Overview

CreateEvent
GetGroundingImpedance
GetSuppliedElements
GetTapPhi
GetTapRatio
GetTapZDependentSide
GetZ0pu
GetZpu
IsQuadBooster
NTap 157
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

busIdx (optional)
Bus index.

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

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

resistance (out)
Real part of the grounding impedance in Ohm.
reactance (out)
Imaginary part of the grounding impedance in Ohm.

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

GetSuppliedElements
Returns the network components that are supplied by the transformer.
A transformer is treated as supplying if it is located in a station. Transformers outside stations
are not supplying in this sense.
A network component is considered to be supplied by a transformer if a topological path from
the transformer to the component exists. A valid topological path in this sense is a path that
starts at the transformer's HV side in direction of transformer (not in direction of HV connected
node) and stops at

• network components that are out of calculation,

• network components that are not active (e.g. hidden or those of currently inactive grids),
• open switches,

158
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

• connections leading to a higher voltage level.

Generally all network components of such a path are considered to be supplied by the trans-
former. Exceptions are components that are out of calculation or in-active. Those components
are never considered to be supplied by any transformer.
A transformer is never considered to supply itself.
Composite components such as ElmBranch, ElmSubstat, ElmTrfstat are considered to be sup-
plied by a transformer if all energized components inside that composite are supplied by the
transformer.
list ElmTr4.GetSuppliedElements([int inclNested])

A RGUMENTS
inclNested (optional)
0 Only include components which are directly supplied by the transformer
(not nested components)
1 Include nested components and components that are directly supplied
by the transformer (default)

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

S EE ALSO

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

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

A RGUMENTS
iSide for tap at side (0=HV, 1=LV1, 2=Lv2, 3=Lv3)
itappos Tap position for corresponding side
inclPhaseShift
1 = Includes the vector group phase shift, 0 = consider only the tap phase shift

R ETURNS
Returns the tap phase shift angle of the transformer for given tap position and side

GetTapRatio
Gets the voltage ratio of the transformer for given tap position and side.
float ElmTr4.GetTapRatio(int iSide,
int itappos,
int includeNomRatio
)

159
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
iSide for tap at side (0=HV, 1=LV1, 2=Lv2, 3=Lv3)
itappos Tap position at corresponding side
includeNomRatio
1 = Includes nominal ratio of the transformer, 0 = consider only tap ratio

R ETURNS
Returns the voltage ratio of the transformer for given tap position and side

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

R ETURNS
-1 if no tap dependent impedance is defined
0 for HV tap
1 for LV1 tap
2 for LV2 tap
2 for LV3 tap

GetZ0pu
Gets the zero-sequence impedance in p.u. of the transformer for the specified tap position. If
the tap position is out of the tap changer range, the respective min. or max. position will be
used.
[float r0pu,
float x0pu ] ElmTr4.GetZ0pu(int itappos,
int iSide,
int systembase)

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

160
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

systembase
0 p.u. is based on rated power.
1 p.u. is based on system base (e.g. 100MVA).

GetZpu
Gets the impedance in p.u. of the transformer for the specified tap position. If the tap position is
out of the tap changer range, the respective min. or max. position will be used.
[float rpu,
float xpu ] ElmTr4.GetZpu(int itappos,
int iSide,
int systembase)

A RGUMENTS
itappos Tap position of the z-dependent tap

iSide
0 Get the HV-LV1 impedance.
1 Get the HV-LV2 impedance.
2 Get the HV-LV3 impedance.
3 Get the LV1-LV2 impedance.
4 Get the LV1-LV3 impedance.
5 Get the LV2-LV3 impedance.
rpu (out) Resistance in p.u.
xpu (out) Reactance in p.u.

systembase
0 p.u. is based on rated power.
1 p.u. is based on system base (e.g. 100MVA).

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

R ETURNS
'1' if the transformer phase shift angle modulus 180◦ does not equal 0 at any of the sides HV,
LV1, LV2, LV3, else '0'

NTap
Gets the transformer tap position.
int ElmTr4.NTap(float busIdx)

161
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

R ETURNS
The tap position.

5.2.34 ElmTrain
Overview

SetPosition

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

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

5.2.35 ElmTrb
Overview

GetGroundingImpedance

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

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

resistance (out)
Real part of the grounding impedance in Ohm.
reactance (out)
Imaginary part of the grounding impedance in Ohm.

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

162
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

5.2.36 ElmTrfstat
Overview

GetSplit
GetSplitCal
GetSplitIndex
GetSuppliedElements

GetSplit
A split of a station is a group of topologically connected elements. Such a group is called split
if all contained components are energized and there is at least one busbar (terminal of usage
'busbar') contained or it has connections to at least two main components (= all components
except switch devices and terminals).
These splits are ordered according to the count of nodes contained and according to their
priority. So each split becomes a unique index.
The function GetSplit offers access to the elements contained in a split. By calling GetSplit with
an index from 0 to n, the elements belonging to the corresponding split are filled into given sets
and returned.
[int error
list mainNodes,
list connectionCubicles,
list allElements ] ElmTrfstat.GetSplit(int index)

A RGUMENTS
index Index of the split used to access the elements of the corresponding split. Value
must be ≥ 0.
mainNodes (out)
Terminals of same usage considered to form the most important nodes for that
group. In most cases, this is the group of contained busbars.

connectionCubicles (optional, out)

All cubicles (of terminals inside the station) that point to an element that sits out-
side the station or to an element that is connected to a terminal outside the station
are filled into the set connectionCubicles. (The connection element (branch) can
be accessed by calling GetBranch() on each of these cubicles. The terminals
of these cubicles (parents) must not necessarily be contained in any split. They
could also be separated by a disconnecting component.)
allElements(optional, out)
All elements (class Elm*) of the split that have no connection to elements outside
the station are filled into this set.

R ETURNS
0 success, split of that index exists and is returned.
1 indicates that there exists no split with given index. (Moreover, this means that
there is no split with index n greater than this value.)

S EE ALSO

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

163
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

GetSplitCal
This function determines the elements that belong to a split. In contrast to ElmTrfstat.GetSplit()
it is based on calculation instead of pure edit object topology. This means the returned nodes
correspond to the calculation nodes, the interconnecting cubicles are those connecting nodes
of different splits.
Note: As this function relies on calculation nodes it can only be executed after a calculation has
been performed (e.g. load flow calculation).
[int error,
list nodes,
list connectionCubicles,
list elements ] ElmTrfstat.GetSplitCal(int index)

A RGUMENTS
index Index of the split used to access the elements of the corresponding split. Refers
to same split as index in ElmTrfstat.GetSplit().
Value must be ≥ 0.
nodes (out)
A set that is filled with terminals. There is one terminal returned for each calcula-
tion node in the split.
connectionCubicles (optional, out)
This set is filled with all cubicles that point from a calculation node of current split
to another calculation node that does not belong to that split. The connecting
element can be accessed by calling GetBranch() on such a cubicle.

elements (optional, out)

This set is filled with network elements that are connected to a calculation node of
current split and have exactly one connection, i.e. these elements are completely
contained in the split.

R ETURNS
0 success, split of that index exists and is returned.
1 indicates that there exists no split with given index. (Moreover, this means that
there is no split with index n greater than this value.)

S EE ALSO

ElmTrfstat.GetSplit()

GetSplitIndex
This function returns the index of the split that contains passed object.
int ElmTrfstat.GetSplitIndex(DataObject o)

A RGUMENTS
o Object for which the split index is to be determined.

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

164
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

S EE ALSO

ElmTrfstat.GetSplit()

GetSuppliedElements
Returns the network components that are supplied by the transformer (located in the station). A
network component is considered to be supplied by a transformer if a topological path from the
transformer to the component exists. A valid topological path in this sense is a path that starts
at the transformer’s HV side in direction of transformer (not in direction of HV connected node)
and stops at

• network components that are out of calculation,

• network components that are not active (e.g. hidden or those of currently inactive grids),
• open switches,
• connections leading to a higher voltage level.

Generally, all network components of such a path are considered to be supplied by the trans-
former.
Exceptions are components that are out of calculation or in-active. Those components are never
considered to be supplied by any transformer. A transformer is never considered to supply itself.
Composite components such as ElmBranch, ElmSubstat, ElmTrfstat are considered to be sup-
plied by a transformer if all energized components inside that composite are supplied by the
transformer.
list ElmTrfstat.GetSuppliedElements([int inclNested])

A RGUMENTS
inclNested (optional)
0 Do not include components that are supplied by nested supplying sta-
tions
1 (default) Include components that are supplied by nested stations

S EE ALSO

ElmTr2.GetSuppliedElements(), ElmTr3.GetSuppliedElements()

5.2.37 ElmVac
Overview

GetGroundingImpedance

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

165
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.38 ElmVoltreg
Overview

CreateEvent
GetGroundingImpedance
GetZpu
NTap

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

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

tapPos (optional)
Position of tap

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

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

resistance (out)
Real part of the grounding impedance in Ohm.
reactance (out)
Imaginary part of the grounding impedance in Ohm.

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

GetZpu
Gets the impedance in p.u. of the voltage regulator for the specified tap position. If the tap
position is out of the tap changer range, the respective min. or max. position will be used.
[float rpu,
float xpu ] ElmVoltreg.GetZpu(int itappos,
int systembase)

A RGUMENTS
itappos Tap position
rpu (out) Resistance in p.u.
xpu (out) Reactance in p.u.
systembase
0 p.u. is based on rated power.
1 p.u. is based on system base (e.g. 100MVA).

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

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

R ETURNS
The tap position.

5.2.39 ElmXnet
Overview

CalcEfficiency
Disconnect
GetGroundingImpedance
GetStepupTransformer
Reconnect

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

167
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

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

A RGUMENTS
voltage voltage level at which the search will stop
swStatus consideration of switch status. Possible values are:
0 consider all switch status

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

Reconnect
Connects a static generator by closing all switches (breakers and isolators) up to the first breaker
on the HV side of a transformer. The topological search to find all the switches, stops at any
busbar.
int ElmXnet.Reconnect()

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

5.2.40 ElmZone
Overview

CalculateInterchangeTo
DefineBoundary
GetAll
GetBranches
GetBuses
GetObjs
SetLoadScaleAbsolute

CalculateInterchangeTo
Calculates interchange power to the given zone (calculated quantities are: Pinter, Qinter, Pex-
port, Qexport, Pimort, Qimport). Prior the calculation the valid load flow calculation is required.
int ElmZone.CalculateInterchangeTo(DataObject zone)

A RGUMENTS
zone zone to which the interchange is calculated

R ETURNS
<0 calculation error (i.e. no valid load flow, empty zone...)
0 no interchange power to the given zone
1 interchange power calculated

DefineBoundary
Defines boundary with this zone as interior part. Resulting cubicles of boundary are busbar-
oriented towards the zone.

169
5.2. NETWORK ELEMENTS CHAPTER 5. OBJECT METHODS

DataObject ElmZone.DefineBoundary(int shift)

A RGUMENTS
shift Elements outside the zone that are within a distance of shift many elements to
a boundary cubicle of the zone are added to the interior part of the resulting
boundary

R ETURNS
The defined boundary is returned in case of success. Otherwise NULL, if an error appeared
in the definition of the boundary.

GetAll
Returns all objects which belong to this zone.
list ElmZone.GetAll()

R ETURNS
The set of objects.

GetBranches
Returns all branches which belong to this zone.
list ElmZone.GetBranches()

R ETURNS
The set of branch objects.

GetBuses
Returns all buses which belong to this zone.
list ElmZone.GetBuses()

R ETURNS
The set of objects.

GetObjs
Returns all objects of the given class which belong to this zone.
list ElmZone.GetObjs(str classname)

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

170
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
The set of contained objects.

SetLoadScaleAbsolute
Readjusts zonal load scaling factor to the given active power. The zonal load scaling factor is
the ratio of the given active power and the loads total actual power.
None ElmZone.SetLoadScaleAbsolute(float Pin)

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

5.3 Station Elements

5.3.1 StaCt
Overview

SetPrimaryTap

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

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

R ETURNS
0 Correctly set.
1 Error.

5.3.2 StaCubic
Overview

GetAll
GetBranch
GetConnectedMajorNodes
GetConnections
GetNearestBusbars
GetPathToNearestBusbar
IsClosed
IsConnected

171
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

GetAll
This function returns a set of network components that are collected by a topological traversal
starting from this cubicle.
list StaCubic.GetAll([int direction = 1,]
[int ignoreOpenSwitches = 0]
)

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

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

GetBranch
Function gets the branch of this cubicle.
DataObject StaCubic.GetBranch()

R ETURNS
Branch object.

GetConnectedMajorNodes
This function returns all busbars being part of a split (inside a station) that can be reached by
starting a topology search from the cubicle in direction of the branch element.
list StaCubic.GetConnectedMajorNodes ([float swtStat])

A RGUMENTS
swtStat
0 (default) First perform a search that respects switch states (stoping at open
switches). If no switches are found, an additional search with ignoring
switch states.
1 Perform one search ignoring switch states (passing open and closed
switches).
2 Search with respecting switch states. But do no additional search when
switch is found.

172
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
A set of all busbars that can be reached starting a topology search from the cubicle in
direction of the branch element.

GetConnections
Function gets all elements connected with this cubicle.
list StaCubic.GetConnections(int swtStat)

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

R ETURNS
Set of elements.

GetNearestBusbars
Function searches for connected and connectable nearest busbars starting at the cubicle.
Search stops at the nearest busbars and out of service elements. Internal and junction nodes,
all types of branch elements and all types of switches - i.e. circuit breakers and disconnectors -
are passed.
Connected busbars are all busbars which are topologically connected to the start cubicle without
passing open switches. Connectable busbars are all busbars which are connectable to the start
cubicle by closing switches. If the start cubicles terminal is a busbar then this busbar is not
included in the result sets.
If more than one path exists between cubicle and a nearest busbar the relevant busbar is added
only once to the result set.
[list connectedBusbars,
list connectableBusbars] StaCubic.GetNearestBusbars(int searchDirection, [int excludeZPUs])

A RGUMENTS
connectedBusbars (out)
Found connected busbars.
connectableBusbars (out)
Found connectable busbars.
searchDirection
Direction of the search relative to the cubicle. Possible values are
0 search in all directions
1 search in direction of cubicles terminal
2 search towards connected branch element

excludeZPUs (optional)
Whether ZPU (ElmZpu) should be ignored in the search. Default=0.

173
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

GetPathToNearestBusbar
Function determines the path from the cubicle to the given busbar. The busbar must be
connected or connectable to the start cubicle without passing additional busbars. If the given
busbar is not a nearest busbar in relation to the cubicle an empty path is returned.
If more than one closed path exists between cubicle and busbar the elements of all these paths
are combined.
list StaCubic.GetPathToNearestBusbar(DataObject nearestBusbar, [int excludeZPUs])

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

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

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

R ETURNS
0 Disconnected cubicle.
1 Connected cubicle.

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

A RGUMENTS
elm Terminal or coupler to check connection with.

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

R ETURNS
0 Not connected.
1 Connected.

174
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.3 StaExtbrkmea
Overview

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

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

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

A RGUMENTS
value (out)
Value for switch status.

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

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

R ETURNS
Status bitfield as an integer value.

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtbrkmea.InitTmp()

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

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

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

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

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

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

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

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

A RGUMENTS
value New value for switch status.

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

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

A RGUMENTS
value New value.

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

SetStatus
Sets the status flags of the measurement object. Please note, this value is interpreted as
a bitfield where the bits have the following meaning. An option is considered enabled if the
corresponding bit is set to 1.

bit0 0x00000001 Manually entered data

177
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit1 0x00000002 Tele-Measurement

bit2 0x00000004 Disturbance

bit3 0x00000008 Protection
bit4 0x00000010 Marked suspect
bit5 0x00000020 Violated constraint

bit6 0x00000040 On Event

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

bit10 0x00000400 Control Block.

bit29 0x20000000 Read
bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None StaExtbrkmea.SetStatus(int status, int dbSync)

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtbrkmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtbrkmea.UpdateCtrl(int dbSync)

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

179
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.4 StaExtcmdmea
Overview

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

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

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

A RGUMENTS
value (out)
Value obtained by parsing stored command string as floating point value.

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

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

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtcmdmea.InitTmp()

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

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

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

181
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

A RGUMENTS
value New value.

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

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

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

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtcmdmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtcmdmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

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

CreateEvent
Creates a “parameter change” event for controller object (’pCtrl’) and attribute (’varName’). The
event is stored in simulation event list and executed immediately.
None StaExtdatmea.CreateEvent()

GetMeaValue
Returns the value stored in the measurement object.
[int error,
float value] StaExtdatmea.GetMeaValue(int unused,
int applyMultiplicator)

A RGUMENTS
value (out)
Value, optionally modified by configured multiplicator

unused Not used.

applyMultiplicator
If 1 (default), returned value will be modified by the multiplicator stored in the
measurement object (depending on Mode incremental/absolute). If 0, raw value
will be returned.

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

R ETURNS
Status bitfield as an integer value.

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtdatmea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtdat-
mea.SetStatus() for details on the status bits.

186
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

int StaExtdatmea.IsStatusBitSetTmp(int mask)

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

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

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

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

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

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

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

187
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit1 0x00000002 Tele-Measurement

bit2 0x00000004 Disturbance

bit3 0x00000008 Protection
bit4 0x00000010 Marked suspect
bit5 0x00000020 Violated constraint

bit6 0x00000040 On Event

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

bit10 0x00000400 Control Block.

bit29 0x20000000 Read
bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None StaExtdatmea.SetStatus(int status, int dbSync)

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtdatmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtdatmea.UpdateCtrl(int dbSync)

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

189
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.6 StaExtfmea
Overview

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

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

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

A RGUMENTS
value (out)
Value for frequency.

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

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

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtfmea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtfmea.SetStatus()
for details on the status bits.
int StaExtfmea.IsStatusBitSetTmp(int mask)

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

191
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

ResetStatusBitTmp
Resets specific bits in the temporary (in memory) status bitfield. See StaExtfmea.SetStatus()
for details on the status bits.
None StaExtfmea.ResetStatusBitTmp(int mask)

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

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

A RGUMENTS
value New value.

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

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

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

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtfmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtfmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

194
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.7 StaExtfuelmea
Overview

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

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

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

A RGUMENTS
value (out)
Value for fuel, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
If 1 (default), returned value will be multiplied by the multiplicator stored in the
measurement object. If 0, raw value will be returned.

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

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

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtfuelmea.InitTmp()

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

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

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

196
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

A RGUMENTS
value New value.

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

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

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

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtfuelmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtfuelmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

199
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.8 StaExtimea
Overview

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

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

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

A RGUMENTS
value (out)
Value for current, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
If 1 (default), returned value will be multiplied by the multiplicator stored in the
measurement object. If 0, raw value will be returned.

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

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtimea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaEx-
timea.SetStatus() for details on the status bits.
int StaExtimea.IsStatusBitSetTmp(int mask)

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

201
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

A RGUMENTS
value New value.

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

SetStatus
Sets the status flags of the measurement object. Please note, this value is interpreted as
a bitfield where the bits have the following meaning. An option is considered enabled if the
corresponding bit is set to 1.

bit0 0x00000001 Manually entered data

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

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

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

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtimea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtimea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

204
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.9 StaExtpfmea
Overview

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

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

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

A RGUMENTS
value (out)
Value for current, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
If 1 (default), returned value will be multiplied by the multiplicator stored in the
measurement object. If 0, raw value will be returned.

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

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

205
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

R ETURNS
Status bitfield as an integer value.

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtpfmea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtpfmea.SetStatus()
for details on the status bits.
int StaExtpfmea.IsStatusBitSetTmp(int mask)

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

206
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

A RGUMENTS
value New value.

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

SetStatus
Sets the status flags of the measurement object. Please note, this value is interpreted as
a bitfield where the bits have the following meaning. An option is considered enabled if the
corresponding bit is set to 1.

bit0 0x00000001 Manually entered data

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

207
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

bit6 0x00000040 On Event

bit7 0x00000080 Event Block.

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

bit29 0x20000000 Read

bit30 0x40000000 Write
bit31 0x80000000 Neglected by SE

None StaExtpfmea.SetStatus(int status, int dbSync)

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

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

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

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

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

208
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

SetStatusTmp
Sets the temporary (in memory) status flags of the measurement object. This temporary value
is used during calculations so that changes do not lead to object modifications and initial value
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtpfmea.SetStatus() for details on
the status bits.
None StaExtpfmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtpfmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtpfmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

209
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.10 StaExtpmea
Overview

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

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

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

A RGUMENTS
value (out)
Value for active power, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
If 1 (default), returned value will be multiplied by the multiplicator stored in the
measurement object. If 0, raw value will be returned.

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

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtpmea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtp-
mea.SetStatus() for details on the status bits.
int StaExtpmea.IsStatusBitSetTmp(int mask)

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

211
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

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

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

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

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtpmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtpmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

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

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

A RGUMENTS
value (out)
Value for reactive power, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
If 1 (default), returned value will be multiplied by the multiplicator stored in the
measurement object. If 0, raw value will be returned.

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

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtqmea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaEx-
tqmea.SetStatus() for details on the status bits.
int StaExtqmea.IsStatusBitSetTmp(int mask)

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

216
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

A RGUMENTS
value New value.

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

SetStatus
Sets the status flags of the measurement object. Please note, this value is interpreted as
a bitfield where the bits have the following meaning. An option is considered enabled if the
corresponding bit is set to 1.

bit0 0x00000001 Manually entered data

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

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

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

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtqmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtqmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

219
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.12 StaExtsmea
Overview

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

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

R ETURNS
Status bitfield as an integer value.

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.

220
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtsmea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtsmea.SetStatus()
for details on the status bits.
int StaExtsmea.IsStatusBitSetTmp(int mask)

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

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

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

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

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

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

A RGUMENTS
value New value.

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

SetStatus
Sets the status flags of the measurement object. Please note, this value is interpreted as
a bitfield where the bits have the following meaning. An option is considered enabled if the
corresponding bit is set to 1.

bit0 0x00000001 Manually entered data

bit1 0x00000002 Tele-Measurement

bit2 0x00000004 Disturbance

bit3 0x00000008 Protection
bit4 0x00000010 Marked suspect

bit5 0x00000020 Violated constraint

bit6 0x00000040 On Event
bit7 0x00000080 Event Block.
bit8 0x00000100 Alarm Block.

bit9 0x00000200 Update Block.

bit10 0x00000400 Control Block.
bit29 0x20000000 Read

bit30 0x40000000 Write

bit31 0x80000000 Neglected by SE

None StaExtsmea.SetStatus(int status, int dbSync)

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

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

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

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

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

SetStatusTmp
Sets the temporary (in memory) status flags of the measurement object. This temporary value
is used during calculations so that changes do not lead to object modifications and initial value
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExtsmea.SetStatus() for details on
the status bits.
None StaExtsmea.SetStatusTmp(int status)

A RGUMENTS
status Bitfield for status flags, see above

223
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 StaExtsmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtsmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

5.3.13 StaExttapmea
Overview

CopyExtMeaStatusToStatusTmp
GetMeaValue
GetStatus
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
SetStatus

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

GetMeaValue
Returns the value for tap position and tap info currently stored in the measurement object.
[int error,
float value] StaExttapmea.GetMeaValue(int unused,
int applyMultiplicator)

A RGUMENTS
value (out)
Value.
type type of value to return

0 tap position
1 operation mode
2 tap changer command
3 tap operation mode
4 tap operation mode command

useTranslationTable
Only supported if type=0 (tap step), if 1 (default) returned value will be translated
according to given table. If 0 is passed, the raw value will be returned.

R ETURNS
0 on success
1 on error, e.g. unsupported type
Returns 1 on erroReturn value has no meaning. It is always 0.

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

R ETURNS
Status bitfield as an integer value.

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExttapmea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExttap-
mea.SetStatus() for details on the status bits.
int StaExttapmea.IsStatusBitSetTmp(int mask)

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

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

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

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

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

A RGUMENTS
value New value.

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

SetStatus
Sets the status flags of the measurement object. Please note, this value is interpreted as
a bitfield where the bits have the following meaning. An option is considered enabled if the
corresponding bit is set to 1.

bit0 0x00000001 Manually entered data

bit1 0x00000002 Tele-Measurement
bit2 0x00000004 Disturbance

bit3 0x00000008 Protection

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

bit7 0x00000080 Event Block.

bit8 0x00000100 Alarm Block.

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

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

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

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

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

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

SetStatusTmp
Sets the temporary (in memory) status flags of the measurement object. This temporary value
is used during calculations so that changes do not lead to object modifications and initial value
remains unchanged.
Please note, this value is interpreted as a bitfield. See StaExttapmea.SetStatus() for details on
the status bits.
None StaExttapmea.SetStatusTmp(int status)

228
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExttapmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExttapmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

229
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.14 StaExtv3mea
Overview

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

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

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

A RGUMENTS
value (out)
Value for voltage, optionally multiplied by configured multiplicator
phase Index of desired phase. Index must be 0, 1 or 2.
applyMultiplicator
If 1 (default), returned value will be multiplied by the multiplicator stored in the
measurement object. If 0, raw value will be returned.

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

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

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtv3mea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtv3mea.SetStatus()
for details on the status bits.
int StaExtv3mea.IsStatusBitSetTmp(int mask)

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

231
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

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

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

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

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtv3mea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtv3mea.UpdateCtrl(int dbSync)

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

234
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.15 StaExtvmea
Overview

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

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

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

A RGUMENTS
value (out)
Value for voltage, optionally multiplied by configured multiplicator
unused Not used.
applyMultiplicator
If 1 (default), returned value will be multiplied by the multiplicator stored in the
measurement object. If 0, raw value will be returned.

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

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

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

R ETURNS
Status bitfield as an integer value.

InitTmp
Initialises the temporary (in memory) fields of the measurement object with the values currently
stored in the corresponding persistent fields. This affects temporary measurement value and
temporary status fields. The temporary measurement value is used internally for comparison of
new and old values for deadband violation. The temporary status is used during calculation in
order to not modify initial value.
This function should be called once after the link has been established and before the calculation
loop is executed.
None StaExtvmea.InitTmp()

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

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

IsStatusBitSetTmp
Checks if specific bit(s) are set in the temporary (in memory) status bitfield. See StaExtvmea.SetStatus()
for details on the status bits.
int StaExtvmea.IsStatusBitSetTmp(int mask)

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

236
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

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

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

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

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

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

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

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

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

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

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

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

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

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

A RGUMENTS
status Bitfield for status flags, see above

UpdateControl
Transfers the value of current measurement object to the controller object (target object 'pCtrl'
and target attribute 'varName'). If target object is a command, it is automatically executed
afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtvmea.UpdateControl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

UpdateCtrl
Transfers the value of current measurement object to the controlled object (target object 'pOb-
ject' and target attribute 'variabName'). If target object is a command, it is automatically exe-
cuted afterwards.
Note: Calculation results will not be reset by this value transfer.
int StaExtvmea.UpdateCtrl(int dbSync)

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

R ETURNS
0 on success
1 on error, e.g. target object does not have an attribute with given name

239
5.3. STATION ELEMENTS CHAPTER 5. OBJECT METHODS

5.3.16 StaSwitch
Overview

Close
IsClosed
IsOpen
Open

Close
Closes the switch by changing its status to ’close’. This action will fail if the status is currently
determined by an active running arrangement.
int StaSwitch.Close()

R ETURNS
0 On success
6= 0 On error

S EE ALSO

StaSwitch.Open()

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

R ETURNS
1 switch is closed
0 switch is open

S EE ALSO

StaSwitch.IsOpen()

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

R ETURNS
1 switch is open
0 switch is closed

S EE ALSO

StaSwitch.IsClosed()

240
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

Open
Opens the switch by changing its status to ’open’. This action will fail if the status is currently
determined by an active running arrangement.
int StaSwitch.Open()

R ETURNS
0 On success
6= 0 On error

S EE ALSO

StaSwitch.Close()

5.4 Commands
Overview

Execute

Execute
Executes the command.
int Com*.Execute()

5.4.1 ComAddlabel
Overview

Execute

Execute
This function executes the Add Statistic Labels command itself for a given plot and curve.
int ComAddlabel.Execute(DataObject plot, int curveIndex)

A RGUMENTS
plot The plot to modify.
curveIndex
The index of the curve inside the plot’s table. The index is zero based, therefore
the index of the first curve is 0.

R ETURNS
0 The function executed without any errors.
1 The plot is visible on a single line graphic only.
2 The parameter plot is None.
3 The parameter plot is not a valid plot object (classname should either be PltLinebarplot
or it should start with Vis).

241
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

5.4.2 ComAddon
Overview

CreateModule
DefineDouble
DefineDoubleMatrix
DefineDoublePerConnection
DefineDoubleVector
DefineDoubleVectorPerConnection
DefineInteger
DefineIntegerPerConnection
DefineIntegerVector
DefineIntegerVectorPerConnection
DefineObject
DefineObjectPerConnection
DefineObjectVector
DefineObjectVectorPerConnection
DefineString
DefineStringPerConnection
DeleteModule
FinaliseModule
GetActiveModule
ModuleExists
SetActiveModule

CreateModule
Creates the calculation module of this AddOn. Volatile object parameters are created for all
variable definitions stored inside this command. They are accessible like any other built in
object parameter.
int ComAddon.CreateModule()

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

S EE ALSO

ComAddon.FinaliseModule() ComAddon.DeleteModule()

DefineDouble
Creates a new floating-point-number parameter for the given type of objects.
int ComAddon.DefineDouble(str class,
str name,
str desc,
str unit,
float initial)

242
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
unit Parameter’s unit
initial Default value of new parameter

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.

S EE ALSO

ComAddon.DefineDoublePerConnection()

DefineDoubleMatrix
Creates a new floating-point-matrix parameter for the given type of objects.
int ComAddon.DefineDoubleMatrix(string class,
str name,
str desc,
str unit,
float initial,
int rows,
int columns)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter.
desc Parameter description.
unit Parameter’s unit.
initial Default value for all entries of new parameter.
rows Number of initial rows. Number of rows will be 0 if a value smaller than 0 is given.
columns Number of initial columns. Number of columns will be 0 if a value smaller than 0
is given.

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.

243
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

DefineDoublePerConnection
Creates a new floating-point-number parameter for every connection for the given type of ob-
jects.
int ComAddon.DefineDoublePerConnection(str class,
str name,
str desc,
str unit,
float initial)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description
unit Parameter’s unit
initial Default value of new parameter

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineDouble shall be used instead.

S EE ALSO

ComAddon.DefineDouble()

DefineDoubleVector
Creates a new floating-point-number vector parameter for the given type of objects.
int ComAddon.DefineDoubleVector(str class,
str name,
str desc,
str unit,
float initial,
int size)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description
unit Parameter’s unit
initial Default value of new parameter
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

244
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.

S EE ALSO

ComAddon.DefineDouble() ComAddon.DefineDoublePerConnection()

DefineDoubleVectorPerConnection
Creates a new floating-point-number vector parameter for the given type of objects for every
connection of the object.
int ComAddon.DefineDoubleVectorPerConnection(str class,
str name,
str desc,
str unit,
float initial,
int size)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter

desc Parameter description

unit Parameter’s unit
initial Default value of new parameter

size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineDoubleVector shall be used instead.

S EE ALSO

ComAddon.DefineDoubleVector()

DefineInteger
Creates a new integer parameter for the given type of objects.

245
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

int ComAddon.DefineInteger(str class,

str name,
str desc,
str unit,
int initial)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description
unit Parameter’s unit
initial Default value of new parameter

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.

S EE ALSO

ComAddon.DefineIntegerPerConnection()

DefineIntegerPerConnection
Creates a new integer parameter for every connection for the given type of objects.
int ComAddon.DefineIntegerPerConnection(str class,
str name,
str desc,
str unit,
int initial)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description
unit Parameter’s unit
initial Default value of new parameter

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.

246
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComAddon.DefineInteger()

DefineIntegerVector
Creates a new integer vector parameter for the given type of objects.
int ComAddon.DefineIntegerVector(str class,
str name,
str desc,
str unit,
int initial,
int size)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description
unit Parameter’s unit
initial Default value of new parameter
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.

S EE ALSO

ComAddon.DefineInteger() ComAddon.DefineIntegerPerConnection()

DefineIntegerVectorPerConnection
Creates a new integer vector parameter for the given type of objects for every connection of the
object.
int ComAddon.DefineIntegerVectorPerConnection(str class,
str name,
str desc,
str unit,
int initial,
int size)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter

247
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

desc Parameter description

unit Parameter’s unit

initial Default value of new parameter
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineIntegerVector shall be used instead.

S EE ALSO

ComAddon.DefineIntegerVector()

DefineObject
Creates a new object parameter for the given type of objects.
int ComAddon.DefineObject(str class,
str name,
str desc,
DataObject initial)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description

initial Default object of new parameter

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.

S EE ALSO

ComAddon.DefineObjectPerConnection()

248
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

DefineObjectPerConnection
Creates a new object parameter for every connection for the given type of objects.
int ComAddon.DefineObjectPerConnection(str class,
str name,
str desc,
DataObject initial)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description

initial Default value of new parameter

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineObject shall be used instead.

S EE ALSO

ComAddon.DefineObject()

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

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.

249
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.

S EE ALSO

ComAddon.DefineObject() ComAddon.DefineObjectPerConnection()

DefineObjectVectorPerConnection
Creates a new object vector parameter for the given type of objects for every connection of the
object.
int ComAddon.DefineObjectVectorPerConnection(str class,
str name,
str desc,
DataObject initial,
int size)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter.
desc Parameter description.
initial Default value of new parameter.
size Initial size of vector. Size will be 0 if a value smaller than 0 is given.

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.
• The elements of class are not branch elements. Therefore there is no con-
nection count. DefineObjectVector shall be used instead.

S EE ALSO

ComAddon.DefineObjectVector()

DefineString
Creates a new text parameter for the given type of objects.
int ComAddon.DefineString(str class,
str name,
str desc,
str unit,
str initial)

250
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

unit Parameter’s unit

initial Default value of new parameter

R ETURNS
0 Ok, Parameter was created.
Other than 0 An error occurred, possible reasons:
• The module of this add on does not exist.
• An object with the given class does not exist in PowerFactory.
• The parameter name for the given class already exists in the module.

S EE ALSO

ComAddon.DefineStringPerConnection()

DefineStringPerConnection
Creates a new text parameter for every connection for the given type of objects.
int ComAddon.DefineStringPerConnection(str class,
str name,
str desc,
str unit,
str initial)

A RGUMENTS
class The type of objects for which the new parameter is to be created, e.g. ElmLne for
the line.
name Name of the new parameter
desc Parameter description

unit Parameter’s unit

initial Default value of new parameter

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.

251
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComAddon.DefineString()

DeleteModule
Deletes the module of this add on.
int ComAddon.DeleteModule()

0 Success. The module is deleted completely.

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

S EE ALSO

ComAddon.CreateModule()

FinaliseModule
Finalises a user defined module which was created using the mthod CreateModule. All user
defined variables defined for this module are read-only after the call of finalise module. The
module is the one being used in the flexible data, single line graphic text boxes and colouring.
It can be reset like any other built-in calculation using the reset button.
int ComAddon.FinaliseModule()

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

S EE ALSO

ComAddon.CreateModule()

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

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

S EE ALSO

ComAddon.SetActiveModule()

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

252
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

S EE ALSO

ComAddon.CreateModule() ComAddon.FinaliseModule() ComAddon.DeleteModule()

SetActiveModule
Set this module as active module. This method is required only if several modules are created
concurrently. In case that only one module is being used, there is no need to use this method,
because CreateModule sets the created module automatically as active module.
int ComAddon.SetActiveModule()

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

S EE ALSO

ComAddon.CreateModule() ComAddon.FinaliseModule() ComAddon.DeleteModule()

5.4.3 ComAmpacity
Overview

ExecuteAmpacityCalc

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

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

5.4.4 ComAuditlog
Overview

Check

Check
Checks integrity of Audit Log.
int ComAuditlog.Check()

253
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
number of errors

5.4.5 ComBoundary
Overview

GetCreatedBoundaries

GetCreatedBoundaries
Gets created boundaries after the command has been executed.
list ComBoundary.GetCreatedBoundaries()

R ETURNS
Container of created boundaries.

5.4.6 ComCapo
Overview

ConnectShuntToBus
LossCostAtBusTech
TotalLossCost

ConnectShuntToBus
Connects the equivalent shunt in the specified terminal and executes the load flow command.
The shunt is not physically added in the database, just the susceptance is added for the
calculation.
int ComCapo.ConnectShuntToBus(DataObject terminal,
float phtech,
float Q
)

A RGUMENTS
terminal The terminal to which the shunt will be connected
phtech Phase technology. Possible values are
0 three-phase
1 ph-ph a-b
2 ph-ph b-c
3 ph-ph a-c
4 ph-e a
5 ph-e b
6 ph-e c
Note: In balanced load flow, the technology will always be three-phase.
Q Reactive power value in Mvar

254
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 An error occurred during load flow execution.

LossCostAtBusTech
Returns the losses cost of the selected terminal and configuration calculated during the sensi-
tivity analysis or the optimization.
float ComCapo.LossCostAtBusTech(DataObject terminal,
float phtech
)

A RGUMENTS
terminal Specified bus
phtech Phase technology. Possible values are
0 three-phase
1 ph-ph a-b
2 ph-ph b-c
3 ph-ph a-c
4 ph-e a
5 ph-e b
6 ph-e c

R ETURNS
Returns the losses cost

TotalLossCost
Returns the total cost calculated after the sensitivity analysis or the optimization.
float ComCapo.TotalLossCost([int iopt])

A RGUMENTS
iopt (optional)
Type of cost. Possible values are
0 Losses in MW (default)
1 Cost of losses
2 Cost of voltage violations
3 Cost of shunts

R ETURNS
Returns losses in MW or cost value.

255
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.7 ComCimdbexp
Overview

Execute

Execute
Executes the export. In case of a validation error the export is not performed.
int ComCimdbexp.Execute([int validate])

A RGUMENTS
validate (optional)
Option to execute CIM Data Validation before export. If not provided, the validation
is executed. Possible values are
0 Do not validate
1 Validate

R ETURNS
0 OK
1 Error: export failed

5.4.8 ComCimdbimp
Overview

Execute
ImportAndConvert

Execute
Executes the import.
int ComCimdbimp.Execute([int validate])

A RGUMENTS
validate (optional)
Option to execute CIM Data Validation after import. If not provided, the validation
is executed. Possible values are
0 Do not validate
1 Validate

R ETURNS
0 OK
1 Error: import failed

256
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

ImportAndConvert
Imports CIM data from file path provided in the ’CIM Data Import’ command without storing
CIM data into database, and converts CIM to Grid using the ’CIM to Grid Conversion’ command
object provided in the function call as template. The CIM to Grid Conversion will be executed
with default settings if the command object is not provided in the function call.
int ComCimdbimp.ImportAndConvert([int validate],
[DataObject cimToGrid])

A RGUMENTS
validate (optional)
Option to execute CIM Data Validation after import. If not provided, the validation
is executed. Possible values are
0 Do not validate
1 Validate

cimToGrid (optional)
ComCimtogrid object with preconfigured settings for converting imported CIM
data. If not provided, the default CIM to Grid Conversion settings will be used.

R ETURNS
0 OK
1 Error: import failed
2 Error: conversion failed

5.4.9 ComCimvalidate
Overview

Execute
GetClassType
GetDescriptionText
GetInputObject
GetModel
GetModelId
GetNumberOfValidationMessages
GetObject
GetObjectId
GetProfile
GetSeverity
GetType

Execute
Executes the validation. Creates no validation report if no errors, or warnings were found.
int ComCimvalidate.Execute([int openReport])

A RGUMENTS
openReport (optional)
Option to open report after validation. If not provided, the report is opened.
Possible values are

257
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

0 Do not open report

1 Open report

R ETURNS
0 OK
1 Error: validation failed

GetClassType
Returns the object class type from the selected validation message.
str ComCimvalidate.GetClassType(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Object class type.

GetDescriptionText
Returns the description from the selected validation message.
str ComCimvalidate.GetDescriptionText(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Message description.

GetInputObject
Returns the object selected for validation.
DataObject ComCimvalidate.GetInputObject()

R ETURNS
Pointer to CimArchive, CimModel, or SetSelect.

GetModel
Returns the CimModel object from the selected validation message.
DataObject ComCimvalidate.GetModel(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

258
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
Pointer to CimModel.

GetModelId
Returns the model ID from the selected validation message.
str ComCimvalidate.GetModelId(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Model ID.

GetNumberOfValidationMessages
Returns the number of validation messages generated.
int ComCimvalidate.GetNumberOfValidationMessages()

R ETURNS
Number of validation messages.

GetObject
Returns the CimObject object from the selected validation message.
DataObject ComCimvalidate.GetObject(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Pointer to CimObject.

GetObjectId
Returns the object ID from the selected validation message.
str ComCimvalidate.GetObjectId(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

259
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
Object ID.

GetProfile
Returns the model profile from the selected validation message.
str ComCimvalidate.GetProfile(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Model profile.

GetSeverity
Returns the severity of the selected validation message.
str ComCimvalidate.GetSeverity(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Message severity.

GetType
Returns the type of the selected validation message.
str ComCimvalidate.GetType(int messageIndex)

A RGUMENTS
messageIndex
Index of the validation message.

R ETURNS
Message type.

5.4.10 ComConreq
Overview

Execute

260
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

Execute
Performs a Connection Request Assessment according to the selected method. Results are
provided for connection request elements in the single line graphic, and are summarised in a
report in the output window.
int ComConreq.Execute()

R ETURNS
0 OK
1 Error: calculation function
2 Error: settings/initialisation/load flow

5.4.11 ComContingency
Overview

ContinueTrace
CreateRecoveryInformation
GetGeneratorEvent
GetInterruptedPowerAndCustomersForStage
GetInterruptedPowerAndCustomersForTimeStep
GetLoadEvent
GetNumberOfGeneratorEventsForTimeStep
GetNumberOfLoadEventsForTimeStep
GetNumberOfSwitchEventsForTimeStep
GetNumberOfTimeSteps
GetObj
GetSwitchEvent
GetTimeOfStepInSeconds
GetTotalInterruptedPower
JumpToLastStep
RemoveEvents
StartTrace
StopTrace

ContinueTrace
Continues trace execution for this contingency.
int ComContingency.ContinueTrace()

R ETURNS
0 On success.
1 On error.

CreateRecoveryInformation
Creates recovery information for a contingency. The recovery information can later be retrieved
e.g. via ComContingency.GetInterruptedPowerAndCustomersForStage().
Can only save one contingency at the same time.
int ComContingency.CreateRecoveryInformation(DataObject resultFileInput)

261
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
resultFileInput
Read from this result file.

R ETURNS
0 On success.
1 On error.

GetGeneratorEvent
Gets generator event of a certain time step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ DataObject generator,
float changedP,
float changedQ ) ]
ComContingency.GetGeneratorEvent(int currentTimeStep,
int loadEvent)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()

switchEvent
Input: Number of generator events for a certain time step are get via ComContin-
gency.GetNumberOfSwitchEventsForTimeStep()
generator (out)
Output: Generator that dispatched
changedP (out)
Output: Changed active power
changedQ (out)
Output: Changed reactive power

GetInterruptedPowerAndCustomersForStage
Gets recovery information of a contingency.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ int error,
float interruptedPower,
float newInterruptedPower,
float interruptedCustomers,
float newInterruptedCustomers ]
ComContingency.GetInterruptedPowerAndCustomersForStage(float timeOfStageInMinutes)

A RGUMENTS
timeOfStageInMinutes
Input: Get Information for this time.
interruptedPower (out)
Output: Interrupted Power at this time.

262
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ float interruptedPower,
float newInterruptedPower,
float interruptedCustomers,
float newInterruptedCustomers ]
ComContingency.GetInterruptedPowerAndCustomersForTimeStep(int currentTimeStep)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()

interruptedPower (out)
Output: Interrupted Power at this time.
newInterruptedPower (out)
Output: New interrupted Power at this time.
interruptedCustomers (out)
Output: Interrupted Customers at this time.
newInterruptedCustomers (out)
Output: New interrupted Customers at this time.

GetLoadEvent
Gets load event of a certain time step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ DataObject load,
float changedP,
float changedQ,
int isTransfer ) ]
ComContingency.GetLoadEvent(int currentTimeStep,
int loadEvent)

263
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()

switchEvent
Input: Number of load events for a certain time step are get via ComContin-
gency.GetNumberOfSwitchEventsForTimeStep()
load (out) Output: Load that is shed or transfered
changedP (out)
Output: Changed active power

changedQ (out)
Output: Changed reactive power
isTransfer (out)
Output: = 0 : is load shedding event. >0 is load transfer event.

GetNumberOfGeneratorEventsForTimeStep
Returns the number of generator events of a certain step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetNumberOfGeneratorEventsForTimeStep([int currentTimeStep])

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()

GetNumberOfLoadEventsForTimeStep
Returns the number of load events of a certain step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetNumberOfLoadEventsForTimeStep([int currentTimeStep])

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()

GetNumberOfSwitchEventsForTimeStep
Returns the number of switch events of a certain step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetNumberOfSwitchEventsForTimeStep([int currentTimeStep])

264
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()

GetNumberOfTimeSteps
Returns the number of time steps during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetNumberOfTimeSteps()

GetObj
Gets interrupted element by index (zero based).
DataObject ComContingency.GetObj(int index)

A RGUMENTS
index Element order index, 0 for the first object.

R ETURNS
object Interupted element for given index.
None Index out of range.

GetSwitchEvent
Gets switch event of a certain time step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
[ DataObject switchToBeActuated,
int isClosed,
int sectionalizingStep ) ]
ComContingency.GetSwitchEvent(int currentTimeStep,
int switchEvent)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()

switchEvent
Input: Number of switch event for a certain time step are get via ComContin-
gency.GetNumberOfSwitchEventsForTimeStep()
switchToBeActuated (out)
Output: Switch to be actuated
isClosed (out)
Output: > 0 if switch is closed
sectionalizingStep (out)
Output: sectionalizing step when this switch is actuated

265
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetTimeOfStepInSeconds
Returns the time of the current step during recovery.
ComContingency.CreateRecoveryInformation() has to be called beforehand to collect the data.
int ComContingency.GetTimeOfStepInSeconds(int currentTimeStep)

A RGUMENTS
currentTimeStep
Input: Number of time steps are get via ComContingency.GetNumberOfTimeSteps()

GetTotalInterruptedPower
Gets the total interrupted power (in kW) during restoration. ComContingency.CreateRecoveryInformation()
has to be called beforehand to collect the data.
float ComContingency.GetTotalInterruptedPower()

JumpToLastStep
Gets the last trace execution for this contingency.
int ComContingency.JumpToLastStep([int timeDelay])

A RGUMENTS
timeDelay (optional)
time delay in seconds between trace steps

R ETURNS
0 On success.
1 On error.

RemoveEvents
Removes events from this contingency.
None ComContingency.RemoveEvents([float emitMessage])
None ComContingency.RemoveEvents(str whichEvents)
None ComContingency.RemoveEvents(float emitMessage,
str whichEvents
)
None ComContingency.RemoveEvents(str whichEvents,
float emitMessage
)

A RGUMENTS
emitMessage(optional)
0: no info message shall be issued after event removal
whichEvents(optional)
’lod’ removed load events, ’gen’ removes generator events, ’switch’ removes switch-
ing events

266
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

StartTrace
Starts trace execution for this contingency.
int ComContingency.StartTrace()

R ETURNS
0 On success.
1 Error, e.g. Contingency is not in trace.
2 On error.

StopTrace
Stops trace execution for this contingency.
int ComContingency.StopTrace([int emitMessage])

A RGUMENTS
emitMessage (optional)
= 0: no trace-stop info messages shall be issued

R ETURNS
0 On Success.
1 Contingency is not in Trace.

5.4.12 ComCoordreport
Overview

DevicesToReport
HasResultsForDirectionalBackup
HasResultsForFuse
HasResultsForInstantaneous
HasResultsForNonDirectionalBackup
HasResultsForOverload
HasResultsForOverreach
HasResultsForShortCircuit
HasResultsForZone
MaxZoneNumberFor
ResultForDirectionalBackupVariable
ResultForFuseVariable
ResultForInstantaneousVariable
ResultForMaxCurrent
ResultForNonDirectionalBackupVariable
ResultForOverloadVariable
ResultForOverreachVariable
ResultForShortCircuitVariable
ResultForZoneVariable
TopologyForDirectionalBackupVariable
TopologyForFuseVariable
TopologyForInstantaneousVariable
TopologyForMaxCurrent
TopologyForNonDirectionalBackupVariable

267
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

TopologyForOverloadVariable
TopologyForOverreachVariable
TopologyForShortCircuitVariable
TopologyForZoneVariable
TransferDirectionalBackupResultsTo
TransferNonDirectionalBackupResultsTo
TransferOverreachResultsTo
TransferResultsTo
TransferZoneResultsTo

DevicesToReport
Returns the devices with stored results, i.e. which can be reported.
list ComCoordreport.DevicesToReport()

R ETURNS
Container with reportable devices.

HasResultsForDirectionalBackup
Checks whether there is a stored directional backup result for the given device.
int ComCoordreport.HasResultsForDirectionalBackup(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 A directional backup result is stored for this device.
0 The device has no stored results or no result for the directional backup.

S EE ALSO

ComCoordreport.HasResultsForZone(),
ComCoordreport.HasResultsForOverreach(),
ComCoordreport.HasResultsForNonDirectionalBackup()

HasResultsForFuse
Checks whether there is a stored fuse result for the given device.
int ComCoordreport.HasResultsForFuse(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An fuse result is stored for this device.
0 The device has no stored results or no fuse result.

268
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

HasResultsForInstantaneous
Checks whether there is a stored instantaneous stage result for the given device.
int ComCoordreport.HasResultsForInstantaneous(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An instantaneous stage result is stored for this device.
0 The device has no stored results or no result for the instantaneous stage.

S EE ALSO

ComCoordreport.HasResultsForOverload(),
ComCoordreport.HasResultsForShortCircuit()

HasResultsForNonDirectionalBackup
Checks whether there is a stored non-directional backup result for the given device.
int ComCoordreport.HasResultsForNonDirectionalBackup(object device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 A non-directional backup result is stored for this device.
0 The device has no stored results or no result for the non-directional backup.

S EE ALSO

ComCoordreport.HasResultsForZone(),
ComCoordreport.HasResultsForOverreach(),
ComCoordreport.HasResultsForDirectionalBackup()

HasResultsForOverload
Checks whether there is a stored overload stage result for the given device.
int ComCoordreport.HasResultsForOverload(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An overload stage result is stored for this device.
0 The device has no stored results or no result for the overload stage.

S EE ALSO

ComCoordreport.HasResultsForShortCircuit(),
ComCoordreport.HasResultsForInstantaneous()

269
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

HasResultsForOverreach
Checks whether there is a stored overreach zone result for the given device.
int ComCoordreport.HasResultsForOverreach(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An overreach zone result is stored for this device.
0 The device has no stored results or no result for the overreach zone.

S EE ALSO

ComCoordreport.HasResultsForZone(),
ComCoordreport.HasResultsForDirectionalBackup(),
ComCoordreport.HasResultsForNonDirectionalBackup()

HasResultsForShortCircuit
Checks whether there is a stored short-circuit stage result for the given device.
int ComCoordreport.HasResultsForShortCircuit(DataObject device)

A RGUMENTS
device Device for which to check.

R ETURNS
1 An short-circuit stage result is stored for this device.
0 The device has no stored results or no result for the short-circuit stage.

S EE ALSO

ComCoordreport.HasResultsForOverload(),
ComCoordreport.HasResultsForInstantaneous()

HasResultsForZone
Checks whether there is a stored result for the given device and zone number.
int ComCoordreport.HasResultsForZone(DataObject device,
int zoneNumber)

A RGUMENTS
device Device for which to check.
zoneNumber
Zone number to check (1-4).

R ETURNS
1 A result is stored for this device and zone number.
0 The device has no stored results or no result for this zone number.

270
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.HasResultsForOverreach(),
ComCoordreport.HasResultsForDirectionalBackup(),
ComCoordreport.HasResultsForNonDirectionalBackup()

MaxZoneNumberFor
Returns the highest zone number in the stored results for the given device.
int ComCoordreport.MaxZoneNumberFor(DataObject device)

A RGUMENTS
device Device for which to retrieve the zone number.

R ETURNS
Highest zone number in the stored results.

ResultForDirectionalBackupVariable
Provides access to the directional backup result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForDirectionalBackupVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.

variable Variable for which to retrieve the result:

dir Tripping direction
Tp Polygonal delay
Tc Circular delay

result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
2 The corresponding topological search failed.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.

S EE ALSO

ComCoordreport.ResultForZoneVariable(),
ComCoordreport.ResultForOverreachVariable(),
ComCoordreport.ResultForNonDirectionalBackupVariable()

271
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

ResultForFuseVariable
Provides access to the fuse result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForFuseVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.
variable Variable for which to retrieve the result:
char Overcurrent characteristic
dir Tripping direction
Iset Overcurrent setpoint
result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
5 The calculated value exceeded the calculated maximum current.

S EE ALSO

ComCoordreport.ResultForMaxCurrent()

ResultForInstantaneousVariable
Provides access to the instantaneous result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForInstantaneousVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.

variable Variable for which to retrieve the result:

char Overcurrent characteristic
dir Tripping direction
Iset Overcurrent setpoint
Tset Overcurrent delay
result (out)
Value of the stored result.

272
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
5 The calculated value exceeded the calculated maximum current.

S EE ALSO

ComCoordreport.ResultForOverloadVariable(),
ComCoordreport.ResultForShortCircuitVariable(),
ComCoordreport.ResultForMaxCurrent()

ResultForMaxCurrent
Provides access to the maximum current result for a given device.
[ int error,
float result ] ComCoordreport.ResultForInstantaneousVariable(DataObject device)

A RGUMENTS
device Device for which to retrieve the result.
result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
6 The orientation of the device is ambuous.

S EE ALSO

ComCoordreport.ResultForOverloadVariable(),
ComCoordreport.ResultForShortCircuitVariable(),
ComCoordreport.ResultForInstantaneousVariable()

ResultForNonDirectionalBackupVariable
Provides access to the non-directional backup result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForNonDirectionalBackupVariable(DataObject device,
str variable)

273
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:
dir Tripping direction
Tp Polygonal delay
Tc Circular delay
result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
2 The corresponding topological search failed.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.

S EE ALSO

ComCoordreport.ResultForZoneVariable(),
ComCoordreport.ResultForOverreachVariable(),
ComCoordreport.ResultForDirectionalBackupVariable()

ResultForOverloadVariable
Provides access to the overload result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForOverloadVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.
variable Variable for which to retrieve the result:
char Overcurrent characteristic
dir Tripping direction
Iset Overcurrent setpoint
Tset Overcurrent delay
result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.
5 The calculated value exceeded the calculated maximum current.

274
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.ResultForShortCircuitVariable(),
ComCoordreport.ResultForInstantaneousVariable(),
ComCoordreport.ResultForMaxCurrent()

ResultForOverreachVariable
Provides access to the overreach result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForOverreachVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the result.
variable Variable for which to retrieve the result:
X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
dir Tripping direction
Tp Polygonal delay
Tc Circular delay
result (out)
Value of the stored result.

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
2 The corresponding topological search failed.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.

S EE ALSO

ComCoordreport.ResultForZoneVariable(),
ComCoordreport.ResultForDirectionalBackupVariable(),
ComCoordreport.ResultForNonDirectionalBackupVariable()

ResultForShortCircuitVariable
Provides access to the short-circuit result for a given device and variable.
[ int error,
float result ] ComCoordreport.ResultForShortCircuitVariable(DataObject device,
str variable)

275
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

ComCoordreport.ResultForOverloadVariable(),
ComCoordreport.ResultForInstantaneousVariable(),
ComCoordreport.ResultForMaxCurrent()

ResultForZoneVariable
Provides access to the result for a given device, zone number and variable.
[ int error,
float result ] ComCoordreport.ResultForZoneVariable(DataObject device,
int zoneNumber,
str variable)

A RGUMENTS
device Device for which to retrieve the result.
zoneNumber
Zone number for which to retrieve the result (1-4).
variable Variable for which to retrieve the result:
X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
dir Tripping direction
Tp Polygonal delay
Tc Circular delay
result (out)
Value of the stored result.

276
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 The result is valid.
1 The result was not calculated or not found.
2 The corresponding topological search failed.
3 The corresponding topological search ended prematurely (e.g. end of network
reached).
4 The correponding equation required a nominal current and none could be deter-
mined.

S EE ALSO

ComCoordreport.ResultForOverreachVariable(),
ComCoordreport.ResultForDirectionalBackupVariable(),
ComCoordreport.ResultForNonDirectionalBackupVariable()

TopologyForDirectionalBackupVariable
Returns the associated directional backup topology for a given device and variable.
list ComCoordreport.TopologyForDirectionalBackupVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Tp Polygonal delay
Tc Circular delay

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForZoneVariable(),
ComCoordreport.TopologyForOverreachVariable(),
ComCoordreport.TopologyForNonDirectionalBackupVariable()

TopologyForFuseVariable
Returns the associated fuse topology for a given device and variable.
list ComCoordreport.TopologyForFuseVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Iset Overcurrent setpoint

R ETURNS
Elements traversed by the topological search determining this variables result.

277
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComCoordreport.TopologyForMaxCurrent()

TopologyForInstantaneousVariable
Returns the associated instantaneous stage topology for a given device and variable.
list ComCoordreport.TopologyForInstantaneousVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.

variable Variable for which to retrieve the topology:

Iset Overcurrent setpoint
Tset Overcurrent delay

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForOverloadVariable(),
ComCoordreport.TopologyForShortCircuitVariable(),
ComCoordreport.TopologyForMaxCurrent()

TopologyForMaxCurrent
Returns the associated maximum current topology for a given device.
list ComCoordreport.TopologyForMaxCurrent(DataObject device)

A RGUMENTS
device Device for which to retrieve the topology.

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForOverloadVariable(),
ComCoordreport.TopologyForShortCircuitVariable(),
ComCoordreport.TopologyForInstantaneousVariable()

TopologyForNonDirectionalBackupVariable
Returns the associated non-directional backup topology for a given device and variable.
list ComCoordreport.TopologyForNonDirectionalBackupVariable(DataObject device,
str variable)

278
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Tp Polygonal delay
Tc Circular delay

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForZoneVariable(),
ComCoordreport.TopologyForOverreachVariable(),
ComCoordreport.TopologyForDirectionalBackupVariable()

TopologyForOverloadVariable
Returns the associated overload stage topology for a given device and variable.
list ComCoordreport.TopologyForOverloadVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Iset Overcurrent setpoint
Tset Overcurrent delay

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForShortCircuitVariable(),
ComCoordreport.TopologyForInstantaneousVariable(),
ComCoordreport.TopologyForMaxCurrent()

TopologyForOverreachVariable
Returns the associated overreach zone topology for a given device and variable.
list ComCoordreport.TopologyForOverreachVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:

X Polygonal reactance
R Polygonal phase-phase resistance

279
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

ComCoordreport.TopologyForZoneVariable(),
ComCoordreport.TopologyForDirectionalBackupVariable(),
ComCoordreport.TopologyForNonDirectionalBackupVariable()

TopologyForShortCircuitVariable
Returns the associated short-circuit stage topology for a given device and variable.
list ComCoordreport.TopologyForShortCircuitVariable(DataObject device,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
variable Variable for which to retrieve the topology:
Iset Overcurrent setpoint
Tset Overcurrent delay

R ETURNS
Elements traversed by the topological search determining this variables result.

S EE ALSO

ComCoordreport.TopologyForOverloadVariable(),
ComCoordreport.TopologyForInstantaneousVariable(),
ComCoordreport.TopologyForMaxCurrent()

TopologyForZoneVariable
Returns the associated topology for a given device, zone number and variable.
list ComCoordreport.TopologyForZoneVariable(DataObject device,
int zoneNumber,
str variable)

A RGUMENTS
device Device for which to retrieve the topology.
zoneNumber
Zone number for which to retrieve the topology (1-4).
variable Variable for which to retrieve the topology:

280
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

ComCoordreport.TopologyForOverreachVariable(),
ComCoordreport.TopologyForDirectionalBackupVariable(),
ComCoordreport.TopologyForNonDirectionalBackupVariable()

TransferDirectionalBackupResultsTo
Transfers the results of the directional backup for the given variables to the device.
int ComCoordreport.TransferDirectionalBackupResultsTo(DataObject device,
str variables)

A RGUMENTS
device Device to transfer the results to.
variable Variables to transfer as semi-colon separated string:

dir Tripping direction

Tp Polygonal delay
Tc Circular delay

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

S EE ALSO

ComCoordreport.TransferZoneResultsTo(),
ComCoordreport.TransferOverreachResultsTo(),
ComCoordreport.TransferNonDirectionalBackupResultsTo()

TransferNonDirectionalBackupResultsTo
Transfers the results of the non-directional backup for the given variables to the device.
int ComCoordreport.TransferNonDirectionalBackupResultsTo(DataObject device,
str variables)

281
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
device Device to transfer the results to.
variable Variables to transfer as semi-colon separated string:
dir Tripping direction
Tp Polygonal delay
Tc Circular delay

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

S EE ALSO

ComCoordreport.TransferZoneResultsTo(),
ComCoordreport.TransferOverreachResultsTo(),
ComCoordreport.TransferDirectionalBackupResultsTo()

TransferOverreachResultsTo
Transfers the results of the overreach zone for the given variables to the device.
int ComCoordreport.TransferOverreachResultsTo(DataObject device,
str variables)

A RGUMENTS
device Device to transfer the results to.

variable Variables to transfer as semi-colon separated string:

X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
dir Tripping direction
Tp Polygonal delay
Tc Circular delay

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

S EE ALSO

ComCoordreport.TransferZoneResultsTo(),
ComCoordreport.TransferDirectionalBackupResultsTo(),
ComCoordreport.TransferNonDirectionalBackupResultsTo()

282
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

TransferResultsTo
Transfers the results for the given variables to one or more devices.
int ComCoordreport.TransferResultsTo(DataObject device,
str variables)

int ComCoordreport.TransferResultsTo(list devices,

str variables)

A RGUMENTS
devices Devices to transfer the results to.
variable Variables to transfer as semi-colon separated string:
X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
dir Tripping direction
Tp Polygonal delay
Tc Circular delay
char Overcurrent characteristic
Iset Overcurrent setpoint
Tset Overcurrent delay

R ETURNS
0 At least one transfer did non succeed.
1 Result transfer successful.

TransferZoneResultsTo
Transfers the results of a particular zone for the given variables to the device.
int ComCoordreport.TransferZoneResultsTo(DataObject device,
int zoneNumber,
str variables)

A RGUMENTS
device Device to transfer the results to.
zoneNumber
Zone number for which to to transfer the results (1-4).
variable Variables to transfer as semi-colon separated string:
X Polygonal reactance
R Polygonal phase-phase resistance
RE Polygonal phase-earth resistance
Z Circular impedance
phi Circular angle
dir Tripping direction
Tp Polygonal delay
Tc Circular delay

283
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Transfer did non succeed.
1 Result transfer successful.

S EE ALSO

ComCoordreport.TransferOverreachResultsTo(),
ComCoordreport.TransferDirectionalBackupResultsTo(),
ComCoordreport.TransferNonDirectionalBackupResultsTo()

5.4.13 ComDllmanager
Overview

Report

Report
Prints a status report of currently available external user-defined dlls (e.g. dpl, exdyn) to the
output window. (Same as pressing the ’Report’ button in the dialog.)
None ComDllmanager.Report()

5.4.14 ComDpl
Overview

CheckSyntax
Encrypt
Execute
GetExternalObject
GetInputParameterDouble
GetInputParameterInt
GetInputParameterString
IsEncrypted
ResetThirdPartyModule
SetExternalObject
SetInputParameterDouble
SetInputParameterInt
SetInputParameterString
SetThirdPartyModule

CheckSyntax
Checks the syntax and input parameter of the DPL script and all its subscripts.
int ComDpl.CheckSyntax()

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.Execute()

284
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

Encrypt
Encrypts a script and all its subscripts. An encrypted script can be executed without password
but decrypted only with password. If no password is given a ’Choose Password’ dialog appears.
int ComDpl.Encrypt([str password = ""],
[int removeObjectHistory = 1],
[int masterCode = 0])

A RGUMENTS
password (optional)
Password for decryption. If no password is given a ’Choose Password’ dialog
appears.

removeObjectHistory (optional)
Handling of unencrypted object history in database, e.g. used by project versions
or by undo:
0 Do not remove.
1 Do remove (default).
2 Show dialog and ask.
masterCode (optional)
Used for re-selling scripts. 3rd party licence codes already set in the script will be
overwritten by this value (default = 0).

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.IsEncrypted()

Execute
Executes the DPL script as subscript.
int ComDpl.Execute([input parameter])

A RGUMENTS
input parameter (optional)
All input parameter from the ’Basic Options’ page of the ’Edit’ dialog can be given
as arguments. If a parameter is not given then the value from the dialog is used.
The values from the dialog itself are not modified. These can be modified via
• ComDpl.SetInputParameterInt()
• ComDpl.SetInputParameterDouble()
• ComDpl.SetInputParameterString().
The arguments are not given by reference. Thus when a subscript changes the
value of a variable then the value from the main script is not changed.

285
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
For scripts without the use of Application.exit() the following values are returned:

0 On a successful execution.
1 An error occurred.
6 User hit the break button.

S EE ALSO

ComDpl.CheckSyntax()

GetExternalObject
Gets the external object defined in the ComDpl edit dialog.
[int error,
DataObject value] ComDpl.GetExternalObject(str name)

A RGUMENTS
name Name of the external object parameter.

value (out)
The external object.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.SetExternalObject(), ComDpl.GetInputParameterInt(), ComDpl.GetInputParameterDouble(),

ComDpl.GetInputParameterString()

GetInputParameterDouble
Gets the double input parameter value defined in the ComDpl edit dialog.
[int error,
float value] ComDpl.GetInputParameterDouble(str name)

A RGUMENTS
name Name of the double input parameter.

value (out)
Value of the double input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.SetInputParameterDouble(), ComDpl.GetInputParameterInt(), ComDpl.GetInputParameterString(),

ComDpl.GetExternalObject()

286
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetInputParameterInt
Gets the integer input parameter value defined in the ComDpl edit dialog.
[int error,
int value ] ComDpl.GetInputParameterInt(str name)

A RGUMENTS
name Name of the integer input parameter.
value (out)
Value of the integer input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.SetInputParameterInt(), ComDpl.GetInputParameterDouble(), ComDpl.GetInputParameterString(),

ComDpl.GetExternalObject()

GetInputParameterString
Gets the string input parameter value defined in the ComDpl edit dialog.
[int error,
str value ] ComDpl.GetInputParameterString(str name)

A RGUMENTS
name Name of the string input parameter.
value (out)
Value of the string input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.SetInputParameterString(), ComDpl.GetInputParameterInt(), ComDpl.GetInputParameterDouble(),

ComDpl.GetExternalObject()

IsEncrypted
Returns the encryption state of the script.
int ComDpl.IsEncrypted()

R ETURNS
1 Script is encrypted.
0 Script is not encrypted.

287
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComDpl.Encrypt()

ResetThirdPartyModule
Resets the third party licence. Only possible for non-encrypted scripts. Requires masterkey
licence for third party module currently set.
int ComDpl.ResetThirdPartyModule()

R ETURNS
0 On success.
1 On error.

SetExternalObject
Sets the external object defined in the ComDpl edit dialog.
int ComDpl.SetExternalObject(str name,
DataObject value
)

A RGUMENTS
name Name of the external object parameter.
value The external object.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.GetExternalObject(), ComDpl.SetInputParameterInt(), ComDpl.SetInputParameterDouble(),

ComDpl.SetInputParameterString()

SetInputParameterDouble
Sets the double input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterDouble(str name,
float value
)

A RGUMENTS
name Name of the double input parameter.
value Value of the double input parameter.

R ETURNS
0 On success.
1 On error.

288
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComDpl.GetInputParameterDouble(), ComDpl.SetInputParameterInt(), ComDpl.SetInputParameterString(),

ComDpl.SetExternalObject()

SetInputParameterInt
Sets the integer input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterInt(str name,
int value
)

A RGUMENTS
name Name of the integer input parameter.
value Value of the integer input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.GetInputParameterInt(), ComDpl.SetInputParameterDouble(), ComDpl.SetInputParameterString(),

ComDpl.SetExternalObject()

SetInputParameterString
Sets the string input parameter value defined in the ComDpl edit dialog.
int ComDpl.SetInputParameterString(str name,
str value
)

A RGUMENTS
name Name of the string input parameter.
value Value of the string input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComDpl.GetInputParameterString(), ComDpl.SetInputParameterInt(), ComDpl.SetInputParameterDouble(),

ComDpl.SetExternalObject()

SetThirdPartyModule
Sets the third party licence to a specific value. Only possible for non-encrypted scripts with no
third party licence set so far. Requires masterkey licence for third party module to be set.
int ComDpl.SetThirdPartyModule(str companyCode,
str moduleCode
)

289
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.15 ComFlickermeter
Overview

Execute

Execute
Calculates the short- and long-term flicker according to IEC 61000-4-15.
int ComFlickermeter.Execute()

R ETURNS
0 OK
1 Error: column not found in file; other internal errors
2 Error: empty input file
3 Error: cannot open file
4 Internal error: matrix empty

5.4.16 ComGenrelinc
Overview

GetCurrentIteration
GetMaxNumIterations

GetCurrentIteration
The command returns the current iteration number of the ’Run Generation Adequacy’ command
(ComGenrel).
int ComGenrelinc.GetCurrentIteration()

R ETURNS
Returns the current iteration number.

290
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 ComGenrelinc.GetMaxNumIterations()

R ETURNS
Returns the maximum number of iterations.

5.4.17 ComGridtocim
Overview

ConvertAndExport
SetAuthorityUri
SetBoundaries
SetGridsToExport

ConvertAndExport
Convert Grid to CIM and export CIM data to given file path without storing into database. If
no file path is provided, the file path from the corresponding CIM Data Export command in the
study will be used. In case of a validation error the export is not performed.
int ComGridtocim.ConvertAndExport([int validate])
int ComGridtocim.ConvertAndExport(str filePath,
[int validate])

A RGUMENTS
filePath File path for CIM data.

validate (optional)
Option to execute CIM Data Validation before export. If not provided, the validation
is executed. Possible values are
0 Do not validate
1 Validate

R ETURNS
0 OK
1 Error: conversion failed
2 Error: export failed

SetAuthorityUri
Sets the authority uri for a specific grid.
None ComGridtocim.SetAuthorityUri(DataObject grid,
str uri)

291
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
grid Grid to set the URI for.
uri Model authority URI to be set.

SetBoundaries
Sets ”Fictitious border grid” parameter on the grids.
None ComGridtocim.SetBoundaries(list grids)

A RGUMENTS
grids The grids to be set as boundary.

SetGridsToExport
Sets the grids as ”Selected” and clears any previous setting.
None ComGridtocim.SetGridsToExport(list grids)

A RGUMENTS
grids The grids to be selected.

5.4.18 ComHostcap
Overview

CalcMaxHostedPower

CalcMaxHostedPower
The function executes predefined hosting capacty analysis command and returns the max.
hosted power (P, Q) at the given terminal. In addition, object where the violation has occured is
returned.
[int returnValue,
float P,
float Q,
violatedElement ] ComHostcap.CalcMaxHostedPower(DataObject terminal)

A RGUMENTS
terminal Hosting site.
P (out) Max. active power.

Q (out) Max. reactive power.

limitingComponent (out)
Element where the limiting violation occurs.

292
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

GetCreatedObjects
GetModifiedObjects

GetCreatedObjects
Returns the newly created objects after execution of a DGS import.
list ComImport.GetCreatedObjects()

R ETURNS
Collection of objects that have been created during DGS import.

GetModifiedObjects
Returns the modified objects after execution of a DGS import.
list ComImport.GetModifiedObjects()

R ETURNS
Collection of objects that have been modified during DGS import.

5.4.20 ComInc
Overview

ZeroDerivative

ZeroDerivative
This function returns 1 if the state variable derivatives are less than the tolerance for the initial
conditions, provided that the Simulation method is set to RMS values and the Verify initial
conditions option is selected in the Calculation of initial conditions command. The tolerance
is defined on the Solver options page in the Maximum error for dynamic model equations field.
The function returns 0 if the aforementioned conditions are not met, or if at least one state
variable has a derivative larger than the tolerance.

293
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

int ComInc.ZeroDerivative()

R ETURNS
0 At least one state variable has a derivative larger than the tolerance, or the re-
quired command options have not been set.
1 All state variable derivatives are less than the tolerance.

5.4.21 ComLdf
Overview

CheckControllers
DoNotResetCalc
EstimateOutage
Execute
IsAC
IsBalanced
IsDC
PrintCheckResults
SetOldDistributeLoadMode

CheckControllers
Check the conditions of all controllers based on available load flow results. The report will be
printed out in output window.
int ComLdf.CheckControllers()

R ETURNS
Always return 1.

DoNotResetCalc
The load flow results will not be reset even the load flow calculation fails.
int ComLdf.DoNotResetCalc(int doNotReset)

A RGUMENTS
doNotReset
Specifies whether the results shall be reset or not.

0 Reset load flow results if load flow fails.

1 Load flow results will remain even load flow fails.

R ETURNS
Always return 0.

EstimateOutage
Estimate the loading of all branches with outages of given set of branch elements.

294
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

int ComLdf.EstimateOutage(list branches,

int init
)

A RGUMENTS
branches The branch elements to be in outage.
init Initialisation of sensitivities.
0 No need to calculate sensitivities; it assumes that sensitivities have
been calculated before hand.
1 Sensitivities will be newly calculated.

R ETURNS
0 On success.
1 On error.

Execute
Performs a load flow analysis on a network. Results are displayed in the single line graphic and
available in relevant elements.
int ComLdf.Execute()

R ETURNS
0 OK
1 Load flow failed due to divergence of inner loops.
2 Load flow failed due to divergence of outer loops.

IsAC
Check whether this load flow is configured as AC method or not.
int ComLdf.IsAC()

R ETURNS
0 Is a DC method.
1 Is an AC method.

IsBalanced
Check whether this load flow command is configured as balanced or unbalanced.
int ComLdf.IsBalanced()

R ETURNS
Returns true if the load flow is balanced.

295
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

IsDC
Check whether this load flow is configured as DC method or not.
int ComLdf.IsDC()

R ETURNS
0 Is an AC method.
1 Is a DC method.

PrintCheckResults
Shows the verification report in the output window.
int ComLdf.PrintCheckResults()

R ETURNS
Always return 1.

SetOldDistributeLoadMode
Set the old scaling mode in case of Distributed Slack by loads.
None ComLdf.SetOldDistributeLoadMode(int iOldMode)

A RGUMENTS
iOldMode The flag showing if the old model is used.

0 Use standard mode.

1 Use old mode.

5.4.22 ComLink
Overview

LoadMicroSCADAFile
ReceiveData
SendData
SentDataStatus
SetOPCReceiveQuality
SetSwitchShcEventMode

LoadMicroSCADAFile
Reads in a MicroSCADA snapshot file.
int ComLink.LoadMicroSCADAFile(str filename,
[int populate]
)

A RGUMENTS
filename name of the file to read

296
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

populate (optional)
determines whether new values should be populated to the network elements
(0=no, 1=yes)

R ETURNS
0 On success.
1 On error.

ReceiveData
Reads and processes values for all (in PowerFactory configured) items from OPC server (OPC
only).
int ComLink.ReceiveData([int force])

A RGUMENTS
force (optional)
0 (default) Processes changed values (asynchronously) received by Pow-
erFactory via callback
1 Forces (synchronous) reading and processing of all values (independet
of value changes)

R ETURNS
Number of read items

SendData
Sends values from configured measurement objects to OPC server (OPC only).
int ComLink.SendData([int force])

A RGUMENTS
force (optional)
0 (default) Send only data that have been changed and difference be-
tween old and new value is greater than configured deadband
1 Forces writing of all values (independet of previous value)

R ETURNS
Number of written items

SentDataStatus
Outputs status of all items marked for sending to output window.
int ComLink.SentDataStatus()

R ETURNS
Number of items configured for sending.

297
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetOPCReceiveQuality
Allows to override the actual OPC receive quality by this value. (Can be used for testing.)
int ComLink.SetOPCReceiveQuality(int quality)

A RGUMENTS
quality new receive quality (bitmask)

R ETURNS
0 On success.
1 On error.

SetSwitchShcEventMode
Configures whether value changes for switches are directly transferred to the object itself of
whether shc switch events shall be created instead.
None ComLink.SetSwitchShcEventMode(int enabled)

A RGUMENTS
enabled
0 Values are directly written to switches
1 For each value change a switch event will be created

5.4.23 ComMerge
Overview

CheckAssignments
Compare
CompareActive
ExecuteRecording
ExecuteWithActiveProject
GetCorrespondingObject
GetModification
GetModificationResult
GetModifiedObjects
Merge
PrintComparisonReport
PrintModifications
Reset
SetAutoAssignmentForAll
SetObjectsToCompare
ShowBrowser
WereModificationsFound

CheckAssignments
Checks if all assignments are correct and merge can be done.
int ComMerge.CheckAssignments()

298
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 Cancelled by user.
2 Missing assignments found.
3 Conflicts found.
4 On other errors.

Compare
Starts a comparison according to the settings in this ComMerge object. The merge browser is
not shown.
int ComMerge.Compare()

CompareActive
Starts a comparison according to the settings in this ComMerge object. The merge browser is
not shown. Can compare with the active project.
int ComMerge.CompareActive()

ExecuteRecording
Starts a comparison according to the settings in this ComMerge object and shows the merge
browser. Records modifications in the active scenario and/or expansion stage of the target
project.
int ComMerge.ExecuteRecording()

ExecuteWithActiveProject
Starts a comparison according to the settings in this ComMerge object and shows the merge
browser. Can compare with the active project.
None ComMerge.ExecuteWithActiveProject()

GetCorrespondingObject
Searches corresponding object for given object.
DataObject ComMerge.GetCorrespondingObject(DataObject sourceObj,
[int target]
)

A RGUMENTS
sourceObj
Object for which corresponding object is searched.
target
0 Get corresponding object from “Base” (default)
1 Get corresponding object from “1st”
2 Get corresponding object from “2nd”

299
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
object Corresponding object.
None Corresponding object not found.

GetModification
Gets kind of modification between corresponding objects of “Base” and “1st” or “2nd”.
int ComMerge.GetModification(DataObject sourceObj,
[int taget]
)

A RGUMENTS
sourceObj
Object from any source for which modification is searched.
target
1 Get modification from “Base” to “1st” (default)
2 Get modification from “Base” to “2nd”

R ETURNS
0 On error.
1 No modifications (equal).
2 Modified.
3 Added in “1st”/“2nd”.
4 Removed in “1st”/“2nd”.

GetModificationResult
Gets kind of modifications between compared objects in “1st” and “2nd”.
int ComMerge.GetModificationResult(DataObject obj)

A RGUMENTS
obj Object from any source for which modification is searched.

R ETURNS
0 On error.
1 No modifications (equal).
2 Same modifications in “1st” and “2nd” (no conflict).
3 Different modifications in “1st” and “2nd” (conflict).

GetModifiedObjects
Gets all objects with a certain kind of modification.
list ComMerge.GetModifiedObjects(int modType,
[int modSource]
)

300
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
modType
1 get unmodified objects
2 get modified objects
3 get added objects
4 get removed obejcts
modSource
1 consider modification between “Base” and “1st” (default)
2 consider modification between “Base” and “2nd”

R ETURNS
Set with matching objects.
Unmodified, modified and added objects are always from given “modSource”, removed ob-
jects are always from “Base” .

Merge
Checks assignments, merges modifications according to assignments into target and prints
merge report to output window.
None ComMerge.Merge(int printReport)

A RGUMENTS
printReport
1 print merge report (default)
0 do not print merge report
always set to 0 in paste and split mode

PrintComparisonReport
Prints the modifications of all compared objects as a report to the output window.
None ComMerge.PrintComparisonReport(int mode)

A RGUMENTS
mode
0 no report
1 only modified compare objects
2 all compare objects

PrintModifications
Prints modifications of given objects (if any) to the output window.
int ComMerge.PrintModifications(list objs)
int ComMerge.PrintModifications(DataObject obj)

301
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
objs Set of objects for which the modifications are printed.
obj Object for which the modifications are printed.

R ETURNS
0 On error: object(s) not found in comparison.
1 On success: modifications were printed.

Reset
Resets/clears and deletes all temp. object sets, created internally for the comparison.
None ComMerge.Reset()

SetAutoAssignmentForAll
Sets the assignment of all compared objects automatically.
None ComMerge.SetAutoAssignmentForAll(int conflictVal)

A RGUMENTS
conflictVal
Assignment of compared objects with undefined automatic values (e.g. conflicts)
0 no assignment
1 assign from “Base”
2 assign from 1st
3 assign from 2nd

SetObjectsToCompare
Sets top level objects for comparison.
None ComMerge.SetObjectsToCompare(DataObject base,
[DataObject first,]
[DataObject second]
)

A RGUMENTS
base Top level object to be set as “Base”
first Top level object to be set as “1st”
second Top level object to be set as “2nd”

ShowBrowser
Shows merge browser with initialized settings and all compared objects. Can only be called
after a comparison was executed.
int ComMerge.ShowBrowser()

302
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 The browser was left with ok button.
1 The browser was left with cancel button.
2 On error.

WereModificationsFound
Checks, if modifications were found in comparison.
int ComMerge.WereModificationsFound()

R ETURNS
0 All objects in comparison are equal.
1 Modifications found in comparison.

5.4.24 ComMot
Overview

GetMotorConnections
GetMotorSwitch
GetMotorTerminal

GetMotorConnections
Finds the cables connecting the motor to the switch.
list ComMot.GetMotorConnections(DataObject motor)

A RGUMENTS
motor The motor element

R ETURNS
Returns the set of cables connecting the motor to the switch.

GetMotorSwitch
Finds the switch which will connect the motor to the network.
DataObject ComMot.GetMotorSwitch(DataObject motor)

A RGUMENTS
motor The motor element

R ETURNS
Returns the switch element.

303
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetMotorTerminal
Finds the terminal to which the motor will be connected.
DataObject ComMot.GetMotorTerminal(DataObject motor)

A RGUMENTS
motor The motor element

R ETURNS
Returns the terminal element.

5.4.25 ComNmink
Overview

AddRef
Clear
GenerateContingenciesForAnalysis
GetAll

AddRef
Adds shortcuts to the objects to the existing selection.
None ComNmink.AddRef(DataObject O)
None ComNmink.AddRef(list S)

A RGUMENTS
O(optional)
an object
S(optional)
a Set of objects

Clear
Delete all contents, i.e. to empty the selection.
None ComNmink.Clear()

GenerateContingenciesForAnalysis
Generates Contingencies for Contingency Analysis. Similar to calling ’Execute’ but does not
pop-up the contingency command.
int ComNmink.GenerateContingenciesForAnalysis()

R ETURNS
0 On success.
1 On error.

304
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetAll
Returns all objects which are of the class 'ClassName'.
list ComNmink.GetAll(str className)

A RGUMENTS
className
The object class name.

R ETURNS
The set of objects

5.4.26 ComOmr
Overview

GetFeeders
GetOMR
GetRegionCount

GetFeeders
Get all feeders for which optimal manual switches have been determined. This function can be
used after execution of an Optimal Manual Restoration command only.
list ComOmr.GetFeeders()

R ETURNS
The set of all feeders used for optimisation.

GetOMR
Get terminal and connected optimal manual switches determined by the optimisation for the
given feeder and its region(pocket) of the given index. For a detailed description of a pocket,
please consult the manual. This function can be used after execution of an Optimal Manual
Restoration command only.
list ComOmr.GetOMR(DataObject arg0,
int arg1
)

A RGUMENTS
arg0 The feeder to derive the resulting optimal terminal with its connected (optimal)
manual switches for.
arg1 The index of the region(pocket) inside the given feeder to derive the resulting
optimal terminal with its connected (optimal) manual switches for.

R ETURNS
The resulting optimal terminal with its connected (optimal) manual switches for the region in
the feeder.

305
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetRegionCount
Get total number of regions(pockets) separated by infeeding point, feeder ends and certain
switches for the provided feeder. For a detailed description of a pocket, please consult the
manual. This function can be used after execution of an Optimal Manual Restoration command
only.
int ComOmr.GetRegionCount(DataObject feeder)

A RGUMENTS
feeder Feeder to derive number of regions(pockets) for.

R ETURNS
Number of regions(pockets) for the feeder.

5.4.27 ComOpc
Overview

ReceiveData
SendData

ReceiveData
Reads and processes values for all (in PowerFactory configured) items from OPC server (OPC
only).
int ComOpc.ReceiveData([int force])

A RGUMENTS
force (optional)
1 Forces (synchronous) reading and processing of all values (independet
of value changes)

R ETURNS
1 if successfully received data -1 if an error occurred -2 if the link is not connected

SendData
Sends values from configured measurement objects to OPC server (OPC only).
int ComOpc.SendData([int force])

A RGUMENTS
force (optional)
0 (default) Send only data that have been changed and difference be-
tween old and new value is greater than configured deadband
1 Forces writing of all values (independet of previous value)

R ETURNS
1 if successfully received data -1 if an error occurred -2 if the link is not connected

306
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.28 ComOutage
Overview

ContinueTrace
ExecuteTime
GetObject
RemoveEvents
SetObjs
StartTrace
StopTrace

ContinueTrace
Continue the next step of the trace.
int ComOutage.ContinueTrace()

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

ExecuteTime
Execute contingency (with multiple time phase) for the given time.
int ComOutage.ExecuteTime(float time)

A RGUMENTS
time the given time to be executed.

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

GetObject
Get the element stored in line number “line” in the table of ComOutage. The line index starts
with 0.
DataObject ComOutage.GetObject(int line)

A RGUMENTS
line line index, if index exceeds the range None is returned

R ETURNS
the element of line “line” in the table.

307
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

RemoveEvents
Remove all events defined in this contingency.
None ComOutage.RemoveEvents ([int info])
None ComOutage.RemoveEvents (str type)
None ComOutage.RemoveEvents (int info, str type)
None ComOutage.RemoveEvents (str type, int info)

A RGUMENTS
type
none Hidden objects are ignored and not added to the set
'Lod' remove all EvtLod
'Gen' remove all EvtGen
'Switch' remove all EvtSwitch
info(optional)
1 show info message in output window (default)
0 do not show info message

SetObjs
To fill up the ”interrupted components” with given elements.
Sets the list of objects according to S.
int ComOutage.SetObjs(list S)

A RGUMENTS
S the set of objects

R ETURNS
0 On success.
1 On error.

StartTrace
Start trace all post fault events of this contingency.
int ComOutage.StartTrace()

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

StopTrace
To stop the trace.
int ComOutage.StopTrace([int msg])

308
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
msg (optional)
Emit messages or not.
0 Suppress messages.
1 Emit messages.

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

5.4.29 ComPfdimport
Overview

GetImportedObjects

GetImportedObjects
Returns the imported objects of last execution of command.
list ComPfdimport.GetImportedObjects()

R ETURNS
Returns the imported objects of the last execution of the command.

5.4.30 ComPrjconnector
Overview

GetSuccesfullyConnectedItems
GetUnsuccesfullyConnectedItems

GetSuccesfullyConnectedItems
Returns a list of elements which were correctly processed in the last run of the command
list ComPrjconnector.GetSuccesfullyConnectedItems()

GetUnsuccesfullyConnectedItems
Returns a list of elements which were not correctly processed in the last run of the command
list ComPrjconnector.GetUnsuccesfullyConnectedItems()

309
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.31 ComProtgraphic
Overview

AddToUpdatePages
ClearUpdatePages

AddToUpdatePages
Adds pages (*.SetVipage) to the user-defined selection of plot pages to update.
None ComProtgraphic.AddToUpdatePages(list pages)

ClearUpdatePages
Clears the user-defined selection of plot pages to update.
None ComProtgraphic.ClearUpdatePages()

5.4.32 ComPvcurves
Overview

FindCriticalBus

FindCriticalBus
Returns the critical bus for a given PV-Curve result file. The critical bus is the one with the
highest gradient at the last iteration. If a bus is found, whose voltage drop is twice as high, as
the one with the highest gradient, the bus with the higher voltage drop is the critical one.
DataObject ComPvcurves.FindCriticalBus(DataObject resultfile)

5.4.33 ComPython
Overview

GetExternalObject
GetInputParameterDouble
GetInputParameterInt
GetInputParameterString
SetExternalObject
SetInputParameterDouble
SetInputParameterInt
SetInputParameterString

GetExternalObject
Gets the external object defined in the ComPython edit dialog.
[int error,
DataObject value] ComPython.GetExternalObject(str name)

310
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
name Name of the external object parameter.
value (out)
The external object.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComPython.SetExternalObject(), ComPython.GetInputParameterInt(),
ComPython.GetInputParameterDouble(), ComPython.GetInputParameterString()

GetInputParameterDouble
Gets the double input parameter value defined in the ComPython edit dialog.
[int error,
float value] ComPython.GetInputParameterDouble(str name)

A RGUMENTS
name Name of the double input parameter.
value (out)
Value of the double input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComPython.SetInputParameterDouble(), ComPython.GetInputParameterInt(),
ComPython.GetInputParameterString(), ComPython.GetExternalObject()

GetInputParameterInt
Gets the integer input parameter value defined in the ComPython edit dialog.
[int error,
int value ] ComPython.GetInputParameterInt(str name)

A RGUMENTS
name Name of the integer input parameter.

value (out)
Value of the integer input parameter.

R ETURNS
0 On success.
1 On error.

311
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComPython.SetInputParameterInt(), ComPython.GetInputParameterDouble(),
ComPython.GetInputParameterString(), ComPython.GetExternalObject()

GetInputParameterString
Gets the string input parameter value defined in the ComPython edit dialog.
[int error,
str value ] ComPython.GetInputParameterString(str name)

A RGUMENTS
name Name of the string input parameter.
value (out)
Value of the string input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComPython.SetInputParameterString(), ComPython.GetInputParameterInt(),
ComPython.GetInputParameterDouble(), ComPython.GetExternalObject()

SetExternalObject
Sets the external object defined in the ComPython edit dialog.
int ComPython.SetExternalObject(str name,
DataObject value
)

A RGUMENTS
name Name of the external object parameter.
value The external object.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComPython.GetExternalObject(), ComPython.SetInputParameterInt(),
ComPython.SetInputParameterDouble(), ComPython.SetInputParameterString()

SetInputParameterDouble
Sets the double input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterDouble(str name,
float value
)

312
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
name Name of the double input parameter.
value Value of the double input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComPython.GetInputParameterDouble(), ComPython.SetInputParameterInt(),
ComPython.SetInputParameterString(), ComPython.SetExternalObject()

SetInputParameterInt
Sets the integer input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterInt(str name,
int value
)

A RGUMENTS
name Name of the integer input parameter.

value Value of the integer input parameter.

R ETURNS
0 On success.
1 On error.

S EE ALSO

ComPython.GetInputParameterInt(), ComPython.SetInputParameterDouble(),
ComPython.SetInputParameterString(), ComPython.SetExternalObject()

SetInputParameterString
Sets the string input parameter value defined in the ComPython edit dialog.
int ComPython.SetInputParameterString(str name,
str value
)

A RGUMENTS
name Name of the string input parameter.
value Value of the string input parameter.

R ETURNS
0 On success.
1 On error.

313
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

S EE ALSO

ComPython.GetInputParameterString(), ComPython.SetInputParameterInt(),
ComPython.SetInputParameterDouble(), ComPython.SetExternalObject()

5.4.34 ComRed
Overview

LdfEquivalentVerification
ReductionInMemory
ResetReductionInMemory
SimEquivalentVerification

LdfEquivalentVerification
Right after Network Reduction execution, get the verification results of the load flow equivalents.
int ComRed.LdfEquivalentVerification()

R ETURNS
-1 Calculation is not available or the varification is not enabled.
0 The reduced network is equivalent to the original network.
1 The load flow doesn’t converge after reduction.
2 The load flow converges after reduction but the results differ from original net-
work.

ReductionInMemory
Execute network reduction in memory, no change to database. Note: afterwards, the function
ResetReductionInMemory() must be called to revert the reduction.
int ComRed.ReductionInMemory()

R ETURNS
Returns 0 if successfully executed.

ResetReductionInMemory
Restore the network back to original after reduction in memory.
void ComRed.ResetReductionInMemory()

SimEquivalentVerification
Right after Network Reduction execution, get the verification results of the dynamic simulation
equivalents.
int ComRed.SimEquivalentVerification()

314
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

AnalyseElmRes
ExeEvt
OvlAlleviate
RemoveEvents
RemoveOutages
ValidateConstraints

AnalyseElmRes
Evaluate the results object created by the last calculation. Performs exactly the same as
pressing the button 'Perform Evaluation of Result File' in the dialogue box of the command.
int ComRel3.AnalyseElmRes([int error])

A RGUMENTS
error (optional)
0 do not display an error message (default)
1 display error messages in case of errors

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

ExeEvt
Executes a given event.
None ComRel3.ExeEvt([DataObject event])

A RGUMENTS
event The event that shall be executed.

OvlAlleviate
Performs an overload alleviation for given events.
int ComRel3.OvlAlleviate([list preCalcEvents])

315
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
preCalcEvents (optional)
The events which will be executed before the calculation.

R ETURNS
0 On success.
1 Failure in load flow.
2 No overloading detected.
>2 On error.

RemoveEvents
Removes all events stored in all contingencies (*.ComContingency) inside the reliability com-
mand.
None ComRel3.RemoveEvents()

RemoveOutages
Removes all contingency definitions (*.ComContingencies) stored inside the reliability com-
mand.
None ComRel3.RemoveOutages([int msg])

A RGUMENTS
msg( optional)
1 Show info message in output window (default value).
0 Do not emit messages.

ValidateConstraints
Checks if the restoration of a contingency violates any constraint according to the current
settings of the reliability calculation. These do not necessarily have to be the settings used
during calculation. Of course the selected calculation method of ComRel3 has to be ’Load flow
analysis’ to check for constraint violations.
int ComRel3.ValidateConstraints(DataObject contingency)

A RGUMENTS
contingency
The contingency which will be checked for constraint violations.

R ETURNS
0 No constraint violations, or all constraint violations could be solved.
1 Constraints are violated.
−1 Contingency not valid.
−2 Load flow did not converge.
−3 Network error.

316
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.36 ComRelpost
Overview

CalcContributions
GetContributionOfComponent

CalcContributions
Calculates the contributions to load interruptions of the loads that are passed to this function.
The loads can be e.g. inside a feeder or a zone as well. If nothing is passed as input all loads
will be analysed.
int ComRelpost.CalcContributions([list elements])

A RGUMENTS
elements (optional)
Elements (Loads) for which the contributions shall be calculated (default: all loads,
if no argument is passed).

R ETURNS
0 Calculation successful.
1 On error.

GetContributionOfComponent
Gets the contributions of a component to a certain reliability indice.
float ComRelpost.GetContributionOfComponent(int componentNr,
str indice)

A RGUMENTS
componentNr 1. Lines
2. Cables
3. Transformers
4. Busbars
5. Generators
6. Common Modes
7. Double Earth Faults
indice Avalaible indices are: ’SAIFI’, ’SAIDI’, ’ASIFI’, ’ASIDI’, ’ENS’, ’EIC’

R ETURNS
The contribution of this component to this reliability indice.

5.4.37 ComRelreport
Overview

GetContingencies
GetContributionOfComponent
317
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetContingencies
Gets all contingencies of reliability for reporting.
list ComRelpost.GetContingencies()

R ETURNS
All contingencies of reliability for reporting.

GetContributionOfComponent
Is described in ComRelpost.GetContributionOfComponent().
float ComRelreport.GetContributionOfComponent(int componentNr,
str indice)

5.4.38 ComRes
Overview

ExportFullRange
FileNmResNm

ExportFullRange
Executes the export command for the whole data range.
None ComRes.ExportFullRange()

FileNmResNm
Sets the filename for the data export to the name of the result object being exported (classes:
ElmRes, IntComtrade)
None ComRes.FileNmResNm()

5.4.39 ComShc
Overview

ExecuteRXSweep
GetFaultType
GetOverLoadedBranches
GetOverLoadedBuses

ExecuteRXSweep
Calculates RX Sweep. If no impedance passed, the value from the command shall be used. If
argument passed then the impedance changes are stored to the command (Rf, Xf).
int ComShc.ExecuteRXSweep()
int ComShc.ExecuteRXSweep(float Zr,
float Zi

318
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
Zr Impedance real part
Zi Impedance imaginary part

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

GetFaultType
Returns the short-circuit fault type.
int ComShc.GetFaultType()

R ETURNS
0 three phase fault
1 single phase to ground
2 two phase fault
3 two phase to ground fault
4 three phase unbalanced fault
5 single phase to neutral fault
6 single phase, neutral to ground fault
7 two phase to neutral fault
8 two phase, neutral to ground fault
9 three phase to neutral fault
10 three phase, neutral to ground fault
20 DC fault

GetOverLoadedBranches
Get overloaded branches after a short-circuit calculation.
[int error,
list branches] ComShc.GetOverLoadedBranches(float ip,
float ith)

A RGUMENTS
ip Max. peak-current loading, in %
ith Max. thermal loading, in %
branches (out)
Set of branches which are checked

R ETURNS
=0 On error or 0 branches found.
6= 0 Number of branches.

319
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

E XAMPLE

GetOverLoadedBuses
Get overloaded buses after a short-circuit calculation.
[int error,
list buses] ComShc.GetOverLoadedBuses(float ip,
float ith)

A RGUMENTS
ip Max. peak-current loading, in %
ith Max. thermal loading, in %

buses (optional, out)

Set of buses which are checked

R ETURNS
=0 On error or 0 buses found.
6= 0 Number of buses.

E XAMPLE

5.4.40 ComShctrace
Overview

BlockSwitch
ExecuteAllSteps
ExecuteInitialStep
ExecuteNextStep
GetBlockedSwitches
GetCurrentTimeStep
GetDeviceSwitches
GetDeviceTime
GetNonStartedDevices
GetStartedDevices
GetSwitchTime
GetTrippedDevices
NextStepAvailable

BlockSwitch
Blocks a switch from operating for the remainder of the trace.
int ComShctrace.BlockSwitch(DataObject switchDevice)

A RGUMENTS
switchDevice
Switch device to block.

320
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Switch can not be blocked (e.g. because it already operated).
1 Switch is blocked.

ExecuteAllSteps
Executes all steps of the short circuit trace. This function requires the trace to be already
running
int ComShctrace.ExecuteAllSteps()

R ETURNS
0 No error occurred, trace is complete.
!=0 An error occurred, calculation was reset.

S EE ALSO

ComShctrce.ExecuteInitialStep()

ExecuteInitialStep
Executes the first step of the short circuit trace.
int ComShctrace.ExecuteInitialStep()

R ETURNS
0 No error occurred, the short-circuit trace is now running.
!=0 An error occurred, calculation was reset.

ExecuteNextStep
Executes the next step of the short circuit trace. This function requires the trace to be already
running
int ComShctrace.ExecuteNextStep()

R ETURNS
0 No error occurred, step was executed .
!=0 An error occurred, calculation was reset.

S EE ALSO

ComShctrce.ExecuteInitialStep()

GetBlockedSwitches
Returns all switches which are currently blocked.
list ComShctrace.GetBlockedSwitches()

321
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
All blocked switches.

GetCurrentTimeStep
Returns the current time step of the trace in seconds.
int ComShctrace.GetCurrentTimeStep()

R ETURNS
The current time step in [s].

GetDeviceSwitches
Returns all switches operated by a protection device.
list ComShctrace.GetDeviceSwitches(DataObject device)

A RGUMENTS
device Protection device to get the switches for.

R ETURNS
All switches devices operated by the protection device.

GetDeviceTime
Returns the time a protection device operated or will operate at.
int ComShctrace.GetDeviceTime(DataObject device)

A RGUMENTS
device Protection device to get the time for.

R ETURNS
The tripping time of the device itself, if the device already tripped, or the prospective tripping
time.

GetNonStartedDevices
Returns all protection devices which are not started.
list ComShctrace.GetNonStartedDevices()

R ETURNS
All protection devices which are not started.

GetStartedDevices
Returns all started but not yet tripped protection devices.
list ComShctrace.GetStartedDevices()

322
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
All started but not yet tripped protection devices.

GetSwitchTime
Returns the time a switch device operated or will operate at.
int ComShctrace.GetSwitchTime(DataObject device,
DataObject switchDevice
)

A RGUMENTS
device Reference protection device for the switch.
device Switch device to get the time for.

R ETURNS
The tripping time of the switch device, based on the tripping time of the reference protection
device. If the switch already operated, the time of operation will be returned.

GetTrippedDevices
Returns all protection devices already tripped.
list ComShctrace.GetTrippedDevices()

R ETURNS
All protection devices already tripped.

NextStepAvailable
Indicates whether or not a next time step can be executed.
int ComShctrace.NextStepAvailable()

R ETURNS
0 Next step is not available, the trace is completed.
1 A next step is available.

5.4.41 ComSim
Overview

GetSimulationTime
GetTotalWarnA
GetTotalWarnB
GetTotalWarnC
GetViolatedScanModules
LoadSnapshot
SaveSnapshot

323
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetSimulationTime
Get the actual simulation time if the initial conditions are calculated.
int ComSim.GetSimulationTime()

R ETURNS
Returns the simulation time in seconds. If the initial conditions are not calculated, then the
function returns ’nan’.

GetTotalWarnA
Returns the total number of type-A (serious) warnings related to the time-domain simulation.
int ComSim.GetTotalWarnA()

R ETURNS
Returns the total number of type-A (serious) warnings.

GetTotalWarnB
Returns the total number of type-B (moderate) warnings related to the time-domain simulation.
int ComSim.GetTotalWarnB()

R ETURNS
Returns the total number of type-B (moderate) warnings.

GetTotalWarnC
Returns the total number of type-C (minor) warnings related to the time-domain simulation.
int ComSim.GetTotalWarnC()

R ETURNS
Returns the total number of type-C (minor) warnings.

GetViolatedScanModules
Returns a set of scan modules of which each have at least one violation.
list ComSim.GetViolatedScanModules()

R ETURNS
Returns a set of scan modules of which each have at least one violation.

LoadSnapshot
Load the state of a dynamic simulation from a file.
int ComSim.LoadSnapshot([string snapshotFilePath], [int suppressUserMessage])

324
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

D EPRECATED N AMES
LoadSimulationState

A RGUMENTS
snapshotFilePath (optional)
The snapshot file to load. If no file is specified, the last snapshot stored in the
memory is used. (default = ”)

suppressUserMessage (optional)
The pop-up window asking for data overwrite is not displayed if this value is set to
1. (default = 0)

R ETURNS
0 Saved simulation state has been loaded.
1 Saved simulation state cannot be loaded.
2 Saved simulation state does not match actual model. Calculation will be reset.

SaveSnapshot
Save the state of a dynamic simulation to memory and to a file.
int ComSim.SaveSnapshot(string snapshotFilePath, [int suppressUserMessage])

D EPRECATED N AMES
SaveSimulationState

A RGUMENTS
snapshotFilePath (optional)
The snapshot file to save. If no file is specified, the last snapshot is saved in the
non-persistent memory slot. (default = ”)
suppressUserMessage (optional)
The pop-up window asking for file overwriting is not displayed if this value is set to
1. (default = 0)

R ETURNS
0 OK
1 Error

5.4.42 ComSimoutage
Overview

AddCntcy
AddContingencies
AddRas
ClearCont
CreateFaultCase
Execute
ExecuteAndCheck
GetNTopLoadedElms

325
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

MarkRegions
RemoveAllRas
RemoveContingencies
RemoveRas
Reset
SetLimits
Update

AddCntcy
Executes an (additional) ComOutage, without resetting results. The results of the outage
analysis will be added to the intermediate results. Object “O” must be a ComOutage object.
If the outage definition has already been analyzed, it will be ignored. The ComOutage will be
renamed to “name” when “name” is given.
int ComSimoutage.AddCntcy(DataObject O,
[str name]
)

A RGUMENTS
O The ComOutage object
name A name for the outage

R ETURNS
0 On success.
1 On error.

AddContingencies
Adds contingencies for fault cases/groups selected by the user to the command. Shows a modal
window with the list of available fault cases and groups. Functionality as “Add Cases/Groups”
button in dialog.
None ComSimoutage.AddContingencies()

AddRas
Adds a reference to a given IntRas to the ComSimoutage.
int ComSimoutage.AddRas(DataObject ras)

A RGUMENTS
ras The IntRas object

R ETURNS
0 If the reference to the IntRas has been added.
1 If the reference to the IntRas has already been there or on error.

ClearCont
Reset existing contingency analysis results and delete existing contingency cases.
int ComSimoutage.ClearCont()

326
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 On error.

CreateFaultCase
Create fault cases from the given elements.
int ComSimoutage.CreateFaultCase(list elms,
int mode,
[int createEvt],
[DataObject folder]
)

A RGUMENTS
elms Selected elements to create fault cases.
mode How the fault cases are created:
0 Single fault case containing all elements.
1 n-1 (multiple cases).
2 n-2 (multiple cases).
3 Collecting coupling elements and create fault cases for line couplings.
createEvt (optional)
Switch event:
0 Do NOT create switch events.
1 Create switch events.
folder (optional)
Folder in which the fault case is stored.

R ETURNS
0 On success.
1 On error.

Execute
Execute contingency analysis.
int ComSimoutage.Execute()

R ETURNS
0 On success.
1 On error.

ExecuteAndCheck
Executes contingency analysis and checks the violated constraints. The constraints are defined
in models, such as maximum and minimum voltage of buses, maximum loading of lines etc.
On the first occured constraint violation, the further contingency execution will be terminated,
making the calculation faster, but with less information.

327
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

int ComSimoutage.ExecuteAndCheck([int workMode,]

[int initMode,]
[int considerOPFflags,]
[int considerVstep]
)

A RGUMENTS
workMode (optional)
the mode how the contingency analysis is executed; default is 0
0 Normal execution (doesn’t check limits, write results file)
1 Check constraints (thermal loading, bus voltage range) and terminate
execution if violates any limit, writes result file
2 Check constraints (thermal loading, bus voltage range) and terminate
execution if violates any limit, does not write result file
3 Check thermal loading only and terminate execution if violates any
limit, writes result file
4 Check thermal loading only and terminate execution if violates any
limit, does not write result file
5 Check voltage limits only and terminate execution if violates any limit,
writes result file
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.

328
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 contingencies successfully executed without any violation
1 calculation was interrupted by the user
2 error occurred during contingency analysis
3 initialisation failed, such as base case laod flow diverged
4 for AC/DC combined method, base case is already critical and calculation stopped
5 any loading constraint violated
6 any contingency cannot be analysed, non-convergent case
7 any voltage constraint violated
8 any constraint violated already in the base case

GetNTopLoadedElms
To get certain number of top loaded components (most close to its limit).
list ComSimoutage.GetNTopLoadedElms(int number)

A RGUMENTS
number The number of elements to be found.
elements (out)
The top loaded elements.

MarkRegions
To execute Region marker for certain system status (like prefault, post fault etc.), which will
indentifies energizing mode for each element.
int ComSimoutage.MarkRegions(int stage)

A RGUMENTS
stage which system stage to be analyzed, 0¡=stage¡=2

R ETURNS
0 On success.
1 On error.

RemoveAllRas
Removes all IntRas from to the ComSimoutage. Only deletes the references not the IntRas
itself.
None ComSimoutage.RemoveAllRas()

RemoveContingencies
Removes all contingencies from the command. Functionality as ”Remove All” button in dialog.
None ComSimoutage.RemoveContingencies()

329
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

RemoveRas
Removes the reference to a given IntRas from the ComSimoutage.
int ComSimoutage.RemoveRas(DataObject ras)

A RGUMENTS
ras The IntRas object

R ETURNS
0 If the reference to the IntRas has been successfully removed.
1 If the reference to the IntRas has not been in the container or on error.

Reset
Resets the intermediate results of the outage simulation.
int ComSimoutage.Reset()

R ETURNS
0 On success.
1 On error.

SetLimits
Sets the recording limits for the Contingency Analysis.
None ComSimoutage.SetLimits(float vlmin,
float vlmax,
float ldmax)

A RGUMENTS
vlmin The minimum voltage
vlmax The maximum voltage
ldmax The maximum loading

Update
To update contingency cases via topology search. It will find interrupted elements, required
switch actions for each contingency.
int ComSimoutage.Update()

R ETURNS
0 On success.
1 On error.

330
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.43 ComSvgexport
Overview

SetFileName
SetObject
SetObjects

SetFileName
Sets SVG file for export.
None ComSvgexport.SetFileName(str path)

A RGUMENTS
path Path of target SVG file

SetObject
Sets annotation layer or group for export.
None ComSvgexport.SetObject(DataObject obj)

A RGUMENTS
obj Annotation layer (IntGrflayer) or group (IntGrfgroup) to be exported

SetObjects
Sets annotation layers and groups for export.
None ComSvgexport.SetObjects(set objs)

A RGUMENTS
objs Set of annotation layers (IntGrflayer) and/or groups (IntGrfgroup) to be exported

5.4.44 ComSvgimport
Overview

SetFileName
SetObject

SetFileName
Sets source SVG file for import.
None ComSvgimport.SetFileName(str path)

A RGUMENTS
path Path of SVG file to be imported

331
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetObject
Sets target annotation layer or group for import.
None ComSvgimport.SetObject(DataObject obj)

A RGUMENTS
obj Target annotation layer (IntGrflayer) or group (IntGrfgroup)

5.4.45 ComTasks
Overview

AppendCommand
AppendStudyCase
GetCommandsForStudyCase
GetNumberOfCommandsForStudyCase
GetNumberOfStudyCases
GetStudyCases
IsAdditionalResultsFlagSetForCommand
IsCommandIgnored
IsStudyCaseIgnored
RemoveCmdsForStudyCaseRow
RemoveCommand
RemoveStudyCase
RemoveStudyCases
SetAdditionalResultsFlagForCommand
SetIgnoreFlagForCommand
SetIgnoreFlagForStudyCase
SetResultsFolder

AppendCommand
Appends a command for calculation.
int ComTasks.AppendCommand(DataObject command,
[int studyCaseRow]
)

R ETURNS
0 Command could not be added for calculation.
1 Command has been successfully added for calculation.

A RGUMENTS
command
Command to add for calculation.
studyCaseRow
≤0 Command is added to the list of commands for its study case.
>0 Optionally, the row in the study case table containing the study case
for which this command shall be added can be passed. This is helpful,
e.g., if a study case has been added multiple times for calculation with
different command lists.

332
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

AppendStudyCase
Appends a study case to the list of study cases for calculation.
int ComTasks.AppendStudyCase(DataObject studyCase)

R ETURNS
0 Study case could not be added for calculation.
1 Study case has been successfully added for calculation.

A RGUMENTS
studyCase
Study case to add for calculation.

GetCommandsForStudyCase
Get all selected commands to be processed for a study case from the Task Automation com-
mand.
list ComTasks.GetCommandsForStudyCase(DataObject studyCase,
[int studyCaseRow])

R ETURNS
Returns ordered set of all selected commands to be processed for a study case.

A RGUMENTS
studyCase
Study case to get all selected commands to be processed from.
studyCaseRow
≤0 Commands for the first matching study case found will be returned.
>0 Optionally, the row in the study case table containing the study case
for which commands shall be returned can be passed. This is helpful,
e.g., if a study case has been added multiple times for calculation with
different command lists.

GetNumberOfCommandsForStudyCase
Get number of all selected commands to be processed for a study case from the Task Automa-
tion command.
int ComTasks.GetNumberOfCommandsForStudyCase(DataObject studyCase,
[int studyCaseRow])

R ETURNS
Returns number of all selected commands to be processed for a study case.

A RGUMENTS
studyCase
Study case to get number of selected commands to be processed from.
studyCaseRow

333
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

≤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 ComTasks.GetNumberOfStudyCases()

R ETURNS
Returns number of selected study cases from the Task Automation command.

GetStudyCases
Get all selected study cases from the Task Automation command.
list ComTasks.GetStudyCases()

R ETURNS
Returns ordered set of all selected study cases from the Task Automation command, set is
empty on failure.

IsAdditionalResultsFlagSetForCommand
Returns whether additional results flag of a command is set or not (using study case row and
task row / using a command directly).
int ComTasks.IsAdditionalResultsFlagSetForCommand(int studyCaseRow,
int taskRow)
int ComTasks.IsAdditionalResultsFlagSetForCommand(DataObject command)

A RGUMENTS
studyCaseRow ≤ 0
The row in the study cases table of the command’s study case for which the
additional results flag shall be derived.
taskRow > 0
The row in the commands table for which the additional results flag shall be
derived.
command
The command to get the additional results flag for.

R ETURNS
0 Additional results flag of command is not set.
1 Additional results flag of command is set.
-1 Additional results flag was not found for provided study case row and task row /
provided command.

334
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

IsCommandIgnored
Returns whether the processing of a command will be ignored or not (using study case row and
task row / using provided command).
int ComTasks.IsCommandIgnored(int studyCaseRow,
int taskRow)
int ComTasks.IsCommandIgnored(DataObject command)

A RGUMENTS
studyCaseRow ≤ 0
The row in the study cases table of the command’s study case for which the ignore
flag shall be derived.
taskRow > 0
The row in the commands table for which the ignore flag shall be derived.
command
The command to get the ignore-flag for.

R ETURNS
0 Processing of command will be done.
1 Processing of command will be ignored.
-1 Command was not found (for provided study case row and task row / at all).

IsStudyCaseIgnored
Returns whether the command processing for a study case will be ignored or not.
int ComTasks.IsStudyCaseIgnored(DataObject studyCase,
[int studyCaseRow])

R ETURNS
0 Command processing for study case will be done.
1 Command processing for study case will be ignored.
-1 study case or row was not found.

A RGUMENTS
studyCase
Study case to get ignore-flag from.
studyCaseRow
≤0 Ignore flag for the first matching study case found will be returned.
>0 Optionally, the row in the study case table containing the study case
for which ignore-flag shall be returned can be passed. This is helpful,
e.g., if a study case has been added multiple times for calculation with
different command lists.

RemoveCmdsForStudyCaseRow
Removes all commands selected for calculation for a given row in the study case table.
int ComTasks.RemoveCmdsForStudyCaseRow(int studyCaseRow)

335
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Commands could not be removed from calculation.
1 All commands of study case row were successfully removed from calculation.

A RGUMENTS
studyCaseRow> 0
The row in the study case table containing the study case for which all commands
shall be removed.

RemoveCommand
Remove a command from the calculation (for study case row and task row / for all appear-
ances).
int ComTasks.RemoveCommand(int studyCaseRow,
int taskRow
)
int ComTasks.RemoveCommand(DataObject command)

A RGUMENTS
studyCaseRow> 0
The row in the study cases table of the command’s study case for which the
command shall be removed.
taskRow> 0
The row in the commands table for which the command shall be removed.
command
Command to remove.

R ETURNS
0 Command could not be removed.
1 Command has been successfully removed.

RemoveStudyCase
Removes a study case from the study cases table.
int ComTasks.RemoveStudyCase(DataObject studyCase,
[int studyCaseRow]
)

R ETURNS
0 Study case could not be removed.
1 Study case has been successfully removed.

A RGUMENTS
studyCase
Study case which shall be removed.
studyCaseRow
≤0 Study case is removed for all entries in the study cases table matching
the provided study case.

336
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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

SetAdditionalResultsFlagForCommand
Set the flag whether to record an additional result file for a command of the calculation (using
study case row and task row / using command).
int ComTasks.SetAdditionalResultsFlagForCommand(int studyCaseRow,
int taskRow,
int addResVal
)
int ComTasks.SetAdditionalResultsFlagForCommand(DataObject command,
int addResVal
)

A RGUMENTS
studyCaseRow> 0
The row in the study cases table of the command’s study case for which the flag
to record additional results shall be set.

taskRow> 0
The row in the commands table for which the flag to record additional results shall
be set.
command
The command for which the flag to record additional results shall be set.

addResVal
1 Will set the command to record additional results for the calculation.
0 Will set the command to avoid recording of results for calculation.

R ETURNS
0 Flag to record (or not record) additional results could not be set.
1 Flag to record (or not record) additional results has been successfully set.

SetIgnoreFlagForCommand
Set the flag whether to ignore a command for the calculation (using study case row and task
row / using command).
int ComTasks.SetIgnoreFlagForCommand(int studyCaseRow,
int taskRow,
int ignoreVal
)

337
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

int ComTasks.SetIgnoreFlagForCommand(DataObject command,

int ignoreVal
)

A RGUMENTS
studyCaseRow> 0
The row in the study cases table of the command’s study case for which the ignore
flag shall be set.
taskRow> 0
The row in the commands table for which the ignore flag shall be set.
command
Command for which the ignore flag shall be set.
ignoreVal
1 Will set the command to be ignored for calculation.
0 Will set the command to be processed for calculation.

R ETURNS
0 Ignore flag could not be set.
1 Ignore flag has been successfully set.

SetIgnoreFlagForStudyCase
Set the flag whether to ignore the processing of commands of a study case for the calculation.
int ComTasks.SetIgnoreFlagForStudyCase(DataObject studyCase,
int ignoreVal,
[int studyCaseRow]
)

R ETURNS
0 Ignore flag could not be set.
1 Ignore flag has been successfully set.

A RGUMENTS
studyCase
Study case for which the ignore flag shall be set.

ignoreVal
1 Will set the flag to ignore the processing of commands of a study case.
0 Will set the flag to process the commands of a study case.
studyCaseRow
≤0 Ignore flag is set for all entries in the study cases table matching the
provided study case.
>0 Optionally, the row in the study case table containing the study case
for which the ignore-flag shall be set can be passed. This is helpful,
e.g., if a study case has been added multiple times for calculation with
different command lists.

338
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

SetResultsFolder
Set a folder to store results for a given row in the study case table.
int ComTasks.SetResultsFolder(DataObject folder, int studyCaseRow)

R ETURNS
0 New folder could not be set as results folder for the given row in the study case
table.
1 Folder was successfully set as resuls folder for given row in the study case table.

A RGUMENTS
folder The new folder to store results in.
studyCaseRow
The row in the study case table containing the study case for which results folder
shall be set.

5.4.46 ComTececo
Overview

UpdateTablesByCalcPeriod

UpdateTablesByCalcPeriod
Update all calculation points with respect to a new start- and end year
int ComTececo.UpdateTablesByCalcPeriod(float start,
float end
)

A RGUMENTS
start Start year of the study period
end End year of the study period

R ETURNS
0 Calculation points have been successfully set.
1 Invalid input data: end year of study period must be greater or equal to start year.

5.4.47 ComTececocmp
Overview

AppendStudyCase
CalcDiscountedEstimatedPaybackPeriod
CalcEstimatedPaybackPeriod
CalcInternalRateOfReturn
RemoveStudyCases

339
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

AppendStudyCase
Appends a study case to the list of study cases.
int ComTececocmp.AppendStudyCase(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.

CalcDiscountedEstimatedPaybackPeriod
Calculates the discounted estimated payback period (in years) for a grid expansion w.r.t. a
base grid configuration. The grid expansion and base configurations must be given by means
of two study cases and their configured variation. Moreover, these study cases must contain
corresponding result files calculated by techno-economical calculations. The calculatory interest
rate from the result file written by the Techno-economical Calculation to evaluate will be used
for discounting.
[int error,
float epp] Application.CalcDiscountedEstimatedPaybackPeriod(DataObject strategyToEval,
DataObject baseStrategy)

A RGUMENTS
strategyToEval
Study case defining grid expansion to evaluate.

baseStrategy
Study case defining base grid configuration.
epp (out) Resulting discounted estimated payback period (in years).

R ETURNS
Returns 0, if calculation was successfull and 1 otherwise.

CalcEstimatedPaybackPeriod
Calculates the estimated payback period (in years) for a grid expansion w.r.t. a base grid
configuration. The grid expansion and base configurations must be given by means of two study
cases and their configured variation. Moreover, these study cases must contain corresponding
result files calculated by techno-economical calculations.
[int error,
float epp] Application.CalcEstimatedPaybackPeriod(DataObject strategyToEval,
DataObject baseStrategy)

340
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

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.
[int error,
float irr] Application.CalcInternalRateOfReturn(DataObject strategyToEval,
DataObject baseStrategy)

A RGUMENTS
strategyToEval
Study case defining grid expansion to evaluate.
baseStrategy
Study case defining base grid configuration.
irr (out) Resulting internal rate of return.

R ETURNS
Returns 0, if calculation was successfull and 1 otherwise.

RemoveStudyCases
Removes all study cases from calculation.
None ComTececocmp.RemoveStudyCases()

5.4.48 ComTransfer
Overview

GetTransferCalcData
IsLastIterationFeasible

341
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetTransferCalcData
The function returns the calculated transfer capacity and the total number of iteration after the
transfer capacity command has been executed.
[float transferCapacity,
int totalIterations ] ComTransfer.GetTransferCalcData()

A RGUMENTS
transferCapacity (out)
Transfer capacity value at the last feasible iteration.
totalIterations (out)
Total iteration number.

IsLastIterationFeasible
The function verifies if the last transfer calculation iteration resulted in a feasible solution or not.
int ComTransfer.IsLastIterationFeasible()

R ETURNS
1 Last transfer calculation iteration resulted in a feasible solution.
0 Last transfer calculation iteration did not result in a feasible solution.

5.4.49 ComUcte
Overview

SetBatchMode

SetBatchMode
The batch mode allows to suppress all messages except error and warnings. This can be useful
when used in scripts where additional output might be confusing.
None ComUcte.SetBatchMode(int enabled)

A RGUMENTS
enabled
0 disables batch mode, all messages are printed to output window (de-
fault).
1 enables batch mode, only error and warning messages are printed to
output window.

342
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

5.4.50 ComUcteexp
Overview

BuildNodeNames
DeleteCompleteQuickAccess
ExportAndInitQuickAccess
GetConnectedBranches
GetFromToNodeNames
GetOrderCode
GetUcteNodeName
InitQuickAccess
QuickAccessAvailable
ResetQuickAccess
SetGridSelection

BuildNodeNames
Builds the node names as used in UCTE export and makes them accessible via :UcteNode-
Name attribute. The node names will only be available as long as topology has not been
changed. They must be re-build after any topology relevant modification.
Furthermore, the method fills the quick access cache given by the cache index for node names
and branch topologies as used in UCTE export. The quick access cache endures also topology
changes. The cache index is optional. If no cache index is given the default quick access cache
is used.
int ComUcteexp.BuildNodeNames([int cacheIndex])

A RGUMENTS
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

R ETURNS
0 On success.
1 0n error (e.g. load flow calculation failed).

DeleteCompleteQuickAccess
Deletes all quick access caches.
None ComUcteexp.DeleteCompleteQuickAccess()

ExportAndInitQuickAccess
Performs an UCTE export and fills the quick access cache given by the cache index.
None ComUcteexp.ExportAndInitQuickAccess(int cacheIndex)

A RGUMENTS
cacheIndex
Index of the quick access cache (must be greater than or equals to 0)

343
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetConnectedBranches
Determines the connected branches for the given terminal from the quick access cache given
by the optional cache index. If no cache index is given the default quick access cache is used.
list ComUcteexp.GetConnectedBranches(DataObject terminal,
[int cacheIndex])

A RGUMENTS
terminal Terminal to determine the connected branches from
connectedBranches (out)
Connected branches for the given terminal
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

GetFromToNodeNames
Determines the UCTE node names of the branch ends from the quick access cache given by
the optional cache index. If no cache index is given the default quick access cache is used.
[str nodeNameFrom,
str nodeNameTo ] ComUcteexp.GetFromToNodeNames(DataObject branch,
[int cacheIndex])

A RGUMENTS
branch Branch to find the UCTE node names from
nodeNameFrom (out)
UCTE node name of start node
nodeNameTo (out)
UCTE node name of end node
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

GetOrderCode
Determines the order code of the given branch element as used for UCTE export from the quick
access cache given by the optional cache index. If no cache index is given the default quick
access cache is used.
str ComUcteexp.GetOrderCode(DataObject branch,
[int cacheIndex])

A RGUMENTS
branch Branch element to get the UCTE order code from
orderCode (out)
Order code of the given branch element
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

344
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

GetUcteNodeName
Determines the node name of the given terminal as used for UCTE export from the quick access
cache given by the optional cache index. If no cache index is given the default quick access
cache is used.
None ComUcteexp.GetOrderCode(DataObject terminal,
[int cacheIndex])

A RGUMENTS
terminal Terminal to get the UCTE node name from
ucteNodeName (out)
UCTE node name of the given terminal
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

InitQuickAccess
Initializes the quick access cache given by the optional cache index. The quick acess cache
contains node names and branch topologies as used in UCTE export and endures topology
changes. InitQuickAccess() requires a successful executed UCTE export as pre-condition. The
cache index is optional. If no cache index is given the default quick access cache is used.
None ComUcteexp.InitQuickAccess([int cacheIndex])

A RGUMENTS
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

QuickAccessAvailable
Checks if the quick access cache given by the optional cache index is available. If no cache
index is given the default quick access cache is checked for availability.
int ComUcteexp.QuickAccessAvailable([int cacheIndex])

A RGUMENTS
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

R ETURNS
0 on success and 1 on error.

ResetQuickAccess
Resets the given quick access cache for node names and branch topologies as used in UCTE
export. The cache index is optional. If no cache index is given the default quick access cache
is reset.
None ComUcteexp.ResetQuickAccess([int cacheIndex])

345
5.4. COMMANDS CHAPTER 5. OBJECT METHODS

A RGUMENTS
cacheIndex (optional)
Index of the quick access cache (must be greater than or equals to 0)

SetGridSelection
Configures the selected grids in the UCTE export command.
None ComUcteexp.SetGridSelection(list gridsToExport)

A RGUMENTS
gridsToExport
Grids (instances of class ElmNet) to be selected for export. All not contained grids
will be de-selected.

5.4.51 ComWktimp
Overview

GetCreatedObjects
GetModifiedObjects

GetCreatedObjects
Returns the newly created objects after execution of a WKT import.
list ComWktimp.GetCreatedObjects()

R ETURNS
Collection of objects that have been created during WKT import.

GetModifiedObjects
Returns the modified objects after execution of a WKT import.
list ComWktimp.GetModifiedObjects()

R ETURNS
Collection of objects that have been modified during WKT import.

346
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5 Settings

5.5.1 SetCluster
Overview

CalcCluster
GetNumberOfClusters

CalcCluster
Performs a load flow calculation for the cluster index passed to the function. To execute properly
this function requires that a valid load flow result is already calculated before calling it.
int SetCluster.CalcCluster(int clusterIndex,
[int messageOn]
)

A RGUMENTS
clusterIndex
The cluster index. Zero based value, the first cluster has index 0.
messageOn (optional)
Possible values:
0 Do not emit a message in the output window.
1 Emit a message in the output window in case that the function does
not execute properly.

R ETURNS
0 On success.
1 There are no clusters, the number of clusters is 0.
2 The cluster index exceeds the number of clusters.
3 There is no load flow in memory before running CalcCluster.

GetNumberOfClusters
Get the number of clusters.
int SetCluster.GetNumberOfClusters()

R ETURNS
The number of clusters.

347
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.2 SetColscheme
Overview

CreateFilter
GetAlarmColouringMode
GetColouringMode
GetEnergisingColouringMode
SetColouring
SetFilter

CreateFilter
Creates filter used to determine objects to be colored.
int SetColscheme.CreateFilter([int pageNr])

A RGUMENTS
pageNr empty Create filter for currently valid calculation
set Dialog page number for which filter is created (see table below)

348
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Table 5.5.3

Dialog Page Name ”pageNr” value

Basic Data 101
Load Flow 102
AC Load Flow Sensitivities 120
AC Contingency Analysis 121
AC Quasi-dynamic Simulation 137
DC Load Flow 122
DC Load Flow Sensitivities 123
DC Contingency Analysis 124
DC Quasi-dynamic Simulation 138
VDE/IEC Short-Circuit 103
Complete Short-Circuit 111
ANSI Short-Circuit 112
IEC 61363 114
DC Short-Circuit 117
RMS-Simulation 104
Modal Analysis 128
EMT-Simulation 105
Harmonics/Power Quality 106
Frequency Sweep 127
D-A-CH-CZ Connection Request 139
BDEW/VDE Connection Request 142
Optimal Power Flow 108
DC Optimal Power Flow 130
DC OPF with Contingencies 135
State Estimation 113
Reliability 109
General Adequacy 115
Tie Open Point Opt. 116
Motor Starting Calculation 133
Arc Flash Calculation 129
Optimal Capacitor Placement 126
Voltage Profile Optimisation 125
Backbone Calculation 131
Optimal RCS Placement 132
Optimal Manual Restoration 136
Phase Balance Optimisation 141
User defined calculation 142

R ETURNS
0 On success.
1 On error.

GetAlarmColouringMode
Returns the alarm colouring number for the given or currently valid calculation.
int SetColscheme.GetAlarmColouringMode(str page)

A RGUMENTS
page

349
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

empty for currently valid calculation

set page (see table above)

R ETURNS
The colouring number of ”Alarm” colouring or negative value if not set.

GetColouringMode
Returns the alarm colouring number for the given or currently valid calculation.
int SetColscheme.GetColouringMode(str page)

A RGUMENTS
page
empty for currently valid calculation
set page (see table above)

R ETURNS
The colouring number of ”Others” colouring or negative value if not set.

GetEnergisingColouringMode
Returns the energising status colouring number for the given or currently valid calculation.
int SetColscheme.GetEnergisingColouringMode(str page)

A RGUMENTS
page
empty for currently valid calculation
set page (see table above)

R ETURNS
The colouring number of ”Energising Status” colouring or negative value if not set.

SetColouring
Sets colouring for given or currently valid calculation.
int SetColscheme.SetColouring(str page,
int energizing,
[int alarm,]
[int normal]
)

A RGUMENTS
page
empty set for currently valid calculation
set page for which modes are set (see table below)

350
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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)

351
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Table 5.5.4

Dialog Page Name ”page” value

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

Table 5.5.5

Energizing State Name ”energizing” value

De-energized 33
Out of Calculation 37
De-energised, Planned Outage 61

352
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Table 5.5.6

Alarm Name ”alarm” value

Voltage Violations / Overloading 29
Outages 32
Overloading of Thermal / Peak Short Circuit Current 31
Feeder Radiality Check 38

353
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Table 5.5.7

Other Colouring Name Group ”normal” value

Voltages / Loading Results 1
Voltage Levels Topology 2
Individual Individual 4
Connected Grid Components Topology 5
According to Filter User-defined see notes below table
Grids Groupings 7
Modifications in Variations / System Stages Variations / System Stages 8
Loading of Thermal / Peak Short-Circuit Current Results 9
Paths Groupings 10
System Type AC/DC and Phases Topology 11
Relays, Current and Voltage Transformers Secondary Equipment 12
Fault Clearing Times Results 13
Feeders Topology 14
Switches, Type of Usage Secondary Equipment 15
Measurement Locations Secondary Equipment 16
Missing graphical connections Topology 17
Zones Groupings 18
State Estimation Results 19
Boundaries (Interior Region) Topology 20
Station Connectivity Topology 21
Outage Check Topology 22
Energizing Status Topology 23
Modifications in Recording Expansion Stage Variations / System Stages 24
Areas Groupings 25
Owners Groupings 26
Routes Groupings 27
Operators Groupings 28
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 354 Results 60
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Note: User-defined filters can be set with a “normal” value of 1000 or higher. The first filter in
the list has the value 1000, the next one has 1001 and so on.

R ETURNS
0 error (at least one of the given colourings cannot be set, e.g. not available for
given page). Nothing is changed.
1 ok

SetFilter
Sets filter for given or currently valid calculation.
int SetColscheme.SetFilter(int filter,
[int page]
)
int SetColscheme.SetFilter(DataObject obj,
[int page]
)

A RGUMENTS
filter number of filter to be set
obj user-defined filter to be set

page (optional)
Dialog page number for which filter is set (for numbers see table listed in Set-
Colscheme.CreateFilter())

R ETURNS
0 ok
1 error (filter or page not found)

S EE ALSO

SetColscheme.CreateFilter()

5.5.3 SetDatabase
Overview

EmptyCache

EmptyCache
Empties characteristics cache for this database connection.
None SetDatabase.EmptyCache()

355
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.4 SetDataext
Overview

AddConfiguration
GetConfiguration
GetConfigurations
RemoveAllConfigurations
RemoveConfiguration

AddConfiguration
Adds a new IntAddonvars configuration object for the given classFilter with the descriptiveName
as object name. For the classFilter expressions like Elm* or ElmTr? are possible. If there
already is an object matching classFilter and descriptiveName exactly, this object is returned
instead.
DataObject SetDataext.AddConfiguration(str classFilter, str descriptiveName)

A RGUMENTS
classFilter
The class filter of the IntAddonvars object
descriptiveName
The object name of the IntAddonvars object

R ETURNS
The IntAddonvars object which exactly matches the classFilter and descriptive name or a
newly created one. Returns nothing if the object cannot be modified.

S EE ALSO

IntAddonvars.AddDouble(), IntAddonvars.AddDoubleMatrix(), IntAddonvars.AddDoubleVector(),

IntAddonvars.AddInteger(), IntAddonvars.AddIntegerVector(), IntAddonvars.AddObject(), In-
tAddonvars.AddObjectVector(), IntAddonvars.AddString(), IntAddonvars.RemoveParameter()

GetConfiguration
Returns the IntAddonvars object which exactly matches the classFilter and descriptiveName, if
the latter is specified. If there are multiple matches the first object will be returned. Otherwise
nothing is returned.
DataObject SetDataext.GetConfiguration(str classFilter, [str descriptiveName])

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

356
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

S EE ALSO

IntAddonvars.AddDouble(), IntAddonvars.AddDoubleMatrix(), IntAddonvars.AddDoubleVector(),

IntAddonvars.AddInteger(), IntAddonvars.AddIntegerVector(), IntAddonvars.AddObject(), In-
tAddonvars.AddObjectVector(), IntAddonvars.AddString(), IntAddonvars.RemoveParameter()

GetConfigurations
Returns all IntAddonvars objects by a given classFilter.
list SetDataext.GetConfigurations(str classFilter)
list SetDataext.GetConfigurations()

A RGUMENTS
classFilter
The class filter for the IntAddonvars object

R ETURNS
A list of IntAddonvars objects matching the classFilter exactly. If no filter is specified all
IntAddonvars are returned.

S EE ALSO

IntAddonvars.AddDouble(), IntAddonvars.AddDoubleMatrix(), IntAddonvars.AddDoubleVector(),

IntAddonvars.AddInteger(), IntAddonvars.AddIntegerVector(), IntAddonvars.AddObject(), In-
tAddonvars.AddObjectVector(), IntAddonvars.AddString(), IntAddonvars.RemoveParameter()

RemoveAllConfigurations
Removes all IntAddonvars objects effectively removing all Data Extensions.
None SetDataext.RemoveAllConfigurations()

RemoveConfiguration
Removes the IntAddonvars object exactly matching classFilter and descriptive name.
None SetDataext.RemoveConfiguration(str classFilter, [str descriptiveName])

A RGUMENTS
classFilter
The class filter of the IntAddonvars object

descriptiveName (optional)
The object name of the IntAddonvars object

5.5.5 SetDeskpage
Overview

Close
Show

357
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Close
Closes the graphic page, if currently shown in the graphics board.
int SetDeskpage.Close()

R ETURNS
0 On success, no error occurred.
1 Otherwise

Show
Displays the diagram page in the graphics board.
int SetDeskpage.Show()

R ETURNS
0 On success, no error occurred.
1 Otherwise

5.5.6 SetDesktop
Overview

AddPage
Close
DoAutoScaleX
Freeze
GetActivePage
GetCanvasSize
GetPage
IsFrozen
IsOpened
RemovePage
SetAdaptX
SetAutoScaleX
SetResults
SetScaleX
SetXVar
Show
Unfreeze
WriteWMF
ZoomAll

AddPage
Adds an existing page to a graphics and activates it

• Opens the graphics board if not already open.

• Adds the page if it is not already part of the graphics board.

DataObject SetDesktop.AddPage(DataObject page2add)

358
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
page2add
The page to add to the desktop.
• Page is a plot page (GrpPage or SetVipage): A copy of the page is added.
• Page is an IntGrfnet (Single line graphic, block diagram): The graphic is
added.

R ETURNS
The page displayed or None if the desktop was not changed.

Close
Closes the graphics board, if it is currently shown.
int SetDesktop.Close()

R ETURNS
0 on success
1 on error

DoAutoScaleX
Scales the x-axes of all plots in the graphics board which use the x-axis scale defined in the
graphics board.
None SetDesktop.DoAutoScaleX()

Freeze
Enables the graphical freeze mode, preventing changes to open diagrams.
int SetDesktop.Freeze()

R ETURNS
0 on success
1 on error

GetActivePage
Returns the page object of the currently shown page.
DataObject SetDesktop.GetActivePage()

R ETURNS
Page object of the active page, or 0 if no page is active.

359
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

GetCanvasSize
Returns the pixel dimensions of the currently active (top-most) graphic page.
[int valid
int width,
int height] SetDesktop.GetCanvasSize()

A RGUMENTS
width (out)
Pixel width of the canvas. -1 if no graphics page is open.
height (out)
Pixel height of the canvas. -1 if no graphics page is open.

R ETURNS
0 on success: canvas size could be determined
1 on error: no graphics page is open

GetPage
Searches, activates and returns a graphics page in the currently open graphics board. If “create”
is true, then a new page will be created and added to the graphics board if no page with name
was found.
DataObject SetDesktop.GetPage(str name,
[int create,]
[str class]
)

A RGUMENTS
name Name of the page.
create (optional)
Possible values:
0 do not create new plot page
1 create plot page if it does not exist already
class (optional)
Classname of the plot page object to create: either 'GrpPage' or 'SetVipage'. If
not specified, a 'GrpPage' will be created if the new plot framework is enabled in
the project settings, otherwise a 'SetVipage' will be created.

R ETURNS
Plot page (GrpPage or SetVipage), or network graphic page (SetDeskpage)

IsFrozen
Returns whether the graphical freeze mode is currently enabled.
int SetDesktop.IsFrozen()

360
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

R ETURNS
0 freeze mode is disabled, or the graphics board is not open
1 graphics board is open and freeze mode is enabled

IsOpened
Returns whether the graphics board is currently shown.
int SetDesktop.IsOpened()

R ETURNS
1 if graphics board is shown
0 otherwise

RemovePage
Removes a graphic page. The page to be removed can be identified either by its name or by its
page object.
int SetDesktop.RemovePage(str pageName)
int SetDesktop.RemovePage(DataObject pageObject)

A RGUMENTS
pageName
Name of graphics page.
pageObject
A graphics page object.

R ETURNS
0 on success
1 on error

SetAdaptX
Sets the Adapt Scale option of the x-scale.
None SetDesktop.SetAdaptX(int mode,
[float trigger]
)

A RGUMENTS
mode Possible values:
0 off
1 on
trigger (optional)
Trigger value, unused if mode is off or empty

361
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

SetAutoScaleX
Sets automatic scaling mode of the x-scale. A warning is issued if an invalid mode is passed to
the function.
None SetDesktop.SetAutoScaleX(int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

SetResults
Sets default results object of graphics board.
None SetDesktop.SetResults(DataObject res)

A RGUMENTS
res Result object to set or None to reset. Valid result object is any of class ElmRes,
IntComtrade and IntComtradeset.

SetScaleX
Sets x-axis scale. A function call without arguments sets the Auto Scale setting to On without
changing the scale itself.
None SetDesktop.SetScaleX()
None SetDesktop.SetScaleX(float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of x-scale.

max (optional)
Maximum of x-scale.
log (optional)
Possible values:

0 linear
1 logarithmic

SetXVar
Sets x-axis variable. If The default x-axis variable (time) is set if no argument is passed.

362
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

None SetDesktop.SetXVar()
None SetDesktop.SetXVar(DataObject obj,]
str varname
)

A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj

Show
Shows the virtual instrument panel with the same name as 'pageObject' or the page with
name 'pageName' in the graphics board. The object 'pageObject' is typically a object of class
'SetVipage' (virtual instrument panel) but, as only its name is used, it may be any other type of
object. Calling the function without an argument opens the graphics board.
int SetDesktop.Show()
int SetDesktop.Show(str pageName)
int SetDesktop.Show(DataObject pageObject)

A RGUMENTS
pageName (optional)
Name of graphics page.
pageObject (optional)
A graphics page oject.

R ETURNS
0 on success
1 on error

Unfreeze
Disables the graphical freeze mode, allowing changes to open diagrams.
int SetDesktop.Unfreeze()

R ETURNS
0 on success
1 on error

WriteWMF
Writes the currently open graphic to a windows metafile file (*.wmf).
Please use the Save File command (ComWr) for writing to other formats like *.pdf, *.png, *.svg,
*.emf or *.bmp.
int SetDesktop.WriteWMF(str filename)

363
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
filename Filename without extension.

R ETURNS
0 On error.
1 On success.

ZoomAll
Adjusts the zoom level of the currently active (top-most) graphic page such that the entire
diagram is shown.
int SetDesktop.ZoomAll()

R ETURNS
0 on success
1 on error

5.5.7 SetDistrstate
Overview

CalcCluster

CalcCluster
Calculates a load flow with a given load distribution state applied.
list(int, ...) SetDistrstate.CalcCluster(int clusterIndex,
[int messageOn]
)

A RGUMENTS
clusterIndex
The cluster index. Zero based value, the first cluster has index 0.
messageOn (optional)
Possible values:

0 Do not emit a message in the output window.

1 Emit a message in the output window in case that the function does
not execute properly.

R ETURNS
0 if ok. -1 if load flow of cluster did not converge.

364
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.8 SetFilt
Overview

Get

Get
Returns a container with the filtered objects.
list SetFilt.Get()

R ETURNS
The set of filtered objects.

5.5.9 SetLevelvis
Overview

AdaptWidth
Align
ChangeFont
ChangeFrameAndWidth
ChangeLayer
ChangeRefPoints
ChangeWidthVisibilityAndColour
Mark
Reset

AdaptWidth
This function resizes the in the object specified group of text boxes regarding their text contents.
None SetLevelvis.AdaptWidth()

Align
This function aligns the text within a text box.
None SetLevelvis.Align(int iPos)

A RGUMENTS
iPos Alignment position
0 left
1 middle
2 right

ChangeFont
This function sets the font number for the specified group of text boxes.
None SetLevelvis.ChangeFont(int iFont)

365
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
iFont Font number (default fonts range from 0 to 13)

ChangeFrameAndWidth
This method is not available anymore. Please use SetLevelvis.ChangeWidthVisibilityAndColour()
instead.
list(None, ...) SetLevelvis.ChangeFrameAndWidth([int iFrame,]
[int iWidth,]
[int iVisibility,]
[int iColour]
)

ChangeLayer
This function sets the specified group of text boxes to a given layer.
None SetLevelvis.ChangeLayer(str sLayer)

A RGUMENTS
sLayer Layer name (e.g. 'Object Names', 'Results', 'Invisible Objects',..)

ChangeRefPoints
This function sets the reference points between a text box (second parameter) and its parent
object (first parameter), e.g. if the result box of a busbar shall be shown on top of a drawn
bar instead of below the bar the values change from (6,4) to (4,6). The first number specifies
the reference number of the text box. The integer values describe the position of the reference
points within a rectangle (0=centre, 1=middle right, 2=top right,..):
432
501
678

None SetLevelvis.ChangeRefPoints(int iParRef,

int iTBRef
)

A RGUMENTS
iParRef Defines the reference point on the parent object (e.g. busbar)
iTBRef Defines the reference point on the text box

ChangeWidthVisibilityAndColour
This function sets the visibility of the frame, the width (in number of letters), the visibility and the
colour of text boxes.
None SetLevelvis.ChangeWidthVisibilityAndColour([int iWidth,]
[int iVisibility,]
[int iColour]
)

366
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

A RGUMENTS
iWidth Sets the width in number of letters
0..n width
iVisibility Sets the visibility

0 not visible
1 visible
iColour Sets the colour
0..255 colour

Mark
Marks the specified group of text boxes in the currently shown diagram.
None SetLevelvis.Mark()

Reset
This function resets the individually modified text box settings.
None SetLevelvis.Reset(int iMode)

A RGUMENTS
iMode
0 Reset to default (changed reference points are not reset)
1 Only font
2 Shift to original layer (result boxes to layer 'Results', object names to
layer 'Object Names')

5.5.10 SetParalman
Overview

GetNumSlave
SetNumSlave
SetTransfType

GetNumSlave
To get the number of slaves which is currently configured.
int SetParalman.GetNumSlave()

R ETURNS
the number of slaves which is currently configured.

367
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

SetNumSlave
To configue the number of slaves to be used for parallel computing.
int SetParalman.SetNumSlave(int numSlaves)

A RGUMENTS
numSlaves
Number of slaves to be used for parallel computing

−1 All cores available will be used.

>0 The number of slaves to be used.

R ETURNS
Always return 0.

SetTransfType
To change the data transfer type: via file or via socket communication.
int SetParalman.SetTransfType(int viaFile)

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.11 SetPath
Overview

AllBreakers
AllClosedBreakers
AllOpenBreakers
AllProtectionDevices
Create
GetAll
GetBranches
GetBuses
GetPathFolder

AllBreakers
Returns all breakers in the path definition.
list SetPath.AllBreakers()

368
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

R ETURNS
The set of breakers.

AllClosedBreakers
Returns all closed breakers in the path definition.
list SetPath.AllClosedBreakers()

R ETURNS
The set of closed breakers.

AllOpenBreakers
Returns all open breakers in the path definition.
list SetPath.AllOpenBreakers()

R ETURNS
The set of open breakers.

AllProtectionDevices
Returns all protection devices in the path definition for a given direction.
list SetPath.AllProtectionDevices(int reverse)

A RGUMENTS
reverse
0 Return devices in forward direction.
1 Return devices in reverse direction.

R ETURNS
The set of protection devices.

Create
Creates or extends the path with the elements provided.
DataObject SetPath.Create(list elements)

A RGUMENTS
elements Elements the path shall be created or extended with.

R ETURNS
DataObject Modification was successful.
None Modification failed. (e.g. elements form an incomplete path)

369
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

GetAll
Returns all objects in the path definition.
list SetPath.GetAll()

R ETURNS
The set of objects.

GetBranches
Returns all breanches in the path definition.
list SetPath.GetBranches([int reverse])

A RGUMENTS
reverse (optional)
0 Sort the branches in forward direction.
1 Sort the branches in reverse direction.

R ETURNS
The set of branches.

GetBuses
Returns all busbars and terminals in the path definition.
list SetPath.GetBuses()

R ETURNS
The set of busbars and terminals.

GetPathFolder
Returns the default folder for storing path objects.
DataObject SetPath.GetPathFolder([int create])

A RGUMENTS
create (optional)
0 Return only if the folder exists.
1 Create the folder if it does not exist.

R ETURNS
DataObject Default folder for storing path.
None Default folder does not exist or could not be created.

370
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

5.5.12 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 SetPrj.GetFontID(const char* fontName,
int fontSize,
[int fontStyle = 0])

A RGUMENTS
fontName
Font name
fontSize Font size

fontStyle (optional)
Bitfield if bold, italic and/or underline
0 Regular (no style used
1 Bold
2 Italic
3 Bold and italic
4 Underline

R ETURNS
Returns the font ID. The value is always greater than zero.

SetFontFor
Sets a font for a specified group of text boxes.
None SetPrj.SetFontFor(int sglOrBlock,
int labelResultOrTitle,
int nodesOrBranches,
string fontName,
int fontSize,
int fontStyle)

A RGUMENTS
sglOrBlock
Font settings for single line or block diagrams
0 Single line diagrams
1 Block diagrams
labelResultOrTitle
Type of text box to be modified.

371
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

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.13 SetScenario
Overview

Check
Default
Print

Check
Checks the scenario configuration. The action is identical to pressing the corresponding button
in the dialog.
NB: This function is only available if called on the configuration (SetScenario) of the currently
active project.
int IntScenario.Check()

R ETURNS
0 Ok, check did not reveal any problems
1 Not ok, check found some problems. See the output window for details.

Default
Resets the scenario configuration to the default, built-in configuration. The action is identical to
pressing the corresponding button in the dialog.
NB: This function is only available if no scenario is active and called on the configuration
(SetScenario) of the currently active project.
None IntScenario.Default()

372
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

Print
Prints the scenario configuration to the output window. The action is identical to pressing the
corresponding button in the dialog.
NB: This function is only available if called on the configuration (SetScenario) of the currently
active project.
None IntScenario.Print()

5.5.14 SetSelect
Overview

AddRef
All
AllAsm
AllBars
AllBreakers
AllClosedBreakers
AllElm
AllLines
AllLoads
AllOpenBreakers
AllSym
AllTypLne
Clear
GetAll

AddRef
Adds a reference to the objects to the existing selection.
None SetSelect.AddRef(DataObject O)
None SetSelect.AddRef(list S)

A RGUMENTS
O An object.
S A set of objects.

All
Returns all objects in the selection.
list SetSelect.All()

R ETURNS
The set of objects

AllAsm
Returns all asynchronous machines in the selection.
list SetSelect.AllAsm()

373
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

R ETURNS
The set of objects

AllBars
Returns all busbars and terminals in the selection.
list SetSelect.AllBars()

R ETURNS
The set of objects

AllBreakers
Returns all breakers in the selection.
list SetSelect.AllBreakers()

R ETURNS
The set of objects

AllClosedBreakers
Returns all closed breakers in the selection.
list SetSelect.AllClosedBreakers()

R ETURNS
The set of objects

AllElm
Returns all elements (Elm*) in the selection.
list SetSelect.AllElm()

R ETURNS
The set of containing objects

AllLines
Returns all lines and line routes in the selection.
list SetSelect.AllLines()

R ETURNS
The set of objects

374
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

AllLoads
Returns all loads in the selection.
list SetSelect.AllLoads()

R ETURNS
The set of objects

AllOpenBreakers
Returns all open breakers in the selection.
list SetSelect.AllOpenBreakers()

R ETURNS
The set of objects

AllSym
Returns all synchronous machines in the selection.
list SetSelect.AllSym()

R ETURNS
The set of objects

AllTypLne
Returns all line types in the selection.
list SetSelect.AllTypLne()

R ETURNS
The set of objects

Clear
Clears (deletes) the selection.
None SetSelect.Clear()

GetAll
Returns all objects in the selection which are of the class 'ClassName'.
list SetSelect.GetAll(str ClassName)

A RGUMENTS
ClassName
The object class name.

375
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

R ETURNS
The set of objects

5.5.15 SetTboxconfig
Overview

Check
GetAvailableButtons
GetDisplayedButtons
Purge
SetDisplayedButtons

Check
Checks buttons to be displayed for invalid or duplicate ids and prints error messages.
int SetTboxconfig.Check()

R ETURNS
0 No errors found.
1 Errors found.

GetAvailableButtons
Gets buttons available for selected tool bar.
str SetTboxconfig.GetAvailableButtons()

R ETURNS
String ids of all buttons available for selected tool bar; ids are separated by '\n'.

GetDisplayedButtons
Gets buttons configured to be displayed in selected tool bar.
str SetTboxconfig.GetDisplayedButtons()

R ETURNS
String ids of all buttons configured to be displayed in selected tool bar; ids are separated by
'\n'.

Purge
Purges buttons to be displayed from invalid or duplicate ids.
int SetTboxconfig.Purge()

R ETURNS
0 No problems found.
1 Configuration was adapted.

376
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

SetDisplayedButtons
Sets buttons to be displayed in selected tool bar. Purges given buttons from invalid or duplicate
buttons (duplicate separators or breaks are kept).
int SetTboxconfig.SetDisplayedButtons(str buttonIds)

A RGUMENTS
buttonIds String ids of all buttons to be set as displayed buttons; ids have to be separated
by '\n'

R ETURNS
0 Given buttons were stored without modification.
1 Given buttons were purged from invalid or duplicate ids.

5.5.16 SetTime
Overview

Date
SetTime
SetTimeUTC
Time

Date
Sets date component to current system date.
None SetTime.Date()

S EE ALSO

SetTime.Time(), SetTime.SetTimeUTC()

SetTime
Sets the time in the current year. There is no restriction to the values for H, M and S, except
for the fact that negative values are interpreted as zero. Values higher than 24 or 60 will be
processed normally by adding the hours, minutes and seconds into an absolute time, from
which a new hour-of-year, hour-of-day, minutes and seconds are calculated.
None SetTime.SetTime(float H,
[float M,]
[float S]
)

A RGUMENTS
H The hours
M (optional)
The minutes

S (optional)
The seconds

377
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 SetTime.SetTimeUTC(int time)

A RGUMENTS
time UTC time in seconds since 01.01.1970 00:00 GMT

S EE ALSO

SetTime.Date(), SetTime.Time()

Time
Sets time component to current system time.
None SetTime.Time()

S EE ALSO

SetTime.Date(), SetTime.SetTimeUTC()

5.5.17 SetUser
Overview

GetNumProcesses

GetNumProcesses
This function returns the actual number of processes for parallel computation.
int SetUser.GetNumProcesses()

R ETURNS
The actual number of processes for parallel computation.

5.5.18 SetVipage
Overview

Close
DoAutoScaleX
DoAutoScaleY
GetOrInsertPlot
InsertPlot
MigratePage
SetAdaptX
SetAutoScaleX
SetResults
SetScaleX
SetStyle

378
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 SetVipage.Close()

R ETURNS
0 On success, no error occurred.
1 Otherwise

DoAutoScaleX
Scales the x-axes of all plots on the virtual instrument panel automatically.
None SetVipage.DoAutoScaleX()

DoAutoScaleY
Scales the y-axes of all plots on the virtual instrument panel automatically.
None SetVipage.DoAutoScaleY()

GetOrInsertPlot
Get or create a virtual instrument of the virtual instrument panel.
DataObject SetVipage.GetOrInsertPlot (str name,
[str class,]
[int create]
)

D EPRECATED N AMES
GetVI

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

379
5.5. SETTINGS CHAPTER 5. OBJECT METHODS

InsertPlot
Creates a copy of the virtual instrument passed and displays the copy on this panel.
DataObject SetVipage.InsertPlot(DataObject vi)

D EPRECATED N AMES
CreateVI

A RGUMENTS
vi The virtual instrument which will be copied. Only virtual instruments are allowed
(classname 'Vis*').

R ETURNS
Returns the created virtual instrument.

MigratePage
Converts this SetVipage to the new plot framework introduced in PowerFactory 2021, creating
a GrpPage:

• The original SetVipage will remain unchanged

• The created GrpPage will initially be hidden. Use GrpPage.Show() to make it visible.

None SetVipage.MigratePage()

R ETURNS
The migrated plot page (GrpPage)

SetAdaptX
Sets the Adapt Scale option of the x-scale.
None SetVipage.SetAdaptX(int mode,
[float trigger]
)

A RGUMENTS
mode Possible values:
0 off
1 on
trigger (optional)
Trigger value, unused if mode is off or empty

SetAutoScaleX
Sets automatic scaling mode of the x-scale. A warning is issued if an invalid mode is passed to
the function.
None SetVipage.SetAutoScaleX(int mode)

380
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 SetVipage.SetResults(DataObject res)

A RGUMENTS
res Result object to set or None to reset. Valid result object is any of class ElmRes,
IntComtrade and IntComtradeset.

SetScaleX
Sets x-axis scale. A function call without arguments sets the Auto Scale setting to On without
changing the scale itself.
None SetVipage.SetScaleX()
None SetVipage.SetScaleX(float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

SetStyle
Sets style of virtual instrument panel. A warning message is issued in the case that a style with
the given name does not exist.
None SetVipage.SetStyle(str name)

A RGUMENTS
name Style Name

381
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetTile
Rearranges the virtual instrument on the panel.
None SetVipage.SetTile([int tile])

A RGUMENTS
tile=1 (optional) tile =0 arrange virtual instruments automatically (like tiles)
tile=1 arrange them horizontally

SetXVar
Sets x-axis variable. If The default x-axis variable (time) is set if no argument is passed.
None SetVipage.SetXVar()
None SetVipage.SetXVar(DataObject obj,
str varname
)

A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj

Show
Displays the plot page in the graphics board.
int SetVipage.Show()

R ETURNS
0 On success, no error occurred.
1 Otherwise

5.6 Others

5.6.1 BlkDef
Overview

Check
Compile
Encrypt
GetCheckSum
Pack
PackAsMacro
ResetThirdPartyModule
SetThirdPartyModule

382
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Check
Verify the DSL model equations.
int BlkDef.Check()

R ETURNS
0 BlkDef is OK.
1 Error during parsing.
2 Compiled model, no check is possible.

Compile
Compiles the model to a DLL. Can be called on an already compiled model. A study case of a
project has to be active.
None BlkDef.Compile([string modelPath])

A RGUMENTS
modelPath (optional)
Full path to a location where the model should be stored. Leave empty to use
default.

Encrypt
Encrypts this block definition. It has to be packed as macro before.
int BlkDef.Encrypt([int removeObjectHistory])

A RGUMENTS
removeObjectHistory (optional)
H andling of unencrypted object history in database, e.g. used by project versions
or by undo:
0 Do not remove.
1 Do remove (default).
2 Show dialog and ask.

R ETURNS
0 On success.
1 On error.

S EE ALSO

BlkDef.PackAsMacro()

GetCheckSum
str BlkDef.GetCheckSum()

D EPRECATED N AMES
CalculateCheckSum

383
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
The checksum of the block definition (0000-0000-0000-0000 for frames).

Pack
Copies all used macros (i.e. referenced BlkDef) to this block.
int BlkDef.Pack()

R ETURNS
0 On success.
1 On error.

PackAsMacro
Collects all equations, stores them to this model and deletes block diagram and all macro
references.
int BlkDef.PackAsMacro()

R ETURNS
0 On success.
1 On error.

S EE ALSO

BlkDef.Encrypt()

ResetThirdPartyModule
Resets the third party licence. Only possible for non-encrypted, non-compiled blocks. Requires
masterkey licence for third party module currently set.
int BlkDef.ResetThirdPartyModule()

R ETURNS
0 On success.
1 On error.

SetThirdPartyModule
Sets the third party licence to a specific value. Only possible for non-encrypted, non-compiled
blocks with no third party licence set so far. Requires masterkey licence for third party module
to be set.
int BlkDef.SetThirdPartyModule(str companyCode,
str moduleCode
)

384
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.2 BlkSig
Overview

GetFromSigName
GetToSigName

GetFromSigName
str BlkSig.GetFromSigName()

R ETURNS
The name of the output from which the signal is connected. In cases of no connection, an
empty string.

GetToSigName
str BlkSig.GetToSigName()

R ETURNS
The name of the input to which the signal is connected. In cases of no connection, an empty
string.

5.6.3 ChaVecfile
Overview

Update

Update
Reloads the file from disk. Same behaviour like button update.
int ChaVecfile.Update([int msgOn = 0])

A RGUMENTS
msgOn (optional)
Reporting of errors:
0 No error message is shown in case that the file can not be loaded

385
5.6. OTHERS CHAPTER 5. OBJECT METHODS

(default).
1 Emit an error message in case that the file can not be loaded.

R ETURNS
The number of samples (rows) read from the file.

5.6.4 CimModel
Overview

DeleteParameterAtIndex
GetAttributeEnumerationType
GetModelsReferencingThis
GetParameterCount
GetParameterNamespace
GetParameterValue
HasParameter
RemoveParameter
SetAssociationValue
SetAssociationValue
SetAttributeEnumeration
SetAttributeEnumeration
SetAttributeValue
SetAttributeValue

DeleteParameterAtIndex
Removes the parameter (attribute, or association) value at the given index.
None CimModel.DeleteParameterAtIndex(str parameter, int index)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.profile”)
index Index of the parameter

GetAttributeEnumerationType
Returns the enumeration type of the attribute.
str CimModel.GetAttributeEnumerationType(str attribute)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”GeneratingUnit.genControlSource”)

GetModelsReferencingThis
Returns all CIM models (CimModel) that reference the calling model.
list CimModel.GetModelsReferencingThis()

386
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
CIM models that reference the calling model. The order of the set is undefined.

GetParameterCount
Returns the number of parameters (attribute, or association) of given type.
int CimModel.GetParameterCount(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.profile”)

GetParameterNamespace
Returns the namesace of the parameter (attribute, or association).
str CimModel.GetParameterNamespace(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.profile”)

GetParameterValue
Returns the value of the parameter (attribute, or association) at the given index if available. If the
parameter (attribute, or association) is not available, or the index is out of bounds the function
returns an empty string.
str CimModel.GetParameterValue(str parameter, [int index])

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.modelingAuthoritySet”)
index Index of the parameter:
0 Default index

HasParameter
Checks whether the CimModel has the parameter (attribute, or association) specified.
int CimModel.HasParameter(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.modelingAuthoritySet”)

387
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
1 if parameter is specified
0 if parameter is not specified

RemoveParameter
Removes all occurrences of the parameter (attribute, or association).
None CimModel.RemoveParameter(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.modelingAuthoritySet”)

SetAssociationValue
Adds the association if not available yet, and sets its value at the given index. If the association
is already added, the function sets a new value at the given index only.
None CimModel.SetAssociationValue(str association,
str value,
[int index])

A RGUMENTS
association
Full-name specifier of the association (e.g. ”Model.DependentOn”)
value Value of the association
index Index of the association:

0 Default index

SetAssociationValue
Adds the association if not available yet, and sets its namespace and value. If the association
is already added, the function sets its namespace and value only.
None CimModel.SetAssociationValue(str association,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the association (e.g. ”Model.DependentOn”)

value Value of the association

nspace Namespace of the association (e.g. ”md”)

388
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAttributeEnumeration
Adds the attribute if not available yet, and sets its enumeration type and value. If the attribute is
already added, the function sets its enumeration type and value only.
None CimModel.SetAttributeEnumeration(str attribute,
str enumerationType,
str value)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”GeneratingUnit.genControlSource”)
enumerationType
Enumeration type of the attribute (e.g. ”GeneratorControlSource”)

value Value of the enumeration (e.g. ”offAGC”)

SetAttributeEnumeration
Adds the attribute if not available yet, and sets its namespace, enumeration type and value.
If the attribute is already added, the function sets its namespace, enumeration type and value
only.
None CimModel.SetAttributeEnumeration(str attribute,
str enumerationType,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”GeneratingUnit.genControlSource”)

enumerationType
Enumeration type of the attribute (e.g. ”GeneratorControlSource”)
value Value of the attribute (e.g. ”offAGC”)
nspace Namespace of the attribute (e.g. ”cim”)

SetAttributeValue
Adds the attribute if not available yet, and sets its value at the given index. If the attribute is
already added, the function sets a new value at the given index only.
None CimModel.SetAttributeValue(str attribute,
str value,
[int index])

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”Model.modelingAuthoritySet”)
value Value of the attribute

index Index of the attribute:

0 Default index

389
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 CimModel.SetAttributeValue(str attribute,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”Model.modelingAuthoritySet”)
value Value of the attribute

nspace Namespace of the attribute (e.g. ”md”)

5.6.5 CimObject
Overview

DeleteParameterAtIndex
GetAttributeEnumerationType
GetObjectsReferencingThis
GetObjectsWithSameId
GetParameterCount
GetParameterNamespace
GetParameterValue
GetPfObjects
HasParameter
RemoveParameter
SetAssociationValue
SetAssociationValue
SetAttributeEnumeration
SetAttributeEnumeration
SetAttributeValue
SetAttributeValue

DeleteParameterAtIndex
Removes the parameter (attribute, or association) value at the given index.
None CimObject.DeleteParameterAtIndex(str parameter, int index)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.profile”)
index Index of the parameter

GetAttributeEnumerationType
Returns the enumeration type of the attribute.
str CimObject.GetAttributeEnumerationType(str attribute)

390
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”GeneratingUnit.genControlSource”)

GetObjectsReferencingThis
Returns all CIM objects (CimObject) that reference the calling object. The set of objects returned
is also determined by the DependentOn and Supersedes references set in parent CIM model
objects. In order for a CIM object to reference another CIM object, the parent CIM model of the
former object has to hold a reference to the parent CIM model of the later object.
list CimObject.GetObjectsReferencingThis()

R ETURNS
CIM objects that reference the calling object. The order of the set is undefined.

GetObjectsWithSameId
Returns all CIM objects (CimObject) that have the same Resource ID as this object.
list CimObject.GetObjectsWithSameId()

R ETURNS
CIM objects that have the same Resource ID as this object.

GetParameterCount
Returns the number of parameters (attribute, or association) of given type.
int CimObject.GetParameterCount(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”Model.profile”)

GetParameterNamespace
Returns the namesace of the parameter (attribute, or association).
str CimObject.GetParameterNamespace(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”IdentifiedObject.name”)

391
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetParameterValue
Returns the value of the parameter (attribute, or association) at the given index if available. If the
parameter (attribute, or association) is not available, or the index is out of bounds the function
returns an empty string.
str CimObject.GetParameterValue(str parameter, [int index])

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”IdentifiedObject.name”)

index Index of the parameter:

0 Default index

GetPfObjects
Returns all PF objects that have the same Resource ID as this CIM object.
list CimObject.GetPfObjects()

R ETURNS
PF objects that have the same Resource ID as this CIM object.

HasParameter
Checks whether the CimObject has the parameter (attribute, or association) specified.
int CimObject.HasParameter(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”IdentifiedObject.name”)

R ETURNS
1 if parameter is specified
0 if parameter is not specified

RemoveParameter
Removes all occurrences of the parameter (attribute, or association).
None CimObject.RemoveParameter(str parameter)

A RGUMENTS
parameter
Full-name specifier of the attribute, or association (e.g. ”IdentifiedObject.name”)

392
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAssociationValue
Adds the association if not available yet, and sets its value at the given index. If the association
is already added, the function sets a new value at the given index only.
None CimObject.SetAssociationValue(str association,
str value,
[int index])

A RGUMENTS
association
Full-name specifier of the association (e.g. ”Equipment.EquipmentContainer”)
value Value of the association

index Index of the association:

0 Default index

SetAssociationValue
Adds the association if not available yet, and sets its namespace and value. If the association
is already added, the function sets its namespace and value only.
None CimObject.SetAssociationValue(str association,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the association (e.g. ”Equipment.EquipmentContainer”)
value Value of the association
nspace Namespace of the association (e.g. ”cim”)

SetAttributeEnumeration
Adds the attribute if not available yet, and sets its enumeration type and value. If the attribute is
already added, the function sets its enumeration type and value only.
None CimObject.SetAttributeEnumeration(str attribute,
str enumerationType,
str value)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”GeneratingUnit.genControlSource”)
enumerationType
Enumeration type of the attribute (e.g. ”GeneratorControlSource”)

value Value of the enumeration (e.g. ”offAGC”)

393
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAttributeEnumeration
Adds the attribute if not available yet, and sets its namespace, enumeration type and value.
If the attribute is already added, the function sets its namespace, enumeration type and value
only.
None CimObject.SetAttributeEnumeration(str attribute,
str enumerationType,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”GeneratingUnit.genControlSource”)
enumerationType
Enumeration type of the attribute (e.g. ”GeneratorControlSource”)

value Value of the attribute (e.g. ”offAGC”)

nspace Namespace of the attribute (e.g. ”cim”)

SetAttributeValue
Adds the attribute if not available yet, and sets its value at the given index. If the attribute is
already added, the function sets a new value at the given index only.
None CimObject.SetAttributeValue(str attribute,
str value,
[int index])

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”IdentifiedObject.name”)
value Value of the attribute
index Index of the attribute:

0 Default index

SetAttributeValue
Adds the attribute if not available yet, and sets its namespace and value. If the attribute is
already added, the function sets its namespace and value only.
None CimObject.SetAttributeValue(str attribute,
str value,
str nspace)

A RGUMENTS
attribute Full-name specifier of the attribute (e.g. ”IdentifiedObject.name”)

value Value of the attribute

nspace Namespace of the attribute (e.g. ”cim”)

394
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.6 GrpPage
Overview

ChangeStyle
DoAutoScale
DoAutoScaleX
DoAutoScaleY
GetOrInsertCurvePlot
GetOrInsertDiscreteBarPlot
GetOrInsertModalAnalysisPlot
GetOrInsertVectorPlot
GetOrInsertXYPlot
GetPlot
RemovePage
SetAutoScaleModeX
SetAutoScaleModeY
SetLayoutMode
SetResults
SetScaleTypeX
SetScaleTypeY
SetScaleX
SetScaleY
Show

ChangeStyle
Applies the plot style identified by the given name to all plots on this page.
None GrpPage.ChangeStyle(str styleName)

A RGUMENTS
styleName
Name of the style template to apply

R ETURNS
0 on success
1 on error

DoAutoScale
Adapts axis ranges of all plots on the page such that they show the entire data range.
None GrpPage.DoAutoScale([int axisDimension])

A RGUMENTS
axisDimension (optional)
Limits auto-scaling to one dimension. Possible values:

0 scale only x-axes

1 scale only y-axes

395
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScaleX
Adapts x-axis ranges of all plots on the page such that they show the entire data range.
None GrpPage.DoAutoScaleX()

DoAutoScaleY
Adapts y-axis ranges of all plots on the page such that they show the entire data range.
None GrpPage.DoAutoScaleY()

GetOrInsertCurvePlot
Finds a curve plot by name, or creates it if not found.
DataObject GrpPage.GetOrInsertCurvePlot(str name,
[int create]
)

A RGUMENTS
name Name of plot
create=1 (optional)
Possible values:
0 do not create new plot
1 create plot if it does not exist already

R ETURNS
PltLinebarplot object

GetOrInsertDiscreteBarPlot
Finds a discrete bar plot by name, or creates it if not found. A discrete bar plot is a PltLinebarplot
whose x-axis mode is set to 'Discrete', i.e., it shows net elements on the x-axis.
DataObject GrpPage.GetOrInsertDiscreteBarPlot(str name,
[int create]
)

A RGUMENTS
name Name of plot
create=1 (optional)
Possible values:
0 do not create new plot
1 create plot if it does not exist already

R ETURNS
PltLinebarplot object

396
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetOrInsertModalAnalysisPlot
Finds a modal analysis plot by name, or creates it if not found.
DataObject GrpPage.GetOrInsertModalAnalysisPlot(str name,
int type,
[int create]
)

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=1 (optional)
Possible values:
0 do not create new plot
1 create plot if it does not exist already

R ETURNS
PltLinebarplot (eigenvalue plot, mode bar plot) or PltVectorplot (mode polar plot)

GetOrInsertVectorPlot
Finds a vector plot by name, or creates it if not found.
DataObject GrpPage.GetOrInsertVectorPlot(str name,
[int create]
)

A RGUMENTS
name Name of plot
create=1 (optional)
Possible values:
0 do not create new plot
1 create plot if it does not exist already

R ETURNS
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 GrpPage.GetOrInsertXYPlot(str name,
[int create]
)

397
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
name Name of plot
create=1 (optional)
Possible values:
0 do not create new plot
1 create plot if it does not exist already

R ETURNS
PltLinebarplot object

GetPlot
Returns the plot on this page with the given name.
DataObject GrpPage.GetPlot(str name)

A RGUMENTS
name Name of the plot to look for

R ETURNS
Plot object if found, or NULL otherwise

RemovePage
Closes the graphic page, if currently shown, and deletes it from the database.
int GrpPage.RemovePage()

SetAutoScaleModeX
Defines whether the x-axes on the page should automatically adapt their range on data changes.

None GrpPage.SetAutoScaleModeX(int mode)

A RGUMENTS
mode Possible values:
0 off (do not react to data changes)
1 adapt scale after calculation has finished
2 adapt scale during live plotting

SetAutoScaleModeY
Defines whether the y-axes on the page should automatically adapt their range on data changes.

None GrpPage.SetAutoScaleModeY(int mode)

398
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

SetLayoutMode
Defines the automatic arrangement of plots on the page.
None GrpPage.SetLayoutMode(int mode)

A RGUMENTS
mode Possible values:
0 off (do not arrange plots automatically)
1 arrange plots vertically
2 arrange plots on grid

SetResults
Sets the default results object of page.
None GrpPage.SetResults(DataObject res)

A RGUMENTS
res Result object to set or None to reset. Valid result object is any of class ElmRes,
IntComtrade and IntComtradeset.

SetScaleTypeX
Sets the scale type (linear, logarithmic) of all x-axes on the page.
None GrpPage.SetScaleTypeX(int scaleType)

A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic

SetScaleTypeY
Set the scale type (linear, logarithmic, dB) of all y-axes on the page.
None GrpPage.SetScaleTypeY(int scaleType)

399
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic
2 dB

SetScaleX
Sets the scale of all x-axes on the page.
None GrpPage.SetScaleX(float min,
float max
)

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets the scale of all y-axes on the page.
None GrpPage.SetScaleY(float min,
float max
)

A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.

Show
Displays the diagram page in the graphics board.
int GrpPage.Show()

R ETURNS
0 On success, no error occurred.
1 Otherwise

5.6.7 IntAddonvars

400
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Overview

AddDouble
AddDoubleMatrix
AddDoubleVector
AddInteger
AddIntegerVector
AddObject
AddObjectVector
AddString
RemoveParameter
SetConstraint

AddDouble
Adds a new double parameter to the Data Extension configuration object.
int IntAddonvars.AddDouble(str parameterName,
str desc,
str unitText,
float initialValue
)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
unitText The unit of the new parameter
initialValue
The initial value of the new parameter

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

AddDoubleMatrix
Adds a new double vector parameter to the Data Extension configuration object.
int IntAddonvars.AddDoubleMatrix(str parameterName,
str desc,
int initialRows,
int initialColumns,
str unitText,
float initialValue)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
initialRows
The initial number of rows for the matrix

401
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

AddDoubleVector
Adds a new double vector parameter to the Data Extension configuration object.
int IntAddonvars.AddDoubleVector(str parameterName,
str desc,
int initialSize,
str unitText,
float initialValue
)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter

initialSize The initial size of the vector

unitText The unit of the new parameter
initialValue
The initial value for the elements

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.

AddInteger
Adds a new integer parameter to the Data Extension configuration object.
int IntAddonvars.AddInteger(str parameterName,
str desc,
str unitText,
int initialValue
)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter

402
5.6. OTHERS CHAPTER 5. OBJECT METHODS

unitText The unit of the new parameter

initialValue
The initial value of the new parameter

R ETURNS
Zero if attribute was successfully added. One based row number if there already is a param-
eter with the same name. Returns -1 if the object cannot be modified.

AddIntegerVector
Adds a new integer vector parameter to the Data Extension configuration object.
int IntAddonvars.AddIntegerVector(str parameterName,
str desc,
int initialSize,
str unitText,
int initialValue)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
initialSize The initial size of the vector
unitText The unit of the new parameter

initialValue
The initial value for the elements

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.

AddObject
Adds a new string parameter to the Data Extension configuration object.
int IntAddonvars.AddObject(str parameterName,
str desc,
str classFilter
)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter
classFilter
The filter for the objects which are allowed for selection

403
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Zero if attribute was successfully added. One based row number if there already is a param-
eter with the same name. Returns -1 if the object cannot be modified.

AddObjectVector
Adds a new object vector parameter to the Data Extension configuration object.
int IntAddonvars.AddObjectVector(str parameterName,
str desc,
int initialSize,
str classFilter
)

A RGUMENTS
parameterName
The name of the new parameter

desc The description of the new parameter

initialSize The initial size of the vector
classFilter
The filter for the objects which are allowed for selection

R ETURNS
Zero if attribute was successfully added. One based row number if there already is a param-
eter with the same name.

AddString
Adds a new string parameter to the Data Extension configuration object.
int IntAddonvars.AddString(str parameterName,
str desc,
str unitText,
str initialValue
)

A RGUMENTS
parameterName
The name of the new parameter
desc The description of the new parameter

unitText The unit of the new parameter

initialValue
The initial value of the new parameter

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

404
5.6. OTHERS CHAPTER 5. OBJECT METHODS

RemoveParameter
Removes the given parameter from the Data Extension configuration.
None IntAddonvars.RemoveParameter(str parameterName)

A RGUMENTS
parameterName
The name of the parameter to be removed

SetConstraint
Adds a constraint for the parameter to the Data Extension configuration object.
The arguments passed must be convertible into the configured data type for the parameter.
Upper and lower bounds are mutually exclusive with a list of values. An empty string should be
passed when a constraint should not be used or removed.
int IntAddonvars.SetConstraint(str parameterName,
str minValue,
str maxValue,
str allowedValues
)

A RGUMENTS
parameterName
The name of the parameter to be modified

minValue The minimum value

maxValue
The maximum value
allowedValues
List of the allowed values (;-separated)

R ETURNS
0 ok
-1 error (parameter does not exist)
-2 error (upper/lower bounds and list of values are mutually exclusive)
-3 error (underlying type does not support constraints)
-4 error (upper/lower bounds cannot be used for strings)
-5 error (the values passed cannot be converted into the underlying type)

5.6.8 IntCase
Overview

Activate
ApplyNetworkState
ApplyStudyTime
Consolidate
Deactivate
SetStudyTime
405
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Activate
Activates the study case. Deactivates other study cases first.
int IntCase.Activate()

R ETURNS
0 on success
1 on error

ApplyNetworkState
For a study case in a combined project, copy the network state from another case.
Copies the active grids, scenarios and network variations configuration to the current case. The
data will be added to any already existing configuration.
int IntCase.ApplyNetworkState(DataObject other)

A RGUMENTS
other The source Study Case to copy data from

R ETURNS
0 On success
1 Source object is not an IntCase object
2 Case where function is called on is not the active case
3 Source case is not from active project
4 Source Study Case is not from a source project in a combined project
5 Other error. Details are given in an error message

ApplyStudyTime
For a study case in a combined project, apply the study time from another study case.
int IntCase.ApplyStudyTime(DataObject other)

A RGUMENTS
other The source study case to copy study time from

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

406
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Consolidate
Changes that are recorded in a project’s active Variations are permanently applied to the Net-
work Data folder (like right mouse button Consolidate Network Variation)
Note: Modified scenarios are not saved!
Works only:

• For active study cases

• If a network variation is active

int IntCase.Consolidate()

R ETURNS
0 On success
1 If an error has occured

S EE ALSO

IntScheme.Consolidate()

Deactivate
De-activates the study case.
int IntCase.Deactivate()

R ETURNS
0 on success
1 on error

SetStudyTime
Sets the current Study Case time to seconds since 01.01.1970 00:00:00. Use IntCase:iStudyTime
for getting current Study Case time.
None IntCase.SetStudyTime(int dateTime)

A RGUMENTS
dateTime Seconds since 01.01.1970 00:00:00.

5.6.9 IntComtrade
Overview

ConvertToASCIIFormat
ConvertToBinaryFormat
FindColumn
FindMaxInColumn
FindMinInColumn
GetAnalogueDescriptions
GetColumnValues

407
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetDescription
GetDigitalDescriptions
GetNumberOfAnalogueSignalDescriptions
GetNumberOfColumns
GetNumberOfDigitalSignalDescriptions
GetNumberOfRows
GetObjectValue
GetSignalHeader
GetUnit
GetValue
GetVariable
Load
Release
SortAccordingToColumn

ConvertToASCIIFormat
Creates new comtrade configuration and data files in ASCII format in the file system directory of
the original files. The new configuration file is linked automatically to a new IntComtrade object
created in the same PowerFactory folder like this object. An existing IntComtrade object is
already in ASCII format when its parameter ’Binary’ is set to 0.
int IntComtrade.ConvertToASCIIFormat()

R ETURNS
0 File successfully converted.
1 Error occurred, e.g. file is already in ASCII format.

ConvertToBinaryFormat
Creates new comtrade configuration and data files in binary format in the file system directory of
the original files. The new configuration file is linked automatically to a new IntComtrade object
created in the same PowerFactory folder like this object. An existing IntComtrade object is
already in binary format when its parameter ’Binary’ is set to 1.
int IntComtrade.ConvertToBinaryFormat()

R ETURNS
0 File successfully converted.
1 Error occurred, e.g. file is already in binary format.

FindColumn
Returns the first column matching the variable name.
int IntComtrade.FindColumn(str variable,
[int startCol]
)

A RGUMENTS
variable The variable name to look for.
startCol (optional)
The index of the column at which to start the search.

408
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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] IntComtrade.FindMaxInColumn(int column)

A RGUMENTS
column The column index.

value (optional, out)

The maximum value found. The value is 0. in case that the maximum value was
not found.

R ETURNS
<0 The maximum value of column was not found.
≥0 The row with the maximum value of the column.

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

A RGUMENTS
column The column index.
value (optional, out)
The minimum value found. The value is 0. in case that the minimum value was
not found.

R ETURNS
<0 The minimum value of column was not found.
≥0 The row with the minimum value of the column.

GetAnalogueDescriptions
Get the descriptions of the analogue channel Please note that the comtrade info file contains
proprietary data from PFM. Info files not written by DIgSILENT PFM are not supported.
str IntComtrade.GetAnalogueDescriptions(int index)

A RGUMENTS
index) Digital channel index

409
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Descriptions for analogue channel in the comtrade info file.

GetColumnValues
Get complete column values.
int IntComtrade.GetColumnValues(DataObject dataVector,
int column)

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

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

GetDescription
Get the description of a column.
str IntComtrade.GetDescription([int column],
[int short]
)

A RGUMENTS
column (optional)
The column index. The description name of the default variable is returned if the
parameter is nor passed to the function.
short (optional)
0 long desc. (default)
1 short description

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

GetDigitalDescriptions
Get the descriptions of the digital channel Please note that the comtrade info file contains
proprietary data from PFM. Info files not written by DIgSILENT PFM are not supported.
str IntComtrade.GetDigitalDescriptions(int index)

A RGUMENTS
index Digital channel index

410
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Descriptions for digital channel in the comtrade info file.

GetNumberOfAnalogueSignalDescriptions
Gets the number of descriptions for analogue channels in the comtrade info file. Please note that
the comtrade info file contains proprietary data from PFM. Info files not written by DIgSILENT
PFM are not supported.
int IntComtrade.GetNumberOfAnalogueSignalDescriptions()

R ETURNS
Number of descriptions for analogue channels in the comtrade info file.

GetNumberOfColumns
Returns the number of variables (columns) in result file excluding the default variable (e.g. time
for time domain simulation).
int IntComtrade.GetNumberOfColumns()

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

GetNumberOfDigitalSignalDescriptions
Get the number of descriptions for digital channels in the comtrade info file. Please note that
the comtrade info file contains proprietary data from PFM. Info files not written by DIgSILENT
PFM are not supported.
int IntComtrade.GetNumberOfDigitalSignalDescriptions()

R ETURNS
Number of descriptions for digital channels in the comtrade info file.

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

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

GetObjectValue
Returns a value from a result object for row iX of curve col.
[int error,
DataObject o ] IntComtrade.GetObjectValue(int iX,
[int col])

411
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
o (out) The object retrieved from the data.
iX The row.
col (optional)
The curve number, which equals the variable or column number, first column value
(time,index, etc.) is returned when omitted.

R ETURNS
0 when ok
1 when iX out of bound
2 when col out of bound
3 when invalid value is returned from a sparse file. Sparse files are written e.g.
by the contingency analysis, the value is invalid in case that it was not written,
because it was below the recording limit. Result files created using DPL/Python
are always full and will not return invalid values.

GetSignalHeader
Get the headline of the channel section in the comtrade info file. Please note that the comtrade
info file contains proprietary data from PFM. Info files not written by DIgSILENT PFM are not
supported.
str IntComtrade.GetSignalHeader()

R ETURNS
Headline of signal descriptions

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

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

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

GetValue
Returns a value from a result object for row iX of curve col.
[int error,
float d ] IntComtrade.GetValue(int iX,
[int col])

412
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 IntComtrade.GetVariable([int column])

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

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

Load
Loads the data of a result object (IntComtrade) in memory for reading.
None IntComtrade.Load()

Release
Releases the data loaded to memory. This function should be used whenever several result
objects are processed in a loop. Data is always released from memory automatically after
execution of the current script.
None IntComtrade.Release()

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The IntComtrade itself remains
unchanged.
int IntComtrade.SortAccordingToColumn(int column)

413
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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.10 IntComtradeset
Overview

FindColumn
FindMaxInColumn
FindMinInColumn
GetAnalogueDescriptions
GetColumnValues
GetDescription
GetDigitalDescriptions
GetNumberOfAnalogueSignalDescriptions
GetNumberOfColumns
GetNumberOfDigitalSignalDescriptions
GetNumberOfRows
GetObjectValue
GetSignalHeader
GetUnit
GetValue
GetVariable
Load
Release
SortAccordingToColumn

FindColumn
Returns the first column matching the variable name.
int IntComtradeset.FindColumn(str variable,
[int startCol]
)

A RGUMENTS
variable The variable name to look for.
startCol (optional)
The index of the column at which to start the search.

R ETURNS
≥0 The column index found.
<0 The column with name variable was not found.

414
5.6. OTHERS CHAPTER 5. OBJECT METHODS

FindMaxInColumn
Find the maximum value of the variable in the given column.
[int row,
float value] IntComtradeset.FindMaxInColumn(int column)

A RGUMENTS
column The column index.
value (optional, out)
The maximum value found. The value is 0. in case that the maximum value was
not found.

R ETURNS
<0 The maximum value of column was not found.
≥0 The row with the maximum value of the column.

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

A RGUMENTS
column The column index.
value (optional, out)
The minimum value found. The value is 0. in case that the minimum value was
not found.

R ETURNS
<0 The minimum value of column was not found.
≥0 The row with the minimum value of the column.

GetAnalogueDescriptions
Get the descriptions of the analogue channel Please note that the comtrade info file contains
proprietary data from PFM. Info files not written by DIgSILENT PFM are not supported.
str IntComtradeset.GetAnalogueDescriptions(int index)

A RGUMENTS
index) Digital channel index

R ETURNS
Descriptions for analogue channel in the comtrade info file.

GetColumnValues
Get complete column values.
int IntComtradeset.GetColumnValues(DataObject dataVector,
int column)

415
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 IntComtradeset.GetDescription([int column],
[int short]
)

A RGUMENTS
column (optional)
The column index. The description name of the default variable is returned if the
parameter is nor passed to the function.
short (optional)
0 long desc. (default)
1 short description

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

GetDigitalDescriptions
Get the descriptions of the digital channel Please note that the comtrade info file contains
proprietary data from PFM. Info files not written by DIgSILENT PFM are not supported.
str IntComtradeset.GetDigitalDescriptions(int index)

A RGUMENTS
index Digital channel index

R ETURNS
Descriptions for digital channel in the comtrade info file.

GetNumberOfAnalogueSignalDescriptions
Gets the number of descriptions for analogue channels in the comtrade info file. Please note that
the comtrade info file contains proprietary data from PFM. Info files not written by DIgSILENT
PFM are not supported.
int IntComtradeset.GetNumberOfAnalogueSignalDescriptions()

416
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

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

GetNumberOfDigitalSignalDescriptions
Get the number of descriptions for digital channels in the comtrade info file. Please note that
the comtrade info file contains proprietary data from PFM. Info files not written by DIgSILENT
PFM are not supported.
int IntComtradeset.GetNumberOfDigitalSignalDescriptions()

R ETURNS
Number of descriptions for digital channels in the comtrade info file.

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

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

GetObjectValue
Returns a value from a result object for row iX of curve col.
[int error,
DataObject o ] IntComtradeset.GetObjectValue(int iX,
[int col])

A RGUMENTS
o (out) The object retrieved from the data.

iX The row.
col (optional)
The curve number, which equals the variable or column number, first column value
(time,index, etc.) is returned when omitted.

417
5.6. OTHERS 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.

GetSignalHeader
Get the headline of the channel section in the comtrade info file. Please note that the comtrade
info file contains proprietary data from PFM. Info files not written by DIgSILENT PFM are not
supported.
str IntComtradeset.GetSignalHeader()

R ETURNS
Headline of signal descriptions

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

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

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

GetValue
Returns a value from a result object for row iX of curve col.
[int error,
float d ] IntComtradeset.GetValue(int iX,
[int col])

A RGUMENTS
d (out) The value retrieved from the data.
iX The row.
col (optional)
The curve number, which equals the variable or column number, first column value
(time,index, etc.) is returned when omitted.

418
5.6. OTHERS 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 IntComtradeset.GetVariable([int column])

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

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

Load
Loads the data of a result object (IntComtradeset) in memory for reading.
None IntComtradeset.Load()

Release
Releases the data loaded to memory. This function should be used whenever several result
objects are processed in a loop. Data is always released from memory automatically after
execution of the current script.
None IntComtradeset.Release()

SortAccordingToColumn
Sorts all rows in the data loaded according to the given column. The IntComtradeset itself
remains unchanged.
int IntComtradeset.SortAccordingToColumn(int column)

A RGUMENTS
col The column number.

419
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

AddRef
All
Clear
GetAll

AddRef
Adds new reference(s) for passed object(s) as children to the dataset object. Nothing happens
if there exists already a reference for the passed object.
None IntDataset.AddRef(DataObject object)
None IntDataset.AddRef(list objects)

A RGUMENTS
obj/objects
Object(s) for which references should be created and added to the dataset object

All
Returns all children of the dataset object.
list IntDataset.All()

R ETURNS
All objects contained in dataset object.

Clear
Deletes all children of the dataset object.
None IntDataset.Clear()

GetAll
Returns all children of the dataset filtered according to given class name.
list IntDataset.GetAll(str className)

A RGUMENTS
className
class name filter, e.g. ElmTerm

420
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
All objects of given class stored in dataset object.

5.6.12 IntDocument
Overview

Export
Import
Reset
View

Export
Exports the embedded data as new file on disk. The embedded data remains unmodified. If
desired it can be removed by calling the Reset() function afterwards
int IntDocument.Export(str filename)

A RGUMENTS
filename Name of export file on disk

R ETURNS
0 On success.
1 On error.

S EE ALSO

IntDocument.Import()

Import
Imports the content of selected file into the PowerFactory object. The data is afterwards em-
bedded in the PowerFactory database.
int IntDocument.Import()

R ETURNS
0 On success.
1 On error.

S EE ALSO

IntDocument.Export()

Reset
Resets embedded data and reference to an external file.
int IntDocument.Reset()

421
5.6. OTHERS CHAPTER 5. OBJECT METHODS

View
Views the file in external application. If the file is embedded, it’s extracted into a temporary file
that is opened afterwards. Please note, the action is only executed if access to given file (type)
is enabled in the 'External Access' configuration of PowerFactory (IntExtaccess).
int IntDocument.View()

R ETURNS
0 Success, file was opened
1 Error, file not opened (because of invalid address or security reasons)

S EE ALSO

IntUrl.View()

5.6.13 IntDplmap
Overview

Clear
Contains
First
GetValue
Insert
Next
Remove
Size
Update

Clear
Removes all key/value pairs from the container and resets type information.
None IntDplmap.Clear()

Contains
Checks if a key/value pair with given key is contained in the container.
int IntDplmap.Contains(int | float | str | DataObject | list key)

A RGUMENTS
key Key of the associated pair in the container

R ETURNS
1 if an entry of same key is contained, otherwise 0.

First
Outputs the first key/value pair stored in the container.
Note:

422
5.6. OTHERS CHAPTER 5. OBJECT METHODS

• The sequence of the returned pairs is determined by internal criteria and cannot be
changed.
• It is not allowed to modify a container while iterating over it. If doing so, the next call of the
Next command will return a value of 1.
Exception: Update() does not invalidate current position.

[int end,
int | float | str | DataObject | list key
int | float | str | DataObject | list value] IntDplmap.First()

A RGUMENTS
key (out) Key of the associated pair in the container
value (out)
Value of the associated pair in the container

R ETURNS
1 if no next entry is available in the container (e.g. end is reached), otherwise 0.

GetValue
Returns the associated value for given key.
[int|float|str|DataObject|list value,
int error] IntDplmap.GetValue(int|float|str|DataObject|list key)

A RGUMENTS
key Key of the associated pair in the container to find.
error (optional, out)
1 Key was not found in container.
0 Key was found in the container.

R ETURNS
The value which is associated to the given key or an undefined value if key is not associated
with any value.

Insert
Inserts given key and value as an associated pair into the container.
On the first insertion, the container is (automatically) typed by given data types of key and value.
From now on, only keys and values of that types are accepted. (This type information is removed
when IntDplmap.Clear() is called.)
If given key already exists in the container, its associated value will be overwritten. (Each key
can only be contained once in a map (no multi-map support).)
Note:

• Type of key and value can be different, of course.

• Sets are always inserted by value, not by reference!

None IntDplmap.Insert (int | float | str | DataObject | list key,

int | float | str | DataObject | list value)

423
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
key Key of the associated pair in the container.
value Value of the associated pair in the container.

Next
Outputs the next key/value pair relative to the last key/value pair in the container.
Note:

• The sequence of the returned pairs is determined by internal criteria and cannot be
changed.
• It is not allowed to modify a container while iterating over it. If doing so, the next call of the
Next command will return a value of 1.
Exception: Update() does not invalidate current position.

[int end,
int | float | str | DataObject | list key
int | float | str | DataObject | list value] IntDplmap.Next()

A RGUMENTS
key (out) Key of the associated pair in the container.
value (out)
Value of the associated pair in the container.

R ETURNS
1 if no next entry is available in the container (e.g. end is reached), otherwise 0.

Remove
Removes the key/value pair for given key from the container. No error will occur, if the key is not
contained in the container.
None IntDplmap.Remove (int | float | str | DataObject | list key)

A RGUMENTS
key Key of the associated pair in the container

Size
Returns the number of key/value pairs stored in the container.
int IntDplmap.Size()

R ETURNS
Number of key-value pairs stored in the container.

424
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Update
Is a special insert function that can be used for updating key/value pairs in the map. It can only
be used if the key is already contained in the map.
None IntDplmap.Update(int | float | str | DataObject | list key,
int | float | str | DataObject | list value)

A RGUMENTS
key Key of the associated pair in the container
value Value of the associated pair in the container

5.6.14 IntDplvec
Overview

Clear
Get
IndexOf
Insert
Remove
Size
Sort

Clear
Removes all elements from the container and resets the typ information.
None IntDplvec.Clear()

Get
Returns the element stored at given position in the container.
int|float|str|DataObject|list IntDplvec.Get(int position)

A RGUMENTS
position Position in the container. It is zero-based and must always be lesser than the
container’s size.

R ETURNS
Element stored at given position in the container.

IndexOf
Returns the position where the given element is stored in the container.
int IntDplvec.IndexOf(int|float|str|DataObject|list element,
[int startPosition]
)

425
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
element Element for which the position will be searched.
startPosition
Start position from which the next occurrence greater or equal to this position is
searched.

R ETURNS
Position of the the given element in the container. The returned position is zero-based. If no
occurrence was found, -1 is returned.

Insert
Inserts an element at given position into the container. If no position is given then the element
is appended to the back. Inserting an element to an empty container fixes the type of elements
which can be hold by itself. Clearing the container resets this type information.
None IntDplvec.Insert(int|float|str|DataObject|list element)
None IntDplvec.Insert(int position,
int|float|str|DataObject|list element
)

A RGUMENTS
element Element to be inserted.
position Position (zero-based) to insert the element at. Any old entry at that position will
be overwritten. Note: The size of the vector is automatically increased if given
position is greater than current size.

Remove
Removes the element stored at given position from the container.
None IntDplvec.Remove(int position)

A RGUMENTS
position Given position (zero-based) at which the element is to be removed.

Size
Returns the number of elements stored in the container.
int IntDplvec.Size()

R ETURNS
Number of elements stored in the container.

Sort
Sorts the elements of the vector depending on the type of elements stored inside the vector:

426
5.6. OTHERS CHAPTER 5. OBJECT METHODS

string lexically

double/int
according to value
object according to full name (path + name) or given attribute

None IntDplvec.Sort([int descending,]

[str attribute]
)

A RGUMENTS
descending (optional)
1 Descending sorting order
0 Ascending sorting order (default)
attribute (optional)
For objects only: Attribute according to which the sorting is done (default is full
name)

5.6.15 IntEvt
Overview

CreateCBEvents
RemoveSwitchEvents

CreateCBEvents
Create boundary breaker events for all shc locations which occur simultaneously in this fault
case.
None IntEvt.CreateCBEvents([int iRemoveExisting])

A RGUMENTS
iRemoveExisting (optional)
-1 Query user if circuit breaker events exist.
0 Do not create circuit breaker events if circuit breaker events are already
defined events exist (default)
1 Remove existing circuit breaker events.

RemoveSwitchEvents
Remove all switch events of this fault case.
None IntEvt.RemoveSwitchEvents([int onlyContingency])

A RGUMENTS
onlyContingency (optional)
Condition to remove.
0 Remove all switch events regardless of the calculation type.

427
5.6. OTHERS CHAPTER 5. OBJECT METHODS

1 Remove all switch events only when this fault case is used for contin-
gency analysis.

5.6.16 IntExtaccess
Overview

CheckUrl

CheckUrl
Checks whether access to given url will be granted or not according to the security settings.
See also IntUrl.View() for accessing that url.
int IntExtaccess.CheckUrl(str url)

A RGUMENTS
url url to check

R ETURNS
0 access granted
1 access denied

5.6.17 IntGate
Overview

AddTrigger

AddTrigger
Adds either a condition or a gate to the gate.
list IntGate.AddTrigger(DataObject newTrigger)

A RGUMENTS
newTrigger
The condition or gate that shall be added.

5.6.18 IntGrf
Overview

MoveToLayer

428
5.6. OTHERS CHAPTER 5. OBJECT METHODS

MoveToLayer
Moves an IntGrf object to the selected target layer, provided that the object is a valid object
for that layer. Annotation elements stored as (obsolete) IntGrf objects can be moved to any
annotation layer (IntGrflayer ) or group (IntGrfgroup).
None IntGrf.MoveToLayer(DataObject layer)

A RGUMENTS
layer Target IntGrflayer or IntGrfgroup object.

5.6.19 IntGrfgroup
Overview

ClearData
Export
Import

ClearData
Removes all annotation elements from this group.
None IntGrfgroup.ClearData()

Export
Exports all objects of a group into svg-file.
None IntGrfgroup.Export(str path,
[int OpenDialog])

A RGUMENTS
path Full export file path
OpenDialog (optional)
Prompt for export path in dialog
0 Export directly and do not show any dialog (default)
1 Show dialog with path before exporting

Import
Imports svg-file into group object.
None IntGrfgroup.Import(str path)

A RGUMENTS
path Path of file to be imported.

429
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.20 IntGrflayer
Overview

AdaptWidth
Align
ChangeFont
ChangeLayer
ChangeRefPoints
ChangeWidthVisibilityAndColour
ClearData
Export
ExportToVec
Import
ImportFromVec
Mark
Reset

AdaptWidth
Resizes the specified group of text boxes regarding their maximum text length.
None IntGrflayer.AdaptWidth(int objectType,
[str symbolName])

A RGUMENTS
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

Align
Aligns the text within a text box.
None IntGrflayer.Align(int alignPos,
int objectType,
[string symbolName])

A RGUMENTS
alignPos Alignment within bounding box
0 left
1 middle
2 right
objectType
Object type

430
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 IntGrflayer.ChangeFont(str fontName,
int fontSize,
int fontStyle,
int objectType,
[str symbolName])

A RGUMENTS
fontName
Font name
fontSize Font size
fontStyle Font style

0 Regular
1 Bold
2 Italic
3 Bold and Italic
4 Underline
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
symbolName
Symbol name (only relevant if objectType == 3)

ChangeLayer
Sets the specified group of text boxes to a given layer.
None IntGrflayer.ChangeLayer(DataObject newLayer,
int objectType,
[str symbolName])

431
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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)

ChangeRefPoints
Sets the reference points between a text box (second parameter) and its parent object (first
parameter), e.g. if the result box of a busbar shall be shown on top of a drawn bar instead of
below the bar the values change from (6,4) to (4,6). The first number specifies the reference
number of the text box. The integer values describe the position of the reference points within a
rectangle (0=centre, 1=middle right, 2=top right,..):
432
501
678

None IntGrflayer.ChangeRefPoints(int parentRef,

int textBoxRef,
int objectType,
[str symbolName])

A RGUMENTS
parentRef
Defines the reference point on the parent object (e.g. busbar)
textBoxRef
Defines the reference point on the text box
objectType
Object type

0 Nodes and branches

1 Nodes
2 Branches
3 Symbol dependent

symbolName
Symbol name (only relevant if objectType == 3)

432
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ChangeWidthVisibilityAndColour
Sets the visibility of the frame, the width (in number of letters), the visibility and the colour of text
boxes.
None IntGrflayer.ChangeWidthVisibilityAndColour(int objectType,
[string symbolName],
[int columns],
[int visibility],
[int colorNumber])

A RGUMENTS
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches
3 Symbol dependent
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

ClearData
Removes all annotation elements on this layer (keeps contained groups and annotation ele-
ments).
None IntGrflayer.ClearData()

Export
Exports all objects of a layer into svg-file, inclusive annotation objects of contained group
objects.
None IntGrflayer.Export(str path,
[int OpenDialog])

433
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
path Full export file path
OpenDialog (optional)
Prompt for export path in dialog
0 Export directly and do not show any dialog (default)
1 Show dialog with path before exporting

ExportToVec
Fills string description of annotation elements of this layer into an IntDplvec. Clears IntDplvec
before filling it.

A RGUMENTS
intDplVec IntDplvec object to be filled.

Import
Imports svg file into layer.
None IntGrflayer.Import(str path)

A RGUMENTS
path Path of file to be imported.

ImportFromVec
Fills this layer with the string description of annotation elements from an IntDplvec. Clears layer
before filling it.

A RGUMENTS
intDplVec IntDplvec containg description of annotation elements.

Mark
Marks the specified group of text boxes in the currently shown diagram.
None IntGrflayer.Mark(int objectType,
[string symbolName])

A RGUMENTS
objectType
Object type
0 Nodes and branches
1 Nodes
2 Branches

434
5.6. OTHERS CHAPTER 5. OBJECT METHODS

3 Symbol dependent

symbolName
Symbol name (only relevant if objectType == 3)

Reset
Resets the individually modified text box settings.
None IntGrflayer.Reset(int mode,
int objectType,
[str symbolName])

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)

5.6.21 IntGrfnet
Overview

Close
SetFontFor
SetLayerVisibility
SetSymbolComponentVisibility
Show

Close
Closes the graphic page that displays this diagram.
int IntGrfnet.Close()

R ETURNS
0 On success, no error occurred.
1 Otherwise

435
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetFontFor
Sets a font for a specified group of text boxes.
None IntGrfnet.SetFontFor(int labelResultOrTitle,
int nodesOrBranches,
str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
labelResultOrTitle
Type of text box to be modified.
0 Labels
1 Results
2 Title and Legends
nodesOrBranches
Type of parent object
0 Nodes
1 Branches
fontName
Font name
fontSize Font size
fontStyle Font style
1 Bold
2 Italic
3 Bold and italic
4 Underline

SetLayerVisibility
Sets a layer visible or invisible.
None IntGrfnet.SetLayerVisibility(str sLayer,
int iVis)

A RGUMENTS
sLayer Layer to be modified.
iVis Visibility
0 Make layer invisible.
1 Make layer visible.

SetSymbolComponentVisibility
Determines which parts of net element symbols are shown in the diagram.
None IntGrfnet.SetSymbolComponentVisibility(int componentID,
int visible)

436
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
componentID
Component to be modified.
5 Connection points
7 Tap positions
8 Vector groups
9 Load flow arrows
11 Phases
13 Line sections and loads
14 Connection arrows
21 Connection numbers (block diagrams only)
22 Connection names (block diagrams only)
33 Remotely controlled substation markers
38 Tie open point markers
39 Open standby switch markers
40 Normally open switch markers
visible Visibility
0 Make component invisible.
1 Make component visible.

Show
Opens a diagram.
int IntGrfnet.Show()

R ETURNS
0 On success, no error occurred.
1 Otherwise

5.6.22 IntIcon
Overview

Export
Import

Export
Exports current icon as a bitmap file.
int IntIcon.Export(str filename)

A RGUMENTS
filename Name of export image on disk. Extension needs to be ’.bmp’

437
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 On success.
1 On error.

S EE ALSO

IntIcon.Import()

Import
Imports icon from a bitmap file.
int IntIcon.Import(str filename)

A RGUMENTS
filename Name of bitmap file on disk. Extension and format needs to be ’.bmp’

R ETURNS
0 On success.
1 On error.

S EE ALSO

IntIcon.Export()

5.6.23 IntLibrary
Overview

Activate
Deactivate

Activate
Activates this library. If another library is already activated it will be deactivated first.
int IntLibrary.Activate()

R ETURNS
1 if successful
0 otherwise

Deactivate
Deactivates this library.
int IntLibrary.Deactivate()

R ETURNS
1 if successful
0 otherwise

438
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.24 IntMat
Overview

ColLbl
Get
GetColumnLabel
GetColumnLabelIndex
GetNumberOfColumns
GetNumberOfRows
GetRowLabel
GetRowLabelIndex
Init
Invert
Multiply
Resize
RowLbl
Save
Set
SetColumnLabel
SetRowLabel
SortToColumn

ColLbl
Deprecated function to get or set the label of the given column. Please use IntMat.GetColumnLabel()
or IntMat.SetColumnLabel() instead.
str IntMat.ColLbl(int column)
str IntMat.ColLbl(str label,
int column
)

Get
Returns the value at the position (row, column) of the matrix. A run-time error will occur when
'row' or 'column' is out of range.
float IntMat.Get(int row,
int column
)

A RGUMENTS
row Row in matrix: 1 ... GetNumberOfRows().

column column in matrix: 1 ... GetNumberOfColumn()

R ETURNS
Value in matrix.

S EE ALSO

IntMat.Set()

439
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetColumnLabel
Returns the label of a column.
str IntMat.GetColumnLabel(int column)

A RGUMENTS
column Column index (first column has index 1).

R ETURNS
Column label of given column.

D EPRECATED N AMES
ColLbl

S EE ALSO

IntMat.SetColumnLabel(), IntMat.GetColumnLabelIndex(), IntMat.GetRowLabel()

GetColumnLabelIndex
Gets the index of a label in all column labels.
int IntMat.GetColumnLabelIndex(str label)

A RGUMENTS
label Label to search.

R ETURNS
≥1 The index in the column labels, if label was found.
0 Otherwise

S EE ALSO

IntMat.GetColumnLabel()

GetNumberOfColumns
Returns the number of columns in the matrix.
int IntMat.GetNumberOfColumns()

R ETURNS
The number of columns of the matrix.

D EPRECATED N AMES
NCol, SizeY

S EE ALSO

IntMat.GetNumberOfRows()

440
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetNumberOfRows
Returns the number of rows in the matrix.
int IntMat.GetNumberOfRows()

R ETURNS
The number of rows.

D EPRECATED N AMES
NRow, SizeX

S EE ALSO

IntMat.GetNumberOfColumns()

GetRowLabel
Returns the label of a row.
str IntMat.GetRowLabel(int row)

A RGUMENTS
row Row index (first row has index 1).

R ETURNS
Row label of given row.

D EPRECATED N AMES
RowLbl

S EE ALSO

IntMat.SetRowLabel(), IntMat.GetRowLabelIndex(), IntMat.GetColumnLabel()

GetRowLabelIndex
Gets the index of a label in all row labels.
int IntMat.GetRowLabelIndex(str label)

A RGUMENTS
label Label to search.

R ETURNS
≥1 The index in the row labels, if it was found.
0 Otherwise

S EE ALSO

IntMat.GetRowLabel()

441
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Init
Initializes the matrix with given size and values, regardless of the previous size and data.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
int IntMat.Init(int numberOfRows,
int numberOfColumns,
[float initialValue = 0.0]
)

A RGUMENTS
numberOfRows
The number of rows.
numberOfColumns
The number of columns.
initialValue (optional)
Initial values: All matrix entries are initialised with this value. Matrix is initialized
with 0 if ommitted.

R ETURNS
Always 1 and can be ignored.

S EE ALSO

IntMat.Resize()

Invert
Inverts the matrix.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
int IntMat.Invert()

R ETURNS
0 Success, the matrix is replaced by its inversion.
1 Error, inversion not possible. Original matrix was not changed.

Multiply
Multiplies 2 matrixes and stores the result in this matrix.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
int IntMat.Multiply(DataObject M1,
DataObject M2
)

A RGUMENTS
object M1
Matrix 1 to be multiplied.

442
5.6. OTHERS CHAPTER 5. OBJECT METHODS

object M2
Matrix 2 to be multiplied.

R ETURNS
Always 0 and can be ignored.

Resize
Resizes the matrix to a given size. Existing values will not be changed. Added values will be
set to the optional value, otherwise to 0.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
int IntMat.Resize(int numberOfRows,
int numberOfColumns,
[float initialValue = 0.0]
)

A RGUMENTS
numberOfRows
The number of rows.
numberOfColumns
The number of columns.
initialValue (optional)
Initial values: Additional matrix entries are initialised with this value. Additional
values are initialized with 0. if ommitted.

R ETURNS
Always 1 and can be ignored.

S EE ALSO

IntMat.Init()

RowLbl
Deprecated function to get or set the label of the given row. Please use IntMat.GetRowLabel()
or IntMat.SetRowLabel() instead.
str IntMat.RowLbl(int row)
str IntMat.RowLbl(str label,
int row
)

Save
Saves the current state of this matrix to database.
If the matrix is calculation relevant, an optional parameter allows to control whether available
calculation results shall be reset afterwards or not.
Note: In QDSL, the calculation results are never reset and the parameter ”resetCalculation” is
ignored.
None IntMat.Save()
None IntMat.Save(int resetCalculation)

443
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
resetCalculation (optional)
1 reset calculation results (default)
0 keep calculation results

Set
Sets a value at the position (row, column) of the matrix. The matrix is resized automatically if
the given coordinates exceed the size.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
int IntMat.Set(int row,
int column,
float value
)

A RGUMENTS
row Row index, 1 based. The first row has index 1. Invalid index (leq0) leads to
scripting error.
column Column index, 1 based. The first column has index 1. Invalid index (leq0) leads to
scripting error.
value Value to assign.

R ETURNS
Always 1 and can be ignored.

S EE ALSO

IntMat.Get()

SetColumnLabel
Sets the label of a column.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
None IntMat.SetColumnLabel(int column,
str label
)

A RGUMENTS
column Column index (first column has index 1).
label Label to set.

S EE ALSO

IntMat.GetColumnLabel(), IntMat.GetColumnLabelIndex(), IntMat.SetRowLabel()

444
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetRowLabel
Sets the label of a row.
This operation is performed in memory only. Use IntMat.Save() to save the modified matrix to
database.
str IntMat.SetRowLabel(int row,
str label
)

A RGUMENTS
row Row index (first row has index 1).

label Label to set.

S EE ALSO

IntMat.GetRowLabel(), IntMat.GetRowLabelIndex(), IntMat.SetColumnLabel()

SortToColumn
Sorts the matrix alphanumerically according to a column, which is specified by the input param-
eter. The row labels are sorted accordingly (if input parameter storeInDB is 1).
int IntMat.SortToColumn(int columnIndex,
[float epsilon = 0.0],
[int storeInDB = 1])

D EPRECATED N AMES
SortToColum

A RGUMENTS
columnIndex
The column index, 1 based. The first column has index 1.
epsilon (optional)
Accuracy for comparing equal values. Values which differ less than epsilon are
treated as being equal. Default value is 0.
storeInDb (optional)
Possible Values:
0 Non-persistent change. Values are not stored in database.
1 Values are stored in database. (default)

R ETURNS
0 On success.
1 Error. Original matrix was not changed.

5.6.25 IntMon

445
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Overview

AddVar
AddVars
ClearVars
GetVar
NVars
PrintAllVal
PrintVal
RemoveVar

AddVar
Appends the variable “name” to the list of selected variable names.
None IntMon.AddVar(str name)

A RGUMENTS
name The variable name to add.

AddVars
Appends the filtered variables to the list of selected variables.
None IntMon.AddVars(str varFilter)

A RGUMENTS
varFilter The filter for variables to add. For example: ’e:*’ to add all parameters of element
to variable selection.

ClearVars
Clears the list of selected variable names.
None IntMon.ClearVars()

GetVar
Returns the variable name on the given row of the variable selection text on the second page of
the IntMon dialogue, which should contain one variable name per line.
str IntMon.GetVar(int row)

A RGUMENTS
row Given row

R ETURNS
The variable name in line row.

446
5.6. OTHERS CHAPTER 5. OBJECT METHODS

NVars
Returns the number of selected variables or, more exact, the number of lines in the variable
selection text on the second page of the IntMon dialogue, which usually contains one variable
name per line.
int IntMon.NVars()

R ETURNS
The number of variables selected.

PrintAllVal
Writes all calculation results of the object assigned in obj id to the output window. The output
includes the variable name followed by the value, its unit and the description.
It should be noted that the variable set itself is modified by this method.
None IntMon.PrintAllVal()

PrintVal
Prints the values of the selected variables to the output window.
None IntMon.PrintVal()

RemoveVar
Removes the variable “name” from the list of selected variable names.
int IntMon.RemoveVar(str name)

A RGUMENTS
name The variable name.

R ETURNS
0 If variable with name was found and removed.
1 If the variable name was not found.

5.6.26 IntOutage
Overview

Apply
ApplyAll
Check
CheckAll
IsInStudyTime
ResetAll

447
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Apply
None IntOutage.Apply([int reportSwitches])

Applies the outage object. The functionality corresponds to pressing the ’Apply’ button in edit
dialog with the difference that the scripting function can also be used without an active scenario.
A RGUMENTS
reportSwitches (optional)
Flag to enable the reporting of changed switches to the output window.
0 No output (default)
1 Print switches to output window

ApplyAll
None IntOutage.ApplyAll([int reportSwitches])

Applies all currently relevant (=in study time and not out-of-service) outage objects of current
project. The functionality corresponds to pressing the ’ApplyAll’ button in edit dialog with the
difference that the scripting function can also be used without an active scenario. It applies all
relevant outages independent of the one it was called on.
A RGUMENTS
reportSwitches (optional)
Flag to enable the reporting of changed switches to the output window.
0 No output (default)
1 Print switches to output window

Check
int IntOutage.Check([int outputMessage])

This function checks if the outage is correctly reflected by the network elements.
A RGUMENTS
outputMessage (optional)
Flag to enable detailed output to the output window.
0 No output (default)
1 Detailed report of mismatch to output window

R ETURNS
0 Ok, outage is correctly reflected
1 Not ok, status of network elements does not reflect outage

CheckAll
This function checks if all outages are correctly reflected by the network components for current
study time. It checks all outages independent of the one it was called on.
[list notOutaged,
list wronglyOutaged] IntOutage.CheckAll([int emitMsg,]
[DataObject gridfilter,])

448
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
int emitMsg (optional)
whether to report inconistencies to the output window
-1 No output
0 (Default) print inconsistencies but without start / end message
1 Full output, including start / end message
gridfilter (optional)
Possibility to restrict checking for accidentally outaged elements to given object
(e.g. grid) and its children (by default, all elements for all active grids are checked).

notOutaged (optional, out)(optional)

If given, all network components that should be outaged but are not are filled into
this set.
wronglyOutaged (optional, out)(optional)
If given, all network components that should be outaged but are not are filled into
this set.

IsInStudyTime
int IntOutage.IsInStudyTime()

Checks if outage is relevant for current study time, i.e. the study time lies within the outage’s
validity period.
R ETURNS
0 Outage is not relevant for current study time (outside validity period)
1 Outage is relevant for current study time (inside validity period)

D EPRECATED N AMES
IsInStudytime

ResetAll
None IntOutage.ResetAll([int reportSwitches])

Resets all currently relevant (=in study time and not out-of-service) outage objects of current
project. The functionality corresponds to pressing the ’Reset’ button in all outage objects with
difference that the scripting function can also be used without an active scenario. It resets all
relevant outages independent of the one it was called on.
A RGUMENTS
reportSwitches (optional)
Flag to enable the reporting of changed switches to the output window.
0 No output (default)
1 Print switches to output window

449
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.27 IntPlannedout
Overview

SetRecurrence

SetRecurrence
Copies the settings of a Recurrence Pattern object to the planned outage object and enables
the flag Recurrent.
int IntPlannedout.SetRecurrence(DataObject recurrencePattern)

A RGUMENTS
recurrencePattern
Recurrence pattern object, classname IntRecurrence

R ETURNS
0 Ok, settings copied successful
1 Failed, passed object is NULL or not of class IntRecurrence

5.6.28 IntPlot
Overview

SetAdaptY
SetAutoScaleY
SetScaleY

SetAdaptY
Sets the Adapt Scale option of the x-scale.
None IntPlot.SetAdaptY(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 IntPlot.SetAutoScaleY(int mode)

450
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 IntPlot.SetScaleY()
None IntPlot.SetScaleY(float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.
log (optional)
Possible values:
0 linear
1 logarithmic

5.6.29 IntPrj
Overview

Activate
AddProjectToCombined
AddProjectToRemoteDatabase
Archive
BeginDataExtensionModification
CanAddProjectToRemoteDatabase
CanSubscribeProjectReadOnly
CanSubscribeProjectReadWrite
ClearInvalidReferences
CopyDataExtensionFrom
CreateVersion
Deactivate
EndDataExtensionModification
GetDerivedProjects
GetExternalReferences
GetGeoCoordinateSystem
GetLatestVersion

451
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetVersions
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 IntPrj.Activate()

R ETURNS
0 on success
1 on error

AddProjectToCombined
Adds a project to this using the Project Combination logic. The passed object must be an
IntVersion. The receiving project must be activated but not have a Study Case active, otherwise
this method will fail.
int IntPrj.AddProjectToCombined(object projectVersion)

A RGUMENTS
projectVersion
The verson of a project to add

R ETURNS
0 operation was successful
1 an error occurred

AddProjectToRemoteDatabase
Adds a project to the online database if possible.
Can only be used if the database driver is set to Offline Mode.
int IntPrj.AddProjectToRemoteDatabase()

452
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Archive
Archives the project if the functionality is configured and activated. Does nothing otherwise.
int IntPrj.Archive()

R ETURNS
0 project has been archived
1 project has not been archived

BeginDataExtensionModification
Signals the start of a Data Extension modification.
Must be terminated with EndDataExtensionModification, otherwise all changes will be discarded.
Data Extensions can only be modified when the project is active.
DataObject IntPrj.BeginDataExtensionModification()

R ETURNS
The SetDataext configuration object in the settings folder for further processing.

S EE ALSO

IntPrj.EndDataExtensionModification(), SetDataext.AddConfiguration(), SetDataext.GetConfiguration(),

SetDataext.GetConfigurations(), SetDataext.RemoveAllConfigurations(), SetDataext.RemoveConfiguration()

CanAddProjectToRemoteDatabase
Checks if the project can be pushed to the remote database.
The project must be subscribable as read and write and it must be unsubscribed. Can only be
used if the database driver is set to Offline Mode.
int IntPrj.CanAddProjectToRemoteDatabase()

R ETURNS
0 project cannot be added to the remote database
1 project can be added to the remote database

CanSubscribeProjectReadOnly
Checks if a project can be subscribed read-only by the user executing the script.
int IntPrj.CanSubscribeProjectReadOnly()

R ETURNS
0 no permission to subscribe project
1 project can be subscribed

CanSubscribeProjectReadWrite
Checks if a project can be subscribed read-write by the user executing the script.
int IntPrj.CanSubscribeProjectReadWrite()

453
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 no permission to subscribe project
1 project can be subscribed

ClearInvalidReferences
Removes all references from the project which can no longer be resolved due to target objects
being deleted or projects no longer being available in the database, i.e. project stubs and non-
migrated projects.
int IntPrj.ClearInvalidReferences(int type)

A RGUMENTS
type
0 Remove references to deleted objects
1 Remove references to project stubs and non-migrated projects
2 Remove both

R ETURNS
Number of references cleared.

CopyDataExtensionFrom
Copies the Data Extension configuration from another project into this project. The configuration
is applied immediately. The target project must be active.
int IntPrj.CopyDataExtensionFrom(object other)

A RGUMENTS
other Project to copy the Data Extension configuration from.

R ETURNS
0 Copied successfully
1 Target project is not active
2 Source object is not a project
3 Error during copying, see Output Window

CreateVersion
Creates a new version of project it was called on.
Optionally allows to pass the version name, the timestamp, a bool for user notification, a bool to
enforce project approval and a description.
DataObject IntPrj.CreateVersion([str name = "",]
[int timestamp = 0,]
[int notifyUsers = 0,]
[int approvalRequired = 0,]
[str description = ""]
)
DataObject IntPrj.CreateVersion(int notifyUsersAndApprovalRequired,

454
5.6. OTHERS CHAPTER 5. OBJECT METHODS

[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:
0 Create version without approval (default).
1 Require approval.
notifyUsersAndApprovalRequired
Project approval required and user notifications activated:
0 Create version without approval and do not notify users (default).
1 Require approval and notify users.
description
Version description. (default: empty string)

R ETURNS
DataObject Newly created IntVersion object.
None On failure e.g. missing permission rights.

Deactivate
De-activates the project if it is active. Does nothing otherwise.
int IntPrj.Deactivate()

R ETURNS
0 on success
1 on error

EndDataExtensionModification
Terminates a Data Extension modification previously initiated with BeginDataExtensionModifi-
cation.
This will deactivate the Study Case if the new Data Extension configuration can be applied. In
case of errors the project will be deactivated and rolled back. Omitting the call to EndDataEx-
tensionModification and exiting from the script will discard all changes to the Data Extension
configuration.

455
5.6. OTHERS CHAPTER 5. OBJECT METHODS

None IntPrj.EndDataExtensionModification()

S EE ALSO

IntPrj.BeginDataExtensionModification()

GetDerivedProjects
Return a set holding all versions created in the project.
list IntPrj.GetDerivedProjects()

R ETURNS
Set holding all versions of a project.

GetExternalReferences
Fills the given map with objects from this project mapping to its external references.
int IntPrj.GetExternalReferences(DataObject resultMap,
[DataObject externalReferencesSettings])

A RGUMENTS
resultMap
DPL map (IntDplmap) which will contain objects mapping to its external refer-
ences. Objects without external references are not mapped.

externalReferencesSettings (optional)
External References settings object (SetExtref). Defines the properties for objects
being external references. The External References settings object from current
user is used if ommitted.

R ETURNS
0 Getting external references succeeded.
1 Getting external references cancelled in dialogue or failed e.g project inactive or
not migrated.

S EE ALSO

IntPrj.HasExternalReferences(), IntPrj.PackExternalReferences()

GetGeoCoordinateSystem
Returns the EPSG code of the geographic coordinate system in which the geo coordinates of
the project’s net elements are stored.
int IntPrj.GetGeoCoordinateSystem()

R ETURNS
EPSG code of the project’s geographic coordinate system, or 0 if the coordinate system is
not known.

456
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetLatestVersion
Returns the most recent version available in the project which has the notify users option set.
Optionally allows to consider all versions, regardless of notify users option.
DataObject IntPrj.GetLatestVersion([int onlyregular])

A RGUMENTS
onlyregular (optional)
1 consider only regular version (default)
0 consider all versions

R ETURNS
Latest version of the project

GetVersions
Returns a set containing all versions of the project.
list IntPrj.GetVersions()

R ETURNS
Set that contains all versions of the project

HasExternalReferences
Checks if any object inside the project references external non-system objects and prints a
report to the Output Window.
int IntPrj.HasExternalReferences([int considerGlobal = 1,]
[int considerRemoteVariants = 0]
)
int IntPrj.HasExternalReferences(DataObject externalReferencesSettings])

A RGUMENTS
considerGlobal (optional)
0 References to global (non-system) objects are not considered as ex-
ternal references.
1 References to global (non-system) objects are considered as external
references (default).
considerRemoteVariants (optional)
0 References to remote variants are not considered as external refer-
ences (default).
1 References to remote variants are considered as external references.
externalReferencesSettings (optional)
External References settings object (SetExtref). Defines the properties for objects
being external references.

R ETURNS
0 No external reference was found.
1 An external reference was found.

457
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

IntPrj.PackExternalReferences(), IntPrj.GetExternalReferences()

LoadData
Loads all objects of the project from the data base. Does nothing when called on an active
project.
This function is useful to optimise searches which would traverse deep into an inactive project.
None IntPrj.LoadData()

MergeToBaseProject
Merges the modifications of a derived project to the base project.
int IntPrj.MergeToBaseProject(int conflictMode)

A RGUMENTS
conflictMode
Assignment in case of modification conflict:

0 Favour none. Diff browser is shown in case of conflicts.

1 Favour base version.
2 Favour derived project.
3 Favour base project.

R ETURNS

0 Merge finished sucessfully.

1 Merge failed (no further information).
2 Merge failed due to failing assignment check.
3 Merge failed due to invalid projects (e.g. no derived project).
4 Merge was canceled by user.
5 Merge completed with errors (see output window).

Migrate
Migrates a project from version V13 to V14. Migration is only executed if project has been
created in build 400 or earlier (and is not yet migrated).
None IntPrj.Migrate([int createCopy])

A RGUMENTS
createCopy (optional)
1 Creates a copy of current project (original copy is maintained) (default)
0 Does an ”in-place” migration of the project (original is overwritten)

458
5.6. OTHERS CHAPTER 5. OBJECT METHODS

NormaliseCombined
Normalises a combined project so it appears to be a regular project. This will remove all
intermediate folders which were added when creating the combined project. This might lead
to naming duplications which will be resolved by the normal logic of numbering duplicates.
int IntPrj.NormaliseCombined()

R ETURNS
0 operation was successful
1 operation was cancelled because the project is active

PackExternalReferences
Packs external references of this project and prints a report to the Output Window.
int IntPrj.PackExternalReferences([DataObject externalReferencesSettings])

A RGUMENTS
externalReferencesSettings (optional)
External References settings object (SetExtref). Defines the properties for objects
being external references. The External References settings object from current
user is used if ommitted.

R ETURNS
0 Packing external references succeeded.
1 Packing external references cancelled in dialogue or failed e.g project inactive or
not migrated.

S EE ALSO

IntPrj.HasExternalReferences(), IntPrj.GetExternalReferences()

Purge
Purges project storage and updates storage statistics.
Requires write access to the project; the functions does nothing when the project is locked by
another user.
None IntPrj.Purge()

PurgeObjectKeys
Purges project’s object key table.

R ETURNS
Number of purged records. −1 in case of errors.
int IntPrj.PurgeObjectKeys()

459
5.6. OTHERS CHAPTER 5. OBJECT METHODS

RemoveProjectFromCombined
Removes a project from a combined project. For the removal the mapping key must be specified.
Mapping keys are stored in the project, parameter project mapped. The project this method is
called on must be activated but not have a Study Case active, otherwise this method will fail.
int IntPrj.RemoveProjectFromCombined(str mappingKey)

A RGUMENTS
mappingKey
The mapping key for the project that should be removed

R ETURNS
0 operation was successful
1 an unknown error occurred
2 an error occurred and is documented in the output window

Restore
Restores an archived project so it can be used again. Does nothing if the project is not an
archived one.
int IntPrj.Restore()

R ETURNS
0 project has not been restored
1 project has been restored

SetGeoCoordinateSystem
Defines the the geographic coordinate system in which the geo coordinates of the project’s net
elements are stored.
None IntPrj.SetGeoCoordinateSystem(int epsgCode)

A RGUMENTS
epsgCode
EPSG code of the geographic coordinate system to be used for this project. A
value of 0 denotes an unknown coordinate system.

SubscribeProjectReadOnly
Subscribes a project read only if the permission is granted.
Can only be used if the database driver is set to Offline Mode.
None IntPrj.SubscribeProjectReadOnly()

460
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SubscribeProjectReadWrite
Subscribes a project read/write if the permission is granted.
Can only be used if the database driver is set to Offline Mode.
None IntPrj.SubscribeProjectReadWrite()

TransformGeoCoordinates
Transforms geographic coordinates from a source coordinate system to a destination coordinate
system. Geodetic coordinates (longitude/latitude) are specified in decimal degrees. Projected
coordinates are specified in meters.
[int error,
float xOut,
float yOut] IntPrj.TransformGeoCoordinates(float xIn, float yIn,
int sourceEpsg, int destEpsg
)

A RGUMENTS
xIn horizontal component of the input location: x position or longitude, resp.

yIn vertical component of the input location: y position or latitude, resp.

xOut (out)
horizontal component of the output location: x position or longitude, resp.
yOut (out)
vertical component of the output location: y position or latitude, resp.
sourceEpsg
EPSG code of the source coordinate system
destEpsg EPSG code of the destination coordinate system

R ETURNS
0 operation was successful
1 an error occurred

TransformToGeographicCoordinateSystem
Transforms geographic coordinates of all net elements contained by the project to a destina-
tion coordinate system, and updates the configured project coordinate system accordingly.
Please note: The project’s geographic diagram needs to be shown when this function is called.
Otherwise, annotations will not be transformed.
[int error] IntPrj.TransformToGeographicCoordinateSystem(int destEpsg)

A RGUMENTS
destEpsg EPSG code of the destination coordinate system

R ETURNS
0 operation was successful
1 an error occurred

461
5.6. OTHERS CHAPTER 5. OBJECT METHODS

UnsubscribeProject
Unsubscribes a project.
Can only be used if the database driver is set to Offline Mode.
None IntPrj.UnsubscribeProject()

UpdateStatistics
Updates the storage statistics for a project. The statistics are displayed on the page Storage of
a project.
Note: This function requires write access to the project otherwise the update is not executed
and an error message is printed to the output window.
None IntPrj.UpdateStatistics()

UpdateToDefaultStructure
Updates folder structure of currently active project to that of the default project (used for creation
of new projects). Existing folders will be moved to a new location within the project. Folders that
have no correspondence in the default project will remain untouched.
NB: Folders might get moved or additional ones might be created, but no folder is deleted by
this routine.
int IntPrj.UpdateToDefaultStructure(int createMissingFolders, int updateForeignKeys)

A RGUMENTS
createMissingFolders (optional)
0 Missing folders will not be created. Only existing ones will be moved to
new locations, if required.
1 Missing folders will be created (default).

updateForeignKeys (optional)
0 Foreign-keys of folders will not be updated.
1 Foreign-keys of folders will be updated (default).

R ETURNS
0 operation was successful
1 operation was not successful, e.g. project not active

UpdateToMostRecentBaseVersion
Updates a derived project to the most recent version of the base project. This is done by creating
a new derived project from the new version and (optionally) merging the modifications from the
existing derived project into it.
int IntPrj.UpdateToMostRecentBaseVersion(DataObject newDerivedProject,
int versionWithNotification,
int discardOwnModifications,
[int conflictMode = 0]
)

462
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
newDerivedProject (out)
New derived project if no error occured.
versionWithNotification
0 Update to the most recent version independent of the ”Notify users”
setting.
1 Update to the most recent version with ”Notify users” enabled.
discardOwnModifications
0 Merge modifications of new version and derived project.
1 Discard modifications of dervived project. The Compare and Merge
Tool is not used at all.
conflictMode (optional)
Assignment in case of modification conflict (only used if not discarding derived
modifications):

0 Favour none. Diff browser is shown in case of conflicts. (default)

1 Favour new base version.
2 Favour derived project.

R ETURNS
0 Merge finished sucessfully.
1 Merge failed (no further information).
2 Merge failed due to failing assignment check.
3 Merge failed due to invalid projects (e.g. no derived project).
4 Merge was canceled by user.
5 Merge completed with errors (see output window).

5.6.30 IntPrjfolder
Overview

GetProjectFolderType
IsProjectFolderType

GetProjectFolderType
Returns the type of the project folder stored in attribute “iopt type”.
The following types are currently available (language independent):

• blk - User Defined Models

• cbrat - CB Ratings

• chars - Characteristics
• cstgen - Generator Cost Curves
• effgen - Generator Efficiency Curves

463
5.6. OTHERS CHAPTER 5. OBJECT METHODS

• rnd - Probabilistic Assessment

• cim - CIM Model

• common - Common Mode Failures
• demand - Demand Transfers
• dia - Diagrams

• equip - Equipment Type Library

• fault - Faults
• ras - Remedial Action Schemes
• gen - Generic

• lib - Library
• mvar - Mvar Limit Curves
• netdat - Network Data

• netmod - Network Model

• oplib - Operational Library
• outage - Outages
• qpc - QP-Curves

• ra - Running Arrangements
• report - Table Reports
• scen - Operation Scenarios

• scheme - Variations
• script - Scripts
• study - Study Cases
• sw - StationWare

• tariff - Tariffs
• templ - Templates
• therm - Thermal Ratings

• ucc - V-Control-Curves

str IntPrjfolder.GetProjectFolderType()

R ETURNS
The type of the project folder as string. For possible return values see list above.

S EE ALSO

Application.GetProjectFolder()

464
5.6. OTHERS CHAPTER 5. OBJECT METHODS

IsProjectFolderType
This function checks if a project folder is of given type.
int IntPrjfolder.IsProjectFolderType(str type)

A RGUMENTS
type Folder type; for possible type values see IntPrjfolder.GetProjectFolderType()

R ETURNS
1 true, is of given type
0 false, is not of given type

S EE ALSO

Application.GetProjectFolder(), IntPrjfolder.GetProjectFolderType()

5.6.31 IntQlim
Overview

GetQlim

GetQlim
Returns either the current maximum or the minimum reactive power limit, given the specified
active power and voltage.
The active power must be given in the same units as the input mode definition of the capability
curve object (parameter ”inputmod” is 0 for MW/Mvar and 1 for p.u.).
float IntQlim.GetQlim(float p,
float v,
[float minmax]
)

A RGUMENTS
p the current value of active power in MW or p.u.
v the current value of voltage in p.u.
minmax (optional)
Returns either the maximum or minimum value. Possible values are:

-1 minimum value
1 maximum value. This is the default value

R ETURNS
Returns the minimum/maximum limit. The units might be Mvar or p.u., depending on the
input mode of the capability curve. Also, the limits are calculated for a single machine.

465
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.32 IntRas
Overview

AddEvent
AddTrigger
IsValid

AddEvent
Adds an event to the Remedial Action Scheme.
list IntRas.AddEvent(DataObject newEvent)

A RGUMENTS
newEvent
The event that shall be added.

AddTrigger
Adds either a condition or a gate to the Remedial Action Scheme.
list IntRas.AddTrigger(DataObject newTrigger)

A RGUMENTS
newTrigger
The condition or gate that shall be added.

IsValid
Checks if the Remedial Action Scheme is valid.
int IntRas.IsValid(int emitMessage = 0)

A RGUMENTS
emitMessage
Emit messages if not equal to zero.

R ETURNS
0 If invalid.
1 If valid.

5.6.33 IntRunarrange
Overview

GetSwitchStatus

466
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetSwitchStatus
Determines the status of the given switch in the running arrangement, without assigning or
applying the running arrangement.
int IntRunarrange.GetSwitchStatus(DataObject switch)

A RGUMENTS
switch ElmCoup or StaSwitch from which to get the status stored in running arrange-
ment

R ETURNS
Status of the switch in the running arrangement. Possible values are

-1 Switch is not part of the running arrangement

0 Switch is open
1 Switch is closed

5.6.34 IntScenario
Overview

Activate
Apply
ApplySelective
Deactivate
DiscardChanges
GetObjects
GetOperationValue
ReleaseMemory
Save
SetOperationValue

Activate
Activates a scenario. If there is currently another scenario active that one will be deactivated
automatically.
int IntScenario.Activate()

R ETURNS
0 successfully activated
1 error, e.g. already activate, no project and study case active

Apply
Copies the values stored in a scenario to the corresponding network elements. The value
transfer is identical to scenario activation, however, the scenario will not be activated. In case of
having an active variation or another scenario, the values will be recorded there.
int IntScenario.Apply([int requestUserConfirmation])
int IntScenario.Apply(int requestUserConfirmation,
DataObject parentfilter
)

467
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
requestUserConfirmation(optional)
0 silent, just apply the data without further confirmation requests
1 request a user confirmation first (default)
parentfilter (optional)
If given, scenario data is only applied for given object and all of its children (hier-
archical filter)

R ETURNS
0 on success

ApplySelective
Similar to function Apply() but copies only the set of attributes listed in the given apply configu-
ration. An apply configuration is a folder consisting of variable selection objects (IntMon), one
per class. For each class the attributes to be copied can be selected.
int IntScenario.ApplySelective(DataObject configuration)
int IntScenario.ApplySelective(int requestUserConfirmation,
DataObject applyConfiguration
)

A RGUMENTS
applyConfiguration
folder containing variable selection objects
requestUserConfirmation(optional)
0 silent, just apply the data without further confirmation requests
1 request a user confirmation first (default)

R ETURNS
0 on succes

Deactivate
Deactivates the currently active scenario.
int IntScenario.Deactivate([int saveOrUndo])

A RGUMENTS
saveOrUndo(optional)
Determines whether changes in active scenario will be saved or discarded before
the scenario is deactivated. If this argument is omitted, the user will be asked.
0 discard changes
1 save changes

R ETURNS
0 on success

468
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DiscardChanges
Discards all unsaved changes made to a scenario.
int IntScenario.DiscardChanges([int resetCalculation])

A RGUMENTS
resetCalculation(optional)
Determines whether calculation results should be reset afterwards.
0 no reset, retain results
1 default, reset results

R ETURNS
0 on success
1 error, scenario was not modified or not active

GetObjects
Returns a set of all objects for which operational data are stored in scenario.
list IntScenario.GetObjects()

R ETURNS
Set of all objects for which operational data are stored in scenario

GetOperationValue
This function offers read access to the operation data values stored in the scenario.
[int error,
int|float|str|DataObject value] IntScenario.GetOperationValue(DataObject obj,
str attribute,
[int fromObject])

A RGUMENTS
value (out)
variable that holds the value after call

obj object for which the operation to be retrieved

attribute name of the operation data attribute
fromObject
only if current scenario is active:

0 value is taken from scenario (as stored on db)

1 (default), value is taken from object (reflects un-saved modifications)

R ETURNS
0 on success

469
5.6. OTHERS CHAPTER 5. OBJECT METHODS

ReleaseMemory
Releases the memory used by a scenario. Any further access to the scenario will reload the
data from database. The function can be called on inactive scenarios only. Use this function
with care!
int IntScenario.ReleaseMemory()

R ETURNS
0 on success
1 error, scenario is active

Save
Saves the current active value of all operational attributes for all active network elements to
database.
int IntScenario.Save()

R ETURNS
0 successfully saved
1 error, scenario was not modified or not active

SetOperationValue
Offers write access to operational data stored in a scenario.
int IntScenario.SetOperationValue(int|float|str|DataObject newvalue,
DataObject obj,
str attribute,
[int toObject = 1]
)

A RGUMENTS
newvalue New value to store in the scenario.
obj Object for which the operation data to store.
attribute Name of the operation data attribute.

toObject Only if current scenario is active:

0 Value is only stored to scenario on db.
1 As 0 but value is also updated on object in memory. (default)

R ETURNS
0 on success, otherwise 1.

5.6.35 IntScensched

470
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Overview

Activate
Deactivate
DeleteRow
GetScenario
GetStartEndTime
SearchScenario

Activate
Activates a scenario scheduler.
int IntScensched.Activate()

R ETURNS
0 successfully activated
1 error, e.g. already activate, no project and study case active

Deactivate
Deactivates a scenario scheduler.
int IntScensched.Deactivate()

R ETURNS
0 successfully deactivated
1 error, e.g. already deactivates, no project and study case active

DeleteRow
Delete row(s) of the scenario scheduler.
None IntScensched.DeleteRow(int row, [int numberOfRows])

A RGUMENTS
row row number (begin with 0)
numberOfRows (optional)
number of rows to delete (default = 1)

GetScenario
Get the scenario for corresponding time 'iTime'.
DataObject IntScensched.GetScenario(int iTime)

A RGUMENTS
iTime Time (UCTE) to get the corresponding scenario.

471
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
None No scenario at time 'iTime'defined
IntScenario Scenario will be activated at time 'iTime'

GetStartEndTime
Get start and end time of the corresponding scenario.
[int error
int startTime,
int endTime ] IntScensched.GetStartEndTime(DataObject scenario)

A RGUMENTS
scenario A scenario (IntScenario).

startTime (out)
Start time (time when the scenario is activated)).
endTime (out)
End time (time until the scenario is still activated).

R ETURNS
−1 Scenario not found (not part of scenario scheduler)
≥0 Vector index (index of scenario)

SearchScenario
Search at which table index (row) the corresponding scenario is defined in the scheduler.
int IntScensched.SearchScenario(DataObject scenarioObject)

A RGUMENTS
scenarioObject
scenario object

R ETURNS
−1 Scenario not found (not part of scenario scheduler).
≥0 Vector index (row, index of scenario).

5.6.36 IntScheme
Overview

Activate
Consolidate
Deactivate
GetActiveScheduler
NewStage

472
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Activate
Activates a variation and inserts a variation reference in a 'Variation Configuration Folder'stored
in the study case.
int IntScheme.Activate()

R ETURNS
0 successfully activated
1 error, e.g. already activate, no project and study case active

Consolidate
Changes that are recorded in this variation will be permanently applied to the original location.
Note: Modified scenarios are not saved.
Works only:

• for non network variation e.g. used for Mvar Limit Curves, Thermal Ratings ...
• and the variation must be activated.

int IntScheme.Consolidate()

R ETURNS
0 On success.
1 If an error has occured.

Deactivate
Deactivates a variation and removes the variation reference in the 'Variation Configuration
Folder'stored in the study case.
int IntScheme.Deactivate()

R ETURNS
0 successfully deactivated
1 error, e.g. already deactivated, no project and study case active

GetActiveScheduler
Returns the corresponding active variation scheduler or None if no scheduler is active for this
variation (IntScheme).
DataObject IntScheme.GetActiveScheduler()

NewStage
Adds a new expansion stage into the variation (name = sname).
int IntScheme.NewStage(str name,
int activationTime,
int activate
)

473
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
name Name of the new expansion stage.
activationTime
Activation time of the new expansion stage in seconds since 01.01.1970 00:00:00.
activate
1 The actual study time is changed to the parameter iUTCtime and the
varation will be activated. If the variation is a network variation, the
new created expansion stage is used as 'recording 'expansion stage.
If the variation (this) is not active, the variation will be automatically
activated.
0 Expansion stage and/or variation will not be activated.

5.6.37 IntSscheduler
Overview

Activate
Deactivate
Update

Activate
Activates a variation scheduler. An already activated scheduler for same variation will be
deactivated automatically.
int IntSscheduler.Activate()

R ETURNS
=0 On success
6= 0 If an error has occurred

Deactivate
Deactivates a variation scheduler.
int IntSscheduler.Deactivate()

R ETURNS
=0 on success
6= 0 If an error has occurred especially if scheduler was not active (to be consistent
with scenario scheduler deactivate()).

Update
Update variation scheduler (updates internal reference stages).
int IntSscheduler.Update()

474
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
=0 On success
6= 0 If an error has occurred

5.6.38 IntSstage
Overview

Activate
CreateStageObject
EnableDiffMode
GetVariation
IsExcluded
PrintModifications
ReadValue
WriteValue

Activate
Activates the expansion stage and sets the 'recording' expansion stage. The study time will be
automatically set to the correponsing time of the stage.
int IntSstage.Activate([int iQueryOption])

A RGUMENTS
iQueryOption
0 (default) The user must confirm the query.
1 The “Yes” button is automatically applied.
2 The “No” button is automatically applied.

R ETURNS
0 Successfully activated.
1 Error, e.g. scheme is not active.

CreateStageObject
Creates a stage object (delta or delete object) inside corresponding IntSstage.
DataObject IntSstage.CreateStageObject(int type,
DataObject rootObject
)

A RGUMENTS
type Kind of object to create
1 Delete object
2 Delta object
rootObject
(Original) object for which the stage object should be created.

475
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
Stage object on success.

EnableDiffMode
Enables the comparison mode for the variation management system. If the mode is enabled a
DELTA object is only created when the object is different.
None IntSstage.EnableDiffMode(int enable)

A RGUMENTS
enable
0 disables the difference/comparison mode
1 enables the difference/comparison mode

GetVariation
Returns variation of expansion stage.
DataObject IntSstage.GetVariation()

R ETURNS
Variation object corresponding to stage.

D EPRECATED N AMES
GetScheme

IsExcluded
Returns if expansion stage flag 'Exclude from Activation' is switched on (return value = 1) or not
(return value = 0). The function checks also if the stage is excluded regarding the restricted
validity period of the corresponding variation and considers also the settings of an variation
scheduler when defined.
float IntSstage.IsExcluded()

R ETURNS
1 if stage is excluded
0 if stage is considered

PrintModifications
Reports in the the output window the modification of the corresponding expansion stage. Works
only if the expansion stage is the active 'recording 'expansion stage.
int IntSstage.PrintModifications([int onlyNetworkData,]
[str ignoredParameter]
)

476
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
onlyNetworkData (optional)
1 (default) Show only network data modifications. Graphical modifica-
tions are not report when the diagrams folder are recored.
0 Show all modifications

ignoredParameter (optional)
Comma separated list of parameters which are ignored for reporting.

R ETURNS
0 on success
1 if the actual expansion stage is not the 'recording 'expansion stage.

ReadValue
Get the value for an attribute of an ADD or DELTA object which modifies “rootObj” (root object).
[int error,
float|str|DataObject value] IntSstage.ReadValue(DataObject rootObj,
str attributeName)

R ETURNS
=0 On success.
6= 0 Error e.g. wrong data type.

WriteValue
Writes a value for an attribute to an ADD or DELTA object which modifies rootObj (root object).
int IntSstage.WriteValue(float|str|DataObject value,
DataObject rootObj,
str attributeName)

R ETURNS
=0 On success.
6= 0 Error e.g. wrong data type.

5.6.39 IntSubset
Overview

Apply
ApplySelective
Clear
GetConfiguration
GetObjects

477
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 IntSubset.Apply([int requestUserConfirmation])

A RGUMENTS
requestUserConfirmation(optional)
0 silent, just apply the data without further confirmation requests
1 request a user confirmation first (default)

R ETURNS
0 on success

ApplySelective
Similar to function Apply() but copies only the set of attributes listed in the given apply configu-
ration. An apply configuration is a folder consisting of variable selection objects (IntMon), one
per class. For each class the attributes to be copied can be selected.
int IntSubset.ApplySelective(DataObject applyConfiguration)
int IntSubset.ApplySelective(int requestUserConfirmation,
DataObject applyConfiguration
)

A RGUMENTS
applyConfiguration
folder containing variable selection objects
requestUserConfirmation(optional)
0 silent, just apply the data without further confirmation requests
1 request a user confirmation first (default)

R ETURNS
0 on succes

Clear
Clears all values stored in the subset.
Please note that this function can only be called on subsets of currently in-active scenarios.
int IntSubset.Clear()

R ETURNS

0 On success.
1 On error, e.g. subset belongs to a currently active scenario.

478
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetConfiguration
Returns class and attribute configuration for the subset.
str IntSubset.GetConfiguration(str subset)

A RGUMENTS
subset

R ETURNS
Returns a list of classes and attributes for which operational data are stored in subset.

GetObjects
Returns a set of all objects for which operational data are stored in the subset.
list IntSubset.GetObjects()

R ETURNS
Set of all objects for which operational data are stored in the subset

5.6.40 IntThrating
Overview

GetCriticalTimePhase
GetRating

GetCriticalTimePhase
This function returns the smallest duration (time-phase) for which the power flow is beyond the
rating.
float IntThrating.GetCriticalTimePhase(float Flow,
float Loading
)

A RGUMENTS
Flow Power from the load flow calculation, in MVA.
Loading Element loading, in %.

R ETURNS
>0 Smallest time-phase for which the flow is beyond the rating.
-1 In case that no rating is violated.

GetRating
This function returns the rating in MVA according to the thermal rating table, considering element
overloading and its duration (time-phase).
float IntThrating.GetRating(float Loading,
float Duration
)

479
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
Loading Element loading, in %.
Duration Duration or time phase for which the loading is considered, in minutes

R ETURNS
Rating in MVA or 0 if not found.

5.6.41 IntUrl
Overview

View

View
Requests the operating system to open given URL for viewing. The performed action depends
on the default action configured in the system. For example, by default 'http://www.google.com'
would be opened in standard browser.
Please note, the action is only executed if access to given URL is enabled in the 'External
Access' configuration of PowerFactory (IntExtaccess).
int IntUrl.View()

R ETURNS
The returned value reports the success of the operation:

0 Success, URL was opened

1 Error, URL was not opened (because of invalid address or security reasons)

5.6.42 IntUser
Overview

Purge
SetPassword
TerminateSession

Purge
Purges project storage and updates storage statistics for all projects of the user.
Requires write access to the project; the functions does nothing when the project is locked by
another user.
None IntUser.Purge()

480
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 IntUser.SetPassword(str newpassword)

A RGUMENTS
newpassword
Case sensitive user password to set

R ETURNS
Returns whether or not the password has successfully been set. Possible values are:

0 error
1 password set successfully

TerminateSession
Allows the Administrator to log out another user. Prints an error if the current user is not the
Administrator.
None IntUser.TerminateSession()

5.6.43 IntUserman
Overview

CreateGroup
CreateUser
GetGroups
GetUsers
UpdateGroups

CreateGroup
Creates a new user group of given name. If a group with given name already exists the existing
one is returned instead.
Note: Only Administrator user is allowed to call this function.
DataObject IntUserman.CreateGroup(str name)

A RGUMENTS
name Given name of the user group

R ETURNS
Created user group (IntGroup)

481
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 IntUserman.CreateUser(str name)

A RGUMENTS
name Given name of the user

R ETURNS
Created user (IntUser)

GetGroups
Returns a container with all user groups.
Note: Only the administrator user is allowed to call this function.
list IntUserman.GetGroups()

R ETURNS
Set of all available users

GetUsers
Returns a container with all users as they are currently visible in the Data Manager tree.
Note: Only the administrator user is allowed to call this function.
list IntUserman.GetUsers()

R ETURNS
Set of all available users

UpdateGroups
Updates the Everybody group so it contains all currently existing users and cleans it of removed
users.
None IntUserman.UpdateGroups()

482
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.44 IntVec
Overview

Get
Init
Max
Mean
Min
Resize
Save
Set
Size
Sort

Get
Get the value in row index. Index is one based, therefore the index of the first entry is 1.
float IntVec.Get(int index)

A RGUMENTS
index Index in vector, one based.

S EE ALSO

IntVec.Set()

Init
Initializes the vector. Resizes the vector and initializes all values to 0.
This operation is performed in memory only. Use IntVec.Save() to save the modified vector to
database.
None IntVec.Init(int size)

A RGUMENTS
size The new size of the vector.

Max
Gets the maximum value stored in the vector.
float IntVec.Max()

R ETURNS
The maximum value stored in the vector. Empty vectors return 0 as maximum value.

Mean
Calculates the average value of the vector.
float IntVec.Mean()

483
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 IntVec.Min()

R ETURNS
The minimum value stored in the vector. Empty vectors return 0 as minimum value.

Resize
Resizes the vector. Inserted values are initialized to 0.
This operation is performed in memory only. Use IntVec.Save() to save the modified vector to
database.
None IntVec.Resize(int size)

A RGUMENTS
size The new size.

Save
Saves the current state of this vector to database.
If the matrix is calculation relevant, an optional parameter allows to control whether available
calculation results shall be reset afterwards or not.
Note: In QDSL, the calculation results are never reset and the parameter ”resetCalculation” is
ignored.
None IntVec.Save()
None IntVec.Save(int resetCalculation)

A RGUMENTS
resetCalculation (optional)
1 reset calculation results (default)
0 keep calculation results

Set
Set the value in row index. Index is one based, therefore the index of the first entry is 1.
The vector is resized automatically to size index in case that the index exceeds the current
vector size. Values inserted are automatically initialized to a value of 0.
This operation is performed in memory only. Use IntVec.Save() to save the modified vector to
database.
None IntVec.Set(int index,
float value)

484
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
index Index in vector.
value Value to assign in row index.

S EE ALSO

IntVec.Get()

Size
Returns the size of the vector.
int IntVec.Size()

R ETURNS
The size of the vector.

Sort
Sorts the vector.
This operation is performed in memory only. Use IntVec.Save() to save the modified vector to
database.
None IntVec.Sort([int ascending = 0])

A RGUMENTS
ascending
Sort order:

0 Highest value first (descending, default).

1 Smallest value first (ascending).

5.6.45 IntVecobj
Overview

Get
Resize
Save
Search
Set
Size

Get
Get the object in row index. Index is one based, therefore the index of the first entry is 1.
DataObject IntVecobj.Get(int index)

A RGUMENTS
index Index in vector, one based.

485
5.6. OTHERS CHAPTER 5. OBJECT METHODS

S EE ALSO

IntVecobj.Set()

Resize
Resizes the vector. Inserted new entries are initialized to None.
This operation is performed in memory only. Use IntVecobj.Save() to save the modified vector
to database.
None IntVecobj.Resize(int size)

A RGUMENTS
size The new size.

Save
Saves the current state of this vector to database.
If the vector is calculation relevant, an optional parameter allows to control whether available
calculation results shall be reset afterwards or not.
Note: In QDSL, the calculation results are never reset and the parameter ”resetCalculation” is
ignored.
None IntVecobj.Save()
None IntVecobj.Save(int resetCalculation)

A RGUMENTS
resetCalculation (optional)
1 reset calculation results (default)
0 keep calculation results

Search
Search if the object (obj) is part of the vecor and returns the corresponding index of the vector
(one based).
int IntVecobj.Search(DataObject obj)

R ETURNS
1 ... size object found, located at index
0 object not part of vector

Set
Set the object (obj) in row index. Index is one based, therefore the index of the first entry is 1.
The vector is resized automatically to size index in case that the index exceeds the current
vector size. Object inserted are automatically initialized to a value of None.
This operation is performed in memory only. Use IntVecobj.Save() to save the modified vector
to database.

486
5.6. OTHERS CHAPTER 5. OBJECT METHODS

None IntVecobj.Set(int index,

DataObject obj)

A RGUMENTS
index Index in vector.
obj Object to assign in row index.

S EE ALSO

IntVecobj.Get()

Size
Returns the size of the vector.
int IntVecobj.Size()

R ETURNS
The size of the vector.

5.6.46 IntVersion
Overview

CreateDerivedProject
GetDerivedProjects
GetHistoricalProject
Rollback

CreateDerivedProject
Creates a derived project from the version.
DataObject IntVersion.CreateDerivedProject(str name,
[DataObject parent]
)

A RGUMENTS
name The name of the project which will be created.
parent(optional)
The parent of the project which will be created. Default is the current user.

R ETURNS
Returns the created project.

GetDerivedProjects
list of projects derived from this version
list IntVersion.GetDerivedProjects()

487
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
list of derived projects

GetHistoricalProject
Returns historic project within version
DataObject IntVersion.GetHistoricalProject()

R ETURNS
Returns the historic project object

Rollback
Roll backs the project to this version. No project have to be active. Furthermore no script from
the project of the version have to be running.
int IntVersion.Rollback()

R ETURNS
0 on success
1 otherwise

5.6.47 IntViewbookmark
Overview

JumpTo
UpdateFromCurrentView

JumpTo
Opens the referenced diagram (if not already open) and sets the viewing area.
None IntViewbookmark.JumpTo()

UpdateFromCurrentView
Updates the bookmark’s diagram and view area from the current drawing window.
None IntViewbookmark.UpdateFromCurrentView()

5.6.48 PltAxis
Overview

DoAutoScale
SetFont

488
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScale
Adapts the axis range such that it includes the entire data range. Note: Only works if the plot
this axis belongs to is currently shown.
None PltAxis.DoAutoScale()

SetFont
Sets the font for this axis
None PltAxis.SetFont(str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
fontName
Font name
fontSize Font size

fontStyle Font style

1 Bold
2 Italic
3 Bold and italic
4 Underline

5.6.49 PltComplexdata
Overview

AddVector
ChangeColourPalette
ClearVectors

AddVector
Appends a vector to the plot.
None PltComplexdata.AddVector(DataObject element,
string complexVariable)

A RGUMENTS
element Element to display
complexVariable
Complex variable to display, e.g.: ’m:ur:bus1 + j * m:ui:bus1’

ChangeColourPalette
Colours the vectors according to the colour palette identified by the given name. Additionally,
the colour palette is set as the object’s default palette.

489
5.6. OTHERS CHAPTER 5. OBJECT METHODS

None PltComplexdata.ChangeColourPalette(str paletteName)

A RGUMENTS
paletteName
Name of the colour palette to apply

R ETURNS
0 on success
1 on error

ClearVectors
Removes all vectors from the plot.
None PltComplexdata.ClearVectors()

5.6.50 PltDataseries
Overview

AddCurve
AddXYCurve
ChangeColourPalette
ClearCurves
GetDataSource
GetIntCalcres

AddCurve
Appends a curve to the plot.
None PltDataseries.AddCurve(DataObject element,
str varname,
[DataObject datasource]
)

A RGUMENTS
element Element to display
varname Name of the element variable to display
datasource (optional)
Data source to assign to the curve (ElmRes or IntComtrade). If not specified, the
plot’s default result file will be used for the curve.

AddXYCurve
Appends a curve to a XY plot.
None PltDataseries.AddXYCurve(DataObject elementX,
str varnameX,
DataObject elementY,

490
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 PltDataseries.ChangeColourPalette(str paletteName)

A RGUMENTS
paletteName
Name of the colour palette to apply

R ETURNS
0 on success
1 on error

ClearCurves
Removes all curves from the plot.
None PltDataseries.ClearCurves()

GetDataSource
Returns the data source that is used for the curve with given index.
DataObject PltDataseries.GetDataSource(int curveIndex)

A RGUMENTS
int curveIndex
curve index in table, must be ≥ 0

491
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
DataObject Data source
None No data source found

GetIntCalcres
Gets all user Calculated Result objects (IntCalcres) stored inside the data series.
list PltDataseries.GetIntCalcres()

R ETURNS
All Calculated Result objects (IntCalcres) stored inside the data series.

5.6.51 PltLegend
Overview

SetFont

SetFont
Sets the font for this axis
None PltAxis.SetFont(str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
fontName
Font name
fontSize Font size

fontStyle Font style

1 Bold
2 Italic
3 Bold and italic
4 Underline

5.6.52 PltLinebarplot
Overview

ChangeStyle
DoAutoScale
DoAutoScaleX
DoAutoScaleY
GetAxisX
GetAxisY
GetDataSeries

492
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetLegend
GetTitleObject
SetAutoScaleModeX
SetAutoScaleModeY
SetAxisSharingLevelX
SetAxisSharingLevelY
SetScaleTypeX
SetScaleTypeY
SetScaleX
SetScaleY

ChangeStyle
Applies the plot style identified by the given name to this plot.
None PltLinebarplot.ChangeStyle(str styleName)

A RGUMENTS
styleName
Name of the style template to apply

R ETURNS
0 on success
1 on error

DoAutoScale
Adapts the plot’s axes ranges such that they show the entire data range.
None PltLinebarplot.DoAutoScale([int axisDimension])

A RGUMENTS
axisDimension (optional)
Limits auto-scaling to one dimension. Possible values:

0 scale only x-axes

1 scale only y-axes

DoAutoScaleX
Adapts the plot’s x-axes ranges such that they show the entire data range.
None PltLinebarplot.DoAutoScaleX()

DoAutoScaleY
Adapts the plot’s y-axes ranges such that they show the entire data range.
None PltLinebarplot.DoAutoScaleY()

493
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetAxisX
Returns one of the plot’s x-axes.
DataObject PltLinebarplot.GetAxisX([int axisIndex])

A RGUMENTS
axisIndex=0 (optional)
Determines which x-axis should be returned:
0 main x-axis
1 second x-axis (will be created if not yet present)

R ETURNS
PltAxis object

GetAxisY
Returns one of the plot’s y-axes.
DataObject PltLinebarplot.GetAxisY([int axisIndex])

A RGUMENTS
axisIndex=0 (optional)
Determines which y-axis should be returned:
0 main y-axis
1 second y-axis (will be created if not yet present)

R ETURNS
PltAxis object

GetDataSeries
Returns the plot’s data series object (PltDataseries).
DataObject PltLinebarplot.GetDataSeries()

R ETURNS
Data series object (PltDataseries)

GetLegend
Returns the plot’s legend object (PltLegend).
DataObject PltLinebarplot.GetLegend()

R ETURNS
Legend object (PltLegend)

494
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetTitleObject
Returns the plot’s title object (PltTitle).
DataObject PltLinebarplot.GetTitleObject()

R ETURNS
Title object (PltTitle)

SetAutoScaleModeX
Defines whether the plot should automatically adapt its main x-axis range on data changes.
None PltLinebarplot.SetAutoScaleModeX(int mode)

A RGUMENTS
mode Possible values:
0 off (do not react to data changes)
1 adapt scale after calculation has finished
2 adapt scale during live plotting

SetAutoScaleModeY
Defines whether the plot should automatically adapt its main y-axis range on data changes.
None PltLinebarplot.SetAutoScaleModeY(int mode)

A RGUMENTS
mode Possible values:
0 off (do not react to data changes)
1 adapt scale after calculation has finished
2 adapt scale during live plotting

SetAxisSharingLevelX
Defines whether the plot has its own x-axis or should share its x-axis across the page or the
entire graphics board.
None PltLinebarplot.SetAxisSharingLevelX(int level)

A RGUMENTS
level Possible values:
0 local (do not share x-axis)
1 use x-axis from page
2 use x-axis from graphics board

495
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetAxisSharingLevelY
Defines whether the plot has its own y-axis or should share its y-axis across the page or the
entire graphics board.
None PltLinebarplot.SetAxisSharingLevelY(int level)

A RGUMENTS
level Possible values:
0 local (do not share y-axis)
1 use y-axis from page
2 use y-axis from graphics board

SetScaleTypeX
Sets the scale type of the plot’s main x-axis.
None PltLinebarplot.SetScaleTypeX(int scaleType)

A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic

SetScaleTypeY
Set the scale type of the plot’s main y-axis.
None PltLinebarplot.SetScaleTypeY(int scaleType)

A RGUMENTS
scaleType
Possible values:
0 linear
1 logarithmic
2 dB

SetScaleX
Sets the scale of the plot’s main x-axis.
None PltLinebarplot.SetScaleX(float min,
float max
)

496
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets the scale of the plot’s main y-axis.
None PltLinebarplot.SetScaleY(float min,
float max
)

A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.

5.6.53 PltTitle
Overview

SetFont

SetFont
Sets the font for this axis
None PltAxis.SetFont(str fontName,
int fontSize,
int fontStyle)

A RGUMENTS
fontName
Font name
fontSize Font size
fontStyle Font style
1 Bold
2 Italic
3 Bold and italic
4 Underline

497
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.54 PltVectorplot
Overview

ChangeStyle
DoAutoScale
GetAxisX
GetAxisY
GetComplexData
GetLegend
GetTitleObject
SetAutoScaleModeX
SetAutoScaleModeY
SetScaleX
SetScaleY

ChangeStyle
Applies the plot style identified by the given name to this plot.
None PltVectorplot.ChangeStyle(str styleName)

A RGUMENTS
styleName
Name of the style template to apply

R ETURNS
0 on success
1 on error

DoAutoScale
Adapts the plot’s axes ranges such that they show the entire data range.
None PltVectorplot.DoAutoScale()

GetAxisX
Returns the plot’s x-axis.
DataObject PltVectorplot.GetAxisX()

R ETURNS
PltAxis object

GetAxisY
Returns the plot’s y-aies.
DataObject PltVectorplot.GetAxisY()

498
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
PltAxis object

GetComplexData
Returns the plot’s complex data definition object (PltComplexdata).
DataObject PltVectorplot.GetComplexData()

R ETURNS
Complex data definition object (PltComplexdata)

GetLegend
Returns the plot’s legend object (PltLegend).
DataObject PltVectorplot.GetLegend()

R ETURNS
Legend object (PltLegend)

GetTitleObject
Returns the plot’s title object (PltTitle).
DataObject PltVectorplot.GetTitleObject()

R ETURNS
Title object (PltTitle)

SetAutoScaleModeX
Defines whether the plot should automatically adapt its main x-axis range on data changes.
None PltVectorplot.SetAutoScaleModeX(int mode)

A RGUMENTS
mode Possible values:
0 off (do not react to data changes)
1 adapt scale after calculation has finished

SetAutoScaleModeY
Defines whether the plot should automatically adapt its main y-axis range on data changes.
None PltVectorplot.SetAutoScaleModeY(int mode)

499
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
mode Possible values:
0 off (do not react to data changes)
1 adapt scale after calculation has finished

SetScaleX
Sets the scale of the plot’s x-axis.
None PltVectorplot.SetScaleX(float min,
float max
)

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets the scale of the plot’s y-axis.
None PltVectorplot.SetScaleY(float min,
float max
)

A RGUMENTS
min Minimum of y-scale.
max Maximum of y-scale.

5.6.55 RelChar
Overview

SetCurve

SetCurve
Assign a tripping curve by name. The curve must be defined in the associated type object.
int RelChar.SetCurve(str name)

A RGUMENTS
name Name of the curve to assign (may contain wildcards).

R ETURNS
0 The curve was found and assigned.
1 No curve with the given name is defined or multiple curves matched the name.

500
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.56 RelToc
Overview

SetCurve

SetCurve
Assign a tripping curve by name. The curve must be defined in the associated type object.
int RelToc.SetCurve(str name)

A RGUMENTS
name Name of the curve to assign (may contain wildcards).

R ETURNS
0 The curve was found and assigned.
1 No curve with the given name is defined or multiple curves matched the name.

5.6.57 RelZpol
Overview

AssumeCompensationFactor
AssumeReRl
AssumeXeXl

AssumeCompensationFactor
Triggers a calculation of the complex compensation factor and stores the result.
int RelZpol.AssumeCompensationFactor()

R ETURNS
0 The compensation factor was successfully calculated.
1 An error occurred (e.g. conencted branch was not found).

AssumeReRl
Triggers a calculation of the real part of the decoupled compensation factor and stores the
result.
int RelZpol.AssumeReRl()

R ETURNS
0 The compensation factor was successfully calculated.
1 An error occurred (e.g. conencted branch was not found).

501
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AssumeXeXl
Triggers a calculation of the imaginary part of the decoupled compensation factor and stores
the result.
int RelZpol.AssumeXeXl()

R ETURNS
0 The compensation factor was successfully calculated.
1 An error occurred (e.g. conencted branch was not found).

5.6.58 ScnFreq
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float ScnFreq.GetLimit(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The limit value (in p.u.) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

GetNumberOfViolations
Returns the number of violations.
int ScnFreq.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float ScnFreq.GetValue(int vIdx)

A RGUMENTS
vIdx vIdx > 0

502
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
The ith value (in p.u.), given by vIdx, which causes the violation. If vIdx is negative, zero or
greater than the number of violations, then the function returns ’nan’.

GetVariable
Returns the name of the variable of the ith violation, given by vIdx.
str ScnFreq.GetVariable(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The name of the variable of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ”NoVariable”.

GetViolatedElement
Returns the element of the ith violation, given by vIdx.
DataObject ScnFreq.GetViolatedElement(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The element of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns None.

GetViolationTime
Returns the time (in seconds) of the ith violation, given by vIdx.
float ScnFreq.GetViolationTime(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The time (in seconds) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

503
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.59 ScnFrt
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float ScnFrt.GetLimit(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The limit value of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns ’nan’.

GetNumberOfViolations
Returns the number of violations.
int ScnFrt.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value, given by vIdx, which causes the violation.
float ScnFrt.GetValue(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The ith value, given by vIdx, which causes the violation. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

GetVariable
Returns the name of the variable of the ith violation, given by vIdx.
str ScnFrt.GetVariable(int vIdx)

504
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The name of the variable of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ”NoVariable”.

GetViolatedElement
Returns the element of the ith violation, given by vIdx.
DataObject ScnFrt.GetViolatedElement(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The element of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns None.

GetViolationTime
Returns the time (in seconds) of the ith violation, given by vIdx.
float ScnFrt.GetViolationTime(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The time (in seconds) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

5.6.60 ScnSpeed
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float ScnSpeed.GetLimit(int vIdx)

505
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The limit value (in p.u.) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

GetNumberOfViolations
Returns the number of violations.
int ScnSpeed.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float ScnSpeed.GetValue(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The ith value (in p.u.), given by vIdx, which causes the violation. If vIdx is negative, zero or
greater than the number of violations, then the function returns ’nan’.

GetVariable
Returns the name of the variable of the ith violation, given by vIdx.
str ScnSpeed.GetVariable(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The name of the variable of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ”NoVariable”.

GetViolatedElement
Returns the element of the ith violation, given by vIdx.
DataObject ScnSpeed.GetViolatedElement(int vIdx)

A RGUMENTS
vIdx vIdx > 0

506
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 ScnSpeed.GetViolationTime(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The time (in seconds) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

5.6.61 ScnSync
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float ScnSync.GetLimit(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The limit value of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns ’nan’.

GetNumberOfViolations
Returns the number of violations.
int ScnSync.GetNumberOfViolations()

R ETURNS
The number of violations.

507
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetValue
Returns the ith value, given by vIdx, which causes the violation.
float ScnSync.GetValue(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The ith value, given by vIdx, which causes the violation. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

GetVariable
Returns the name of the variable of the ith violation, given by vIdx.
str ScnSync.GetVariable(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The name of the variable of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ”NoVariable”.

GetViolatedElement
Returns the element of the ith violation, given by vIdx.
DataObject ScnSync.GetViolatedElement(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The element of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns None.

GetViolationTime
Returns the time (in seconds) of the ith violation, given by vIdx.
float ScnSync.GetViolationTime(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The time (in seconds) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

508
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.62 ScnVar
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value of the ith violation, given by vIdx.
float ScnVar.GetLimit(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The limit value of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns ’nan’.

GetNumberOfViolations
Returns the number of violations.
int ScnVar.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value, given by vIdx, which causes the violation.
float ScnVar.GetValue(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The ith value, given by vIdx, which causes the violation. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

GetVariable
Returns the name of the variable of the ith violation, given by vIdx.
str ScnVar.GetVariable(int vIdx)

509
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 ScnVar.GetViolatedElement(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The element of the ith violation, given by vIdx. If vIdx is negative, zero or greater than the
number of violations, then the function returns None.

GetViolationTime
Returns the time (in seconds) of the ith violation, given by vIdx.
float ScnVar.GetViolationTime(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The time (in seconds) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

5.6.63 ScnVolt
Overview

GetLimit
GetNumberOfViolations
GetValue
GetVariable
GetViolatedElement
GetViolationTime

GetLimit
Returns the limit value (in p.u.) of the ith violation, given by vIdx.
float ScnVolt.GetLimit(int vIdx)

510
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The limit value (in p.u.) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

GetNumberOfViolations
Returns the number of violations.
int ScnVolt.GetNumberOfViolations()

R ETURNS
The number of violations.

GetValue
Returns the ith value (in p.u.), given by vIdx, which causes the violation.
float ScnVolt.GetValue(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The ith value (in p.u.), given by vIdx, which causes the violation. If vIdx is negative, zero or
greater than the number of violations, then the function returns ’nan’.

GetVariable
Returns the name of the variable of the ith violation, given by vIdx.
str ScnVolt.GetVariable(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The name of the variable of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ”NoVariable”.

GetViolatedElement
Returns the element of the ith violation, given by vIdx.
DataObject ScnVolt.GetViolatedElement(int vIdx)

A RGUMENTS
vIdx vIdx > 0

511
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 ScnVolt.GetViolationTime(int vIdx)

A RGUMENTS
vIdx vIdx > 0

R ETURNS
The time (in seconds) of the ith violation, given by vIdx. If vIdx is negative, zero or greater
than the number of violations, then the function returns ’nan’.

5.6.64 StoMaint
Overview

SetElms

SetElms
Sets the maintenance elements.
None StoMaint.SetElms(DataObject singleElement)
None StoMaint.SetElms(list multipleElements)

A RGUMENTS
singleElement
single Element for Maintenance

multipleElements
multiple Elements for Maintenance

5.6.65 TypAsmo
Overview

CalcElParams

CalcElParams
Calculates the electrical parameters from the input data. Behaves as the calculate button on
the basic data page was pressed and the parameter estimation is executed. Shall be applied
only if the Input mode is set to ’Slip-Torque/Current Characteristic’ or ’Measurement curves’.
int TypAsmo.CalcElParams([float acceptSqError = 1.e-03],
[int solverType = 0],

512
5.6. OTHERS CHAPTER 5. OBJECT METHODS

[int useLinConst = 1],

[int considerEff = 1],
[float kx = 0.5],
[float kr = 1.])

A RGUMENTS
acceptSqError (optional)
If calculated squared error is bolow this value, calculation is successfull.
solverType (optional)
Solver used in the parameter estimation. Possible values are:

0 LBFGS (default).
1 Particle swarm optimisation.
2 Conjugate gradient descent.
3 Newton (old, deprecated).

useLinConst (optional)
0: Xs from type is used, 1: linear constraints used.
considerEff (optional)
If = 1, efficiency is considered in the estimation.
kx (optional)
value for kx (only if linear constraints selected).
kr (optional)
value for kr (only if linear constraints selected and efficiency not considered).

R ETURNS
0 Calculation successfully (squared error less than acceptSqError).
1 Error.

5.6.66 TypCtcore
Overview

AddRatio
RemoveRatio
RemoveRatioByIndex

AddRatio
Adds the given ratio to the core. The ratio is added so that the sorting remains in ascending
order. The accuracy parameters will be copied from the previous row. If the new ratio is to be
the first ratio, the accuracy parameters will be copied from the next row instead.
int TypCtcore.AddRatio(float ratio)

A RGUMENTS
ratio New ratio to add.

R ETURNS
0 New ratio was added.

513
5.6. OTHERS CHAPTER 5. OBJECT METHODS

1 An error occurred.

RemoveRatio
Removes the given ratio from the core. The last remaining ratio can never be removed.
int TypCtcore.RemoveRatio(float ratio)

A RGUMENTS
ratio Ratio to remove.

R ETURNS
0 Ratio was removed.
1 An error occurred.

RemoveRatioByIndex
Removes the ratio with the given index from the core. The index is zero based. The last
remaining ratio can never be removed.
int TypCtcore.RemoveRatio(int index)

A RGUMENTS
index Index to remove.

R ETURNS
0 Index was removed.
1 An error occurred.

5.6.67 TypLne
Overview

IsCable

IsCable
Checks if the line type is a cable type.
int TypLne.IsCable()

R ETURNS
1 Type is a cable
0 Type is not a cable

514
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.68 TypMdl
Overview

Check
Compile

Check
Checks the model for errors e.g during parsing of interpreted model, during loading of compiled
model.
int TypMdl.Check()

R ETURNS
0 TypMdl is OK.
1 Error during parsing of interpreted model.
2 Error during loading of compiled model.

Compile
Compile the model.
int TypMdl.Compile([const char* modelPath], [int overrideModel])

A RGUMENTS
modelPath (optional)
Full path to a location where the model should be stored. Leave empty to use
default.

overrideModel (optional)
The model will be overrided if already present at the selected location and if the
value is set to 1. (default = 0)

R ETURNS
0 Compilation is Ok.
1 Compilation failled

5.6.69 TypQdsl
Overview

Encrypt
IsEncrypted
ResetThirdPartyModule
SetThirdPartyModule

515
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Encrypt
Encrypts a type. An encrypted type can be used without password but decrypted only with
password. If no password is given a ’Choose Password’ dialog appears.
int TypQdsl.Encrypt([str password = ""],
[int removeObjectHistory = 1],
[int masterCode = 0])

A RGUMENTS
password (optional)
Password for decryption. If no password is given a ’Choose Password’ dialog
appears.

removeObjectHistory (optional)
Handling of unencrypted object history in database, e.g. used by project versions
or by undo:
0 Do not remove.
1 Do remove (default).
2 Show dialog and ask.
masterCode (optional)
Used for re-selling types. Third party licence codes already set in the type will be
overwritten by this value (default = 0).

R ETURNS
0 On success.
1 On error.

S EE ALSO

TypQdsl.IsEncrypted()

IsEncrypted
Returns the encryption state of the type.
int TypQdsl.IsEncrypted()

R ETURNS
1 Type is encrypted.
0 Type is not encrypted.

S EE ALSO

TypQdsl.Encrypt()

ResetThirdPartyModule
Resets the third party licence. Only possible for non-encrypted models. Requires masterkey
licence for third party module currently set.
int TypQdsl.ResetThirdPartyModule()

516
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 models with no
third party licence set so far. Requires masterkey licence for third party module to be set.
int TypQdsl.SetThirdPartyModule(str companyCode,
str moduleCode
)

A RGUMENTS
companyCode
D isplay name or numeric value of company code.
moduleCode
D isplay name or numeric value of third party module.

R ETURNS
0 On success.
1 On error.

5.6.70 TypTr2
Overview

GetZeroSequenceHVLVT

GetZeroSequenceHVLVT
Returns the calculated star equivalent of the zero sequence impedances.
[int error,
float hvReal,
float hvImag,
float lvReal,
float lvImag,
float tReal ,
float tImag ] TypTr2.GetZeroSequenceHVLVT()

A RGUMENTS
hvReal (out)
Real part of the HV impedance in %.
hvImag (out)
Imaginary part of the HV impedance in %.
lvReal (out)
Real part of the LV impedance in %.
lvImag (out)
Imaginary part of the LV impedance in %.

517
5.6. OTHERS CHAPTER 5. OBJECT METHODS

tReal (out)
Real part of the tertiary (delta) impedance in %.

tImag (out)
Imaginary part of the tertiary (delta) impedance in %.

R ETURNS
0 No error occurred.
1 An error occurred; the values are invalid.

5.6.71 VisBdia
Overview

AddObjs
AddResObjs
Clear
SetScaleY
SetXVariable
SetYVariable

AddObjs
Adds objects to elements column in table 'Bars'.
None VisBdia.AddObjs(list elements)

A RGUMENTS
elements Elements to add in table.

AddResObjs
Adds objects to elements column in table 'Bars' (similar to AddObjs). Additionally a result file is
assigned to all rows added in the 'Result File' column.
None VisBdia.AddResObjs(DataObject resultFileObj,
list elements
)

A RGUMENTS
resultFileObj
The result file to assign. Must be an object of class ElmRes.
elements Elements to add in table.

Clear
Removes all elements from plot by erasing all rows from the table named 'Bars'.
None VisBdia.Clear()

518
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetScaleY
Sets y-axis scale limits.
None VisBdia.SetScaleY(float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

SetXVariable
Set the x-axis Variable of the Distortion Analysis Diagram
int VisBdia.SetXVariable(str variable)

A RGUMENTS
variable x-axis variable to set.Length of variable must not exceed 37 characters.

R ETURNS
0 if ok, 1 if variable length exceeds 37 characters,

SetYVariable
Set the y-axis variable of the Distortion Analysis Diagram
int VisBdia.SetYVariable(str variable)

A RGUMENTS
variable y-axis variable to set.Length of variable must not exceed 37 characters.

R ETURNS
0 if ok, 1 if variable length exceeds 37 characters,

519
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.72 VisDraw
Overview

AddRelay
AddRelays
CentreOrigin
Clear
DoAutoScaleOnAll
DoAutoScaleOnCharacteristics
DoAutoScaleOnImpedances
DoAutoScaleX
DoAutoScaleY

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None VisDraw.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])

A RGUMENTS
relay The protection device to be added.
colour (optional)
The colour to be used.
style (optional)
The line style to be used.
width (optional)
The line width to be used.

AddRelays
Adds relays to the plot.
None VisDraw.AddRelays(list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

CentreOrigin
Centre the origin of the plot
None VisDraw.CentreOrigin()

520
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Clear
Removes all protection devices from the plot.
None VisDraw.Clear()

DoAutoScaleOnAll
Scales the plot automatically under consideration of relay characteristics, simulation curves and
short circuit arrows. The function works for local scales only.
int VisDraw.DoAutoScaleOnAll()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

DoAutoScaleOnCharacteristics
Scales the plot automatically under consideration of relay characteristics. Same as button
named Characteristics. The function works for local scales only.
int VisDraw.DoAutoScaleOnCharacteristics()

R ETURNS
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 VisDraw.DoAutoScaleOnImpedances()

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

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

521
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

5.6.73 VisHrm
Overview

Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
GetScaleObjX
GetScaleObjY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc
SetDefScaleX
SetDefScaleY

Clear
Removes all curves by clearing table named 'Curves'.
None VisHrm.Clear()

DoAutoScaleX
Scales x-axis automatically.
int VisHrm.DoAutoScaleX()

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scale is not local

DoAutoScaleY
Scales y-axis automatically.
int VisHrm.DoAutoScaleY()

R ETURNS
0 Ok, call to DoAutoScaleY() was successfull
1 Failed, because the y-scale is not local

522
5.6. OTHERS CHAPTER 5. OBJECT METHODS

GetDataSource
Get data source for curve with index
DataObject VisHrm.GetDataSource(int curveIndex)

A RGUMENTS
int curveIndex
Possible values:
<0 invalid
≥0 curve index in table

R ETURNS
DataObject Data source
None No data source found

GetScaleObjX
Gets the object used for scaling the x-axis.
DataObject VisHrm.GetScaleObjX()

R ETURNS
this object In case that 'Use local Axis' is set to 'Local'.
the virtual instrument panel In case that 'Use local axis' is set to 'Current Page'.
the graphics board In case that 'Use local axis' is set to 'Graphics Board'.

GetScaleObjY
Gets the object used for scaling the y-axis.
DataObject VisHrm.GetScaleObjY()

R ETURNS
this object In case that 'Use local Axis' is enabled.
the plot type In case that 'Use local axis' is disabled.

SetAutoScaleX
Sets Auto Scale setting of the x-scale. The scale is automatic set to local, in case that the
waveform plot is using the scale of the graphics board or the virtual instrument panel.
None VisHrm.SetAutoScaleX(int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation

523
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
waveform plot is using the scale of the plot type.
None VisHrm.SetAutoScaleY(int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation

SetCrvDesc
Sets the user defined description of a curve.
None VisHrm.SetCrvDesc(int curveIndex, str curveDescription)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set

SetDefScaleX
Sets the x-scale to be used to the graphics board.
None VisHrm.SetDefScaleX()

SetDefScaleY
Sets the y-scale to be used to the plot type.
None VisHrm.SetDefScaleY()

5.6.74 VisMagndiffplt
Overview

AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY
Refresh

524
5.6. OTHERS CHAPTER 5. OBJECT METHODS

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None VisMagndiffplt.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])

A RGUMENTS
relay The protection device to be added.
colour (optional)
The colour to be used.
style (optional)
The line style to be used.
width (optional)
The line width to be used.

AddRelays
Adds relays to the plot.
None VisMagndiffplt.AddRelays(list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

Clear
Removes all protection devices from the plot.
None VisMagndiffplt.Clear()

DoAutoScaleX
Scales the x-axis of the plot automatically. The function works for local x-scales only. If the
x-scale is not local a warning is shown in the output window and 1 is returned by the function.
int VisMagndiffplt.DoAutoScaleX()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

DoAutoScaleY
Scales the y-axis of the plot automatically. The function works for local y-scales only. If the
x-scale is not local a warning is shown in the output window and 1 is returned by the function.
int VisMagndiffplt.DoAutoScaleY()

525
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

Refresh
Refreshes the plot by attempting to automatically scale both axes.
None VisMagndiffplt.Refresh()

5.6.75 VisOcplot
Overview

AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY
Refresh

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None VisOcplot.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])

A RGUMENTS
relay The protection device to be added.
colour (optional)
The colour to be used.

style (optional)
The line style to be used.
width (optional)
The line width to be used.

AddRelays
Adds relays to the plot.
None VisOcplot.AddRelays(list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

526
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Clear
Removes all protection devices from the plot.
None VisOcplot.Clear()

DoAutoScaleX
Scales the x-axis of the plot automatically. The function works for local x-scales only. If the
x-scale is not local a warning is shown in the output window and 1 is returned by the function.
int VisOcplot.DoAutoScaleX()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

DoAutoScaleY
Scales the y-axis of the plot automatically. The function works for local y-scales only. If the
x-scale is not local a warning is shown in the output window and 1 is returned by the function.
int VisOcplot.DoAutoScaleY()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

Refresh
Refreshes the plot by attempting to automatically scale both axes.
None VisOcplot.Refresh()

5.6.76 VisPath
Overview

Clear
DoAutoScaleX
DoAutoScaleY
SetAdaptX
SetAdaptY
SetScaleX
SetScaleY

Clear
Removes all curves by clearing table named 'Variables' on page 'Curves'.
None VisPath.Clear()

527
5.6. OTHERS CHAPTER 5. OBJECT METHODS

DoAutoScaleX
Scales x-axis automatically.
int VisPath.DoAutoScaleX()

R ETURNS
Always 0

DoAutoScaleY
Scales y-axis automatically.
int VisPath.DoAutoScaleY()

R ETURNS
Always 0

SetAdaptX
Sets the Adapt Scale option of the x-scale.
None VisPath.SetAdaptX(int mode)

A RGUMENTS
mode Possible values:
0 off
1 on

SetAdaptY
Sets the Adapt Scale option of the x-scale.
None VisPath.SetAdaptY(int mode)

A RGUMENTS
mode Possible values:

0 off
1 on

SetScaleX
Sets x-axis scale.
None VisPath.SetScaleX(float min,
float max
)

528
5.6. OTHERS CHAPTER 5. OBJECT METHODS

A RGUMENTS
min Minimum of x-scale.
max Maximum of x-scale.

SetScaleY
Sets y-axis scale limits.
None VisPath.SetScaleY(float min,
float max,
[int log]
)

A RGUMENTS
min Minimum of y-scale.

max Maximum of y-scale.

log (optional)
Possible values:
0 linear
1 logarithmic

5.6.77 VisPcompdiffplt
Overview

AddRelay
AddRelays
CentreOrigin
Clear
DoAutoScaleX
DoAutoScaleY

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None VisPcompdiffplt.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])

A RGUMENTS
relay The protection device to be added.
colour (optional)
The colour to be used.

style (optional)
The line style to be used.

529
5.6. OTHERS CHAPTER 5. OBJECT METHODS

width (optional)
The line width to be used.

AddRelays
Adds relays to the plot.
None VisPcompdiffplt.AddRelays(list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

CentreOrigin
Centre the origin of the plot
None VisPcompdiffplt.CentreOrigin()

Clear
Removes all protection devices from the plot.
None VisPcompdiffplt.Clear()

DoAutoScaleX
Scales the x-axis of the plot automatically. The function works for local x-scales only. If the
x-scale is not local a warning is shown in the output window and 1 is returned by the function.
int VisPcompdiffplt.DoAutoScaleX()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

DoAutoScaleY
Scales the y-axis of the plot automatically. The function works for local y-scales only. If the
x-scale is not local a warning is shown in the output window and 1 is returned by the function.
int VisPcompdiffplt.DoAutoScaleY()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

530
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.78 VisPlot
Overview

AddResVars
AddVars
Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
GetIntCalcres
GetScaleObjX
GetScaleObjY
SetAdaptX
SetAdaptY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc
SetDefScaleX
SetDefScaleY
SetScaleX
SetScaleY
SetXVar

AddResVars
Appends variables to the plot. Variables which are already in the plot are not added.
None VisPlot.AddResVars(DataObject elmRes,
DataObject element,
str varname
)

A RGUMENTS
elmRes Result object, classname ElmRes.

elememt Element to add.

varname Variable name.

AddVars
Appends variables to the plot. Variables which are already in the plot are not added.
None VisPlot.AddVars(DataObject element,
str varname
)

A RGUMENTS
elememt Element to add.
varname Variable name.

531
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Clear
Removes all curves from plot.
None VisPlot.Clear()

DoAutoScaleX
Scales x-axis automatically.
int VisPlot.DoAutoScaleX()

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scale is not local

DoAutoScaleY
Scales y-axis automatically.
int VisPlot.DoAutoScaleY()

R ETURNS
0 Ok, call to DoAutoScaleY() was successfull
1 Failed, because the y-scale is not local

GetDataSource
Get data source for curve with index
DataObject VisPlot.GetDataSource(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 VisPlot.GetIntCalcres()

532
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
All Calculated Result objects (IntCalcres) stored inside plot.

GetScaleObjX
Gets the object used for scaling the x-axis.
DataObject VisPlot.GetScaleObjX()

R ETURNS
this object In case that 'Use local Axis' is set to 'Local'.
the virtual instrument panel In case that 'Use local axis' is set to 'Current Page'.
the graphics board In case that 'Use local axis' is set to 'Graphics Board'.

GetScaleObjY
Gets the object used for scaling the y-axis.
DataObject VisPlot.GetScaleObjY()

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 VisPlot.SetAdaptX(int mode,
[float trigger]
)

A RGUMENTS
mode Possible values:
0 off
1 on
trigger (optional)
Trigger value, unused if mode is off or empty

SetAdaptY
Sets the Adapt Scale option of the local y-scale.
None VisPlot.SetAdaptY(int mode,
[float offset]
)

533
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 graphics board or the virtual instrument panel.
None VisPlot.SetAutoScaleX(int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

SetAutoScaleY
Sets Auto Scale setting of the y-scale. The scale is automatic set to local, in case that the plot
is using the scale of the plot type.
None VisPlot.SetAutoScaleY(int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

SetCrvDesc
Sets the user defined description of a curve.
None VisPlot.SetCrvDesc(int curveIndex,
str curveDescription
)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set.

534
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetDefScaleX
Sets the x-scale to be used to the graphics board.
None VisPlot.SetDefScaleX()

SetDefScaleY
Sets the y-scale to be used to the plot type.
None VisPlot.SetDefScaleY()

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 VisPlot.SetScaleX()
None VisPlot.SetScaleX(float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.
log (optional)
Possible values:
0 linear
1 logarithmic

SetScaleY
Sets the local y-axis scale. A function call without arguments sets the Auto Scale setting to On
without changing the scale itself.
None VisPlot.SetScaleY()
None VisPlot.SetScaleY(float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of y-scale.
max (optional)
Maximum of y-scale.
log (optional)
Possible values:

535
5.6. OTHERS CHAPTER 5. OBJECT METHODS

0 linear
1 logarithmic

SetXVar
Sets the local x-axis variable. If The default x-axis variable (time) is set if no argument is
passed.
None VisPlot.SetXVar()
None VisPlot.SetXVar(DataObject obj,]
str varname
)

A RGUMENTS
obj (optional)
x-axis object

varname (optional)
variable of obj

5.6.79 VisPlot2
Overview

AddResVars
AddVars
Clear
DoAutoScaleX
DoAutoScaleY
DoAutoScaleY2
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 VisPlot2.AddResVars(DataObject elmRes,
DataObject element,
str varname,
[int y2]

536
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 VisPlot2.AddVars(DataObject element,
str varname,
[int y2]
)

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 VisPlot2.Clear([int y2])

A RGUMENTS
y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

DoAutoScaleX
Scales x-axis automatically.
int VisPlot2.DoAutoScaleX()

537
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scale is not local

DoAutoScaleY
Scales y1-axis automatically.
int VisPlot2.DoAutoScaleY()

R ETURNS
0 Ok, call to DoAutoScaleY() was successfull
1 Failed, because the y-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

GetDataSource
Get data source for curve with index
DataObject VisPlot2.GetDataSource(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 VisPlot2.GetScaleObjX()

538
5.6. OTHERS CHAPTER 5. OBJECT METHODS

R ETURNS
this object In case that 'Use local Axis' is set to 'Local'.
the virtual instrument panel In case that 'Use local axis' is set to 'Current Page'.
the graphics board In case that 'Use local axis' is set to 'Graphics Board'.

GetScaleObjY
Returns used object defining y-scale. The returned object is either the plot itself or the plot type
(IntPlot).
DataObject VisPlot2.GetScaleObjY ([int y2])

R ETURNS
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 VisPlot2.SetAdaptX(int mode,
[float trigger]
)

A RGUMENTS
mode Possible values:
0 off
1 on
trigger (optional)
Trigger value, unused if mode is off or empty

SetAdaptY
Sets the Adapt Scale option of the local y-scale.
None VisPlot2.SetAdaptY(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:

539
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 graphics board or the virtual instrument panel.
None VisPlot2.SetAutoScaleX(int mode)

A RGUMENTS
mode Possible values:
0 never
1 after simulation
2 during simulation

SetAutoScaleY
Sets automatic scaling mode of the y-scale. The axis given in the second argument is automat-
ically set to local.
None VisPlot2.SetAutoScaleY (int mode,
[int y2]
)

A RGUMENTS
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 VisPlot2.SetCrvDesc(int curveIndex, str curveDescription)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.
curveDescription
Description to set

540
5.6. OTHERS CHAPTER 5. OBJECT METHODS

SetDefScaleX
Sets the x-scale to be used to the graphics board.
None VisPlot2.SetDefScaleX()

SetDefScaleY
Sets the y-scale to be used to the plot type.
None VisPlot2.SetDefScaleY([int y2])

A RGUMENTS
y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

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 VisPlot.SetScaleX()
None VisPlot.SetScaleX(float min,
float max,
[int log]
)

A RGUMENTS
min (optional)
Minimum of x-scale.
max (optional)
Maximum of x-scale.
log (optional)
Possible values:
0 linear
1 logarithmic

SetScaleY
Sets scale of y-axis. Calling the function without any argument sets the Auto Scale option for
the y axis (both share the same setting) to On.
None VisPlot2.SetScaleY()
None VisPlot2.SetScaleY(float min,
float max,
[int log,]
[int Y2]
)

541
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

y2 (optional)
Possible values:
1 y1-axis, default value
2 y2 axis

SetXVar
Sets the local x-axis variable. If The default x-axis variable (time) is set if no argument is
passed.
None VisPlot.SetXVar()
None VisPlot.SetXVar(DataObject obj,]
str varname
)

A RGUMENTS
obj (optional)
x-axis object
varname (optional)
variable of obj

ShowY2
Enables or disables the y2 axis.
None VisPlot2.ShowY2([int show])

A RGUMENTS
show (optional)
Possible values:

0 hide y2 axis
1 show y2 axis (default)

542
5.6. OTHERS CHAPTER 5. OBJECT METHODS

5.6.80 VisPlottz
Overview

AddRelay
AddRelays
Clear
DoAutoScaleX
DoAutoScaleY

AddRelay
Adds a relay to the plot and optionally sets the drawing style.
None VisPlottz.AddRelay(DataObject relay,
[float colour,]
[float style,]
[float width])

A RGUMENTS
relay The protection device to be added.
colour (optional)
The colour to be used.
style (optional)
The line style to be used.
width (optional)
The line width to be used.

AddRelays
Adds relays to the plot.
None VisPlottz.AddRelays(list relays)

A RGUMENTS
relays The protection devices (ElmRelay or RelFuse) to be added.

Clear
Removes all protection devices from the plot.
None VisPlottz.Clear()

DoAutoScaleX
Scales the x-axis of the plot automatically. The function works for local x-scales only. If the
x-scale is not local a warning is shown in the output window and 1 is returned by the function.
int VisPlottz.DoAutoScaleX()

543
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 VisPlottz.DoAutoScaleY()

R ETURNS
0 Automatic scaling was executed.
1 An Error occurred.

5.6.81 VisVec
Overview

CentreOrigin

CentreOrigin
Centre the origin of the plot
None VisVec.CentreOrigin()

5.6.82 VisVecres
Overview

CentreOrigin

CentreOrigin
Centre the origin of the plot
None VisVecres.CentreOrigin()

5.6.83 VisXyplot
Overview

Clear
DoAutoScaleX
DoAutoScaleY
GetDataSource
SetCrvDescX
SetCrvDescY

544
5.6. OTHERS CHAPTER 5. OBJECT METHODS

Clear
Removes all curves from plot.
None VisXyplot.Clear()

DoAutoScaleX
Scales all used x-axes automatically.
int VisXyplot.DoAutoScaleX()

R ETURNS
0 Ok, call to DoAutoScaleX() was successfull
1 Failed, because the x-scales are not local

DoAutoScaleY
Scales all used y-axes automatically.
int VisXyplot.DoAutoScaleY()

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 VisPlot.GetDataSource(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 VisXyplot.SetCrvDescX(int curveIndex, str curveDescription)

545
5.6. OTHERS CHAPTER 5. OBJECT METHODS

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 VisXyplot.SetCrvDescY(int curveIndex, str curveDescription)

A RGUMENTS
curveIndex
Curve index; first curve in table is index 1.

curveDescription
Description to set

546
Index

version IntAddonvars, 404

Module Functions, 2 AddObjs
VisBdia, 518
Activate AddPage
ElmNet, 111 SetDesktop, 358
IntCase, 406 AddProjectToCombined
IntLibrary, 438 IntPrj, 452
IntPrj, 452 AddProjectToRemoteDatabase
IntScenario, 467 IntPrj, 452
IntScensched, 471 AddRas
IntScheme, 473 ComSimoutage, 326
IntSscheduler, 474 AddRatio
IntSstage, 475 TypCtcore, 513
ActivateProject AddRef
Application Methods, 6 ComNmink, 304
AdaptWidth IntDataset, 420
IntGrflayer, 430 SetSelect, 373
SetLevelvis, 365 AddRelay
AddCntcy VisDraw, 520
ComSimoutage, 326 VisMagndiffplt, 525
AddConfiguration VisOcplot, 526
SetDataext, 356 VisPcompdiffplt, 529
AddContingencies VisPlottz, 543
ComSimoutage, 326 AddRelays
AddCopy VisDraw, 520
General Object Methods, 53 VisMagndiffplt, 525
AddCubicle VisOcplot, 526
ElmBoundary, 88 VisPcompdiffplt, 530
AddCurve VisPlottz, 543
PltDataseries, 490 AddResObjs
AddDouble VisBdia, 518
IntAddonvars, 401 AddResVars
AddDoubleMatrix VisPlot, 531
IntAddonvars, 401 VisPlot2, 536
AddDoubleVector AddString
IntAddonvars, 402 IntAddonvars, 404
AddEvent AddToUpdatePages
IntRas, 466 ComProtgraphic, 310
AddInteger AddTrigger
IntAddonvars, 402 IntGate, 428
AddIntegerVector IntRas, 466
IntAddonvars, 403 AddVar
AddObject IntMon, 446
IntAddonvars, 403 AddVariable
AddObjectVector ElmRes, 120

547
INDEX INDEX

AddVars EncodeColour, 8
ElmRes, 120 ExecuteCmd, 9
IntMon, 446 GetActiveCalculationStr, 9
VisPlot, 531 GetActiveNetworkVariations, 10
VisPlot2, 537 GetActiveProject, 10
AddVector GetActiveScenario, 10
PltComplexdata, 489 GetActiveScenarioScheduler, 10
AddXYCurve GetActiveStages, 10
PltDataseries, 490 GetActiveStudyCase, 11
Align GetAllUsers, 11
IntGrflayer, 430 GetAttributeDescription, 11
SetLevelvis, 365 GetAttributeUnit, 12
All GetBorderCubicles, 12
IntDataset, 420 GetBrowserSelection, 12
SetSelect, 373 GetCalcRelevantObjects, 13
AllAsm GetClassDescription, 13
SetSelect, 373 GetClassId, 14
AllBars GetCurrentDiagram, 14
SetSelect, 374 GetCurrentScript, 14
AllBreakers GetCurrentSelection, 14
SetPath, 368 GetCurrentUser, 15
SetSelect, 374 GetCurrentZoomScaleLevel, 15
AllClosedBreakers GetDataFolder, 15
SetPath, 369 GetDiagramSelection, 16
SetSelect, 374 GetFlowOrientation, 16
AllElm GetFromStudyCase, 16
SetSelect, 374 GetGlobalLibrary, 17
AllLines GetGraphicsBoard, 17
SetSelect, 374 GetInterfaceVersion, 17
AllLoads GetLanguage, 17
SetSelect, 375 GetLocalLibrary, 18
AllOpenBreakers GetMem, 18
SetPath, 369 GetProjectFolder, 18
SetSelect, 375 GetRecordingStage, 19
AllProtectionDevices GetSettings, 19
SetPath, 369 GetSummaryGrid, 19
AllSym GetUserManager, 19
SetSelect, 375 GetUserSettings, 20
AllTypLne Hide, 20
SetSelect, 375 ImportDz, 20
AnalyseElmRes ImportSnapshot, 21
ComRel3, 315 IsAttributeModeInternal, 21
AppendCommand IsLdfValid, 21
ComTasks, 332 IsNAN, 21
AppendStudyCase IsRmsValid, 22
ComTasks, 333 IsScenarioAttribute, 22
ComTececocmp, 340 IsShcValid, 22
Application Methods, 4 IsSimValid, 22
ActivateProject, 6 IsWriteCacheEnabled, 23
ClearRecycleBin, 6 LicenceHasModule, 23
CommitTransaction, 6 LoadProfile, 24
CreateFaultCase, 6 MarkInGraphics, 25
CreateProject, 7 OutputFlexibleData, 25
DecodeColour, 7 PostCommand, 25
DefineTransferAttributes, 8 PrepForUntouchedDelete, 26
DeleteUntouchedObjects, 8 Rebuild, 26

548
INDEX INDEX

ReloadProfile, 26 AssumeReRl
ResetCalculation, 26 RelZpol, 501
ResGetData, 27 AssumeXeXl
ResGetDescription, 27 RelZpol, 502
ResGetFirstValidObject, 27
ResGetFirstValidObjectVariable, 27 BeginDataExtensionModification
ResGetFirstValidVariable, 27 IntPrj, 453
ResGetIndex, 28 BlkDef, 382
ResGetMax, 28 CalculateCheckSum, 383
ResGetMin, 28 Check, 383
ResGetNextValidObject, 28 Compile, 383
ResGetNextValidObjectVariable, 28 Encrypt, 383
ResGetNextValidVariable, 29 GetCheckSum, 383
ResGetObject, 29 Pack, 384
ResGetUnit, 29 PackAsMacro, 384
ResGetValueCount, 29 ResetThirdPartyModule, 384
ResGetVariable, 29 SetThirdPartyModule, 384
ResGetVariableCount, 29 BlkSig, 385
ResLoadData, 29 GetFromSigName, 385
ResReleaseData, 30 GetToSigName, 385
ResSortToVariable, 30 BlockSwitch
SaveAsScenario, 30 ComShctrace, 320
SearchObjectByForeignKey, 30 BuildNodeNames
SelectToolbox, 30 ComUcteexp, 343
SetAttributeModeInternal, 31
SetInterfaceVersion, 31 CalcAggrVarsInRadFeed
SetShowAllUsers, 31 ElmFeeder, 95
SetWriteCacheEnabled, 32 CalcCluster
Show, 32 SetCluster, 347
SplitLine, 32 SetDistrstate, 364
StatFileGetXrange, 33 CalcContributions
StatFileResetXrange, 33 ComRelpost, 317
StatFileSetXrange, 33 CalcDiscountedEstimatedPaybackPeriod
WriteChangesToDb, 34 ComTececocmp, 340
Apply CalcEfficiency
ElmBmu, 88 ElmAsm, 81
IntOutage, 448 ElmGenstat, 98
IntScenario, 467 ElmPvsys, 112
IntSubset, 478 ElmSym, 140
ApplyAll ElmXnet, 167
IntOutage, 448 CalcElParams
ApplyAndResetRA TypAsmo, 512
ElmSubstat, 135 CalcEstimatedPaybackPeriod
ApplyNetworkState ComTececocmp, 340
IntCase, 406 CalcInternalRateOfReturn
ApplySelective ComTececocmp, 341
IntScenario, 468 CalcMaxHostedPower
IntSubset, 478 ComHostcap, 292
ApplyStudyTime CalcShiftedReversedBoundary
IntCase, 406 ElmBoundary, 89
Archive CalculateCheckSum
IntPrj, 453 BlkDef, 383
AreDistParamsPossible CalculateInterchangeTo
ElmLne, 103 ElmArea, 79
AssumeCompensationFactor ElmNet, 111
RelZpol, 501 ElmZone, 169

549
INDEX INDEX

CanAddProjectToRemoteDatabase DeleteParameterAtIndex, 386

IntPrj, 453 GetAttributeEnumerationType, 386
CanSubscribeProjectReadOnly GetModelsReferencingThis, 386
IntPrj, 453 GetParameterCount, 387
CanSubscribeProjectReadWrite GetParameterNamespace, 387
IntPrj, 453 GetParameterValue, 387
CentreOrigin HasParameter, 387
VisDraw, 520 RemoveParameter, 388
VisPcompdiffplt, 530 SetAssociationValue, 388
VisVec, 544 SetAttributeEnumeration, 389
VisVecres, 544 SetAttributeValue, 389, 390
ChangeColourPalette CimObject, 390
PltComplexdata, 489 DeleteParameterAtIndex, 390
PltDataseries, 491 GetAttributeEnumerationType, 390
ChangeFont GetObjectsReferencingThis, 391
IntGrflayer, 431 GetObjectsWithSameId, 391
SetLevelvis, 365 GetParameterCount, 391
ChangeFrameAndWidth GetParameterNamespace, 391
SetLevelvis, 366 GetParameterValue, 392
ChangeLayer GetPfObjects, 392
IntGrflayer, 431 HasParameter, 392
SetLevelvis, 366 RemoveParameter, 392
ChangeRefPoints SetAssociationValue, 393
IntGrflayer, 432 SetAttributeEnumeration, 393, 394
SetLevelvis, 366 SetAttributeValue, 394
ChangeStyle Clear
GrpPage, 395 ComNmink, 304
PltLinebarplot, 493 ElmBoundary, 89
PltVectorplot, 498 ElmRes, 121
ChangeWidthVisibilityAndColour IntDataset, 420
IntGrflayer, 433 IntDplmap, 422
SetLevelvis, 366 IntDplvec, 425
ChaVecfile, 385 IntSubset, 478
Update, 385 Output Window Methods, 50
Check SetSelect, 375
BlkDef, 383 VisBdia, 518
ComAuditlog, 253 VisDraw, 521
IntOutage, 448 VisHrm, 522
SetScenario, 372 VisMagndiffplt, 525
SetTboxconfig, 376 VisOcplot, 527
TypMdl, 515 VisPath, 527
CheckAll VisPcompdiffplt, 530
IntOutage, 448 VisPlot, 532
CheckAssignments VisPlot2, 537
ComMerge, 298 VisPlottz, 543
CheckBbPath VisXyplot, 545
ElmBbone, 85 ClearCont
CheckControllers ComSimoutage, 326
ComLdf, 294 ClearCurves
CheckRanges PltDataseries, 491
ElmRelay, 115 ClearData
CheckSyntax IntGrfgroup, 429
ComDpl, 284 IntGrflayer, 433
CheckUrl ClearInvalidReferences
IntExtaccess, 428 IntPrj, 454
CimModel, 386 ClearOutputWindow

550
INDEX INDEX

Output Window Functions, 47 ComCimdbexp, 256

ClearRecycleBin Execute, 256
Application Methods, 6 ComCimdbimp, 256
ClearUpdatePages Execute, 256
ComProtgraphic, 310 ImportAndConvert, 257
ClearVars ComCimvalidate, 257
IntMon, 446 Execute, 257
ClearVectors GetClassType, 258
PltComplexdata, 490 GetDescriptionText, 258
Close GetInputObject, 258
ElmCoup, 92 GetModel, 258
ElmGndswt, 101 GetModelId, 259
ElmRes, 123 GetNumberOfValidationMessages, 259
IntGrfnet, 435 GetObject, 259
SetDeskpage, 358 GetObjectId, 259
SetDesktop, 359 GetProfile, 260
SetVipage, 379 GetSeverity, 260
StaSwitch, 240 GetType, 260
CloseTableReports ComConreq, 260
Dialogue Boxes Functions, 36 Execute, 261
ColLbl ComContingency, 261
IntMat, 439, 440 ContinueTrace, 261
ComAddlabel, 241 CreateRecoveryInformation, 261
Execute, 241 GetGeneratorEvent, 262
ComAddon, 242 GetInterruptedPowerAndCustomersForStage,
CreateModule, 242 262
DefineDouble, 242 GetInterruptedPowerAndCustomersForTimeStep,
DefineDoubleMatrix, 243 263
DefineDoublePerConnection, 244 GetLoadEvent, 263
DefineDoubleVector, 244 GetNumberOfGeneratorEventsForTimeStep,
DefineDoubleVectorPerConnection, 245 264
DefineInteger, 245 GetNumberOfLoadEventsForTimeStep, 264
DefineIntegerPerConnection, 246 GetNumberOfSwitchEventsForTimeStep, 264
DefineIntegerVector, 247 GetNumberOfTimeSteps, 265
DefineIntegerVectorPerConnection, 247 GetObj, 265
DefineObject, 248 GetSwitchEvent, 265
DefineObjectPerConnection, 249 GetTimeOfStepInSeconds, 266
DefineObjectVector, 249 GetTotalInterruptedPower, 266
DefineObjectVectorPerConnection, 250 JumpToLastStep, 266
DefineString, 250 RemoveEvents, 266
DefineStringPerConnection, 251 StartTrace, 267
DeleteModule, 252 StopTrace, 267
FinaliseModule, 252 ComCoordreport, 267
GetActiveModule, 252 DevicesToReport, 268
ModuleExists, 252 HasResultsForDirectionalBackup, 268
SetActiveModule, 253 HasResultsForFuse, 268
ComAmpacity, 253 HasResultsForInstantaneous, 269
ExecuteAmpacityCalc, 253 HasResultsForNonDirectionalBackup, 269
ComAuditlog, 253 HasResultsForOverload, 269
Check, 253 HasResultsForOverreach, 270
ComBoundary, 254 HasResultsForShortCircuit, 270
GetCreatedBoundaries, 254 HasResultsForZone, 270
ComCapo, 254 MaxZoneNumberFor, 271
ConnectShuntToBus, 254 ResultForDirectionalBackupVariable, 271
LossCostAtBusTech, 255 ResultForFuseVariable, 272
TotalLossCost, 255 ResultForInstantaneousVariable, 272

551
INDEX INDEX

ResultForMaxCurrent, 273 CheckControllers, 294

ResultForNonDirectionalBackupVariable, 273 DoNotResetCalc, 294
ResultForOverloadVariable, 274 EstimateOutage, 294
ResultForOverreachVariable, 275 Execute, 295
ResultForShortCircuitVariable, 275 IsAC, 295
ResultForZoneVariable, 276 IsBalanced, 295
TopologyForDirectionalBackupVariable, 277 IsDC, 296
TopologyForFuseVariable, 277 PrintCheckResults, 296
TopologyForInstantaneousVariable, 278 SetOldDistributeLoadMode, 296
TopologyForMaxCurrent, 278 ComLink, 296
TopologyForNonDirectionalBackupVariable, LoadMicroSCADAFile, 296
278 ReceiveData, 297
TopologyForOverloadVariable, 279 SendData, 297
TopologyForOverreachVariable, 279 SentDataStatus, 297
TopologyForShortCircuitVariable, 280 SetOPCReceiveQuality, 298
TopologyForZoneVariable, 280 SetSwitchShcEventMode, 298
TransferDirectionalBackupResultsTo, 281 Commands Methods, 241
TransferNonDirectionalBackupResultsTo, 281 Execute, 241
TransferOverreachResultsTo, 282 ComMerge, 298
TransferResultsTo, 283 CheckAssignments, 298
TransferZoneResultsTo, 283 Compare, 299
ComDllmanager, 284 CompareActive, 299
Report, 284 ExecuteRecording, 299
ComDpl, 284 ExecuteWithActiveProject, 299
CheckSyntax, 284 GetCorrespondingObject, 299
Encrypt, 285 GetModification, 300
Execute, 285 GetModificationResult, 300
GetExternalObject, 286 GetModifiedObjects, 300
GetInputParameterDouble, 286 Merge, 301
GetInputParameterInt, 287 PrintComparisonReport, 301
GetInputParameterString, 287 PrintModifications, 301
IsEncrypted, 287 Reset, 302
ResetThirdPartyModule, 288 SetAutoAssignmentForAll, 302
SetExternalObject, 288 SetObjectsToCompare, 302
SetInputParameterDouble, 288 ShowBrowser, 302
SetInputParameterInt, 289 WereModificationsFound, 303
SetInputParameterString, 289 CommitTransaction
SetThirdPartyModule, 289 Application Methods, 6
ComFlickermeter, 290 ComMot, 303
Execute, 290 GetMotorConnections, 303
ComGenrelinc, 290 GetMotorSwitch, 303
GetCurrentIteration, 290 GetMotorTerminal, 304
GetMaxNumIterations, 291 ComNmink, 304
ComGridtocim, 291 AddRef, 304
ConvertAndExport, 291 Clear, 304
SetAuthorityUri, 291 GenerateContingenciesForAnalysis, 304
SetBoundaries, 292 GetAll, 305
SetGridsToExport, 292 ComOmr, 305
ComHostcap, 292 GetFeeders, 305
CalcMaxHostedPower, 292 GetOMR, 305
ComImport, 293 GetRegionCount, 306
GetCreatedObjects, 293 ComOpc, 306
GetModifiedObjects, 293 ReceiveData, 306
ComInc, 293 SendData, 306
ZeroDerivative, 293 ComOutage, 307
ComLdf, 294 ContinueTrace, 307

552
INDEX INDEX

ExecuteTime, 307 GetOverLoadedBranches, 319

GetObject, 307 GetOverLoadedBuses, 320
RemoveEvents, 308 ComShctrace, 320
SetObjs, 308 BlockSwitch, 320
StartTrace, 308 ExecuteAllSteps, 321
StopTrace, 308 ExecuteInitialStep, 321
Compare ExecuteNextStep, 321
ComMerge, 299 GetBlockedSwitches, 321
CompareActive GetCurrentTimeStep, 322
ComMerge, 299 GetDeviceSwitches, 322
ComPfdimport, 309 GetDeviceTime, 322
GetImportedObjects, 309 GetNonStartedDevices, 322
Compile GetStartedDevices, 322
BlkDef, 383 GetSwitchTime, 323
TypMdl, 515 GetTrippedDevices, 323
ComPrjconnector, 309 NextStepAvailable, 323
GetSuccesfullyConnectedItems, 309 ComSim, 323
GetUnsuccesfullyConnectedItems, 309 GetSimulationTime, 324
ComProtgraphic, 310 GetTotalWarnA, 324
AddToUpdatePages, 310 GetTotalWarnB, 324
ClearUpdatePages, 310 GetTotalWarnC, 324
ComPvcurves, 310 GetViolatedScanModules, 324
FindCriticalBus, 310 LoadSimulationState, 324
ComPython, 310 LoadSnapshot, 324
GetExternalObject, 310 SaveSimulationState, 325
GetInputParameterDouble, 311 SaveSnapshot, 325
GetInputParameterInt, 311 ComSimoutage, 325
GetInputParameterString, 312 AddCntcy, 326
SetExternalObject, 312 AddContingencies, 326
SetInputParameterDouble, 312 AddRas, 326
SetInputParameterInt, 313 ClearCont, 326
SetInputParameterString, 313 CreateFaultCase, 327
ComRed, 314 Execute, 327
LdfEquivalentVerification, 314 ExecuteAndCheck, 327
ReductionInMemory, 314 GetNTopLoadedElms, 329
ResetReductionInMemory, 314 MarkRegions, 329
SimEquivalentVerification, 314 RemoveAllRas, 329
ComRel3, 315 RemoveContingencies, 329
AnalyseElmRes, 315 RemoveRas, 330
ExeEvt, 315 Reset, 330
OvlAlleviate, 315 SetLimits, 330
RemoveEvents, 316 Update, 330
RemoveOutages, 316 ComSvgexport, 331
ValidateConstraints, 316 SetFileName, 331
ComRelpost, 317 SetObject, 331
CalcContributions, 317 SetObjects, 331
GetContributionOfComponent, 317 ComSvgimport, 331
ComRelreport, 317 SetFileName, 331
GetContingencies, 318 SetObject, 332
GetContributionOfComponent, 318 ComTasks, 332
ComRes, 318 AppendCommand, 332
ExportFullRange, 318 AppendStudyCase, 333
FileNmResNm, 318 GetCommandsForStudyCase, 333
ComShc, 318 GetNumberOfCommandsForStudyCase, 333
ExecuteRXSweep, 318 GetNumberOfStudyCases, 334
GetFaultType, 319 GetStudyCases, 334

553
INDEX INDEX

IsAdditionalResultsFlagSetForCommand, 334 IntComtrade, 408

IsCommandIgnored, 335 CopyData
IsStudyCaseIgnored, 335 General Object Methods, 54
RemoveCmdsForStudyCaseRow, 335 CopyDataExtensionFrom
RemoveCommand, 336 IntPrj, 454
RemoveStudyCase, 336 CopyExtMeaStatusToStatusTmp
RemoveStudyCases, 337 StaExtbrkmea, 175
SetAdditionalResultsFlagForCommand, 337 StaExtcmdmea, 180
SetIgnoreFlagForCommand, 337 StaExtdatmea, 185
SetIgnoreFlagForStudyCase, 338 StaExtfmea, 190
SetResultsFolder, 339 StaExtfuelmea, 195
ComTececo, 339 StaExtimea, 200
UpdateTablesByCalcPeriod, 339 StaExtpfmea, 205
ComTececocmp, 339 StaExtpmea, 210
AppendStudyCase, 340 StaExtqmea, 215
CalcDiscountedEstimatedPaybackPeriod, 340 StaExtsmea, 220
CalcEstimatedPaybackPeriod, 340 StaExttapmea, 225
CalcInternalRateOfReturn, 341 StaExtv3mea, 230
RemoveStudyCases, 341 StaExtvmea, 235
ComTransfer, 341 Create
GetTransferCalcData, 342 SetPath, 369
IsLastIterationFeasible, 342 CreateCBEvents
ComUcte, 342 IntEvt, 427
SetBatchMode, 342 CreateDerivedProject
ComUcteexp, 343 IntVersion, 487
BuildNodeNames, 343 CreateEvent
DeleteCompleteQuickAccess, 343 ElmTr2, 150
ExportAndInitQuickAccess, 343 ElmTr3, 153
GetConnectedBranches, 344 ElmTr4, 158
GetFromToNodeNames, 344 ElmVoltreg, 166
GetOrderCode, 344 StaExtdatmea, 185
GetUcteNodeName, 345 CreateFaultCase
InitQuickAccess, 345 Application Methods, 6
QuickAccessAvailable, 345 ComSimoutage, 327
ResetQuickAccess, 345 CreateFeederWithRoutes
SetGridSelection, 346 ElmLne, 104
ComWktimp, 346 CreateFilter
GetCreatedObjects, 346 SetColscheme, 348
GetModifiedObjects, 346 CreateGroup
ConnectShuntToBus IntUserman, 481
ComCapo, 254 CreateModule
Consolidate ComAddon, 242
IntCase, 407 CreateObject
IntScheme, 473 General Object Methods, 54
Contains CreateProject
IntDplmap, 422 Application Methods, 7
ContainsNonAsciiCharacters CreateRecoveryInformation
General Object Methods, 54 ComContingency, 261
ContinueTrace CreateStageObject
ComContingency, 261 IntSstage, 475
ComOutage, 307 CreateUser
ConvertAndExport IntUserman, 482
ComGridtocim, 291 CreateVersion
ConvertToASCIIFormat IntPrj, 454
IntComtrade, 408 CreateVI
ConvertToBinaryFormat SetVipage, 380

554
INDEX INDEX

Date/Time Functions, 35 ComUcteexp, 343

GetStudyTimeObject, 35 DeleteModule
Date ComAddon, 252
SetTime, 377 DeleteParameterAtIndex
Deactivate CimModel, 386
ElmNet, 111 CimObject, 390
IntCase, 407 DeleteRow
IntLibrary, 438 IntScensched, 471
IntPrj, 455 DeleteUntouchedObjects
IntScenario, 468 Application Methods, 8
IntScensched, 471 Derate
IntScheme, 473 ElmGenstat, 99
IntSscheduler, 474 ElmPvsys, 112
DecodeColour ElmSym, 140
Application Methods, 7 DevicesToReport
Default ComCoordreport, 268
SetScenario, 372 Dialogue Boxes Functions, 35
DefineBoundary CloseTableReports, 36
ElmArea, 79 GetTableReports, 36
ElmNet, 111 ShowModalBrowser, 36
ElmZone, 169 ShowModalSelectBrowser, 36
DefineDouble ShowModelessBrowser, 37
ComAddon, 242 UpdateTableReports, 37
DefineDoubleMatrix DiscardChanges
ComAddon, 243 IntScenario, 469
DefineDoublePerConnection Disconnect
ComAddon, 244 ElmGenstat, 99
DefineDoubleVector ElmPvsys, 112
ComAddon, 244 ElmSym, 140
DefineDoubleVectorPerConnection ElmXnet, 168
ComAddon, 245 DoAutoScale
DefineInteger GrpPage, 395
ComAddon, 245 PltAxis, 489
DefineIntegerPerConnection PltLinebarplot, 493
ComAddon, 246 PltVectorplot, 498
DefineIntegerVector DoAutoScaleOnAll
ComAddon, 247 VisDraw, 521
DefineIntegerVectorPerConnection DoAutoScaleOnCharacteristics
ComAddon, 247 VisDraw, 521
DefineObject DoAutoScaleOnImpedances
ComAddon, 248 VisDraw, 521
DefineObjectPerConnection DoAutoScaleX
ComAddon, 249 GrpPage, 396
DefineObjectVector PltLinebarplot, 493
ComAddon, 249 SetDesktop, 359
DefineObjectVectorPerConnection SetVipage, 379
ComAddon, 250 VisDraw, 521
DefineString VisHrm, 522
ComAddon, 250 VisMagndiffplt, 525
DefineStringPerConnection VisOcplot, 527
ComAddon, 251 VisPath, 528
DefineTransferAttributes VisPcompdiffplt, 530
Application Methods, 8 VisPlot, 532
Delete VisPlot2, 537
General Object Methods, 55 VisPlottz, 543
DeleteCompleteQuickAccess VisXyplot, 545

555
INDEX INDEX

DoAutoScaleY2 ElmBoundary, 88
VisPlot2, 538 AddCubicle, 88
DoAutoScaleY CalcShiftedReversedBoundary, 89
GrpPage, 396 Clear, 89
PltLinebarplot, 493 GetInterior, 89
SetVipage, 379 IsSplitting, 89
VisDraw, 522 Resize, 90
VisHrm, 522 Update, 90
VisMagndiffplt, 525 ElmBranch, 90
VisOcplot, 527 Update, 90
VisPath, 528 ElmCabsys, 90
VisPcompdiffplt, 530 FitParams, 90
VisPlot, 532 GetLineCable, 91
VisPlot2, 538 Update, 91
VisPlottz, 544 ElmComp, 91
VisXyplot, 545 slotupd, 91
DoNotResetCalc SlotUpdate, 91
ComLdf, 294 ElmCoup, 92
Close, 92
EchoOff GetRemoteBreakers, 92
Environment Functions, 38 IsBreaker, 93
EchoOn IsClosed, 93
Environment Functions, 38 IsOpen, 93
ElmArea, 79 Open, 93
CalculateInterchangeTo, 79 ElmDsl, 94
DefineBoundary, 79 ExportToClipboard, 94
GetAll, 79 ExportToFile, 94
GetBranches, 80 ElmFeeder, 95
GetBuses, 80 CalcAggrVarsInRadFeed, 95
GetObjs, 80 GetAll, 95
ElmAsm, 80 GetBranches, 96
CalcEfficiency, 81 GetBuses, 96
GetAvailableGenPower, 81 GetNodesBranches, 96
GetElecTorque, 81 GetObjs, 97
GetGroundingImpedance, 82 ElmFile, 97
GetMechTorque, 82 LoadFile, 97
GetMotorStartingFlag, 83 SaveFile, 97
GetStepupTransformer, 83 ElmFilter, 98
IsPQ, 83 GetGroundingImpedance, 98
ElmAsmsc, 83 ElmGenstat, 98
GetAvailableGenPower, 84 CalcEfficiency, 98
GetGroundingImpedance, 84 Derate, 99
GetStepupTransformer, 85 Disconnect, 99
ElmBbone, 85 GetAvailableGenPower, 99
CheckBbPath, 85 GetGroundingImpedance, 100
GetBbOrder, 86 GetStepupTransformer, 100
GetCompleteBbPath, 86 IsConnected, 101
GetFOR, 86 Reconnect, 101
GetMeanCs, 86 ResetDerating, 101
GetMinCs, 87 ElmGndswt, 101
GetTieOpenPoint, 87 Close, 101
GetTotLength, 87 GetGroundingImpedance, 102
HasGnrlMod, 87 IsClosed, 102
ElmBmu, 88 IsOpen, 102
Apply, 88 Open, 102
Update, 88 ElmLne, 103

556
INDEX INDEX

AreDistParamsPossible, 103 Clear, 121

CreateFeederWithRoutes, 104 Close, 123
FitParams, 104 FindColumn, 121
GetIthr, 104 FindMaxInColumn, 121
GetType, 105 FindMaxOfVariableInRow, 122
GetY0m, 105 FindMinInColumn, 122
GetY1m, 105 FindMinOfVariableInRow, 122
GetZ0m, 106 FinishWriting, 123
GetZ1m, 106 Flush, 123
GetZmatDist, 107 GetColumnValues, 123
HasRoutes, 107 GetDescription, 124
HasRoutesOrSec, 107 GetFirstValidObject, 124
IsCable, 107 GetFirstValidObjectVariable, 125
IsNetCoupling, 108 GetFirstValidVariable, 125
MeasureLength, 108 GetNextValidObject, 126
SetDetailed, 108 GetNextValidObjectVariable, 127
ElmLnesec, 109 GetNextValidVariable, 127
IsCable, 109 GetNumberOfColumns, 128
ElmMdl, 109 GetNumberOfRows, 128
ExportToClipboard, 109 GetObj, 128
ExportToFile, 109 GetObject, 128
ElmNec, 110 GetObjectValue, 128
GetGroundingImpedance, 110 GetRelCase, 129
ElmNet, 110 GetSubElmRes, 129
Activate, 111 GetUnit, 129
CalculateInterchangeTo, 111 GetValue, 130
Deactivate, 111 GetVariable, 130
DefineBoundary, 111 Init, 131
ElmPvsys, 112 InitialiseWriting, 131
CalcEfficiency, 112 Load, 131
Derate, 112 NCol, 128
Disconnect, 112 NRow, 128
GetAvailableGenPower, 113 Release, 131
GetGroundingImpedance, 113 SetAsDefault, 131
IsConnected, 114 SetObj, 132
Reconnect, 114 SetSubElmResKey, 132
ResetDerating, 114 SizeX, 128
ElmRelay, 114 SizeY, 128
CheckRanges, 115 SortAccordingToColumn, 132
GetCalcRX, 115 Write, 132
GetMaxFdetectCalcI, 115 WriteDraw, 133
GetSlot, 116 ElmShnt, 133
GetUnom, 116 GetGroundingImpedance, 133
IsStarted, 116 ElmStactrl, 133
SetImpedance, 117 GetControlledHVNode, 134
SetMaxI, 118 GetControlledLVNode, 134
SetMaxIearth, 118 GetStepupTransformer, 134
SetMinI, 118 Info, 135
SetMinIearth, 118 ElmSubstat, 135
SetOutOfService, 118 ApplyAndResetRA, 135
SetTime, 119 GetSplit, 135
slotupd, 119 GetSplitCal, 136
SlotUpdate, 119 GetSplitIndex, 137
ElmRes, 120 GetSuppliedElements, 137
AddVariable, 120 OverwriteRA, 138
AddVars, 120 ResetRA, 138

557
INDEX INDEX

SaveAsRA, 138 GetGroundingImpedance, 158

SetRA, 138 GetSuppliedElements, 158
ElmSvs, 139 GetTapPhi, 159
GetStepupTransformer, 139 GetTapRatio, 159
ElmSym, 139 GetTapZDependentSide, 160
CalcEfficiency, 140 GetZ0pu, 160
Derate, 140 GetZpu, 161
Disconnect, 140 IsQuadBooster, 161
GetAvailableGenPower, 140 NTap, 161
GetGroundingImpedance, 141 ElmTrain, 162
GetMotorStartingFlag, 141 SetPosition, 162
GetStepupTransformer, 142 ElmTrb, 162
IsConnected, 142 GetGroundingImpedance, 162
Reconnect, 142 ElmTrfstat, 163
ResetDerating, 142 GetSplit, 163
ElmTerm, 143 GetSplitCal, 164
GetBusType, 143 GetSplitIndex, 164
GetCalcRelevantCubicles, 143 GetSuppliedElements, 165
GetConnectedBrkCubicles, 143 ElmVac, 165
GetConnectedCubicles, 144 GetGroundingImpedance, 165
GetConnectedMainBuses, 144 ElmVoltreg, 166
GetConnectionInfo, 144 CreateEvent, 166
GetEquivalentTerminals, 145 GetGroundingImpedance, 166
GetMinDistance, 145 GetZpu, 167
GetNextHVBus, 146 NTap, 167
GetNodeName, 146 ElmXnet, 167
GetSepStationAreas, 146 CalcEfficiency, 167
GetShortestPath, 147 Disconnect, 168
HasCreatedCalBus, 148 GetGroundingImpedance, 168
IsElectrEquivalent, 148 GetStepupTransformer, 168
IsEquivalent, 148 Reconnect, 169
IsInternalNodeInStation, 149 ElmZone, 169
UpdateSubstationTerminals, 149 CalculateInterchangeTo, 169
ElmTr2, 150 DefineBoundary, 169
CreateEvent, 150 GetAll, 170
GetGroundingImpedance, 150 GetBranches, 170
GetSuppliedElements, 151 GetBuses, 170
GetTapPhi, 151 GetObjs, 170
GetTapRatio, 152 SetLoadScaleAbsolute, 171
GetZ0pu, 152 EmptyCache
GetZpu, 152 SetDatabase, 355
IsQuadBooster, 153 EnableDiffMode
NTap, 153 IntSstage, 476
ElmTr3, 153 EncodeColour
CreateEvent, 153 Application Methods, 8
GetGroundingImpedance, 154 Encrypt
GetSuppliedElements, 154 BlkDef, 383
GetTapPhi, 155 ComDpl, 285
GetTapRatio, 155 TypQdsl, 516
GetTapZDependentSide, 156 EndDataExtensionModification
GetZ0pu, 156 IntPrj, 455
GetZpu, 156 Energize
IsQuadBooster, 157 General Object Methods, 55
NTap, 157 Environment Functions, 38
ElmTr4, 157 EchoOff, 38
CreateEvent, 158 EchoOn, 38

558
INDEX INDEX

IsAutomaticCalculationResetEnabled, 38 ElmMdl, 109

IsFinalEchoOnEnabled, 38 ExportToFile
SetAutomaticCalculationResetEnabled, 39 ElmDsl, 94
SetEnableUserBreak, 41 ElmMdl, 109
SetFinalEchoOnEnabled, 39 ExportToVec
SetGraphicUpdate, 39 IntGrflayer, 434
SetGuiUpdateEnabled, 40
SetProgressBarUpdatesEnabled, 40 File System Functions, 34
SetRescheduleFlag, 40 GetInstallationDirectory, 34
SetUserBreakEnabled, 41 GetInstallDir, 34
EstimateOutage GetTempDir, 34
ComLdf, 294 GetTemporaryDirectory, 34
Execute GetWorkingDir, 35
ComAddlabel, 241 GetWorkspaceDirectory, 35
ComCimdbexp, 256 FileNmResNm
ComCimdbimp, 256 ComRes, 318
ComCimvalidate, 257 FinaliseModule
ComConreq, 261 ComAddon, 252
ComDpl, 285 FindColumn
ComFlickermeter, 290 ElmRes, 121
ComLdf, 295 IntComtrade, 408
Commands Methods, 241 IntComtradeset, 414
ComSimoutage, 327 FindCriticalBus
ExecuteAllSteps ComPvcurves, 310
ComShctrace, 321 FindMaxInColumn
ExecuteAmpacityCalc ElmRes, 121
ComAmpacity, 253 IntComtrade, 409
ExecuteAndCheck IntComtradeset, 415
ComSimoutage, 327 FindMaxOfVariableInRow
ExecuteCmd ElmRes, 122
Application Methods, 9 FindMinInColumn
ExecuteInitialStep ElmRes, 122
ComShctrace, 321 IntComtrade, 409
ExecuteNextStep IntComtradeset, 415
ComShctrace, 321 FindMinOfVariableInRow
ExecuteRecording ElmRes, 122
ComMerge, 299 FinishWriting
ExecuteRXSweep ElmRes, 123
ComShc, 318 First
ExecuteTime IntDplmap, 422
ComOutage, 307 FitParams
ExecuteWithActiveProject ElmCabsys, 90
ComMerge, 299 ElmLne, 104
ExeEvt Flush
ComRel3, 315 ElmRes, 123
Export Output Window Methods, 50
IntDocument, 421 FlushOutputWindow
IntGrfgroup, 429 Output Window Functions, 47
IntGrflayer, 433 Freeze
IntIcon, 437 SetDesktop, 359
ExportAndInitQuickAccess
ComUcteexp, 343 General Object Methods, 52
ExportFullRange AddCopy, 53
ComRes, 318 ContainsNonAsciiCharacters, 54
ExportToClipboard CopyData, 54
ElmDsl, 94 CreateObject, 54

559
INDEX INDEX

Delete, 55 SearchObject, 75
Energize, 55 SetAttribute, 75
GetAttribute, 56 SetAttributeLength, 75
GetAttributeDescription, 56 SetAttributes, 76
GetAttributeLength, 56 SetAttributeShape, 76
GetAttributes, 57 ShowEditDialog, 76
GetAttributeShape, 57 ShowModalSelectTree, 77
GetAttributeType, 57 SwitchOff, 77
GetAttributeUnit, 58 SwitchOn, 78
GetChildren, 58 WriteChangesToDb, 78
GetClassName, 59 GenerateContingenciesForAnalysis
GetCombinedProjectSource, 59 ComNmink, 304
GetConnectedElements, 59 Get
GetConnectionCount, 59 IntDplvec, 425
GetContents, 60 IntMat, 439
GetControlledNode, 60 IntVec, 483
GetCubicle, 61 IntVecobj, 485
GetFullName, 61 SetFilt, 365
GetImpedance, 61 GetActiveCalculationStr
GetInom, 62 Application Methods, 9
GetNode, 62 GetActiveModule
GetOperator, 63 ComAddon, 252
GetOwner, 63 GetActiveNetworkVariations
GetParent, 63 Application Methods, 10
GetReferences, 64 GetActivePage
GetRegion, 64 SetDesktop, 359
GetSupplyingSubstations, 64 GetActiveProject
GetSupplyingTransformers, 65 Application Methods, 10
GetSupplyingTrfstations, 65 GetActiveScenario
GetSystemGrounding, 65 Application Methods, 10
GetUnom, 66 GetActiveScenarioScheduler
GetZeroImpedance, 66 Application Methods, 10
HasAttribute, 66 GetActiveScheduler
HasReferences, 67 IntScheme, 473
HasResults, 67 GetActiveStages
IsCalcRelevant, 67 Application Methods, 10
IsDeleted, 68 GetActiveStudyCase
IsEarthed, 68 Application Methods, 11
IsEnergized, 68 GetAlarmColouringMode
IsHidden, 68 SetColscheme, 349
IsInFeeder, 69 GetAll
IsNetworkDataFolder, 69 ComNmink, 305
IsNode, 70 ElmArea, 79
IsObjectActive, 70 ElmFeeder, 95
IsObjectModifiedByVariation, 70 ElmZone, 170
Isolate, 71 IntDataset, 420
IsOutOfService, 71 SetPath, 370
IsReducible, 72 SetSelect, 375
IsShortCircuited, 72 StaCubic, 172
MarkInGraphics, 72 GetAllUsers
Move, 73 Application Methods, 11
PasteCopy, 73 GetAnalogueDescriptions
PurgeUnusedObjects, 74 IntComtrade, 409
ReplaceNonAsciiCharacters, 74 IntComtradeset, 415
ReportNonAsciiCharacters, 74 GetApplication
ReportUnusedObjects, 74 Module Functions, 2

560
INDEX INDEX

GetApplicationExt ElmTerm, 143

Module Functions, 3 GetCalcRelevantCubicles
GetAttribute ElmTerm, 143
General Object Methods, 56 GetCalcRelevantObjects
GetAttributeDescription Application Methods, 13
Application Methods, 11 GetCalcRX
General Object Methods, 56 ElmRelay, 115
GetAttributeEnumerationType GetCanvasSize
CimModel, 386 SetDesktop, 360
CimObject, 390 GetCheckSum
GetAttributeLength BlkDef, 383
General Object Methods, 56 GetChildren
GetAttributes General Object Methods, 58
General Object Methods, 57 GetClassDescription
GetAttributeShape Application Methods, 13
General Object Methods, 57 GetClassId
GetAttributeType Application Methods, 14
General Object Methods, 57 GetClassName
GetAttributeUnit General Object Methods, 59
Application Methods, 12 GetClassType
General Object Methods, 58 ComCimvalidate, 258
GetAvailableButtons GetColouringMode
SetTboxconfig, 376 SetColscheme, 350
GetAvailableGenPower GetColumnLabel
ElmAsm, 81 IntMat, 440
ElmAsmsc, 84 GetColumnLabelIndex
ElmGenstat, 99 IntMat, 440
ElmPvsys, 113 GetColumnValues
ElmSym, 140 ElmRes, 123
GetAxisX IntComtrade, 410
PltLinebarplot, 494 IntComtradeset, 415
PltVectorplot, 498 GetCombinedProjectSource
GetAxisY General Object Methods, 59
PltLinebarplot, 494 GetCommandsForStudyCase
PltVectorplot, 498 ComTasks, 333
GetBbOrder GetCompleteBbPath
ElmBbone, 86 ElmBbone, 86
GetBlockedSwitches GetComplexData
ComShctrace, 321 PltVectorplot, 499
GetBorderCubicles GetConfiguration
Application Methods, 12 IntSubset, 479
GetBranch SetDataext, 356
StaCubic, 172 GetConfigurations
GetBranches SetDataext, 357
ElmArea, 80 GetConnectedBranches
ElmFeeder, 96 ComUcteexp, 344
ElmZone, 170 GetConnectedBrkCubicles
SetPath, 370 ElmTerm, 143
GetBrowserSelection GetConnectedCubicles
Application Methods, 12 ElmTerm, 144
GetBuses GetConnectedElements
ElmArea, 80 General Object Methods, 59
ElmFeeder, 96 GetConnectedMainBuses
ElmZone, 170 ElmTerm, 144
SetPath, 370 GetConnectedMajorNodes
GetBusType StaCubic, 172

561
INDEX INDEX

GetConnectionCount GetDerivedProjects
General Object Methods, 59 IntPrj, 456
GetConnectionInfo IntVersion, 487
ElmTerm, 144 GetDescription
GetConnections ElmRes, 124
StaCubic, 173 IntComtrade, 410
GetContent IntComtradeset, 416
Output Window Methods, 50 GetDescriptionText
GetContents ComCimvalidate, 258
General Object Methods, 60 GetDeviceSwitches
GetContingencies ComShctrace, 322
ComRelreport, 318 GetDeviceTime
GetContributionOfComponent ComShctrace, 322
ComRelpost, 317 GetDiagramSelection
ComRelreport, 318 Application Methods, 16
GetControlledHVNode GetDigitalDescriptions
ElmStactrl, 134 IntComtrade, 410
GetControlledLVNode IntComtradeset, 416
ElmStactrl, 134 GetDisplayedButtons
GetControlledNode SetTboxconfig, 376
General Object Methods, 60 GetElecTorque
GetCorrespondingObject ElmAsm, 81
ComMerge, 299 GetEnergisingColouringMode
GetCreatedBoundaries SetColscheme, 350
ComBoundary, 254 GetEquivalentTerminals
GetCreatedObjects ElmTerm, 145
ComImport, 293 GetExternalObject
ComWktimp, 346 ComDpl, 286
GetCriticalTimePhase ComPython, 310
IntThrating, 479 GetExternalReferences
GetCubicle IntPrj, 456
General Object Methods, 61 GetFaultType
GetCurrentDiagram ComShc, 319
Application Methods, 14 GetFeeders
GetCurrentIteration ComOmr, 305
ComGenrelinc, 290 GetFirstValidObject
GetCurrentScript ElmRes, 124
Application Methods, 14 GetFirstValidObjectVariable
GetCurrentSelection ElmRes, 125
Application Methods, 14 GetFirstValidVariable
GetCurrentTimeStep ElmRes, 125
ComShctrace, 322 GetFlowOrientation
GetCurrentUser Application Methods, 16
Application Methods, 15 GetFontID
GetCurrentZoomScaleLevel SetPrj, 371
Application Methods, 15 GetFOR
GetDataFolder ElmBbone, 86
Application Methods, 15 GetFromSigName
GetDataSeries BlkSig, 385
PltLinebarplot, 494 GetFromStudyCase
GetDataSource Application Methods, 16
PltDataseries, 491 GetFromToNodeNames
VisHrm, 523 ComUcteexp, 344
VisPlot, 532 GetFullName
VisPlot2, 538 General Object Methods, 61
VisXyplot, 545 GetGeneratorEvent

562
INDEX INDEX

ComContingency, 262 GetInterruptedPowerAndCustomersForStage

GetGeoCoordinateSystem ComContingency, 262
IntPrj, 456 GetInterruptedPowerAndCustomersForTimeStep
GetGlobalLibrary ComContingency, 263
Application Methods, 17 GetIthr
GetGraphicsBoard ElmLne, 104
Application Methods, 17 GetLanguage
GetGroundingImpedance Application Methods, 17
ElmAsm, 82 GetLatestVersion
ElmAsmsc, 84 IntPrj, 457
ElmFilter, 98 GetLegend
ElmGenstat, 100 PltLinebarplot, 494
ElmGndswt, 102 PltVectorplot, 499
ElmNec, 110 GetLimit
ElmPvsys, 113 ScnFreq, 502
ElmShnt, 133 ScnFrt, 504
ElmSym, 141 ScnSpeed, 505
ElmTr2, 150 ScnSync, 507
ElmTr3, 154 ScnVar, 509
ElmTr4, 158 ScnVolt, 510
ElmTrb, 162 GetLineCable
ElmVac, 165 ElmCabsys, 91
ElmVoltreg, 166 GetLoadEvent
ElmXnet, 168 ComContingency, 263
GetGroups GetLocalLibrary
IntUserman, 482 Application Methods, 18
GetHistoricalProject GetMaxFdetectCalcI
IntVersion, 488 ElmRelay, 115
GetImpedance GetMaxNumIterations
General Object Methods, 61 ComGenrelinc, 291
GetImportedObjects GetMeanCs
ComPfdimport, 309 ElmBbone, 86
GetInom GetMeaValue
General Object Methods, 62 StaExtbrkmea, 175
GetInputObject StaExtcmdmea, 180
ComCimvalidate, 258 StaExtdatmea, 185
GetInputParameterDouble StaExtfmea, 190
ComDpl, 286 StaExtfuelmea, 195
ComPython, 311 StaExtimea, 200
GetInputParameterInt StaExtpfmea, 205
ComDpl, 287 StaExtpmea, 210
ComPython, 311 StaExtqmea, 215
GetInputParameterString StaExttapmea, 225
ComDpl, 287 StaExtv3mea, 230
ComPython, 312 StaExtvmea, 235
GetInstallationDirectory GetMechTorque
File System Functions, 34 ElmAsm, 82
GetInstallDir GetMem
File System Functions, 34 Application Methods, 18
GetIntCalcres GetMinCs
PltDataseries, 492 ElmBbone, 87
VisPlot, 532 GetMinDistance
GetInterfaceVersion ElmTerm, 145
Application Methods, 17 GetModel
GetInterior ComCimvalidate, 258
ElmBoundary, 89 GetModelId

563
INDEX INDEX

ComCimvalidate, 259 ComContingency, 264

GetModelsReferencingThis GetNumberOfLoadEventsForTimeStep
CimModel, 386 ComContingency, 264
GetModification GetNumberOfRows
ComMerge, 300 ElmRes, 128
GetModificationResult IntComtrade, 411
ComMerge, 300 IntComtradeset, 417
GetModifiedObjects IntMat, 441
ComImport, 293 GetNumberOfStudyCases
ComMerge, 300 ComTasks, 334
ComWktimp, 346 GetNumberOfSwitchEventsForTimeStep
GetMotorConnections ComContingency, 264
ComMot, 303 GetNumberOfTimeSteps
GetMotorStartingFlag ComContingency, 265
ElmAsm, 83 GetNumberOfValidationMessages
ElmSym, 141 ComCimvalidate, 259
GetMotorSwitch GetNumberOfViolations
ComMot, 303 ScnFreq, 502
GetMotorTerminal ScnFrt, 504
ComMot, 304 ScnSpeed, 506
GetNearestBusbars ScnSync, 507
StaCubic, 173 ScnVar, 509
GetNextHVBus ScnVolt, 511
ElmTerm, 146 GetNumProcesses
GetNextValidObject SetUser, 378
ElmRes, 126 GetNumSlave
GetNextValidObjectVariable SetParalman, 367
ElmRes, 127 GetObj
GetNextValidVariable ComContingency, 265
ElmRes, 127 ElmRes, 128
GetNode GetObject
General Object Methods, 62 ComCimvalidate, 259
GetNodeName ComOutage, 307
ElmTerm, 146 ElmRes, 128
GetNodesBranches GetObjectId
ElmFeeder, 96 ComCimvalidate, 259
GetNonStartedDevices GetObjects
ComShctrace, 322 IntScenario, 469
GetNTopLoadedElms IntSubset, 479
ComSimoutage, 329 GetObjectsReferencingThis
GetNumberOfAnalogueSignalDescriptions CimObject, 391
IntComtrade, 411 GetObjectsWithSameId
IntComtradeset, 416 CimObject, 391
GetNumberOfClusters GetObjectValue
SetCluster, 347 ElmRes, 128
GetNumberOfColumns IntComtrade, 411
ElmRes, 128 IntComtradeset, 417
IntComtrade, 411 GetObjs
IntComtradeset, 417 ElmArea, 80
IntMat, 440 ElmFeeder, 97
GetNumberOfCommandsForStudyCase ElmZone, 170
ComTasks, 333 GetOMR
GetNumberOfDigitalSignalDescriptions ComOmr, 305
IntComtrade, 411 GetOperationValue
IntComtradeset, 417 IntScenario, 469
GetNumberOfGeneratorEventsForTimeStep GetOperator

564
INDEX INDEX

General Object Methods, 63 GetRating

GetOrderCode IntThrating, 479
ComUcteexp, 344 GetRecordingStage
GetOrInsertCurvePlot Application Methods, 19
GrpPage, 396 GetReferences
GetOrInsertDiscreteBarPlot General Object Methods, 64
GrpPage, 396 GetRegion
GetOrInsertModalAnalysisPlot General Object Methods, 64
GrpPage, 397 GetRegionCount
GetOrInsertPlot ComOmr, 306
SetVipage, 379 GetRelCase
GetOrInsertVectorPlot ElmRes, 129
GrpPage, 397 GetRemoteBreakers
GetOrInsertXYPlot ElmCoup, 92
GrpPage, 397 GetRowLabel
GetOutputWindow IntMat, 441
Output Window Functions, 48 GetRowLabelIndex
GetOverLoadedBranches IntMat, 441
ComShc, 319 GetScaleObjX
GetOverLoadedBuses VisHrm, 523
ComShc, 320 VisPlot, 533
GetOwner VisPlot2, 538
General Object Methods, 63 GetScaleObjY
GetPage VisHrm, 523
SetDesktop, 360 VisPlot, 533
GetParameterCount VisPlot2, 539
CimModel, 387 GetScenario
CimObject, 391 IntScensched, 471
GetParameterNamespace GetScheme
CimModel, 387 IntSstage, 476
CimObject, 391 GetSepStationAreas
GetParameterValue ElmTerm, 146
CimModel, 387 GetSettings
CimObject, 392 Application Methods, 19
GetParent GetSeverity
General Object Methods, 63 ComCimvalidate, 260
GetPathFolder GetShortestPath
SetPath, 370 ElmTerm, 147
GetPathToNearestBusbar GetSignalHeader
StaCubic, 174 IntComtrade, 412
GetPfObjects IntComtradeset, 418
CimObject, 392 GetSimulationTime
GetPlot ComSim, 324
GrpPage, 398 GetSlot
GetProfile ElmRelay, 116
ComCimvalidate, 260 GetSplit
GetProjectFolder ElmSubstat, 135
Application Methods, 18 ElmTrfstat, 163
GetProjectFolderType GetSplitCal
IntPrjfolder, 463 ElmSubstat, 136
GetQlim ElmTrfstat, 164
IntQlim, 465 GetSplitIndex
GetRandomNumber ElmSubstat, 137
Mathematical Functions, 42 ElmTrfstat, 164
GetRandomNumberEx GetStartedDevices
Mathematical Functions, 42 ComShctrace, 322

565
INDEX INDEX

GetStartEndTime GetSupplyingTransformers
IntScensched, 472 General Object Methods, 65
GetStatus GetSupplyingTrfstations
StaExtbrkmea, 175 General Object Methods, 65
StaExtcmdmea, 180 GetSwitchEvent
StaExtdatmea, 186 ComContingency, 265
StaExtfmea, 190 GetSwitchStatus
StaExtfuelmea, 195 IntRunarrange, 467
StaExtimea, 200 GetSwitchTime
StaExtpfmea, 205 ComShctrace, 323
StaExtpmea, 210 GetSystemGrounding
StaExtqmea, 215 General Object Methods, 65
StaExtsmea, 220 GetTableReports
StaExttapmea, 225 Dialogue Boxes Functions, 36
StaExtv3mea, 230 GetTapPhi
StaExtvmea, 235 ElmTr2, 151
GetStatusTmp ElmTr3, 155
StaExtbrkmea, 176 ElmTr4, 159
StaExtcmdmea, 181 GetTapRatio
StaExtdatmea, 186 ElmTr2, 152
StaExtfmea, 191 ElmTr3, 155
StaExtfuelmea, 196 ElmTr4, 159
StaExtimea, 201 GetTapZDependentSide
StaExtpfmea, 206 ElmTr3, 156
StaExtpmea, 211 ElmTr4, 160
StaExtqmea, 216 GetTempDir
StaExtsmea, 220 File System Functions, 34
StaExttapmea, 226 GetTemporaryDirectory
StaExtv3mea, 231 File System Functions, 34
StaExtvmea, 236 GetTieOpenPoint
GetStepupTransformer ElmBbone, 87
ElmAsm, 83 GetTimeOfStepInSeconds
ElmAsmsc, 85 ComContingency, 266
ElmGenstat, 100 GetTitleObject
ElmStactrl, 134 PltLinebarplot, 495
ElmSvs, 139 PltVectorplot, 499
ElmSym, 142 GetToSigName
ElmXnet, 168 BlkSig, 385
GetStudyCases GetTotalInterruptedPower
ComTasks, 334 ComContingency, 266
GetStudyTimeObject GetTotalWarnA
Date/Time Functions, 35 ComSim, 324
GetSubElmRes GetTotalWarnB
ElmRes, 129 ComSim, 324
GetSuccesfullyConnectedItems GetTotalWarnC
ComPrjconnector, 309 ComSim, 324
GetSummaryGrid GetTotLength
Application Methods, 19 ElmBbone, 87
GetSuppliedElements GetTransferCalcData
ElmSubstat, 137 ComTransfer, 342
ElmTr2, 151 GetTrippedDevices
ElmTr3, 154 ComShctrace, 323
ElmTr4, 158 GetType
ElmTrfstat, 165 ComCimvalidate, 260
GetSupplyingSubstations ElmLne, 105
General Object Methods, 64 GetUcteNodeName

566
INDEX INDEX

ComUcteexp, 345 ScnFrt, 505

GetUnit ScnSpeed, 507
ElmRes, 129 ScnSync, 508
IntComtrade, 412 ScnVar, 510
IntComtradeset, 418 ScnVolt, 512
GetUnom GetWorkingDir
ElmRelay, 116 File System Functions, 35
General Object Methods, 66 GetWorkspaceDirectory
GetUnsuccesfullyConnectedItems File System Functions, 35
ComPrjconnector, 309 GetY0m
GetUserManager ElmLne, 105
Application Methods, 19 GetY1m
GetUsers ElmLne, 105
IntUserman, 482 GetZ0m
GetUserSettings ElmLne, 106
Application Methods, 20 GetZ0pu
GetValue ElmTr2, 152
ElmRes, 130 ElmTr3, 156
IntComtrade, 412 ElmTr4, 160
IntComtradeset, 418 GetZ1m
IntDplmap, 423 ElmLne, 106
ScnFreq, 502 GetZeroImpedance
ScnFrt, 504 General Object Methods, 66
ScnSpeed, 506 GetZeroSequenceHVLVT
ScnSync, 508 TypTr2, 517
ScnVar, 509 GetZmatDist
ScnVolt, 511 ElmLne, 107
GetVar GetZpu
IntMon, 446 ElmTr2, 152
GetVariable ElmTr3, 156
ElmRes, 130 ElmTr4, 161
IntComtrade, 413 ElmVoltreg, 167
IntComtradeset, 419 GrpPage, 395
ScnFreq, 503 ChangeStyle, 395
ScnFrt, 504 DoAutoScale, 395
ScnSpeed, 506 DoAutoScaleX, 396
ScnSync, 508 DoAutoScaleY, 396
ScnVar, 509 GetOrInsertCurvePlot, 396
ScnVolt, 511 GetOrInsertDiscreteBarPlot, 396
GetVariation GetOrInsertModalAnalysisPlot, 397
IntSstage, 476 GetOrInsertVectorPlot, 397
GetVersions GetOrInsertXYPlot, 397
IntPrj, 457 GetPlot, 398
GetVI RemovePage, 398
SetVipage, 379 SetAutoScaleModeX, 398
GetViolatedElement SetAutoScaleModeY, 398
ScnFreq, 503 SetLayoutMode, 399
ScnFrt, 505 SetResults, 399
ScnSpeed, 506 SetScaleTypeX, 399
ScnSync, 508 SetScaleTypeY, 399
ScnVar, 510 SetScaleX, 400
ScnVolt, 511 SetScaleY, 400
GetViolatedScanModules Show, 400
ComSim, 324
GetViolationTime HasAttribute
ScnFreq, 503 General Object Methods, 66

567
INDEX INDEX

HasCreatedCalBus IntVec, 483

ElmTerm, 148 InitialiseWriting
HasExternalReferences ElmRes, 131
IntPrj, 457 InitQuickAccess
HasGnrlMod ComUcteexp, 345
ElmBbone, 87 InitTmp
HasParameter StaExtbrkmea, 176
CimModel, 387 StaExtcmdmea, 181
CimObject, 392 StaExtdatmea, 186
HasReferences StaExtfmea, 191
General Object Methods, 67 StaExtfuelmea, 196
HasResults StaExtimea, 201
General Object Methods, 67 StaExtpfmea, 206
HasResultsForDirectionalBackup StaExtpmea, 211
ComCoordreport, 268 StaExtqmea, 216
HasResultsForFuse StaExtsmea, 220
ComCoordreport, 268 StaExttapmea, 226
HasResultsForInstantaneous StaExtv3mea, 231
ComCoordreport, 269 StaExtvmea, 236
HasResultsForNonDirectionalBackup Insert
ComCoordreport, 269 IntDplmap, 423
HasResultsForOverload IntDplvec, 426
ComCoordreport, 269 InsertPlot
HasResultsForOverreach SetVipage, 380
ComCoordreport, 270 IntAddonvars, 400
HasResultsForShortCircuit AddDouble, 401
ComCoordreport, 270 AddDoubleMatrix, 401
HasResultsForZone AddDoubleVector, 402
ComCoordreport, 270 AddInteger, 402
HasRoutes AddIntegerVector, 403
ElmLne, 107 AddObject, 403
HasRoutesOrSec AddObjectVector, 404
ElmLne, 107 AddString, 404
Hide RemoveParameter, 405
Application Methods, 20 SetConstraint, 405
IntCase, 405
Import Activate, 406
IntDocument, 421 ApplyNetworkState, 406
IntGrfgroup, 429 ApplyStudyTime, 406
IntGrflayer, 434 Consolidate, 407
IntIcon, 438 Deactivate, 407
ImportAndConvert SetStudyTime, 407
ComCimdbimp, 257 IntComtrade, 407
ImportDz ConvertToASCIIFormat, 408
Application Methods, 20 ConvertToBinaryFormat, 408
ImportFromVec FindColumn, 408
IntGrflayer, 434 FindMaxInColumn, 409
ImportSnapshot FindMinInColumn, 409
Application Methods, 21 GetAnalogueDescriptions, 409
IndexOf GetColumnValues, 410
IntDplvec, 425 GetDescription, 410
Info GetDigitalDescriptions, 410
ElmStactrl, 135 GetNumberOfAnalogueSignalDescriptions,
Init 411
ElmRes, 131 GetNumberOfColumns, 411
IntMat, 442 GetNumberOfDigitalSignalDescriptions, 411

568
INDEX INDEX

GetNumberOfRows, 411 Size, 424

GetObjectValue, 411 Update, 425
GetSignalHeader, 412 IntDplvec, 425
GetUnit, 412 Clear, 425
GetValue, 412 Get, 425
GetVariable, 413 IndexOf, 425
Load, 413 Insert, 426
NCol, 411 Remove, 426
NRow, 411 Size, 426
Release, 413 Sort, 426
SizeX, 411 IntEvt, 427
SizeY, 411 CreateCBEvents, 427
SortAccordingToColumn, 413 RemoveSwitchEvents, 427
IntComtradeset, 414 IntExtaccess, 428
FindColumn, 414 CheckUrl, 428
FindMaxInColumn, 415 IntGate, 428
FindMinInColumn, 415 AddTrigger, 428
GetAnalogueDescriptions, 415 IntGrf, 428
GetColumnValues, 415 MoveToLayer, 429
GetDescription, 416 IntGrfgroup, 429
GetDigitalDescriptions, 416 ClearData, 429
GetNumberOfAnalogueSignalDescriptions, Export, 429
416 Import, 429
GetNumberOfColumns, 417 IntGrflayer, 430
GetNumberOfDigitalSignalDescriptions, 417 AdaptWidth, 430
GetNumberOfRows, 417 Align, 430
GetObjectValue, 417 ChangeFont, 431
GetSignalHeader, 418 ChangeLayer, 431
GetUnit, 418 ChangeRefPoints, 432
GetValue, 418 ChangeWidthVisibilityAndColour, 433
GetVariable, 419 ClearData, 433
Load, 419 Export, 433
NCol, 417 ExportToVec, 434
NRow, 417 Import, 434
Release, 419 ImportFromVec, 434
SizeX, 417 Mark, 434
SizeY, 417 Reset, 435
SortAccordingToColumn, 419 IntGrfnet, 435
IntDataset, 420 Close, 435
AddRef, 420 SetFontFor, 436
All, 420 SetLayerVisibility, 436
Clear, 420 SetSymbolComponentVisibility, 436
GetAll, 420 Show, 437
IntDocument, 421 IntIcon, 437
Export, 421 Export, 437
Import, 421 Import, 438
Reset, 421 IntLibrary, 438
View, 422 Activate, 438
IntDplmap, 422 Deactivate, 438
Clear, 422 IntMat, 439
Contains, 422 ColLbl, 439, 440
First, 422 Get, 439
GetValue, 423 GetColumnLabel, 440
Insert, 423 GetColumnLabelIndex, 440
Next, 424 GetNumberOfColumns, 440
Remove, 424 GetNumberOfRows, 441

569
INDEX INDEX

GetRowLabel, 441 GetGeoCoordinateSystem, 456

GetRowLabelIndex, 441 GetLatestVersion, 457
Init, 442 GetVersions, 457
Invert, 442 HasExternalReferences, 457
Multiply, 442 LoadData, 458
NCol, 440 MergeToBaseProject, 458
NRow, 441 Migrate, 458
Resize, 443 NormaliseCombined, 459
RowLbl, 441, 443 PackExternalReferences, 459
Save, 443 Purge, 459
Set, 444 PurgeObjectKeys, 459
SetColumnLabel, 444 RemoveProjectFromCombined, 460
SetRowLabel, 445 Restore, 460
SizeX, 441 SetGeoCoordinateSystem, 460
SizeY, 440 SubscribeProjectReadOnly, 460
SortToColum, 445 SubscribeProjectReadWrite, 461
SortToColumn, 445 TransformGeoCoordinates, 461
IntMon, 445 TransformToGeographicCoordinateSystem,
AddVar, 446 461
AddVars, 446 UnsubscribeProject, 462
ClearVars, 446 UpdateStatistics, 462
GetVar, 446 UpdateToDefaultStructure, 462
NVars, 447 UpdateToMostRecentBaseVersion, 462
PrintAllVal, 447 IntPrjfolder, 463
PrintVal, 447 GetProjectFolderType, 463
RemoveVar, 447 IsProjectFolderType, 465
IntOutage, 447 IntQlim, 465
Apply, 448 GetQlim, 465
ApplyAll, 448 IntRas, 466
Check, 448 AddEvent, 466
CheckAll, 448 AddTrigger, 466
IsInStudyTime, 449 IsValid, 466
IsInStudytime, 449 IntRunarrange, 466
ResetAll, 449 GetSwitchStatus, 467
IntPlannedout, 450 IntScenario, 467
SetRecurrence, 450 Activate, 467
IntPlot, 450 Apply, 467
SetAdaptY, 450 ApplySelective, 468
SetAutoScaleY, 450 Deactivate, 468
SetScaleY, 451 DiscardChanges, 469
IntPrj, 451 GetObjects, 469
Activate, 452 GetOperationValue, 469
AddProjectToCombined, 452 ReleaseMemory, 470
AddProjectToRemoteDatabase, 452 Save, 470
Archive, 453 SetOperationValue, 470
BeginDataExtensionModification, 453 IntScensched, 470
CanAddProjectToRemoteDatabase, 453 Activate, 471
CanSubscribeProjectReadOnly, 453 Deactivate, 471
CanSubscribeProjectReadWrite, 453 DeleteRow, 471
ClearInvalidReferences, 454 GetScenario, 471
CopyDataExtensionFrom, 454 GetStartEndTime, 472
CreateVersion, 454 SearchScenario, 472
Deactivate, 455 IntScheme, 472
EndDataExtensionModification, 455 Activate, 473
GetDerivedProjects, 456 Consolidate, 473
GetExternalReferences, 456 Deactivate, 473

570
INDEX INDEX

GetActiveScheduler, 473 CreateDerivedProject, 487

NewStage, 473 GetDerivedProjects, 487
IntSscheduler, 474 GetHistoricalProject, 488
Activate, 474 Rollback, 488
Deactivate, 474 IntViewbookmark, 488
Update, 474 JumpTo, 488
IntSstage, 475 UpdateFromCurrentView, 488
Activate, 475 Invert
CreateStageObject, 475 IntMat, 442
EnableDiffMode, 476 InvertMatrix
GetScheme, 476 Mathematical Functions, 43
GetVariation, 476 IsAC
IsExcluded, 476 ComLdf, 295
PrintModifications, 476 IsAdditionalResultsFlagSetForCommand
ReadValue, 477 ComTasks, 334
WriteValue, 477 IsAttributeModeInternal
IntSubset, 477 Application Methods, 21
Apply, 478 IsAutomaticCalculationResetEnabled
ApplySelective, 478 Environment Functions, 38
Clear, 478 IsBalanced
GetConfiguration, 479 ComLdf, 295
GetObjects, 479 IsBreaker
IntThrating, 479 ElmCoup, 93
GetCriticalTimePhase, 479 IsCable
GetRating, 479 ElmLne, 107
IntUrl, 480 ElmLnesec, 109
View, 480 TypLne, 514
IntUser, 480 IsCalcRelevant
Purge, 480 General Object Methods, 67
SetPassword, 481 IsClosed
TerminateSession, 481 ElmCoup, 93
IntUserman, 481 ElmGndswt, 102
CreateGroup, 481 StaCubic, 174
CreateUser, 482 StaSwitch, 240
GetGroups, 482 IsCommandIgnored
GetUsers, 482 ComTasks, 335
UpdateGroups, 482 IsConnected
IntVec, 483 ElmGenstat, 101
Get, 483 ElmPvsys, 114
Init, 483 ElmSym, 142
Max, 483 StaCubic, 174
Mean, 483 IsDC
Min, 484 ComLdf, 296
Resize, 484 IsDeleted
Save, 484 General Object Methods, 68
Set, 484 IsEarthed
Size, 485 General Object Methods, 68
Sort, 485 IsElectrEquivalent
IntVecobj, 485 ElmTerm, 148
Get, 485 IsEncrypted
Resize, 486 ComDpl, 287
Save, 486 TypQdsl, 516
Search, 486 IsEnergized
Set, 486 General Object Methods, 68
Size, 487 IsEquivalent
IntVersion, 487 ElmTerm, 148

571
INDEX INDEX

IsExcluded IsShcValid
IntSstage, 476 Application Methods, 22
IsFinalEchoOnEnabled IsShortCircuited
Environment Functions, 38 General Object Methods, 72
IsFrozen IsSimValid
SetDesktop, 360 Application Methods, 22
IsHidden IsSplitting
General Object Methods, 68 ElmBoundary, 89
IsInFeeder IsStarted
General Object Methods, 69 ElmRelay, 116
IsInStudyTime IsStatusBitSet
IntOutage, 449 StaExtbrkmea, 176
IsInStudytime StaExtcmdmea, 181
IntOutage, 449 StaExtdatmea, 186
IsInternalNodeInStation StaExtfmea, 191
ElmTerm, 149 StaExtfuelmea, 196
IsLastIterationFeasible StaExtimea, 201
ComTransfer, 342 StaExtpfmea, 206
IsLdfValid StaExtpmea, 211
Application Methods, 21 StaExtqmea, 216
IsNAN StaExtsmea, 221
Application Methods, 21 StaExttapmea, 226
IsNetCoupling StaExtv3mea, 231
ElmLne, 108 StaExtvmea, 236
IsNetworkDataFolder IsStatusBitSetTmp
General Object Methods, 69 StaExtbrkmea, 176
IsNode StaExtcmdmea, 181
General Object Methods, 70 StaExtdatmea, 186
IsObjectActive StaExtfmea, 191
General Object Methods, 70 StaExtfuelmea, 196
IsObjectModifiedByVariation StaExtimea, 201
General Object Methods, 70 StaExtpfmea, 206
Isolate StaExtpmea, 211
General Object Methods, 71 StaExtqmea, 216
IsOpen StaExtsmea, 221
ElmCoup, 93 StaExttapmea, 226
ElmGndswt, 102 StaExtv3mea, 231
StaSwitch, 240 StaExtvmea, 236
IsOpened IsStudyCaseIgnored
SetDesktop, 361 ComTasks, 335
IsOutOfService IsValid
General Object Methods, 71 IntRas, 466
IsPQ IsWriteCacheEnabled
ElmAsm, 83 Application Methods, 23
IsProjectFolderType
IntPrjfolder, 465 JumpTo
IsQuadBooster IntViewbookmark, 488
ElmTr2, 153 JumpToLastStep
ElmTr3, 157 ComContingency, 266
ElmTr4, 161
IsReducible LdfEquivalentVerification
General Object Methods, 72 ComRed, 314
IsRmsValid LicenceHasModule
Application Methods, 22 Application Methods, 23
IsScenarioAttribute Load
Application Methods, 22 ElmRes, 131

572
INDEX INDEX

IntComtrade, 413 Module Functions, 2

IntComtradeset, 419 version , 2
LoadData GetApplication, 2
IntPrj, 458 GetApplicationExt, 3
LoadFile ModuleExists
ElmFile, 97 ComAddon, 252
LoadMicroSCADAFile Move
ComLink, 296 General Object Methods, 73
LoadProfile MoveToLayer
Application Methods, 24 IntGrf, 429
LoadSimulationState Multiply
ComSim, 324 IntMat, 442
LoadSnapshot
ComSim, 324 NCol
LossCostAtBusTech ElmRes, 128
ComCapo, 255 IntComtrade, 411
IntComtradeset, 417
Mark IntMat, 440
IntGrflayer, 434 Network Elements Methods, 79
SetLevelvis, 367 NewStage
MarkInGraphics IntScheme, 473
Application Methods, 25 Next
General Object Methods, 72 IntDplmap, 424
MarkRegions NextStepAvailable
ComSimoutage, 329 ComShctrace, 323
Mathematical Functions, 41 NormaliseCombined
GetRandomNumber, 42 IntPrj, 459
GetRandomNumberEx, 42 NRow
InvertMatrix, 43 ElmRes, 128
RndExp, 43 IntComtrade, 411
RndGetMethod, 44 IntComtradeset, 417
RndGetSeed, 44 IntMat, 441
RndNormal, 44 NTap
RndSetup, 45 ElmTr2, 153
RndUnifInt, 46 ElmTr3, 157
RndUnifReal, 46 ElmTr4, 161
RndWeibull, 46 ElmVoltreg, 167
SetRandomSeed, 47 NVars
Max IntMon, 447
IntVec, 483
MaxZoneNumberFor Object Methods, 52
ComCoordreport, 271 Open
Mean ElmCoup, 93
IntVec, 483 ElmGndswt, 102
MeasureLength StaSwitch, 241
ElmLne, 108 Other Objects Methods, 382
Merge Output Window Functions, 47
ComMerge, 301 ClearOutputWindow, 47
MergeToBaseProject FlushOutputWindow, 47
IntPrj, 458 GetOutputWindow, 48
Migrate PrintError, 48
IntPrj, 458 PrintInfo, 48
MigratePage PrintPlain, 48
SetVipage, 380 PrintWarn, 48
Min SetOutputWindowState, 48
IntVec, 484 Output Window Methods, 50

573
INDEX INDEX

Clear, 50 SetFont, 497

Flush, 50 PltVectorplot, 498
GetContent, 50 ChangeStyle, 498
Print, 51 DoAutoScale, 498
Save, 51 GetAxisX, 498
SetState, 51 GetAxisY, 498
OutputFlexibleData GetComplexData, 499
Application Methods, 25 GetLegend, 499
OverwriteRA GetTitleObject, 499
ElmSubstat, 138 SetAutoScaleModeX, 499
OvlAlleviate SetAutoScaleModeY, 499
ComRel3, 315 SetScaleX, 500
SetScaleY, 500
Pack PostCommand
BlkDef, 384 Application Methods, 25
PackAsMacro PrepForUntouchedDelete
BlkDef, 384 Application Methods, 26
PackExternalReferences Print
IntPrj, 459 Output Window Methods, 51
PasteCopy SetScenario, 373
General Object Methods, 73 PrintAllVal
PltAxis, 488 IntMon, 447
DoAutoScale, 489 PrintCheckResults
SetFont, 489 ComLdf, 296
PltComplexdata, 489 PrintComparisonReport
AddVector, 489 ComMerge, 301
ChangeColourPalette, 489 PrintError
ClearVectors, 490 Output Window Functions, 48
PltDataseries, 490 PrintInfo
AddCurve, 490 Output Window Functions, 48
AddXYCurve, 490 PrintModifications
ChangeColourPalette, 491 ComMerge, 301
ClearCurves, 491 IntSstage, 476
GetDataSource, 491 PrintPlain
GetIntCalcres, 492 Output Window Functions, 48
PltLegend, 492 PrintVal
SetFont, 492 IntMon, 447
PltLinebarplot, 492 PrintWarn
ChangeStyle, 493 Output Window Functions, 48
DoAutoScale, 493 Purge
DoAutoScaleX, 493 IntPrj, 459
DoAutoScaleY, 493 IntUser, 480
GetAxisX, 494 SetTboxconfig, 376
GetAxisY, 494 PurgeObjectKeys
GetDataSeries, 494 IntPrj, 459
GetLegend, 494 PurgeUnusedObjects
GetTitleObject, 495 General Object Methods, 74
SetAutoScaleModeX, 495
SetAutoScaleModeY, 495 QuickAccessAvailable
SetAxisSharingLevelX, 495 ComUcteexp, 345
SetAxisSharingLevelY, 496
SetScaleTypeX, 496 ReadValue
SetScaleTypeY, 496 IntSstage, 477
SetScaleX, 496 Rebuild
SetScaleY, 497 Application Methods, 26
PltTitle, 497 ReceiveData

574
INDEX INDEX

ComLink, 297 RemoveProjectFromCombined

ComOpc, 306 IntPrj, 460
Reconnect RemoveRas
ElmGenstat, 101 ComSimoutage, 330
ElmPvsys, 114 RemoveRatio
ElmSym, 142 TypCtcore, 514
ElmXnet, 169 RemoveRatioByIndex
ReductionInMemory TypCtcore, 514
ComRed, 314 RemoveStudyCase
Refresh ComTasks, 336
VisMagndiffplt, 526 RemoveStudyCases
VisOcplot, 527 ComTasks, 337
RelChar, 500 ComTececocmp, 341
SetCurve, 500 RemoveSwitchEvents
Release IntEvt, 427
ElmRes, 131 RemoveVar
IntComtrade, 413 IntMon, 447
IntComtradeset, 419 ReplaceNonAsciiCharacters
ReleaseMemory General Object Methods, 74
IntScenario, 470 Report
ReloadProfile ComDllmanager, 284
Application Methods, 26 ReportNonAsciiCharacters
RelToc, 501 General Object Methods, 74
SetCurve, 501 ReportUnusedObjects
RelZpol, 501 General Object Methods, 74
AssumeCompensationFactor, 501 Reset
AssumeReRl, 501 ComMerge, 302
AssumeXeXl, 502 ComSimoutage, 330
Remove IntDocument, 421
IntDplmap, 424 IntGrflayer, 435
IntDplvec, 426 SetLevelvis, 367
RemoveAllConfigurations ResetAll
SetDataext, 357 IntOutage, 449
RemoveAllRas ResetCalculation
ComSimoutage, 329 Application Methods, 26
RemoveCmdsForStudyCaseRow ResetDerating
ComTasks, 335 ElmGenstat, 101
RemoveCommand ElmPvsys, 114
ComTasks, 336 ElmSym, 142
RemoveConfiguration ResetQuickAccess
SetDataext, 357 ComUcteexp, 345
RemoveContingencies ResetRA
ComSimoutage, 329 ElmSubstat, 138
RemoveEvents ResetReductionInMemory
ComContingency, 266 ComRed, 314
ComOutage, 308 ResetStatusBit
ComRel3, 316 StaExtbrkmea, 176
RemoveOutages StaExtcmdmea, 182
ComRel3, 316 StaExtdatmea, 187
RemovePage StaExtfmea, 192
GrpPage, 398 StaExtfuelmea, 197
SetDesktop, 361 StaExtimea, 202
RemoveParameter StaExtpfmea, 207
CimModel, 388 StaExtpmea, 212
CimObject, 392 StaExtqmea, 217
IntAddonvars, 405 StaExtsmea, 221

575
INDEX INDEX

StaExttapmea, 226 IntVec, 484

StaExtv3mea, 232 IntVecobj, 486
StaExtvmea, 237 ResLoadData
ResetStatusBitTmp Application Methods, 29
StaExtbrkmea, 177 ResReleaseData
StaExtcmdmea, 182 Application Methods, 30
StaExtdatmea, 187 ResSortToVariable
StaExtfmea, 192 Application Methods, 30
StaExtfuelmea, 197 Restore
StaExtimea, 202 IntPrj, 460
StaExtpfmea, 207 ResultForDirectionalBackupVariable
StaExtpmea, 212 ComCoordreport, 271
StaExtqmea, 217 ResultForFuseVariable
StaExtsmea, 221 ComCoordreport, 272
StaExttapmea, 227 ResultForInstantaneousVariable
StaExtv3mea, 232 ComCoordreport, 272
StaExtvmea, 237 ResultForMaxCurrent
ResetThirdPartyModule ComCoordreport, 273
BlkDef, 384 ResultForNonDirectionalBackupVariable
ComDpl, 288 ComCoordreport, 273
TypQdsl, 516 ResultForOverloadVariable
ResGetData ComCoordreport, 274
Application Methods, 27 ResultForOverreachVariable
ResGetDescription ComCoordreport, 275
Application Methods, 27 ResultForShortCircuitVariable
ResGetFirstValidObject ComCoordreport, 275
Application Methods, 27 ResultForZoneVariable
ResGetFirstValidObjectVariable ComCoordreport, 276
Application Methods, 27 RndExp
ResGetFirstValidVariable Mathematical Functions, 43
Application Methods, 27 RndGetMethod
ResGetIndex Mathematical Functions, 44
Application Methods, 28 RndGetSeed
ResGetMax Mathematical Functions, 44
Application Methods, 28 RndNormal
ResGetMin Mathematical Functions, 44
Application Methods, 28 RndSetup
ResGetNextValidObject Mathematical Functions, 45
Application Methods, 28 RndUnifInt
ResGetNextValidObjectVariable Mathematical Functions, 46
Application Methods, 28 RndUnifReal
ResGetNextValidVariable Mathematical Functions, 46
Application Methods, 29 RndWeibull
ResGetObject Mathematical Functions, 46
Application Methods, 29 Rollback
ResGetUnit IntVersion, 488
Application Methods, 29 RowLbl
ResGetValueCount IntMat, 441, 443
Application Methods, 29
ResGetVariable Save
Application Methods, 29 IntMat, 443
ResGetVariableCount IntScenario, 470
Application Methods, 29 IntVec, 484
Resize IntVecobj, 486
ElmBoundary, 90 Output Window Methods, 51
IntMat, 443 SaveAsRA

576
INDEX INDEX

ElmSubstat, 138 Application Methods, 30

SaveAsScenario SearchScenario
Application Methods, 30 IntScensched, 472
SaveFile SelectToolbox
ElmFile, 97 Application Methods, 30
SaveSimulationState SendData
ComSim, 325 ComLink, 297
SaveSnapshot ComOpc, 306
ComSim, 325 SentDataStatus
ScnFreq, 502 ComLink, 297
GetLimit, 502 Set
GetNumberOfViolations, 502 IntMat, 444
GetValue, 502 IntVec, 484
GetVariable, 503 IntVecobj, 486
GetViolatedElement, 503 SetActiveModule
GetViolationTime, 503 ComAddon, 253
ScnFrt, 504 SetAdaptX
GetLimit, 504 SetDesktop, 361
GetNumberOfViolations, 504 SetVipage, 380
GetValue, 504 VisPath, 528
GetVariable, 504 VisPlot, 533
GetViolatedElement, 505 VisPlot2, 539
GetViolationTime, 505 SetAdaptY
ScnSpeed, 505 IntPlot, 450
GetLimit, 505 VisPath, 528
GetNumberOfViolations, 506 VisPlot, 533
GetValue, 506 VisPlot2, 539
GetVariable, 506 SetAdditionalResultsFlagForCommand
GetViolatedElement, 506 ComTasks, 337
GetViolationTime, 507 SetAsDefault
ScnSync, 507 ElmRes, 131
GetLimit, 507 SetAssociationValue
GetNumberOfViolations, 507 CimModel, 388
GetValue, 508 CimObject, 393
GetVariable, 508 SetAttribute
GetViolatedElement, 508 General Object Methods, 75
GetViolationTime, 508 SetAttributeEnumeration
ScnVar, 509 CimModel, 389
GetLimit, 509 CimObject, 393, 394
GetNumberOfViolations, 509 SetAttributeLength
GetValue, 509 General Object Methods, 75
GetVariable, 509 SetAttributeModeInternal
GetViolatedElement, 510 Application Methods, 31
GetViolationTime, 510 SetAttributes
ScnVolt, 510 General Object Methods, 76
GetLimit, 510 SetAttributeShape
GetNumberOfViolations, 511 General Object Methods, 76
GetValue, 511 SetAttributeValue
GetVariable, 511 CimModel, 389, 390
GetViolatedElement, 511 CimObject, 394
GetViolationTime, 512 SetAuthorityUri
Search ComGridtocim, 291
IntVecobj, 486 SetAutoAssignmentForAll
SearchObject ComMerge, 302
General Object Methods, 75 SetAutomaticCalculationResetEnabled
SearchObjectByForeignKey Environment Functions, 39

577
INDEX INDEX

SetAutoScaleModeX SetDataext, 356

GrpPage, 398 AddConfiguration, 356
PltLinebarplot, 495 GetConfiguration, 356
PltVectorplot, 499 GetConfigurations, 357
SetAutoScaleModeY RemoveAllConfigurations, 357
GrpPage, 398 RemoveConfiguration, 357
PltLinebarplot, 495 SetDefScaleX
PltVectorplot, 499 VisHrm, 524
SetAutoScaleX VisPlot, 535
SetDesktop, 362 VisPlot2, 541
SetVipage, 380 SetDefScaleY
VisHrm, 523 VisHrm, 524
VisPlot, 534 VisPlot, 535
VisPlot2, 540 VisPlot2, 541
SetAutoScaleY SetDeskpage, 357
IntPlot, 450 Close, 358
VisHrm, 524 Show, 358
VisPlot, 534 SetDesktop, 358
VisPlot2, 540 AddPage, 358
SetAxisSharingLevelX Close, 359
PltLinebarplot, 495 DoAutoScaleX, 359
SetAxisSharingLevelY Freeze, 359
PltLinebarplot, 496 GetActivePage, 359
SetBatchMode GetCanvasSize, 360
ComUcte, 342 GetPage, 360
SetBoundaries IsFrozen, 360
ComGridtocim, 292 IsOpened, 361
SetCluster, 347 RemovePage, 361
CalcCluster, 347 SetAdaptX, 361
GetNumberOfClusters, 347 SetAutoScaleX, 362
SetColouring SetResults, 362
SetColscheme, 350 SetScaleX, 362
SetColscheme, 348 SetXVar, 362
CreateFilter, 348 Show, 363
GetAlarmColouringMode, 349 Unfreeze, 363
GetColouringMode, 350 WriteWMF, 363
GetEnergisingColouringMode, 350 ZoomAll, 364
SetColouring, 350 SetDetailed
SetFilter, 355 ElmLne, 108
SetColumnLabel SetDisplayedButtons
IntMat, 444 SetTboxconfig, 377
SetConstraint SetDistrstate, 364
IntAddonvars, 405 CalcCluster, 364
SetCrvDesc SetElms
VisHrm, 524 StoMaint, 512
VisPlot, 534 SetEnableUserBreak
VisPlot2, 540 Environment Functions, 41
SetCrvDescX SetExternalObject
VisXyplot, 545 ComDpl, 288
SetCrvDescY ComPython, 312
VisXyplot, 546 SetFileName
SetCurve ComSvgexport, 331
RelChar, 500 ComSvgimport, 331
RelToc, 501 SetFilt, 365
SetDatabase, 355 Get, 365
EmptyCache, 355 SetFilter

578
INDEX INDEX

SetColscheme, 355 ElmRelay, 118

SetFinalEchoOnEnabled SetMaxIearth
Environment Functions, 39 ElmRelay, 118
SetFont SetMeaValue
PltAxis, 489 StaExtbrkmea, 177
PltLegend, 492 StaExtcmdmea, 182
PltTitle, 497 StaExtdatmea, 187
SetFontFor StaExtfmea, 192
IntGrfnet, 436 StaExtfuelmea, 197
SetPrj, 371 StaExtimea, 202
SetGeoCoordinateSystem StaExtpfmea, 207
IntPrj, 460 StaExtpmea, 212
SetGraphicUpdate StaExtqmea, 217
Environment Functions, 39 StaExtsmea, 222
SetGridSelection StaExttapmea, 227
ComUcteexp, 346 StaExtv3mea, 232
SetGridsToExport StaExtvmea, 237
ComGridtocim, 292 SetMinI
SetGuiUpdateEnabled ElmRelay, 118
Environment Functions, 40 SetMinIearth
SetIgnoreFlagForCommand ElmRelay, 118
ComTasks, 337 SetNumSlave
SetIgnoreFlagForStudyCase SetParalman, 368
ComTasks, 338 SetObj
SetImpedance ElmRes, 132
ElmRelay, 117 SetObject
SetInputParameterDouble ComSvgexport, 331
ComDpl, 288 ComSvgimport, 332
ComPython, 312 SetObjects
SetInputParameterInt ComSvgexport, 331
ComDpl, 289 SetObjectsToCompare
ComPython, 313 ComMerge, 302
SetInputParameterString SetObjs
ComDpl, 289 ComOutage, 308
ComPython, 313 SetOldDistributeLoadMode
SetInterfaceVersion ComLdf, 296
Application Methods, 31 SetOPCReceiveQuality
SetLayerVisibility ComLink, 298
IntGrfnet, 436 SetOperationValue
SetLayoutMode IntScenario, 470
GrpPage, 399 SetOutOfService
SetLevelvis, 365 ElmRelay, 118
AdaptWidth, 365 SetOutputWindowState
Align, 365 Output Window Functions, 48
ChangeFont, 365 SetParalman, 367
ChangeFrameAndWidth, 366 GetNumSlave, 367
ChangeLayer, 366 SetNumSlave, 368
ChangeRefPoints, 366 SetTransfType, 368
ChangeWidthVisibilityAndColour, 366 SetPassword
Mark, 367 IntUser, 481
Reset, 367 SetPath, 368
SetLimits AllBreakers, 368
ComSimoutage, 330 AllClosedBreakers, 369
SetLoadScaleAbsolute AllOpenBreakers, 369
ElmZone, 171 AllProtectionDevices, 369
SetMaxI Create, 369

579
INDEX INDEX

GetAll, 370 Print, 373

GetBranches, 370 SetSelect, 373
GetBuses, 370 AddRef, 373
GetPathFolder, 370 All, 373
SetPosition AllAsm, 373
ElmTrain, 162 AllBars, 374
SetPrimaryTap AllBreakers, 374
StaCt, 171 AllClosedBreakers, 374
SetPrj, 371 AllElm, 374
GetFontID, 371 AllLines, 374
SetFontFor, 371 AllLoads, 375
SetProgressBarUpdatesEnabled AllOpenBreakers, 375
Environment Functions, 40 AllSym, 375
SetRA AllTypLne, 375
ElmSubstat, 138 Clear, 375
SetRandomSeed GetAll, 375
Mathematical Functions, 47 SetShowAllUsers
SetRecurrence Application Methods, 31
IntPlannedout, 450 SetState
SetRescheduleFlag Output Window Methods, 51
Environment Functions, 40 SetStatus
SetResults StaExtbrkmea, 177
GrpPage, 399 StaExtcmdmea, 182
SetDesktop, 362 StaExtdatmea, 187
SetVipage, 381 StaExtfmea, 192
SetResultsFolder StaExtfuelmea, 197
ComTasks, 339 StaExtimea, 202
SetRowLabel StaExtpfmea, 207
IntMat, 445 StaExtpmea, 212
SetScaleTypeX StaExtqmea, 217
GrpPage, 399 StaExtsmea, 222
PltLinebarplot, 496 StaExttapmea, 227
SetScaleTypeY StaExtv3mea, 232
GrpPage, 399 StaExtvmea, 237
PltLinebarplot, 496 SetStatusBit
SetScaleX StaExtbrkmea, 178
GrpPage, 400 StaExtcmdmea, 183
PltLinebarplot, 496 StaExtdatmea, 188
PltVectorplot, 500 StaExtfmea, 193
SetDesktop, 362 StaExtfuelmea, 198
SetVipage, 381 StaExtimea, 203
VisPath, 528 StaExtpfmea, 208
VisPlot, 535 StaExtpmea, 213
VisPlot2, 541 StaExtqmea, 218
SetScaleY StaExtsmea, 223
GrpPage, 400 StaExttapmea, 228
IntPlot, 451 StaExtv3mea, 233
PltLinebarplot, 497 StaExtvmea, 238
PltVectorplot, 500 SetStatusBitTmp
VisBdia, 519 StaExtbrkmea, 178
VisPath, 529 StaExtcmdmea, 183
VisPlot, 535 StaExtdatmea, 188
VisPlot2, 541 StaExtfmea, 193
SetScenario, 372 StaExtfuelmea, 198
Check, 372 StaExtimea, 203
Default, 372 StaExtpfmea, 208

580
INDEX INDEX

StaExtpmea, 213 Environment Functions, 41

StaExtqmea, 218 SetVipage, 378
StaExtsmea, 223 Close, 379
StaExttapmea, 228 CreateVI, 380
StaExtv3mea, 233 DoAutoScaleX, 379
StaExtvmea, 238 DoAutoScaleY, 379
SetStatusTmp GetOrInsertPlot, 379
StaExtbrkmea, 179 GetVI, 379
StaExtcmdmea, 184 InsertPlot, 380
StaExtdatmea, 189 MigratePage, 380
StaExtfmea, 194 SetAdaptX, 380
StaExtfuelmea, 199 SetAutoScaleX, 380
StaExtimea, 204 SetResults, 381
StaExtpfmea, 209 SetScaleX, 381
StaExtpmea, 214 SetStyle, 381
StaExtqmea, 219 SetTile, 382
StaExtsmea, 223 SetXVar, 382
StaExttapmea, 228 Show, 382
StaExtv3mea, 234 SetWriteCacheEnabled
StaExtvmea, 239 Application Methods, 32
SetStudyTime SetXVar
IntCase, 407 SetDesktop, 362
SetStyle SetVipage, 382
SetVipage, 381 VisPlot, 536
SetSubElmResKey VisPlot2, 542
ElmRes, 132 SetXVariable
SetSwitchShcEventMode VisBdia, 519
ComLink, 298 SetYVariable
SetSymbolComponentVisibility VisBdia, 519
IntGrfnet, 436 Show
SetTboxconfig, 376 Application Methods, 32
Check, 376 GrpPage, 400
GetAvailableButtons, 376 IntGrfnet, 437
GetDisplayedButtons, 376 SetDeskpage, 358
Purge, 376 SetDesktop, 363
SetDisplayedButtons, 377 SetVipage, 382
SetThirdPartyModule ShowBrowser
BlkDef, 384 ComMerge, 302
ComDpl, 289 ShowEditDialog
TypQdsl, 517 General Object Methods, 76
SetTile ShowModalBrowser
SetVipage, 382 Dialogue Boxes Functions, 36
SetTime, 377 ShowModalSelectBrowser
Date, 377 Dialogue Boxes Functions, 36
ElmRelay, 119 ShowModalSelectTree
SetTime, 377 General Object Methods, 77
SetTimeUTC, 378 ShowModelessBrowser
Time, 378 Dialogue Boxes Functions, 37
SetTimeUTC ShowY2
SetTime, 378 VisPlot2, 542
Settings Methods, 347 SimEquivalentVerification
SetTransfType ComRed, 314
SetParalman, 368 Size
SetUser, 378 IntDplmap, 424
GetNumProcesses, 378 IntDplvec, 426
SetUserBreakEnabled IntVec, 485

581
INDEX INDEX

IntVecobj, 487 UpdateControl, 179

SizeX UpdateCtrl, 179
ElmRes, 128 StaExtcmdmea, 180
IntComtrade, 411 CopyExtMeaStatusToStatusTmp, 180
IntComtradeset, 417 GetMeaValue, 180
IntMat, 441 GetStatus, 180
SizeY GetStatusTmp, 181
ElmRes, 128 InitTmp, 181
IntComtrade, 411 IsStatusBitSet, 181
IntComtradeset, 417 IsStatusBitSetTmp, 181
IntMat, 440 ResetStatusBit, 182
slotupd ResetStatusBitTmp, 182
ElmComp, 91 SetMeaValue, 182
ElmRelay, 119 SetStatus, 182
SlotUpdate SetStatusBit, 183
ElmComp, 91 SetStatusBitTmp, 183
ElmRelay, 119 SetStatusTmp, 184
Sort UpdateControl, 184
IntDplvec, 426 UpdateCtrl, 184
IntVec, 485 StaExtdatmea, 185
SortAccordingToColumn CopyExtMeaStatusToStatusTmp, 185
ElmRes, 132 CreateEvent, 185
IntComtrade, 413 GetMeaValue, 185
IntComtradeset, 419 GetStatus, 186
SortToColum GetStatusTmp, 186
IntMat, 445 InitTmp, 186
SortToColumn IsStatusBitSet, 186
IntMat, 445 IsStatusBitSetTmp, 186
SplitLine ResetStatusBit, 187
Application Methods, 32 ResetStatusBitTmp, 187
StaCt, 171 SetMeaValue, 187
SetPrimaryTap, 171 SetStatus, 187
StaCubic, 171 SetStatusBit, 188
GetAll, 172 SetStatusBitTmp, 188
GetBranch, 172 SetStatusTmp, 189
GetConnectedMajorNodes, 172 UpdateControl, 189
GetConnections, 173 UpdateCtrl, 189
GetNearestBusbars, 173 StaExtfmea, 190
GetPathToNearestBusbar, 174 CopyExtMeaStatusToStatusTmp, 190
IsClosed, 174 GetMeaValue, 190
IsConnected, 174 GetStatus, 190
StaExtbrkmea, 175 GetStatusTmp, 191
CopyExtMeaStatusToStatusTmp, 175 InitTmp, 191
GetMeaValue, 175 IsStatusBitSet, 191
GetStatus, 175 IsStatusBitSetTmp, 191
GetStatusTmp, 176 ResetStatusBit, 192
InitTmp, 176 ResetStatusBitTmp, 192
IsStatusBitSet, 176 SetMeaValue, 192
IsStatusBitSetTmp, 176 SetStatus, 192
ResetStatusBit, 176 SetStatusBit, 193
ResetStatusBitTmp, 177 SetStatusBitTmp, 193
SetMeaValue, 177 SetStatusTmp, 194
SetStatus, 177 UpdateControl, 194
SetStatusBit, 178 UpdateCtrl, 194
SetStatusBitTmp, 178 StaExtfuelmea, 195
SetStatusTmp, 179 CopyExtMeaStatusToStatusTmp, 195

582
INDEX INDEX

GetMeaValue, 195 IsStatusBitSetTmp, 211

GetStatus, 195 ResetStatusBit, 212
GetStatusTmp, 196 ResetStatusBitTmp, 212
InitTmp, 196 SetMeaValue, 212
IsStatusBitSet, 196 SetStatus, 212
IsStatusBitSetTmp, 196 SetStatusBit, 213
ResetStatusBit, 197 SetStatusBitTmp, 213
ResetStatusBitTmp, 197 SetStatusTmp, 214
SetMeaValue, 197 UpdateControl, 214
SetStatus, 197 UpdateCtrl, 214
SetStatusBit, 198 StaExtqmea, 215
SetStatusBitTmp, 198 CopyExtMeaStatusToStatusTmp, 215
SetStatusTmp, 199 GetMeaValue, 215
UpdateControl, 199 GetStatus, 215
UpdateCtrl, 199 GetStatusTmp, 216
StaExtimea, 200 InitTmp, 216
CopyExtMeaStatusToStatusTmp, 200 IsStatusBitSet, 216
GetMeaValue, 200 IsStatusBitSetTmp, 216
GetStatus, 200 ResetStatusBit, 217
GetStatusTmp, 201 ResetStatusBitTmp, 217
InitTmp, 201 SetMeaValue, 217
IsStatusBitSet, 201 SetStatus, 217
IsStatusBitSetTmp, 201 SetStatusBit, 218
ResetStatusBit, 202 SetStatusBitTmp, 218
ResetStatusBitTmp, 202 SetStatusTmp, 219
SetMeaValue, 202 UpdateControl, 219
SetStatus, 202 UpdateCtrl, 219
SetStatusBit, 203 StaExtsmea, 220
SetStatusBitTmp, 203 CopyExtMeaStatusToStatusTmp, 220
SetStatusTmp, 204 GetStatus, 220
UpdateControl, 204 GetStatusTmp, 220
UpdateCtrl, 204 InitTmp, 220
StaExtpfmea, 205 IsStatusBitSet, 221
CopyExtMeaStatusToStatusTmp, 205 IsStatusBitSetTmp, 221
GetMeaValue, 205 ResetStatusBit, 221
GetStatus, 205 ResetStatusBitTmp, 221
GetStatusTmp, 206 SetMeaValue, 222
InitTmp, 206 SetStatus, 222
IsStatusBitSet, 206 SetStatusBit, 223
IsStatusBitSetTmp, 206 SetStatusBitTmp, 223
ResetStatusBit, 207 SetStatusTmp, 223
ResetStatusBitTmp, 207 UpdateControl, 224
SetMeaValue, 207 UpdateCtrl, 224
SetStatus, 207 StaExttapmea, 224
SetStatusBit, 208 CopyExtMeaStatusToStatusTmp, 225
SetStatusBitTmp, 208 GetMeaValue, 225
SetStatusTmp, 209 GetStatus, 225
UpdateControl, 209 GetStatusTmp, 226
UpdateCtrl, 209 InitTmp, 226
StaExtpmea, 210 IsStatusBitSet, 226
CopyExtMeaStatusToStatusTmp, 210 IsStatusBitSetTmp, 226
GetMeaValue, 210 ResetStatusBit, 226
GetStatus, 210 ResetStatusBitTmp, 227
GetStatusTmp, 211 SetMeaValue, 227
InitTmp, 211 SetStatus, 227
IsStatusBitSet, 211 SetStatusBit, 228

583
INDEX INDEX

SetStatusBitTmp, 228 ComContingency, 267

SetStatusTmp, 228 ComOutage, 308
UpdateControl, 229 SubscribeProjectReadOnly
UpdateCtrl, 229 IntPrj, 460
StaExtv3mea, 230 SubscribeProjectReadWrite
CopyExtMeaStatusToStatusTmp, 230 IntPrj, 461
GetMeaValue, 230 SwitchOff
GetStatus, 230 General Object Methods, 77
GetStatusTmp, 231 SwitchOn
InitTmp, 231 General Object Methods, 78
IsStatusBitSet, 231
IsStatusBitSetTmp, 231 TerminateSession
ResetStatusBit, 232 IntUser, 481
ResetStatusBitTmp, 232 Time
SetMeaValue, 232 SetTime, 378
SetStatus, 232 TopologyForDirectionalBackupVariable
SetStatusBit, 233 ComCoordreport, 277
SetStatusBitTmp, 233 TopologyForFuseVariable
SetStatusTmp, 234 ComCoordreport, 277
UpdateControl, 234 TopologyForInstantaneousVariable
UpdateCtrl, 234 ComCoordreport, 278
StaExtvmea, 235 TopologyForMaxCurrent
CopyExtMeaStatusToStatusTmp, 235 ComCoordreport, 278
GetMeaValue, 235 TopologyForNonDirectionalBackupVariable
GetStatus, 235 ComCoordreport, 278
GetStatusTmp, 236 TopologyForOverloadVariable
InitTmp, 236 ComCoordreport, 279
IsStatusBitSet, 236 TopologyForOverreachVariable
IsStatusBitSetTmp, 236 ComCoordreport, 279
ResetStatusBit, 237 TopologyForShortCircuitVariable
ResetStatusBitTmp, 237 ComCoordreport, 280
SetMeaValue, 237 TopologyForZoneVariable
SetStatus, 237 ComCoordreport, 280
SetStatusBit, 238 TotalLossCost
SetStatusBitTmp, 238 ComCapo, 255
SetStatusTmp, 239 TransferDirectionalBackupResultsTo
UpdateControl, 239 ComCoordreport, 281
UpdateCtrl, 239 TransferNonDirectionalBackupResultsTo
StartTrace ComCoordreport, 281
ComContingency, 267 TransferOverreachResultsTo
ComOutage, 308 ComCoordreport, 282
StaSwitch, 240 TransferResultsTo
Close, 240 ComCoordreport, 283
IsClosed, 240 TransferZoneResultsTo
IsOpen, 240 ComCoordreport, 283
Open, 241 TransformGeoCoordinates
StatFileGetXrange IntPrj, 461
Application Methods, 33 TransformToGeographicCoordinateSystem
StatFileResetXrange IntPrj, 461
Application Methods, 33 TypAsmo, 512
StatFileSetXrange CalcElParams, 512
Application Methods, 33 TypCtcore, 513
Station Elements Methods, 171 AddRatio, 513
StoMaint, 512 RemoveRatio, 514
SetElms, 512 RemoveRatioByIndex, 514
StopTrace TypLne, 514

584
INDEX INDEX

IsCable, 514 IntUserman, 482

TypMdl, 515 UpdateStatistics
Check, 515 IntPrj, 462
Compile, 515 UpdateSubstationTerminals
TypQdsl, 515 ElmTerm, 149
Encrypt, 516 UpdateTableReports
IsEncrypted, 516 Dialogue Boxes Functions, 37
ResetThirdPartyModule, 516 UpdateTablesByCalcPeriod
SetThirdPartyModule, 517 ComTececo, 339
TypTr2, 517 UpdateToDefaultStructure
GetZeroSequenceHVLVT, 517 IntPrj, 462
UpdateToMostRecentBaseVersion
Unfreeze IntPrj, 462
SetDesktop, 363
UnsubscribeProject ValidateConstraints
IntPrj, 462 ComRel3, 316
Update View
ChaVecfile, 385 IntDocument, 422
ComSimoutage, 330 IntUrl, 480
ElmBmu, 88 VisBdia, 518
ElmBoundary, 90 AddObjs, 518
ElmBranch, 90 AddResObjs, 518
ElmCabsys, 91 Clear, 518
IntDplmap, 425 SetScaleY, 519
IntSscheduler, 474 SetXVariable, 519
UpdateControl SetYVariable, 519
StaExtbrkmea, 179 VisDraw, 520
StaExtcmdmea, 184 AddRelay, 520
StaExtdatmea, 189 AddRelays, 520
StaExtfmea, 194 CentreOrigin, 520
StaExtfuelmea, 199 Clear, 521
StaExtimea, 204 DoAutoScaleOnAll, 521
StaExtpfmea, 209 DoAutoScaleOnCharacteristics, 521
StaExtpmea, 214 DoAutoScaleOnImpedances, 521
StaExtqmea, 219 DoAutoScaleX, 521
StaExtsmea, 224 DoAutoScaleY, 522
StaExttapmea, 229 VisHrm, 522
StaExtv3mea, 234 Clear, 522
StaExtvmea, 239 DoAutoScaleX, 522
UpdateCtrl DoAutoScaleY, 522
StaExtbrkmea, 179 GetDataSource, 523
StaExtcmdmea, 184 GetScaleObjX, 523
StaExtdatmea, 189 GetScaleObjY, 523
StaExtfmea, 194 SetAutoScaleX, 523
StaExtfuelmea, 199 SetAutoScaleY, 524
StaExtimea, 204 SetCrvDesc, 524
StaExtpfmea, 209 SetDefScaleX, 524
StaExtpmea, 214 SetDefScaleY, 524
StaExtqmea, 219 VisMagndiffplt, 524
StaExtsmea, 224 AddRelay, 525
StaExttapmea, 229 AddRelays, 525
StaExtv3mea, 234 Clear, 525
StaExtvmea, 239 DoAutoScaleX, 525
UpdateFromCurrentView DoAutoScaleY, 525
IntViewbookmark, 488 Refresh, 526
UpdateGroups VisOcplot, 526

585
INDEX INDEX

AddRelay, 526 SetCrvDesc, 534

AddRelays, 526 SetDefScaleX, 535
Clear, 527 SetDefScaleY, 535
DoAutoScaleX, 527 SetScaleX, 535
DoAutoScaleY, 527 SetScaleY, 535
Refresh, 527 SetXVar, 536
VisPath, 527 VisPlottz, 543
Clear, 527 AddRelay, 543
DoAutoScaleX, 528 AddRelays, 543
DoAutoScaleY, 528 Clear, 543
SetAdaptX, 528 DoAutoScaleX, 543
SetAdaptY, 528 DoAutoScaleY, 544
SetScaleX, 528 VisVec, 544
SetScaleY, 529 CentreOrigin, 544
VisPcompdiffplt, 529 VisVecres, 544
AddRelay, 529 CentreOrigin, 544
AddRelays, 530 VisXyplot, 544
CentreOrigin, 530 Clear, 545
Clear, 530 DoAutoScaleX, 545
DoAutoScaleX, 530 DoAutoScaleY, 545
DoAutoScaleY, 530 GetDataSource, 545
VisPlot2, 536 SetCrvDescX, 545
AddResVars, 536 SetCrvDescY, 546
AddVars, 537
Clear, 537 WereModificationsFound
DoAutoScaleX, 537 ComMerge, 303
DoAutoScaleY, 538 Write
DoAutoScaleY2, 538 ElmRes, 132
GetDataSource, 538 WriteChangesToDb
GetScaleObjX, 538 Application Methods, 34
GetScaleObjY, 539 General Object Methods, 78
SetAdaptX, 539 WriteDraw
SetAdaptY, 539 ElmRes, 133
SetAutoScaleX, 540 WriteValue
SetAutoScaleY, 540 IntSstage, 477
SetCrvDesc, 540 WriteWMF
SetDefScaleX, 541 SetDesktop, 363
SetDefScaleY, 541
SetScaleX, 541 ZeroDerivative
SetScaleY, 541 ComInc, 293
SetXVar, 542 ZoomAll
ShowY2, 542 SetDesktop, 364
VisPlot, 531
AddResVars, 531
AddVars, 531
Clear, 532
DoAutoScaleX, 532
DoAutoScaleY, 532
GetDataSource, 532
GetIntCalcres, 532
GetScaleObjX, 533
GetScaleObjY, 533
SetAdaptX, 533
SetAdaptY, 533
SetAutoScaleX, 534
SetAutoScaleY, 534

586