DIgSILENT PowerFactory

Technical Reference Documentation

Python Function Reference

Python
 DIgSILENT GmbH

Heinrich-Hertz-Str. 9
72810 - Gomaringen
Germany

T: +49 7072 9168 0

F: +49 7072 9168 88

http://www.digsilent.de
info@digsilent.de
PowerFactory 15.1.1
2013-12-12

This is a preliminary version. A more detailed one will appear with the next release.

Copyright ©2013, DIgSILENT GmbH. Copyright of this document belongs to DIgSILENT GmbH.
No part of this document may be reproduced, copied, or transmitted in any form, by any means
electronic or mechanical, without the prior written permission of DIgSILENT GmbH.

Python Function Reference (Python) 1

Contents

Contents

1 General Description 8

2 PowerFactory module 8

3 Application class 8

4 DataObject class 18

4.1 Methods sorted by classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.2 Global Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.3 Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4.3.1 ElmArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4.3.2 ElmAsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

4.3.3 ElmAsmsc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4.3.4 ElmBay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4.3.5 ElmBbone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4.3.6 ElmBmu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

4.3.7 ElmBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

4.3.8 ElmBranch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

4.3.9 ElmChar2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

4.3.10 ElmComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

4.3.11 ElmCoup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

4.3.12 ElmFeeder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

4.3.13 ElmFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

4.3.14 ElmFsrc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

4.3.15 ElmGenstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.3.16 ElmGndswt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

4.3.17 ElmLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

4.3.18 ElmNet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

4.3.19 ElmPvsys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

4.3.20 ElmRelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

4.3.21 ElmRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Python Function Reference (Python) 2

Contents

4.3.22 ElmStactrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.3.23 ElmSubstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.3.24 ElmSvs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.3.25 ElmSym . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.3.26 ElmTerm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.3.27 ElmTow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.3.28 ElmTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.3.29 ElmTr3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4.3.30 ElmTrfstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4.3.31 ElmZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.4 Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.4.1 TypAsm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.4.2 TypAsmo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.4.3 TypLne . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.4.4 TypScdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.4.5 TypTr2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.5 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.5.1 Com* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.5.2 ComArcreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.5.3 ComCapo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

4.5.4 ComCntreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

4.5.5 ComContingency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

4.5.6 ComCoordreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

4.5.7 ComDiff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

4.5.8 ComDiffoutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

4.5.9 ComDllmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

4.5.10 ComDpl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

4.5.11 ComEcho . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

4.5.12 ComGenrelinc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

4.5.13 ComImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

4.5.14 ComLdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Python Function Reference (Python) 3

Contents

4.5.15 ComLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

4.5.16 ComMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

4.5.17 ComMot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

4.5.18 ComNmink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

4.5.19 ComOmr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

4.5.20 ComOpf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

4.5.21 ComOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

4.5.22 ComProtreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

4.5.23 ComRel3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

4.5.24 ComRelpost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

4.5.25 ComRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

4.5.26 ComSe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

4.5.27 ComSh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

4.5.28 ComShc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

4.5.29 ComSimoutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

4.5.30 ComStep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

4.5.31 ComSvgexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

4.5.32 ComSvgimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

4.5.33 ComTececo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

4.5.34 ComTieopt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

4.5.35 ComTopo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

4.5.36 ComUcte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

4.5.37 ComUcteexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

4.6 Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

4.6.1 BlkSig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

4.6.2 ChaVecfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

4.6.3 Global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

4.6.4 IntCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

4.6.5 IntDataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

4.6.6 IntDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

4.6.7 IntEvt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Python Function Reference (Python) 4

Contents

4.6.8 IntExtaccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

4.6.9 IntForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

4.6.10 IntFormsel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

4.6.11 IntGrf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

4.6.12 IntGrfgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

4.6.13 IntGrflayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

4.6.14 IntGrfnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

4.6.15 IntMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

4.6.16 IntMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

4.6.17 IntMon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

4.6.18 IntOutage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

4.6.19 IntPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

4.6.20 IntPrj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

4.6.21 IntPrjfolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

4.6.22 IntQlim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

4.6.23 IntScenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

4.6.24 IntScensched . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

4.6.25 IntScheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

4.6.26 IntSscheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

4.6.27 IntSstage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

4.6.28 IntSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

4.6.29 IntThrating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

4.6.30 IntUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

4.6.31 IntUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

4.6.32 IntUserman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

4.6.33 IntVariant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

4.6.34 IntVec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

4.6.35 IntVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

4.6.36 IntVsagtable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

4.6.37 RelChar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

4.6.38 RelToc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Python Function Reference (Python) 5

Contents

4.6.39 RelZpol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

4.6.40 SetCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

4.6.41 SetColscheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

4.6.42 SetCurve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

4.6.43 SetDesktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

4.6.44 SetDistrstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

4.6.45 SetFilt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

4.6.46 SetLevelvis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

4.6.47 SetParalman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

4.6.48 SetPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

4.6.49 SetSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

4.6.50 SetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

4.6.51 SetVipage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

4.6.52 StaCt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

4.6.53 StaCubic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

4.6.54 StaExtcmdmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

4.6.55 StaExtdatmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

4.6.56 StaExttapmea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

4.6.57 StaSwitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

4.6.58 StoMaint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

4.6.59 VisBdia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

4.6.60 VisDraw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

4.6.61 VisFft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

4.6.62 VisHrm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

4.6.63 VisOcplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

4.6.64 VisPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

4.6.65 VisPdc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

4.6.66 VisPlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

4.6.67 VisPlot2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

4.6.68 VisPlottz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

4.6.69 VisXyplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Python Function Reference (Python) 6

Contents

5 Vector class 120

6 Matrix class 120

7 Method class 121

Python Function Reference (Python) 7

3 Application class

1 General Description

This document gives an overview of all python functions and methods provided by the Power-
Factory module. This is only preliminary version. A more detailed one will appear with the next
release.

2 PowerFactory module

GetApplication

Application PowerFactory::GetApplication([str username,]

[str password,]
[str commandLineArguments]
)

3 Application class

ActivateProject

int Application::ActivateProject(str project)

ClearOutputWindow

None Application::ClearOutputWindow()

CommitTransaction

None Application::CommitTransaction()

CreateCopy

DataObject Application::CreateCopy(DataObject object

[str name,]
[float nameAppendix,]
[...]
)

CreateFaultCase

int Application::CreateFaultCase(list components,

int level,
[int createSwichEvent]
)

CreateProject

Python Function Reference (Python) 8

3 Application class

DataObject Application::CreateProject(str projectName,

str gridName,
object parent
)

ExecuteCmd

None Application::ExecuteCmd(str command)

GetActiveCalculationStr

str Application::GetActiveCalculationStr()

GetActiveNetworkVariations

list Application::GetActiveNetworkVariations()

GetActiveProject

DataObject Application::GetActiveProject()

GetActiveScenario

DataObject Application::GetActiveScenario()

GetActiveScenarioScheduler

DataObject Application::GetActiveScenarioScheduler()

GetActiveStages

DataObject Application::GetActiveStages([DataObject varFolder])

GetActiveStudyCase

DataObject Application::GetActiveStudyCase()

GetBorderCubicles

list Application::GetBorderCubicles(DataObject element)

GetBrowserSelection

list Application::GetBrowserSelection()

GetCalcRelevantObjects

Python Function Reference (Python) 9

3 Application class

list Application::GetCalcRelevantObjects([str className,]

[int includeOutOfService,]
[int elementsOnly]
)

GetClassDescription

str Application::GetClassDescription(str className)

GetClassId

int Application::GetClassId(str className)

GetCurrentDiagram

DataObject Application::GetCurrentDiagram()

GetCurrentScript

DataObject Application::GetCurrentScript()

GetCurrentUser

DataObject Application::GetCurrentUser()

GetCurrentZoomScaleLevel

int Application::GetCurrentZoomScaleLevel()

GetDataFolder

DataObject Application::GetDataFolder(str className,

[bool create]
)

GetDiagramSelection

list Application::GetDiagramSelection()

GetFlowOrientation

int Application::GetFlowOrientation()

GetFromStudyCase

DataObject Application::GetFromStudyCase(str className)

GetGlobalLibrary

Python Function Reference (Python) 10

3 Application class

DataObject Application::GetGlobalLibrary([str filter])

GetGraphicsBoard

DataObject Application::GetGraphicsBoard()

GetInstallDir

str Application::GetInstallDir()

GetLanguage

str Application::GetLanguage()

GetLocalLibrary

DataObject Application::GetLocalLibrary([str filter])

GetProjectFolder

DataObject Application::GetProjectFolder(str type)

GetRandomNumber

float Application::GetRandomNumber([float,]
[float]
)

GetRandomNumberEx

float Application::GetRandomNumberEx(int mode,

float p1,
float p2)

GetRecordingStage

DataObject Application::GetRecordingStage()

GetSettings

str Application::GetSettings(str settingName)

GetSummaryGrid

DataObject Application::GetSummaryGrid()

GetTempDir

str Application::GetTempDir()

Python Function Reference (Python) 11

3 Application class

GetUserManager

DataObject Application::GetUserManager()

GetWorkingDir

str Application::GetWorkingDir()

Hide

None Application::Hide()

InvertMatrix

int Application::InvertMatrix(DataObject realPart,

[DataObject imaginaryPart]
)

IsLdfValid

int Application::IsLdfValid()

IsRmsValid

int Application::IsRmsValid()

IsScenarioAttribute

int Application::IsScenarioAttribute(str className, str parameterName)

IsShcValid

int Application::IsShcValid()

IsSimValid

int Application::IsSimValid()

IsWriteCacheEnabled

bool Application::IsWriteCacheEnabled()

LoadProfile

int Application::LoadProfile()

PostCommand

Python Function Reference (Python) 12

3 Application class

None Application::PostCommand(str command)

PostCommand

None Application::PostCommand(DataObject command)

PrintError

None Application::PrintError(str text)

PrintInfo

None Application::PrintInfo(str text)

PrintPlain

None Application::PrintPlain(str text)

PrintWarn

None Application::PrintWarn(str text)

Rebuild

None Application::Rebuild([int option])

ReleaseData

None Application::ReleaseData()

ReleaseMemory

None Application::ReleaseMemory()

ReloadProfile

int Application::ReloadProfile()

ResGetData

list Application::ResGetData(DataObject dataObject,

int timeIndex,
[int curveIndex]
)

ResGetDescription

Python Function Reference (Python) 13

3 Application class

Application::ResGetDescription(DataObject,
[float,]
[float]
)

ResGetFirstValidObject

int Application::ResGetFirstValidObject(DataObject resultFile,

int row,
[str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[float limit2,]
[int limitOperator2]
)

ResGetFirstValidObject

int Application::ResGetFirstValidObject(DataObject resultFile,

int row,
list objects
)

ResGetFirstValidObjectVariable

int Application::ResGetFirstValidObjectVariable(DataObject resultFile,

[str variables]
)

ResGetFirstValidVariable

int Application::ResGetFirstValidVariable(DataObject resultFile,

int row,
[str variableNames,]
[int len]
)

ResGetIndex

Application::ResGetIndex(DataObject resultFile,
DataObject object,
[str variableName]
)

ResGetMax

list Application::ResGetMax(DataObject dataObject,

int curveIndex
)

ResGetMax

Python Function Reference (Python) 14

3 Application class

list Application::ResGetMax(DataObject dataObject,

int timeIndex,
str attributeName
)

ResGetMin

list Application::ResGetMin(DataObject dataObject,

int curveIndex
)

ResGetMin

list Application::ResGetMin(DataObject dataObject,

int timeIndex,
str attributeName
)

ResGetNextValidObject

int Application::ResGetNextValidObject(DataObject resultFile,

[str classNames,]
[str variableName,]
[float limit,]
[int limitOperator,]
[float limit2,]
[int limitOperator2]
)

ResGetNextValidObjectVariable

int Application::ResGetNextValidObjectVariable(DataObject resultFile,

[str variables]
)

ResGetNextValidVariable

int Application::ResGetNextValidVariable(DataObject resultFile,

[str variableNames,]
[int len]
)

ResGetObject

DataObject Application::ResGetObject(DataObject resultFile,

[int column]
)

ResGetUnit

str Application::ResGetUnit(DataObject resultFile,

[int column]
)

Python Function Reference (Python) 15

3 Application class

ResGetValueCount

int Application::ResGetValueCount(DataObject resultFile,

int column
)

ResGetVariable

str Application::ResGetVariable(DataObject resultFile,

[int column]
)

ResGetVariableCount

int Application::ResGetVariableCount(DataObject resultFile)

ResLoadData

None Application::ResLoadData(DataObject resultFile)

ResReleaseData

None Application::ResReleaseData(DataObject resultFile)

ResSortToVariable

int Application::ResSortToVariable(DataObject resultFile,

int column
)

ResetCalculation

None Application::ResetCalculation()

SaveAsScenario

DataObject Application::SaveAsScenario(str name,

bool activate
)

SearchObjectByForeignKey

DataObject Application::SearchObjectByForeignKey(str foreignKey)

SelectToolbox

int Application::SelectToolbox(int toolbar,

str toolboxGroupName,
str toolboxName
)

Python Function Reference (Python) 16

3 Application class

SetDialogOptions

int Application::SetDialogOptions(str className, str attributes)

SetEnableUserBreak

None Application::SetEnableUserBreak(bool enabled)

SetGraphicUpdate

None Application::SetGraphicUpdate(bool enabled)

SetOutputWindowState

None Application::SetOutputWindowState(int state)

SetRandomSeed

float Application::SetRandomSeed(float seed)

SetRescheduleFlag

bool Application::SetRescheduleFlag(bool enabled)

SetShowAllUsers

bool Application::SetShowAllUsers(bool)

SetWriteCacheEnabled

None Application::SetWriteCacheEnabled(bool enabled)

Show

None Application::Show()

StatFileGetXrange

list(float min, float max) Application::StatFileGetXrange()

StatFileResetXrange

None Application::StatFileResetXrange()

StatFileSetXrange

None Application::StatFileSetXrange(float min,

float max
)

Python Function Reference (Python) 17

4 DataObject class

UpdateTableReports

None Application::UpdateTableReports()

WriteChangesToDb

None Application::WriteChangesToDb()

4 DataObject class

The return values of methods on data objects behave different than on the other classes be-
cause the arguments are somethimes used for output. In compariton to a method without
arguments which returns only the return value, returns a method with arguments a list with the
return value of the method at the first entry and the updated arguments at the other.

4.1 Methods sorted by classes

This table lists all classes and their available methods.

Class Index
Com* Execute
GetFromSigName
BlkSig
GetToSigName
ChaVecfile Update
GetLabelFileName
ComArcreport
GetLabelVariables
ConnectShuntToBus
ComCapo LossCostAtBusTech
TotalLossCost
GetConfiguredDpl
ComCntreport ResetConfiguredDpl
ResetConfiguredDpl
AddObjState
ContinueTrace
GetObj
JumpToLastStep
RemoveEvents
RemoveEvents
ComContingency RemoveEvents
RemoveEvents
SetObjs
StartTrace
StopTrace
ComCoordreport get selection

Python Function Reference (Python) 18

4 DataObject class

Class Method
Start
ComDiff
Stop
ComDiffoutage Start
ComDllmanager Report
ComDpl CheckSyntax
Off
ComEcho
On
GetCurrentIteration
ComGenrelinc
GetMaxNumIterations
GetCreatedObjects
ComImport
GetModifiedObjects
CalcLdf
CalcParams
CheckControllers
DoNotResetCalc
EstimateLoading
EstimateOutage
ComLdf IsAC
IsBalanced
IsDC
PrintCheckResults
PrintPowerControllers
LoadMicroSCADAFile
ReceiveData
SendData
ComLink SentDataStatus
SetOPCReceiveQuality
SetSwitchShcEventMode
CheckAssignments
Compare
CompareActive
ExecuteRecording
ExecuteWithActiveProject
GetCorrespondingObject
GetModification
GetModificationResult
GetModifiedObjects
Merge
PrintComparisonReport
ComMerge PrintModifications
PrintModifications
Reset
SetAutoAssignmentForAll
SetObjectsToCompare

Python Function Reference (Python) 19

4 DataObject class

Class Method
ShowBrowser
WereModificationsFound
GetMotorConnections
ComMot GetMotorSwitch
GetMotorTerminal
AddRef
AddRef
ComNmink Clear
GetAll
GetFeeders
ComOmr GetOMR
GetRegionCount
ExeEcoDis
ComOpf
ExecOpfWithReducedConstraints
AddObjState
ContinueTrace
ExecuteTime
GetObject
RemoveEvents
RemoveEvents
ComOutage RemoveEvents
RemoveEvents
SetObjs
StartTrace
StopTrace
GetInfoCols
ComProtreport GetOcUnits
GetVoltUnits
AnalyseElmRes
CreateFaultCase
ExeEvt
Execute
OvlAlleviate
RemoveEvents
ComRel3 RemoveEvents
RemoveEvents
RemoveEvents
RemoveOutages
ComRelpost CalcContributions
ExportFullRange
ComRes
FileNmResNm
ComSe EstimateUnobservableArea
GetConfiguredDpl
ComSh ResetConfiguredDpl

Python Function Reference (Python) 20

4 DataObject class

Class Method
ResetConfiguredDpl
ExecuteRXSweep
ExecuteRXSweep
GetFaultType
ComShc
GetOverLoadedBranches
GetOverLoadedBuses
AddCntcy
AddContingencies
ClearCont
CreateFaultCase
ExecuteCntcy
GetRegion
IsEnergized
ComSimoutage MarkRegions
RemoveContingencies
Reset
SetLimits
Update
GetLastIndex
GetMinStepToMax
GetMinStepToMin
GetNextIndex
GetNextStep
ComStep Init
MaxLimOK
MinLimOK
StepAndOutput
SetFileName
ComSvgexport SetObject
SetObjects
SetFileName
ComSvgimport
SetObject
ComTececo UpdateTablesByCalcPeriod
ExeRestoration
ExeSimpleLdf
GetAction
GetActionInComponentObject
GetActionSwitchObject
GetAllElementsSet
GetCloseActionsSet
ComTieopt GetFeedersSet
GetOpenActionsSet
GetOptimalInComponentObject
GetOptimalOpenPointsSet

Python Function Reference (Python) 21

4 DataObject class

Class Method
GetOptimalSwitchObject
FindAreas
GetAreaRestoredBySwitch
GetConnectedElements
GetLoop
ComTopo GetLoopBranches
GetRestoreSwitchList
MarkFeeders
ComUcte SetBatchMode
BuildNodeNames
GetConnectedBranches
GetFromToNodeNames
GetOrderCode
ComUcteexp InitQuickAccessMaps
ResetQuickAccessMaps
SetGridSelection
GetAll
GetBranches
ElmArea GetBuses
GetObjs
GetAvailableGenPower
GetElecTorque
GetMechTorque
ElmAsm GetMotorStartingFlag
GetStepupTransformer
IsPQ
ElmAsmsc GetAvailableGenPower
ElmBay GetAll
CheckBbPath
GetBbOrder
GetCompleteBbPath
GetFOR
GetMeanCs
ElmBbone GetMinCs
GetTieOpenPoint
GetTotLength
HasGnrlMod
Apply
ElmBmu
Update
AddCubicle
Clear
GetInterior
ElmBoundary
IsSplitting
Resize

Python Function Reference (Python) 22

4 DataObject class

Class Method
ElmBranch Update
Get
ElmChar2 Init
Print
ElmComp Slotupd
Close
GetRemoteBreakers
HasGnrlMod
IsBreaker
IsClosed
ElmCoup IsOpen
Open
SoftClose
SoftOpen
CalcAggrVarsInRadFeed
GetAll
GetBranches
ElmFeeder GetBuses
GetNodesBranches
GetObjs
DisableAllSymbolLayers
ElmFolder
EnableSymbolLayer
Init
ElmFsrc SetAmpl
SetPhase
Derate
Disconnect
GetAvailableGenPower
GetStepupTransformer
ElmGenstat IsConnected
Reconnect
ResetDerating
Close
HasGnrlMod
IsClosed
ElmGndswt
IsOpen
Open
AreDistParamsPossible
CreateFeederWithRoutes
CreateFeederWithRoutes
FitParams
GetIthr
GetType
GetY0m

Python Function Reference (Python) 23

ElmLne
4 DataObject class

Class Method
GetY1m
GetZ0m
GetZ1m
GetZmatDist
HasRoutes
HasRoutesOrSec
IsCable
IsNetCoupling
MeasureLength
SetDetailed
Activate
CalcBoundary
ElmNet CalculateInterchangeTo
Deactivate
Derate
Disconnect
GetAvailableGenPower
ElmPvsys IsConnected
Reconnect
ResetDerating
CheckRanges
GetCalcRX
GetMaxFdetectCalcI
GetSlot
GetUnom
IsStarted
SetImpedance
SetImpedance
SetMaxI
SetMaxIearth
ElmRelay
SetMinI
SetMinIearth
SetOutOfService
SetTime
SwitchSettingsGroup
SlotUpdate
AddVars
Clear
Close
Draw
Flush
GetObj
GetRelCase
GetSubElmRes
GetSubElmRes

ElmRes
Python Function Reference (Python) 24
4 DataObject class

Class Method
Init
Init
SetAsDefault
SetObj
SetSubElmResKey
SetSubElmResKey
Write
WriteDraw
GetControlledHVNode
GetControlledLVNode
ElmStactrl GetStepupTransformer
Info
GetSplit
GetSplitCal
GetSplitIndex
GetSuppliedElements
OverwriteRA
ElmSubstat ResetRA
SaveAsRA
SaveAsSwSc
SetRA
ElmSvs GetStepupTransformer
Derate
Disconnect
GetAvailableGenPower
GetMotorStartingFlag
GetStepupTransformer
ElmSym
IsConnected
Reconnect
ResetDerating
GetBusType
GetCalcRelevantCubicles
GetConnectedBrkCubicles
GetConnectedCubicles
GetConnectedMainBuses
GetConnectionInfo
GetMinDistance
GetNextHVBus
GetNodeName
ElmTerm GetSepStationAreas
HasCreatedCalBus
IsElectrEquivalent
IsEquivalent
IsInternalNodeInSubStation

Python Function Reference (Python) 25

4 DataObject class

Class Method
UpdateSubstationTerminals
FitParams
ElmTow
PrintFreqDepParams
CreateEvent
GetShcThermalRating
GetSuppliedElements
ElmTr2
IsQuadBooster
NTap
CreateEvent
GetSuppliedElements
ElmTr3 IsQuadBooster
NTap
GetSplit
GetSplitCal
GetSplitIndex
ElmTrfstat
GetSuppliedElements
SaveAsSwSc
GetAll
GetBranches
GetBuses
ElmZone
GetObjs
SetLoadScaleAbsolute
AddCopy
CopyData
CreateObject
Energize
GetChildren
GetClassName
GetConnectedElements
GetConnectionCount
GetContents
GetControlledNode
GetCubicle
GetFullName
GetImpedance
GetInom
GetNode
GetOperator
GetOwner
GetParent
GetReferences
GetRegion
GetSupplyingSubstations
GetSupplyingTransformers
GetSupplyingTrfstations

Python Function Reference (Python) 26

4 DataObject class

Class Method
GetSystemGrounding
GetUcteOrderCode
GetUnom
GetUserAttribute
GetVariableType
GetZeroImpedance
HasResults
IsCalcRelevant
IsEarthed
IsEnergized
IsInFeeder
IsNode
IsOutOfService
IsReducible
IsShortCircuited
Isolate
MarkInGraphics
Move
PasteCopy
PurgeUnusedObjects
ReportUnusedObjects
SearchObject
ShowEditDialog
ShowModalSelectTree
SwitchOff
SwitchOn
ShowFullName
Activate
Consolidate
Deactivate
IntCase
Reduce
SetStudyTime
AddRef
AddRef
All
IntDataset
Clear
GetAll
Edit
IntDocument
View
CreateCBEvents
IntEvt
RemoveSwitchEvents
IntExtaccess CheckUrl
SetText
SetThisForm
WriteOut
IntForm

Python Function Reference (Python) 27

4 DataObject class

Class Method
WriteOut
WriteOut
IntFormsel ConvertForms
IntGrf MoveToLayer
ClearData
IntGrfgroup Export
Import
ClearData
IntGrflayer Export
Import
IntGrfnet Show
Clear
GetDouble
GetInt
GetString
HasKey
IntMap
SetDouble
SetInt
SetString
ColLbl
ColLbl
Get
Init
InvFFT
Invert
Multiply
Resize
RowLbl
IntMat RowLbl
Set
SizeX
SizeY
SortToColum
SortToColumn
AddVar
ClearVars
GetVar
NVars
IntMon PrintAllVal
PrintVal
RemoveVar
Apply
ApplyAll
Check
IntOutage

Python Function Reference (Python) 28

4 DataObject class

Class Method
CheckAll
IsInStudytime
SetAdaptY
SetAutoScaleY
IntPlot SetScaleY
SetScaleY
Activate
Archive
CreateVersion
Deactivate
GetLatestVersion
GetVersions
IntPrj HasExternalReferences
LoadData
Migrate
Purge
UpdateStatistics
GetProjectFolderType
IntPrjfolder
IsProjectFolderType
IntQlim GetQlim
Activate
ActivateIncrementalSubset
Apply
Apply
Apply
Apply
ApplySelective
ApplySelective
Deactivate
DeactivateIncrementalSubset
IntScenario
DiscardChanges
GetObjects
GetOperationValue
ReleaseMemory
Save
SetOperationValue
Activate
Deactivate
DeleteRow
IntScensched GetScenario
GetStartEndTime
SearchScenario
Activate
Consolidate
Deactivate
IntScheme

Python Function Reference (Python) 29

4 DataObject class

Class Method
GetActiveScheduler
NewStage
Activate
IntSscheduler Deactivate
Update
Activate
CreateStageObject
EnableDiffMode
GetScheme
IsExcluded
IntSstage
PrintModifications
ReadValue
WriteValue
IntSubset Apply
GetCriticalTimePhase
IntThrating
GetRating
IntUrl View
Purge
IntUser SetPassword
TerminateSession
CreateGroup
CreateUser
GetGroups
IntUserman
GetUsers
UpdateGroups
Activate
IntVariant Deactivate
Reduce
DFT1freq
Get
Init
Max
Mean
Min
IntVec Resize
Set
Size
Sort
fft
CreateDerivedProject
IntVersion
Rollback
Clear
Enlarge
Get

IntVsagtable
Python Function Reference (Python) 30
4 DataObject class

Class Method
Init
NCol
NRow
Set
RelChar SetCurve
RelToc SetCurve
AssumeCompensationFactor
RelZpol AssumeReRl
AssumeXeXl
CalcCluster
SetCluster
GetNumberOfClusters
CreateFilter
SetColouring
SetColscheme SetFilter
SetFilter
CalcLinear
CalcMinPoly
CalcPolynom
SetCurve CalcSpline
GetCalcXlogy
GetCalcy
AddPage
DoAutoScaleX
GetPage
SetAdaptX
SetAutoScaleX
SetResults
SetScaleX
SetScaleX
SetDesktop
SetXVar
SetXVar
Show
Show
WriteWMF
CalcCluster
SetDistrstate ResetCalculation
SetupCalculation
SetFilt Get
AdaptWidth
Align
ChangeFont
ChangeFrameAndWidth
ChangeLayer
SetLevelvis
ChangeRefPoints

Python Function Reference (Python) 31

4 DataObject class

Class Method
Mark
Reset
GetNumSlave
GetTransfType
SetParalman SetNumSlave
SetTransfType
AllBreakers
AllClosedBreakers
AllOpenBreakers
Create
GetAbsDistance
GetAll
GetBranches
GetBuses
SetPath GetImpedanceAtPos
GetNode
GetNodeIndex
GetPathFolder
GetRelay
NextRelayBranch
AddRef
AddRef
All
AllAsm
AllBars
AllBreakers
AllClosedBreakers
AllElm
AllLines
SetSelect AllLoads
AllOpenBreakers
AllSym
AllTypLne
Clear
GetAll
Date
DisableUpdateStudyTime
EnableUpdateStudyTime
SetTime SetTime
SetTimeUTC
Time
CreateVI
DoAutoScaleX
DoAutoScaleY
GetScaleObjX

Python Function Reference (Python) 32

4 DataObject class

Class Method
GetVI
SetAdaptX
SetAutoScaleX
SetDefScaleX
SetResults
SetScaleX
SetScaleX
SetStyle
SetTile
SetXVar
SetXVar
StaCt SetPrimaryTap
GetAll
GetBranch
GetConnections
StaCubic
IsClosed
IsConnected
CopyExtMeaStatusToStatusTmp
CreateEvent
GetMeaValue
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
StaExtcmdmea
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
CopyExtMeaStatusToStatusTmp
CreateEvent
GetMeaValue
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
StaExtdatmea
SetStatus
SetStatusBit

Python Function Reference (Python) 33

4 DataObject class

Class Method
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
CopyExtMeaStatusToStatusTmp
CreateEvent
GetMeaValue
GetStatusTmp
InitTmp
IsStatusBitSet
IsStatusBitSetTmp
ResetStatusBit
ResetStatusBitTmp
SetMeaValue
StaExttapmea
SetStatus
SetStatusBit
SetStatusBitTmp
SetStatusTmp
UpdateControl
UpdateCtrl
Close
GetCalBusIndex
IsBusCoupler
IsClosed
IsOpen
StaSwitch IsTieBreaker
Open
SoftClose
SoftOpen
SetElms
StoMaint
SetElms
TypAsm CalcElParams
TypAsmo CalcElParams
TypLne IsCable
Get
TypScdf
Set
TypTr2 GetZeroSequenceHVLVT
VisBdia SetScaleY
AddRelays
VisDraw
AddRelays
GetScaleObjX
GetScaleObjY
SetAutoScaleX
VisFft SetAutoScaleY

Python Function Reference (Python) 34

4 DataObject class

Class Method
SetCrvDesc
SetDefScaleY
GetScaleObjX
GetScaleObjY
SetAutoScaleX
SetAutoScaleY
VisHrm SetCrvDesc
SetDefScaleX
SetDefScaleY
AddRelay
VisOcplot AddRelays
AddRelays
VisPath SetScaleY
AddObjs
AddResObjs
GetScaleObjX
GetScaleObjY
SetAdaptX
SetAdaptY
SetCrvDesc
SetDefScaleX
VisPdc
SetDefScaleY
SetScaleX
SetScaleX
SetScaleY
SetScaleY
AddResVars
AddVars
GetScaleObjX
GetScaleObjY
SetAdaptX
SetAdaptY
SetAutoScaleX
SetAutoScaleY
SetCrvDesc
SetDefScaleX
VisPlot SetDefScaleY
SetScaleX
SetScaleX
SetScaleY
SetScaleY
SetXVar
SetXVar
AddResVars
AddVars

Python Function Reference (Python) 35

4 DataObject class

Class Method
Clear
GetScaleObjY
SetAdaptX
SetAdaptY
SetAutoScaleY
SetCrvDesc
SetDefScaleY
SetScaleX
SetScaleY
SetXVar
SetXVar
ShowY2
AddRelays
VisPlottz
AddRelays
SetCrvDescX
VisXyplot
SetCrvDescY

4.2 Global Methods

AddCopy

DataObject DataObject::AddCopy(DataObject object,

[str name,]
[int appendix,]
...
)

AddCopy

DataObject DataObject::AddCopy(list objects,

[str name,]
[int appendix,]
...
)

CreateObject

DataObject DataObject::CreateObject(str className,

[str name,]
[int appendix,]
...
)

Energize

list(int, ...) DataObject::Energize([list outSwitches,]

Python Function Reference (Python) 36

4 DataObject class

[int resetRA])

GetChildren

list(list, ...) DataObject::GetChildren(int hiddenMode,

[str filter,]
[bool recursive]
)

GetClassName

str DataObject::GetClassName()

GetContents

list(list,...) DataObject::GetContents([str filter,]

[bool recursive]
)

GetConnectionCount

int DataObject::GetConnectionCount()

GetCubicle

DataObject DataObject::GetCubicle(int bus)

GetConnectedElements

list(list, ...) DataObject::GetConnectedElements([int considerBreakerPosition,]

[int considerSeparatorPosition,]
[int ignoreOutage])

GetParent

DataObject DataObject::GetParent()

GetUnom

float DataObject::GetUnom([int bus])

GetImpedance

list(int, ) DataObject::GetImpedance(float outRealPart,

float outImaginaryPart,
float refVoltage,
[int sideTrf3])

GetInom

Python Function Reference (Python) 37

4 DataObject class

float DataObject::GetInom([int bus])

GetFullName

str DataObject::GetFullName()

GetNode

list(DataObject, ...) DataObject::GetNode(int busIndex,

[int considerSwitchStatus])

GetOwner

DataObject DataObject::GetOwner()

GetOperator

DataObject DataObject::GetOperator()

GetVariableType

list(int, ...) DataObject::GetVariableType(str attribute,

str outType)

GetReferences

list(list, ...) DataObject::GetReferences([str filter])

GetControlledNode

list(DataObject, ...) DataObject::GetControlledNode(int busIndex,

float outSetpoint,
[int onlyIfActive])

GetUserAttribute

list(int/float/str, ...) DataObject::GetUserAttribute(str attribute,

int outError)

GetSupplyingTransformers

list DataObject::GetSupplyingTransformers()

GetSupplyingSubstations

list DataObject::GetSupplyingSubstations()

GetSupplyingTrfstations

Python Function Reference (Python) 38

4 DataObject class

list DataObject::GetSupplyingTrfstations()

GetSystemGrounding

int DataObject::GetSystemGrounding()

GetZeroImpedance

list(int, ) DataObject::GetZeroImpedance(float outRealPart,

float outImaginaryPart,
float refVoltage,
[int sideTrf3])

HasResults

int DataObject::HasResults([int bus])

IsCalcRelevant

int DataObject::IsCalcRelevant()

IsEarthed

int DataObject::IsEarthed()

IsEnergized

int DataObject::IsEnergized()

IsInFeeder

list(int, ...) DataObject::IsInFeeder(DataObject feeder,

[int considerNested])

IsNode

int DataObject::IsNode()

Isolate

list(int, ...) DataObject::Isolate([list outSwitches,]

[int resetRA,]
[int isolateCB])

IsOutOfService

int DataObject::IsOutOfService()

IsReducible

Python Function Reference (Python) 39

4 DataObject class

int DataObject::IsReducible()

IsShortCircuited

int DataObject::IsShortCircuited()

MarkInGraphics

None DataObject::MarkInGraphics()

Move

list(int, ...) DataObject::Move(DataObject/list)

PasteCopy

int DataObject::PasteCopy(DataObject object)

PasteCopy

int DataObject::PasteCopy(list objects)

PurgeUnusedObjects

None DataObject::PurgeUnusedObjects()

ReportUnusedObjects

None DataObject::ReportUnusedObjects()

ShowEditDialog

int DataObject::ShowEditDialog()

SearchObject

list(DataObject, ...) DataObject::SearchObject(str name)

SwitchOff

list(int, ...) DataObject::SwitchOff([list outSwitches,]

[int resetRA,]
[int determineSwitchesOnly])

SwitchOn

list(int, ...) DataObject::SwitchOn([list outSwitches,]

[int resetRA,]
[int determineSwitchesOnly])

Python Function Reference (Python) 40

4 DataObject class

ShowModalSelectTree

list(DataObject, ...) DataObject::ShowModalSelectTree([str title,]

[str classFilter])

4.3 Elements

4.3.1 ElmArea

GetAll

list ElmArea::GetAll()

GetBuses

list ElmArea::GetBuses()

GetBranches

list ElmArea::GetBranches()

GetObjs

list(list, ...) ElmArea::GetObjs(str)

4.3.2 ElmAsm

GetMotorStartingFlag

int ElmAsm::GetMotorStartingFlag()

GetStepupTransformer

list(DataObject, ...) ElmAsm::GetStepupTransformer(float,

int
)

IsPQ

int ElmAsm::IsPQ()

GetMechTorque

list(float, ...) ElmAsm::GetMechTorque(float,

float
)

Python Function Reference (Python) 41

4 DataObject class

GetAvailableGenPower

float ElmAsm::GetAvailableGenPower()

GetElecTorque

list(float, ...) ElmAsm::GetElecTorque(float,

float,
[float,]
[float]
)

4.3.3 ElmAsmsc

GetAvailableGenPower

float ElmAsmsc::GetAvailableGenPower()

4.3.4 ElmBay

GetAll

list ElmBay::GetAll()

4.3.5 ElmBbone

GetBbOrder

int ElmBbone::GetBbOrder()

GetTotLength

float ElmBbone::GetTotLength()

GetMeanCs

float ElmBbone::GetMeanCs()

GetFOR

float ElmBbone::GetFOR()

GetTieOpenPoint

DataObject ElmBbone::GetTieOpenPoint()

Python Function Reference (Python) 42

4 DataObject class

GetMinCs

list(float, ...) ElmBbone::GetMinCs(list)

HasGnrlMod

int ElmBbone::HasGnrlMod()

GetCompleteBbPath

list(int, ...) ElmBbone::GetCompleteBbPath(list,

[float,]
[float]
)

CheckBbPath

list(int, ...) ElmBbone::CheckBbPath([float])

4.3.6 ElmBmu

Update

None ElmBmu::Update()

Apply

int ElmBmu::Apply()

4.3.7 ElmBoundary

GetInterior

list ElmBoundary::GetInterior()

Resize

list(None, ...) ElmBoundary::Resize(float,

str
)

AddCubicle

list(int, ...) ElmBoundary::AddCubicle(DataObject,

float
)

Python Function Reference (Python) 43

4 DataObject class

Clear

None ElmBoundary::Clear()

IsSplitting

list(int, ...) ElmBoundary::IsSplitting([list])

4.3.8 ElmBranch

Update

None ElmBranch::Update()

4.3.9 ElmChar2

Init

int ElmChar2::Init()

Print

int ElmChar2::Print()

Get

list(float, ...) ElmChar2::Get(float,

float
)

4.3.10 ElmComp

Slotupd

int ElmComp::Slotupd()

4.3.11 ElmCoup

Close

int ElmCoup::Close()

Open

Python Function Reference (Python) 44

4 DataObject class

int ElmCoup::Open()

SoftClose

int ElmCoup::SoftClose()

SoftOpen

int ElmCoup::SoftOpen()

IsOpen

int ElmCoup::IsOpen()

IsClosed

int ElmCoup::IsClosed()

IsBreaker

int ElmCoup::IsBreaker()

HasGnrlMod

int ElmCoup::HasGnrlMod()

GetRemoteBreakers

list(list, ...) ElmCoup::GetRemoteBreakers(float,

list,
[list]
)

4.3.12 ElmFeeder

GetAll

list(list, ...) ElmFeeder::GetAll([float])

GetBuses

list(list, ...) ElmFeeder::GetBuses([float])

GetBranches

list(list, ...) ElmFeeder::GetBranches([float])

Python Function Reference (Python) 45

4 DataObject class

GetObjs

list(list, ...) ElmFeeder::GetObjs(str,

[float]
)

GetNodesBranches

list(list, ...) ElmFeeder::GetNodesBranches([float])

CalcAggrVarsInRadFeed

list(int, ...) ElmFeeder::CalcAggrVarsInRadFeed([float,]

[float]
)

4.3.13 ElmFolder

EnableSymbolLayer

list(None, ...) ElmFolder::EnableSymbolLayer(float)

DisableAllSymbolLayers

None ElmFolder::DisableAllSymbolLayers()

4.3.14 ElmFsrc

SetAmpl

list(None, ...) ElmFsrc::SetAmpl(float,

float
)

SetPhase

list(None, ...) ElmFsrc::SetPhase(float,

float
)

Init

list(None, ...) ElmFsrc::Init(float)

Python Function Reference (Python) 46

4 DataObject class

4.3.15 ElmGenstat

Derate

list(None, ...) ElmGenstat::Derate(float)

ResetDerating

None ElmGenstat::ResetDerating()

GetStepupTransformer

list(DataObject, ...) ElmGenstat::GetStepupTransformer(float,

int
)

Disconnect

int ElmGenstat::Disconnect()

Reconnect

int ElmGenstat::Reconnect()

IsConnected

int ElmGenstat::IsConnected()

GetAvailableGenPower

float ElmGenstat::GetAvailableGenPower()

4.3.16 ElmGndswt

Close

int ElmGndswt::Close()

Open

int ElmGndswt::Open()

IsOpen

int ElmGndswt::IsOpen()

IsClosed

Python Function Reference (Python) 47

4 DataObject class

int ElmGndswt::IsClosed()

HasGnrlMod

int ElmGndswt::HasGnrlMod()

4.3.17 ElmLne

IsCable

int ElmLne::IsCable()

MeasureLength

float ElmLne::MeasureLength()

HasRoutes

int ElmLne::HasRoutes()

HasRoutesOrSec

int ElmLne::HasRoutesOrSec()

FitParams

int ElmLne::FitParams()

GetType

DataObject ElmLne::GetType()

IsNetCoupling

int ElmLne::IsNetCoupling()

SetDetailed

int ElmLne::SetDetailed()

GetZmatDist

list(int, ...) ElmLne::GetZmatDist(float,

float,
DataObject
)

Python Function Reference (Python) 48

4 DataObject class

AreDistParamsPossible

int ElmLne::AreDistParamsPossible()

GetZ0m

list(int, ...) ElmLne::GetZ0m(DataObject,

float,
float
)

GetZ1m

list(int, ...) ElmLne::GetZ1m(DataObject,

float,
float
)

GetY0m

list(int, ...) ElmLne::GetY0m(DataObject,

float,
float
)

GetY1m

list(int, ...) ElmLne::GetY1m(DataObject,

float,
float
)

GetIthr

float ElmLne::GetIthr()

CreateFeederWithRoutes

list(int, ...) ElmLne::CreateFeederWithRoutes(float,

float,
DataObject
)

CreateFeederWithRoutes

list(int, ...) ElmLne::CreateFeederWithRoutes(float,

float,
DataObject,
float,
float
)

Python Function Reference (Python) 49

4 DataObject class

4.3.18 ElmNet

Activate

int ElmNet::Activate()

Deactivate

int ElmNet::Deactivate()

CalculateInterchangeTo

list(int, ...) ElmNet::CalculateInterchangeTo(DataObject)

CalcBoundary

list(int, ...) ElmNet::CalcBoundary(float,

DataObject
)

4.3.19 ElmPvsys

Derate

list(None, ...) ElmPvsys::Derate(float)

ResetDerating

None ElmPvsys::ResetDerating()

IsConnected

int ElmPvsys::IsConnected()

Disconnect

int ElmPvsys::Disconnect()

Reconnect

int ElmPvsys::Reconnect()

GetAvailableGenPower

float ElmPvsys::GetAvailableGenPower()

Python Function Reference (Python) 50

4 DataObject class

4.3.20 ElmRelay

IsStarted

int ElmRelay::IsStarted()

slotupd

int ElmRelay::SlotUpdate()

SetOutOfService

list(int, ...) ElmRelay::SetOutOfService(float,

float,
float
)

SetTime

list(int, ...) ElmRelay::SetTime(float,

float,
float,
float
)

GetCalcRX

list(int, ...) ElmRelay::GetCalcRX(float,

float,
float,
float
)

GetMaxFdetectCalcI

list(int, ...) ElmRelay::GetMaxFdetectCalcI(float,

float,
float
)

GetUnom

float ElmRelay::GetUnom()

SetMaxI

int ElmRelay::SetMaxI()

SetMinI

int ElmRelay::SetMinI()

Python Function Reference (Python) 51

4 DataObject class

SetMaxIearth

int ElmRelay::SetMaxIearth()

SetMinIearth

int ElmRelay::SetMinIearth()

CheckRanges

int ElmRelay::CheckRanges()

SwitchSettingsGroup

list(int, ...) ElmRelay::SwitchSettingsGroup(float)

GetSlot

list(DataObject, ...) ElmRelay::GetSlot(str,

[float,]
[float]
)

SetImpedance

list(int, ...) ElmRelay::SetImpedance(float,

float,
float,
float,
float
)

SetImpedance

list(int, ...) ElmRelay::SetImpedance(float,

float,
float,
float,
float,
float,
float
)

4.3.21 ElmRes

GetRelCase

list(DataObject, ...) ElmRes::GetRelCase(int)

Close

Python Function Reference (Python) 52

4 DataObject class

list(None, ...) ElmRes::Close([int])

Clear

int ElmRes::Clear()

Draw

int ElmRes::Draw()

WriteDraw

int ElmRes::WriteDraw()

Flush

int ElmRes::Flush()

SetAsDefault

None ElmRes::SetAsDefault()

GetObj

list(DataObject, ...) ElmRes::GetObj(float)

SetObj

list(int, ...) ElmRes::SetObj(DataObject)

Init

int ElmRes::Init()

Init

list(int, ...) ElmRes::Init(str,

str,
str,
[str]
)

Write

list(int, ...) ElmRes::Write([float])

AddVars

Python Function Reference (Python) 53

4 DataObject class

list(None, ...) ElmRes::AddVars(DataObject,

str,
[str]*
)

GetSubElmRes

list(DataObject, ...) ElmRes::GetSubElmRes(float)

GetSubElmRes

list(DataObject, ...) ElmRes::GetSubElmRes(DataObject)

SetSubElmResKey

list(None, ...) ElmRes::SetSubElmResKey(float)

SetSubElmResKey

list(None, ...) ElmRes::SetSubElmResKey(DataObject)

4.3.22 ElmStactrl

Info

int ElmStactrl::Info()

GetStepupTransformer

list(DataObject, ...) ElmStactrl::GetStepupTransformer([float,]

[float]
)

GetControlledHVNode

list(DataObject, ...) ElmStactrl::GetControlledHVNode([float])

GetControlledLVNode

list(DataObject, ...) ElmStactrl::GetControlledLVNode([float])

4.3.23 ElmSubstat

GetSplit

Python Function Reference (Python) 54

4 DataObject class

list(int, ...) ElmSubstat::GetSplit(int,

list,
[list,]
[list])

GetSplitCal

list(int, ...) ElmSubstat::GetSplitCal(int,

list,
[list,]
[list])

GetSplitIndex

list(int, ...) ElmSubstat::GetSplitIndex(DataObject)

SaveAsSwSc

list(DataObject, ...) ElmSubstat::SaveAsSwSc(str)

GetSuppliedElements

list(list, ...) ElmSubstat::GetSuppliedElements([int])

SaveAsRA

list(DataObject, ...) ElmSubstat::SaveAsRA(str)

OverwriteRA

list(int, ...) ElmSubstat::OverwriteRA(DataObject)

SetRA

list(int, ...) ElmSubstat::SetRA(DataObject)

ResetRA

int ElmSubstat::ResetRA()

4.3.24 ElmSvs

GetStepupTransformer

list(DataObject, ...) ElmSvs::GetStepupTransformer(float,

int
)

Python Function Reference (Python) 55

4 DataObject class

4.3.25 ElmSym

Derate

list(None, ...) ElmSym::Derate(float)

ResetDerating

None ElmSym::ResetDerating()

GetMotorStartingFlag

int ElmSym::GetMotorStartingFlag()

GetStepupTransformer

list(DataObject, ...) ElmSym::GetStepupTransformer(float,

int
)

Disconnect

int ElmSym::Disconnect()

Reconnect

int ElmSym::Reconnect()

IsConnected

int ElmSym::IsConnected()

GetAvailableGenPower

float ElmSym::GetAvailableGenPower()

4.3.26 ElmTerm

GetNextHVBus

DataObject ElmTerm::GetNextHVBus()

UpdateSubstationTerminals

list(None, ...) ElmTerm::UpdateSubstationTerminals(int,

int
)

Python Function Reference (Python) 56

4 DataObject class

GetBusType

int ElmTerm::GetBusType()

GetConnectionInfo

list(int, ...) ElmTerm::GetConnectionInfo(float,

float,
float,
float,
float,
float,
float
)

HasCreatedCalBus

int ElmTerm::HasCreatedCalBus()

GetCalcRelevantCubicles

list ElmTerm::GetCalcRelevantCubicles()

IsEquivalent

list(int, ...) ElmTerm::IsEquivalent(DataObject)

IsElectrEquivalent

list(int, ...) ElmTerm::IsElectrEquivalent(DataObject,

float,
float
)

GetNodeName

str ElmTerm::GetNodeName()

IsInternalNodeInSubStation

int ElmTerm::IsInternalNodeInSubStation()

GetConnectedMainBuses

list(list, ...) ElmTerm::GetConnectedMainBuses([float])

GetSepStationAreas

list(list, ...) ElmTerm::GetSepStationAreas([float])

Python Function Reference (Python) 57

4 DataObject class

GetConnectedBrkCubicles

list(list, ...) ElmTerm::GetConnectedBrkCubicles([float])

GetConnectedCubicles

list(list, ...) ElmTerm::GetConnectedCubicles([float])

GetMinDistance

list(float, ...) ElmTerm::GetMinDistance(DataObject,

[float,]
[list,]
[list]
)

4.3.27 ElmTow

FitParams

int ElmTow::FitParams()

PrintFreqDepParams

None ElmTow::PrintFreqDepParams()

4.3.28 ElmTr2

NTap

int ElmTr2::NTap()

IsQuadBooster

int ElmTr2::IsQuadBooster()

CreateEvent

list(int, ...) ElmTr2::CreateEvent([float,]

[float]
)

GetSuppliedElements

list(list, ...) ElmTr2::GetSuppliedElements([float])

Python Function Reference (Python) 58

4 DataObject class

GetShcThermalRating

list(float, ...) ElmTr2::GetShcThermalRating([float,]

[float]
)

4.3.29 ElmTr3

NTap

list(int, ...) ElmTr3::NTap(float)

IsQuadBooster

int ElmTr3::IsQuadBooster()

CreateEvent

list(int, ...) ElmTr3::CreateEvent([float,]

[float,]
[float]
)

GetSuppliedElements

list(list, ...) ElmTr3::GetSuppliedElements([float])

4.3.30 ElmTrfstat

GetSplit

list(int, ...) ElmTrfstat::GetSplit(int,

list,
[list,]
[list])

GetSplitCal

list(int, ...) ElmTrfstat::GetSplitCal(int,

list,
[list,]
[list])

GetSplitIndex

list(int, ...) ElmTrfstat::GetSplitIndex(DataObject)

Python Function Reference (Python) 59

4 DataObject class

SaveAsSwSc

list(DataObject, ...) ElmTrfstat::SaveAsSwSc(str)

GetSuppliedElements

list(list, ) ElmTrfstat::GetSuppliedElements(int)

4.3.31 ElmZone

GetAll

list ElmZone::GetAll()

GetBuses

list ElmZone::GetBuses()

GetBranches

list ElmZone::GetBranches()

GetObjs

list(list, ...) ElmZone::GetObjs(str)

SetLoadScaleAbsolute

list(None, ...) ElmZone::SetLoadScaleAbsolute(float)

4.4 Types

4.4.1 TypAsm

CalcElParams

int TypAsm::CalcElParams()

4.4.2 TypAsmo

CalcElParams

int TypAsmo::CalcElParams()

Python Function Reference (Python) 60

4 DataObject class

4.4.3 TypLne

IsCable

int TypLne::IsCable()

4.4.4 TypScdf

Get

list(int, ...) TypScdf::Get(float,

float,
float
)

Set

list(None, ...) TypScdf::Set(float,

float
)

4.4.5 TypTr2

GetZeroSequenceHVLVT

list(int, ...) TypTr2::GetZeroSequenceHVLVT(float,

float,
float,
float,
float,
float
)

4.5 Commands

4.5.1 Com*

Execute

int Com*::Execute()

4.5.2 ComArcreport

GetLabelFileName

Python Function Reference (Python) 61

4 DataObject class

str ComArcreport::GetLabelFileName()

GetLabelVariables

str ComArcreport::GetLabelVariables()

4.5.3 ComCapo

ConnectShuntToBus

list(int, ...) ComCapo::ConnectShuntToBus(DataObject,

float,
float
)

LossCostAtBusTech

list(float, ...) ComCapo::LossCostAtBusTech(DataObject,

float
)

TotalLossCost

list(float, ...) ComCapo::TotalLossCost([float])

4.5.4 ComCntreport

GetConfiguredDpl

list ComCntreport::GetConfiguredDpl()

ResetConfiguredDpl

list(int, ...) ComCntreport::ResetConfiguredDpl(DataObject)

ResetConfiguredDpl

list(int, ...) ComCntreport::ResetConfiguredDpl(list)

4.5.5 ComContingency

GetObj

list(DataObject, ...) ComContingency::GetObj(int)

Python Function Reference (Python) 62

4 DataObject class

SetObjs

list(int, ...) ComContingency::SetObjs(list)

AddObjState

list(int, ...) ComContingency::AddObjState(DataObject,

float
)

StartTrace

int ComContingency::StartTrace()

ContinueTrace

int ComContingency::ContinueTrace()

RemoveEvents

list(None, ...) ComContingency::RemoveEvents([float,]

[float]
)

RemoveEvents

list(None, ...) ComContingency::RemoveEvents([str,]

[str]
)

RemoveEvents

list(None, ...) ComContingency::RemoveEvents(float,

str
)

RemoveEvents

list(None, ...) ComContingency::RemoveEvents(str,

float
)

JumpToLastStep

list(int, ...) ComContingency::JumpToLastStep([float])

StopTrace

list(int, ...) ComContingency::StopTrace([float])

Python Function Reference (Python) 63

4 DataObject class

4.5.6 ComCoordreport

get selection

list ComCoordreport::get_selection()

4.5.7 ComDiff

Start

None ComDiff::Start()

Stop

None ComDiff::Stop()

4.5.8 ComDiffoutage

Start

list(int, ...) ComDiffoutage::Start(list)

4.5.9 ComDllmanager

Report

None ComDllmanager::Report()

4.5.10 ComDpl

CheckSyntax

int ComDpl::CheckSyntax()

4.5.11 ComEcho

On

int ComEcho::On()

Off

int ComEcho::Off()

Python Function Reference (Python) 64

4 DataObject class

4.5.12 ComGenrelinc

GetCurrentIteration

int ComGenrelinc::GetCurrentIteration()

GetMaxNumIterations

int ComGenrelinc::GetMaxNumIterations()

4.5.13 ComImport

GetModifiedObjects

list ComImport::GetModifiedObjects()

GetCreatedObjects

list ComImport::GetCreatedObjects()

4.5.14 ComLdf

IsBalanced

int ComLdf::IsBalanced()

CalcLdf

int ComLdf::CalcLdf()

IsDC

int ComLdf::IsDC()

IsAC

int ComLdf::IsAC()

CalcParams

int ComLdf::CalcParams()

EstimateLoading

Python Function Reference (Python) 65

4 DataObject class

list(int, ...) ComLdf::EstimateLoading(list,

float
)

EstimateOutage

list(int, ...) ComLdf::EstimateOutage(list,

float
)

DoNotResetCalc

list(int, ...) ComLdf::DoNotResetCalc(float)

PrintCheckResults

int ComLdf::PrintCheckResults()

CheckControllers

int ComLdf::CheckControllers()

PrintPowerControllers

int ComLdf::PrintPowerControllers()

4.5.15 ComLink

SentDataStatus

int ComLink::SentDataStatus()

SetOPCReceiveQuality

list(int, ...) ComLink::SetOPCReceiveQuality(float)

SetSwitchShcEventMode

list(None, ...) ComLink::SetSwitchShcEventMode(float)

ReceiveData

list(int, ...) ComLink::ReceiveData([float])

SendData

list(int, ...) ComLink::SendData([float])

Python Function Reference (Python) 66

4 DataObject class

LoadMicroSCADAFile

list(int, ...) ComLink::LoadMicroSCADAFile(str,

[float]
)

4.5.16 ComMerge

ExecuteWithActiveProject

None ComMerge::ExecuteWithActiveProject()

Compare

int ComMerge::Compare()

CompareActive

int ComMerge::CompareActive()

ExecuteRecording

int ComMerge::ExecuteRecording()

PrintComparisonReport

list(None, ...) ComMerge::PrintComparisonReport(float)

SetAutoAssignmentForAll

list(None, ...) ComMerge::SetAutoAssignmentForAll(float)

CheckAssignments

int ComMerge::CheckAssignments()

ShowBrowser

int ComMerge::ShowBrowser()

Merge

list(None, ...) ComMerge::Merge(float)

Reset

None ComMerge::Reset()

Python Function Reference (Python) 67

4 DataObject class

WereModificationsFound

int ComMerge::WereModificationsFound()

GetCorrespondingObject

list(DataObject, ...) ComMerge::GetCorrespondingObject(DataObject,

[float]
)

GetModificationResult

list(int, ...) ComMerge::GetModificationResult(DataObject)

PrintModifications

list(int, ...) ComMerge::PrintModifications(DataObject)

PrintModifications

list(int, ...) ComMerge::PrintModifications(list)

SetObjectsToCompare

list(None, ...) ComMerge::SetObjectsToCompare(DataObject,

[DataObject,]
[DataObject]
)

GetModification

list(int, ...) ComMerge::GetModification(DataObject,

[float]
)

GetModifiedObjects

list(list, ...) ComMerge::GetModifiedObjects(float,

[float]
)

4.5.17 ComMot

GetMotorTerminal

list(DataObject, ...) ComMot::GetMotorTerminal(DataObject)

GetMotorSwitch

Python Function Reference (Python) 68

4 DataObject class

list(DataObject, ...) ComMot::GetMotorSwitch(DataObject)

GetMotorConnections

list(list, ...) ComMot::GetMotorConnections(DataObject)

4.5.18 ComNmink

Clear

None ComNmink::Clear()

GetAll

list(list, ...) ComNmink::GetAll(str)

AddRef

list(None, ...) ComNmink::AddRef(DataObject)

AddRef

list(None, ...) ComNmink::AddRef(list)

4.5.19 ComOmr

GetFeeders

list ComOmr::GetFeeders()

GetRegionCount

list(int, ...) ComOmr::GetRegionCount(DataObject)

GetOMR

list(list, ...) ComOmr::GetOMR(DataObject,

float
)

4.5.20 ComOpf

ExeEcoDis

Python Function Reference (Python) 69

4 DataObject class

int ComOpf::ExeEcoDis()

ExecOpfWithReducedConstraints

list(int, ...) ComOpf::ExecOpfWithReducedConstraints(list,

float
)

4.5.21 ComOutage

SetObjs

list(int, ...) ComOutage::SetObjs(list)

GetObject

list(DataObject, ...) ComOutage::GetObject(float)

AddObjState

list(int, ...) ComOutage::AddObjState(DataObject,

float
)

StartTrace

int ComOutage::StartTrace()

ContinueTrace

int ComOutage::ContinueTrace()

ExecuteTime

list(int, ...) ComOutage::ExecuteTime(float)

RemoveEvents

list(None, ...) ComOutage::RemoveEvents([float,]

[float]
)

RemoveEvents

list(None, ...) ComOutage::RemoveEvents([str,]

[str]
)

Python Function Reference (Python) 70

4 DataObject class

RemoveEvents

list(None, ...) ComOutage::RemoveEvents(float,

str
)

RemoveEvents

list(None, ...) ComOutage::RemoveEvents(str,

float
)

StopTrace

list(int, ...) ComOutage::StopTrace([float])

4.5.22 ComProtreport

GetOcUnits

str ComProtreport::GetOcUnits()

GetVoltUnits

str ComProtreport::GetVoltUnits()

GetInfoCols

str ComProtreport::GetInfoCols()

4.5.23 ComRel3

Execute

int ComRel3::Execute()

ExeEvt

list(int, ...) ComRel3::ExeEvt([DataObject])

OvlAlleviate

list(int, ...) ComRel3::OvlAlleviate([list])

RemoveOutages

Python Function Reference (Python) 71

4 DataObject class

list(None, ...) ComRel3::RemoveOutages([float])

RemoveEvents

list(None, ...) ComRel3::RemoveEvents([float,]

[float]
)

RemoveEvents

list(None, ...) ComRel3::RemoveEvents([str,]

[str]
)

RemoveEvents

list(None, ...) ComRel3::RemoveEvents(float,

str
)

RemoveEvents

list(None, ...) ComRel3::RemoveEvents(str,

float
)

AnalyseElmRes

list(int, ...) ComRel3::AnalyseElmRes([float])

CreateFaultCase

list(int, ...) ComRel3::CreateFaultCase(list,

float,
[float]
)

4.5.24 ComRelpost

CalcContributions

list(int, ...) ComRelpost::CalcContributions([list])

4.5.25 ComRes

ExportFullRange

int ComRes::ExportFullRange()

Python Function Reference (Python) 72

4 DataObject class

FileNmResNm

int ComRes::FileNmResNm()

4.5.26 ComSe

EstimateUnobservableArea

int ComSe::EstimateUnobservableArea()

4.5.27 ComSh

GetConfiguredDpl

list ComSh::GetConfiguredDpl()

ResetConfiguredDpl

list(int, ...) ComSh::ResetConfiguredDpl(DataObject)

ResetConfiguredDpl

list(int, ...) ComSh::ResetConfiguredDpl(list)

4.5.28 ComShc

GetFaultType

int ComShc::GetFaultType()

ExecuteRXSweep

int ComShc::ExecuteRXSweep()

ExecuteRXSweep

list(int, ...) ComShc::ExecuteRXSweep(float,

float
)

GetOverLoadedBuses

list(int, ...) ComShc::GetOverLoadedBuses(float,

float,
[list]
)

Python Function Reference (Python) 73

4 DataObject class

GetOverLoadedBranches

list(int, ...) ComShc::GetOverLoadedBranches(float,

float,
[list]
)

4.5.29 ComSimoutage

Reset

int ComSimoutage::Reset()

ExecuteCntcy

list(int, ...) ComSimoutage::ExecuteCntcy(DataObject)

SetLimits

list(int, ...) ComSimoutage::SetLimits(float,

float,
float
)

MarkRegions

list(int, ...) ComSimoutage::MarkRegions(float)

GetRegion

list(int, ...) ComSimoutage::GetRegion(DataObject,

float
)

IsEnergized

list(int, ...) ComSimoutage::IsEnergized(DataObject,

float
)

ClearCont

int ComSimoutage::ClearCont()

Update

int ComSimoutage::Update()

RemoveContingencies

Python Function Reference (Python) 74

4 DataObject class

None ComSimoutage::RemoveContingencies()

AddContingencies

None ComSimoutage::AddContingencies()

AddCntcy

list(int, ...) ComSimoutage::AddCntcy(DataObject,

[str]
)

CreateFaultCase

list(int, ...) ComSimoutage::CreateFaultCase(list,

float,
[float]
)

4.5.30 ComStep

GetLastIndex

float ComStep::GetLastIndex()

GetNextIndex

float ComStep::GetNextIndex()

Init

int ComStep::Init()

GetNextStep

int ComStep::GetNextStep()

StepAndOutput

float ComStep::StepAndOutput()

GetMinStepToMax

float ComStep::GetMinStepToMax()

GetMinStepToMin

float ComStep::GetMinStepToMin()

Python Function Reference (Python) 75

4 DataObject class

MaxLimOK

float ComStep::MaxLimOK()

MinLimOK

float ComStep::MinLimOK()

4.5.31 ComSvgexport

SetObject

list(None, ...) ComSvgexport::SetObject(DataObject)

SetObjects

list(None, ...) ComSvgexport::SetObjects(list)

SetFileName

list(None, ...) ComSvgexport::SetFileName(str)

4.5.32 ComSvgimport

SetObject

list(None, ...) ComSvgimport::SetObject(DataObject)

SetFileName

list(None, ...) ComSvgimport::SetFileName(str)

4.5.33 ComTececo

UpdateTablesByCalcPeriod

list(int, ...) ComTececo::UpdateTablesByCalcPeriod(float,

float
)

Python Function Reference (Python) 76

4 DataObject class

4.5.34 ComTieopt

GetCloseActionsSet

list ComTieopt::GetCloseActionsSet()

GetOptimalOpenPointsSet

list ComTieopt::GetOptimalOpenPointsSet()

GetFeedersSet

list ComTieopt::GetFeedersSet()

GetAllElementsSet

list ComTieopt::GetAllElementsSet()

GetOpenActionsSet

list(list, ...) ComTieopt::GetOpenActionsSet([float])

GetActionSwitchObject

list(DataObject, ...) ComTieopt::GetActionSwitchObject(DataObject,

[float]
)

GetActionInComponentObject

list(DataObject, ...) ComTieopt::GetActionInComponentObject(DataObject,

[float]
)

GetAction

list(int, ...) ComTieopt::GetAction(DataObject,

[float]
)

GetOptimalSwitchObject

list(DataObject, ...) ComTieopt::GetOptimalSwitchObject(DataObject,

[float]
)

GetOptimalInComponentObject

list(DataObject, ...) ComTieopt::GetOptimalInComponentObject(DataObject,

[float]
)

Python Function Reference (Python) 77

4 DataObject class

ExeSimpleLdf

list(None, ...) ComTieopt::ExeSimpleLdf([list,]

[list]
)

ExeRestoration

list(int, ...) ComTieopt::ExeRestoration(float,

[list,]
[float,]
[float]
)

4.5.35 ComTopo

GetConnectedElements

list(list, ...) ComTopo::GetConnectedElements(DataObject,

float
)

GetAreaRestoredBySwitch

list(int, ...) ComTopo::GetAreaRestoredBySwitch(DataObject,

list
)

GetRestoreSwitchList

list(int, ...) ComTopo::GetRestoreSwitchList(DataObject,

list
)

GetLoopBranches

list(list, ...) ComTopo::GetLoopBranches(float)

GetLoop

list(list, ...) ComTopo::GetLoop(DataObject,

float
)

MarkFeeders

list(int, ...) ComTopo::MarkFeeders(float)

FindAreas

int ComTopo::FindAreas()

Python Function Reference (Python) 78

4 DataObject class

4.5.36 ComUcte

SetBatchMode

list(None, ...) ComUcte::SetBatchMode(float)

4.5.37 ComUcteexp

InitQuickAccessMaps

None ComUcteexp::InitQuickAccessMaps()

ResetQuickAccessMaps

None ComUcteexp::ResetQuickAccessMaps()

SetGridSelection

list(None, ...) ComUcteexp::SetGridSelection(list)

BuildNodeNames

int ComUcteexp::BuildNodeNames()

GetConnectedBranches

list(None, ...) ComUcteexp::GetConnectedBranches(DataObject,

list
)

GetFromToNodeNames

list(None, ...) ComUcteexp::GetFromToNodeNames(DataObject,

str,
str
)

GetOrderCode

list(None, ...) ComUcteexp::GetOrderCode(DataObject,

str
)

Python Function Reference (Python) 79

4 DataObject class

4.6 Others

4.6.1 BlkSig

GetFromSigName

str BlkSig::GetFromSigName()

GetToSigName

str BlkSig::GetToSigName()

4.6.2 ChaVecfile

Update

list(int, ...) ChaVecfile::Update([float])

4.6.3 Global

4.6.4 IntCase

Activate

int IntCase::Activate()

Deactivate

int IntCase::Deactivate()

SetStudyTime

list(None, ...) IntCase::SetStudyTime(float)

Consolidate

int IntCase::Consolidate()

Reduce

list(int, ...) IntCase::Reduce([float])

Python Function Reference (Python) 80

4 DataObject class

4.6.5 IntDataset

Clear

None IntDataset::Clear()

All

list IntDataset::All()

GetAll

list(list, ...) IntDataset::GetAll(str)

AddRef

list(None, ...) IntDataset::AddRef(DataObject)

AddRef

list(None, ...) IntDataset::AddRef(list)

4.6.6 IntDocument

View

int IntDocument::View()

Edit

int IntDocument::Edit()

4.6.7 IntEvt

CreateCBEvents

list(None, ...) IntEvt::CreateCBEvents([float])

RemoveSwitchEvents

list(None, ...) IntEvt::RemoveSwitchEvents([float])

Python Function Reference (Python) 81

4 DataObject class

4.6.8 IntExtaccess

CheckUrl

list(int, ...) IntExtaccess::CheckUrl(str)

4.6.9 IntForm

SetText

list(None, ...) IntForm::SetText(str)

WriteOut

list(None, ...) IntForm::WriteOut(list,

[list,]
[float]
)

WriteOut

list(None, ...) IntForm::WriteOut(list,

float,
[list]
)

WriteOut

list(None, ...) IntForm::WriteOut(float,

[list,]
[list]
)

SetThisForm

list(int, ...) IntForm::SetThisForm(str,

str,
str,
[float]
)

4.6.10 IntFormsel

ConvertForms

int IntFormsel::ConvertForms()

Python Function Reference (Python) 82

4 DataObject class

4.6.11 IntGrf

MoveToLayer

list(None, ...) IntGrf::MoveToLayer(DataObject)

4.6.12 IntGrfgroup

ClearData

None IntGrfgroup::ClearData()

Import

list(None, ...) IntGrfgroup::Import([str])

Export

list(None, ...) IntGrfgroup::Export([str])

4.6.13 IntGrflayer

ClearData

None IntGrflayer::ClearData()

Import

list(None, ...) IntGrflayer::Import([str])

Export

list(None, ...) IntGrflayer::Export([str])

4.6.14 IntGrfnet

Show

int IntGrfnet::Show()

Python Function Reference (Python) 83

4 DataObject class

4.6.15 IntMap

Clear

int IntMap::Clear()

HasKey

list(int, ...) IntMap::HasKey(str)

GetString

list(str, ...) IntMap::GetString(str)

SetString

list(int, ...) IntMap::SetString(str,

str
)

GetInt

list(int, ...) IntMap::GetInt(str)

SetInt

list(int, ...) IntMap::SetInt(str,

float
)

GetDouble

list(float, ...) IntMap::GetDouble(str)

SetDouble

list(int, ...) IntMap::SetDouble(str,

float
)

4.6.16 IntMat

SizeX

int IntMat::SizeX()

SizeY

Python Function Reference (Python) 84

4 DataObject class

int IntMat::SizeY()

Get

list(float, ...) IntMat::Get(float,

float
)

Set

list(int, ...) IntMat::Set(float,

float,
float
)

Invert

int IntMat::Invert()

Multiply

list(int, ...) IntMat::Multiply(DataObject,

DataObject
)

Init

list(int, ...) IntMat::Init(float,

float,
[float]
)

Resize

list(int, ...) IntMat::Resize(float,

float,
[float]
)

ColLbl

list(str, ...) IntMat::ColLbl(float)

ColLbl

list(str, ...) IntMat::ColLbl(str,

float
)

RowLbl

Python Function Reference (Python) 85

4 DataObject class

list(str, ...) IntMat::RowLbl(float)

RowLbl

list(str, ...) IntMat::RowLbl(str,

float
)

InvFFT

list(None, ...) IntMat::InvFFT(DataObject,

[float]
)

SortToColumn

list(int, ...) IntMat::SortToColumn(float,

[float]
)

SortToColum

list(int, ...) IntMat::SortToColum(float,

[float]
)

4.6.17 IntMon

PrintAllVal

None IntMon::PrintAllVal()

PrintVal

None IntMon::PrintVal()

NVars

int IntMon::NVars()

GetVar

list(str, ...) IntMon::GetVar(float)

RemoveVar

list(int, ...) IntMon::RemoveVar(str)

Python Function Reference (Python) 86

4 DataObject class

ClearVars

None IntMon::ClearVars()

AddVar

list(None, ...) IntMon::AddVar(str)

4.6.18 IntOutage

IsInStudytime

int IntOutage::IsInStudytime()

Check

list(int, ...) IntOutage::Check([float])

CheckAll

list(None, ...) IntOutage::CheckAll([float,]

[DataObject,]
[list,]
[list]
)

Apply

list(None, ...) IntOutage::Apply([float])

ApplyAll

list(None, ...) IntOutage::ApplyAll([float])

4.6.19 IntPlot

SetScaleY

list(None, ...) IntPlot::SetScaleY(float,

float,
[float]
)

SetScaleY

None IntPlot::SetScaleY()

Python Function Reference (Python) 87

4 DataObject class

SetAutoScaleY

list(None, ...) IntPlot::SetAutoScaleY(float)

SetAdaptY

list(None, ...) IntPlot::SetAdaptY(float,

[float]
)

4.6.20 IntPrj

Activate

int IntPrj::Activate()

Deactivate

int IntPrj::Deactivate()

UpdateStatistics

None IntPrj::UpdateStatistics()

Purge

None IntPrj::Purge()

GetVersions

list IntPrj::GetVersions()

LoadData

None IntPrj::LoadData()

HasExternalReferences

list(int, ...) IntPrj::HasExternalReferences([float,]

[float]
)

CreateVersion

list(DataObject, ...) IntPrj::CreateVersion([float])

Migrate

Python Function Reference (Python) 88

4 DataObject class

list(None, ...) IntPrj::Migrate([float])

GetLatestVersion

list(DataObject, ...) IntPrj::GetLatestVersion([float])

Archive

list(int, ...) IntPrj::Archive([str])

4.6.21 IntPrjfolder

IsProjectFolderType

list(int, ...) IntPrjfolder::IsProjectFolderType(str)

GetProjectFolderType

str IntPrjfolder::GetProjectFolderType()

4.6.22 IntQlim

GetQlim

list(float, ...) IntQlim::GetQlim(float,

float,
[float]
)

4.6.23 IntScenario

Activate

int IntScenario::Activate()

Save

int IntScenario::Save()

DiscardChanges

int IntScenario::DiscardChanges()

GetObjects

Python Function Reference (Python) 89

4 DataObject class

list IntScenario::GetObjects()

ReleaseMemory

int IntScenario::ReleaseMemory()

ApplySelective

list(int, ...) IntScenario::ApplySelective(DataObject)

ApplySelective

list(int, ...) IntScenario::ApplySelective(int,

DataObject
)

Apply

int IntScenario::Apply()

Apply

list(int, ...) IntScenario::Apply(int)

Apply

list(int, ...) IntScenario::Apply(int,

DataObject
)

Deactivate

list(int, ...) IntScenario::Deactivate([float])

Apply

list(int, ...) IntScenario::Apply([float,]

[DataObject]
)

GetOperationValue

list(int, ...) IntScenario::GetOperationValue(int/float/str/DataObject,

DataObject,
str,
[int])

SetOperationValue

Python Function Reference (Python) 90

4 DataObject class

list(int, ...) IntScenario::SetOperationValue(int/float/str/DataObject,

DataObject,
str,
[int])

ActivateIncrementalSubset

list(None, ...) IntScenario::ActivateIncrementalSubset([float,]

[float]
)

DeactivateIncrementalSubset

list(None, ...) IntScenario::DeactivateIncrementalSubset([float,]

[float]
)

4.6.24 IntScensched

Activate

int IntScensched::Activate()

Deactivate

int IntScensched::Deactivate()

GetScenario

list(DataObject, ...) IntScensched::GetScenario(float)

GetStartEndTime

list(int, ...) IntScensched::GetStartEndTime(DataObject,

float,
float
)

SearchScenario

list(int, ...) IntScensched::SearchScenario(DataObject)

DeleteRow

list(None, ...) IntScensched::DeleteRow(float,

[float]
)

Python Function Reference (Python) 91

4 DataObject class

4.6.25 IntScheme

Activate

int IntScheme::Activate()

Deactivate

int IntScheme::Deactivate()

GetActiveScheduler

DataObject IntScheme::GetActiveScheduler()

NewStage

list(int, ...) IntScheme::NewStage(str,

float,
float
)

Consolidate

int IntScheme::Consolidate()

4.6.26 IntSscheduler

Update

int IntSscheduler::Update()

Activate

int IntSscheduler::Activate()

Deactivate

int IntSscheduler::Deactivate()

4.6.27 IntSstage

GetScheme

DataObject IntSstage::GetScheme()

CreateStageObject

Python Function Reference (Python) 92

4 DataObject class

list(DataObject, ...) IntSstage::CreateStageObject(float,

DataObject
)

EnableDiffMode

list(None, ...) IntSstage::EnableDiffMode(float)

IsExcluded

float IntSstage::IsExcluded()

PrintModifications

list(int, ...) IntSstage::PrintModifications([float,]

[str]
)

Activate

list(int, ...) IntSstage::Activate([float])

ReadValue

list(int, ) IntSstage::ReadValue(int/float/str/DataObject,
DataObject,
str)

WriteValue

list(int, ) IntSstage::WriteValue(int/float/str/DataObject,
DataObject,
str)

4.6.28 IntSubset

Apply

int IntSubset::Apply()

4.6.29 IntThrating

GetRating

list(float, ...) IntThrating::GetRating(float,

float
)

Python Function Reference (Python) 93

4 DataObject class

GetCriticalTimePhase

list(float, ...) IntThrating::GetCriticalTimePhase(float,

float
)

4.6.30 IntUrl

View

int IntUrl::View()

4.6.31 IntUser

Purge

None IntUser::Purge()

TerminateSession

None IntUser::TerminateSession()

SetPassword

list(None, ...) IntUser::SetPassword(str)

4.6.32 IntUserman

CreateUser

list(DataObject, ...) IntUserman::CreateUser(str)

CreateGroup

list(DataObject, ...) IntUserman::CreateGroup(str)

GetGroups

list IntUserman::GetGroups()

GetUsers

list IntUserman::GetUsers()

Python Function Reference (Python) 94

4 DataObject class

UpdateGroups

None IntUserman::UpdateGroups()

4.6.33 IntVariant

Activate

int IntVariant::Activate()

Deactivate

int IntVariant::Deactivate()

Reduce

list(int, ...) IntVariant::Reduce([float])

4.6.34 IntVec

Sort

list(None, ...) IntVec::Sort(float)

Get

list(float, ...) IntVec::Get(float)

Set

list(None, ...) IntVec::Set(float,

float
)

Init

list(None, ...) IntVec::Init(float)

Resize

list(None, ...) IntVec::Resize(float)

Size

int IntVec::Size()

Python Function Reference (Python) 95

4 DataObject class

Mean

float IntVec::Mean()

Max

float IntVec::Max()

Min

float IntVec::Min()

fft

list(None, ...) IntVec::fft([float])

DFT1freq

list(int, ...) IntVec::DFT1freq(float,

float,
float,
[float]
)

4.6.35 IntVersion

Rollback

int IntVersion::Rollback()

CreateDerivedProject

list(DataObject, ...) IntVersion::CreateDerivedProject(str,

[DataObject]
)

4.6.36 IntVsagtable

Get

list(float, ...) IntVsagtable::Get(float,

float
)

Set

Python Function Reference (Python) 96

4 DataObject class

list(int, ...) IntVsagtable::Set(float,

float,
float
)

Init

list(int, ...) IntVsagtable::Init(float,

float
)

Enlarge

list(int, ...) IntVsagtable::Enlarge(float,

float
)

Clear

int IntVsagtable::Clear()

NRow

int IntVsagtable::NRow()

NCol

int IntVsagtable::NCol()

4.6.37 RelChar

SetCurve

list(int, ...) RelChar::SetCurve(str)

4.6.38 RelToc

SetCurve

list(int, ...) RelToc::SetCurve(str)

4.6.39 RelZpol

AssumeCompensationFactor

Python Function Reference (Python) 97

4 DataObject class

int RelZpol::AssumeCompensationFactor()

AssumeReRl

int RelZpol::AssumeReRl()

AssumeXeXl

int RelZpol::AssumeXeXl()

4.6.40 SetCluster

GetNumberOfClusters

int SetCluster::GetNumberOfClusters()

CalcCluster

list(int, ...) SetCluster::CalcCluster(float,

[float]
)

4.6.41 SetColscheme

CreateFilter

list(int, ...) SetColscheme::CreateFilter([float])

SetFilter

list(int, ...) SetColscheme::SetFilter(float,

[float]
)

SetFilter

list(int, ...) SetColscheme::SetFilter(DataObject,

[float]
)

SetColouring

list(int, ...) SetColscheme::SetColouring(str,

float,
[float,]
[float]
)

Python Function Reference (Python) 98

4 DataObject class

4.6.42 SetCurve

GetCalcXlogy

list(float, ...) SetCurve::GetCalcXlogy(float)

GetCalcy

list(float, ...) SetCurve::GetCalcy(float)

CalcLinear

int SetCurve::CalcLinear()

CalcPolynom

int SetCurve::CalcPolynom()

CalcMinPoly

list(int, ...) SetCurve::CalcMinPoly(float)

CalcSpline

int SetCurve::CalcSpline()

4.6.43 SetDesktop

WriteWMF

list(int, ...) SetDesktop::WriteWMF(str)

AddPage

list(DataObject, ...) SetDesktop::AddPage(DataObject)

DoAutoScaleX

None SetDesktop::DoAutoScaleX()

Show

list(int, ...) SetDesktop::Show([str])

Show

Python Function Reference (Python) 99

4 DataObject class

list(int, ...) SetDesktop::Show(DataObject)

GetPage

list(DataObject, ...) SetDesktop::GetPage(str,

[float]
)

SetResults

list(None, ...) SetDesktop::SetResults(DataObject)

SetXVar

None SetDesktop::SetXVar()

SetXVar

list(None, ...) SetDesktop::SetXVar(DataObject,

str
)

SetScaleX

None SetDesktop::SetScaleX()

SetScaleX

list(None, ...) SetDesktop::SetScaleX(float,

float,
[float]
)

SetAutoScaleX

list(None, ...) SetDesktop::SetAutoScaleX(float)

SetAdaptX

list(None, ...) SetDesktop::SetAdaptX(float,

[float]
)

4.6.44 SetDistrstate

SetupCalculation

int SetDistrstate::SetupCalculation()

Python Function Reference (Python) 100

4 DataObject class

ResetCalculation

int SetDistrstate::ResetCalculation()

CalcCluster

list(int, ...) SetDistrstate::CalcCluster(float,

[float]
)

4.6.45 SetFilt

Get

list SetFilt::Get()

4.6.46 SetLevelvis

AdaptWidth

None SetLevelvis::AdaptWidth()

Mark

None SetLevelvis::Mark()

Align

list(None, ...) SetLevelvis::Align(float)

Reset

list(None, ...) SetLevelvis::Reset(float)

ChangeLayer

list(None, ...) SetLevelvis::ChangeLayer(str)

ChangeRefPoints

list(None, ...) SetLevelvis::ChangeRefPoints(float,

float
)

ChangeFont

Python Function Reference (Python) 101

4 DataObject class

list(None, ...) SetLevelvis::ChangeFont(float)

ChangeFrameAndWidth

list(None, ...) SetLevelvis::ChangeFrameAndWidth([float,]

[float,]
[float,]
[float]
)

4.6.47 SetParalman

SetTransfType

list(int, ...) SetParalman::SetTransfType(float)

GetTransfType

int SetParalman::GetTransfType()

SetNumSlave

list(int, ...) SetParalman::SetNumSlave(float)

GetNumSlave

int SetParalman::GetNumSlave()

4.6.48 SetPath

Create

list(DataObject, ...) SetPath::Create(list)

GetAll

list SetPath::GetAll()

GetBuses

list SetPath::GetBuses()

GetAbsDistance

Python Function Reference (Python) 102

4 DataObject class

list(DataObject, ...) SetPath::GetAbsDistance(DataObject,

DataObject,
float,
float,
float,
float,
float
)

GetImpedanceAtPos

list(DataObject, ...) SetPath::GetImpedanceAtPos(DataObject,

DataObject,
float,
float,
float,
float,
float
)

AllBreakers

list SetPath::AllBreakers()

AllClosedBreakers

list SetPath::AllClosedBreakers()

AllOpenBreakers

list SetPath::AllOpenBreakers()

GetPathFolder

list(DataObject, ...) SetPath::GetPathFolder([float])

GetBranches

list(list, ...) SetPath::GetBranches([float])

GetRelay

list(DataObject, ...) SetPath::GetRelay(DataObject,

[float,]
[float]
)

GetNode

list(DataObject, ...) SetPath::GetNode(DataObject,

[float]
)

Python Function Reference (Python) 103

4 DataObject class

GetNodeIndex

list(int, ...) SetPath::GetNodeIndex(DataObject,

[float]
)

NextRelayBranch

list(DataObject, ...) SetPath::NextRelayBranch(DataObject,

[float,]
[float]
)

4.6.49 SetSelect

Clear

None SetSelect::Clear()

AllElm

list SetSelect::AllElm()

AllLines

list SetSelect::AllLines()

AllBars

list SetSelect::AllBars()

AllLoads

list SetSelect::AllLoads()

AllAsm

list SetSelect::AllAsm()

AllSym

list SetSelect::AllSym()

AllTypLne

list SetSelect::AllTypLne()

Python Function Reference (Python) 104

4 DataObject class

All

list SetSelect::All()

GetAll

list(list, ...) SetSelect::GetAll(str)

AllBreakers

list SetSelect::AllBreakers()

AllClosedBreakers

list SetSelect::AllClosedBreakers()

AllOpenBreakers

list SetSelect::AllOpenBreakers()

AddRef

list(None, ...) SetSelect::AddRef(DataObject)

AddRef

list(None, ...) SetSelect::AddRef(list)

4.6.50 SetTime

Date

None SetTime::Date()

Time

None SetTime::Time()

SetTimeUTC

list(None, ...) SetTime::SetTimeUTC(float)

DisableUpdateStudyTime

None SetTime::DisableUpdateStudyTime()

Python Function Reference (Python) 105

4 DataObject class

EnableUpdateStudyTime

None SetTime::EnableUpdateStudyTime()

SetTime

list(None, ...) SetTime::SetTime(float,

[float,]
[float]
)

4.6.51 SetVipage

CreateVI

list(DataObject, ...) SetVipage::CreateVI(DataObject)

SetStyle

list(None, ...) SetVipage::SetStyle(str)

DoAutoScaleX

None SetVipage::DoAutoScaleX()

DoAutoScaleY

None SetVipage::DoAutoScaleY()

GetVI

list(DataObject, ...) SetVipage::GetVI(str,

[str,]
[float]
)

SetResults

list(None, ...) SetVipage::SetResults(DataObject)

SetXVar

None SetVipage::SetXVar()

SetXVar

list(None, ...) SetVipage::SetXVar(DataObject,

str
)

Python Function Reference (Python) 106

4 DataObject class

SetScaleX

None SetVipage::SetScaleX()

SetScaleX

list(None, ...) SetVipage::SetScaleX(float,

float,
[float]
)

SetDefScaleX

None SetVipage::SetDefScaleX()

SetAutoScaleX

list(None, ...) SetVipage::SetAutoScaleX(float)

GetScaleObjX

DataObject SetVipage::GetScaleObjX()

SetAdaptX

list(None, ...) SetVipage::SetAdaptX(float,

[float]
)

SetTile

list(None, ...) SetVipage::SetTile([float])

4.6.52 StaCt

SetPrimaryTap

list(int, ...) StaCt::SetPrimaryTap([float])

4.6.53 StaCubic

IsConnected

list(int, ...) StaCubic::IsConnected(DataObject,

float
)

Python Function Reference (Python) 107

4 DataObject class

GetConnections

list(list, ...) StaCubic::GetConnections(float)

GetBranch

DataObject StaCubic::GetBranch()

IsClosed

int StaCubic::IsClosed()

GetAll

list(list, ...) StaCubic::GetAll([float,]

[float]
)

4.6.54 StaExtcmdmea

UpdateControl

list(int, ...) StaExtcmdmea::UpdateControl([int])

UpdateCtrl

list(int, ...) StaExtcmdmea::UpdateCtrl([int])

GetMeaValue

list(int, ...) StaExtcmdmea::GetMeaValue(float,

[int,]
[int])

SetMeaValue
no signature available

SetStatus
no signature available

SetStatusTmp
no signature available

GetStatusTmp
no signature available

SetStatusBit
no signature available

SetStatusBitTmp
no signature available

Python Function Reference (Python) 108

4 DataObject class

ResetStatusBit
no signature available

ResetStatusBitTmp
no signature available

IsStatusBitSet

list(int, ...) StaExtcmdmea::IsStatusBitSet(int)

IsStatusBitSetTmp

list(int, ...) StaExtcmdmea::IsStatusBitSetTmp(int)

CopyExtMeaStatusToStatusTmp

int StaExtcmdmea::CopyExtMeaStatusToStatusTmp()

InitTmp

int StaExtcmdmea::InitTmp()

CreateEvent
no signature available

4.6.55 StaExtdatmea

UpdateControl

list(int, ...) StaExtdatmea::UpdateControl([int])

UpdateCtrl

list(int, ...) StaExtdatmea::UpdateCtrl([int])

GetMeaValue
no signature available

SetMeaValue
no signature available

SetStatus

list(int, ...) StaExtdatmea::SetStatus(int)

SetStatusTmp

list(int, ...) StaExtdatmea::SetStatusTmp(int)

Python Function Reference (Python) 109

4 DataObject class

GetStatusTmp

int StaExtdatmea::GetStatusTmp()

SetStatusBit

list(int, ...) StaExtdatmea::SetStatusBit(int)

SetStatusBitTmp

list(int, ...) StaExtdatmea::SetStatusBitTmp(int)

ResetStatusBit

list(int, ...) StaExtdatmea::ResetStatusBit(int)

ResetStatusBitTmp

list(int, ...) StaExtdatmea::ResetStatusBitTmp(int)

IsStatusBitSet

list(int, ...) StaExtdatmea::IsStatusBitSet(int)

IsStatusBitSetTmp

list(int, ...) StaExtdatmea::IsStatusBitSetTmp(int)

CopyExtMeaStatusToStatusTmp

int StaExtdatmea::CopyExtMeaStatusToStatusTmp()

InitTmp

int StaExtdatmea::InitTmp()

CreateEvent
no signature available

4.6.56 StaExttapmea

UpdateControl

list(int, ...) StaExttapmea::UpdateControl([int])

UpdateCtrl

Python Function Reference (Python) 110

4 DataObject class

list(int, ...) StaExttapmea::UpdateCtrl([int])

GetMeaValue
no signature available

SetMeaValue
no signature available

SetStatus
no signature available

SetStatusTmp
no signature available

GetStatusTmp
no signature available

SetStatusBit

list(int, ...) StaExttapmea::SetStatusBit(int)

SetStatusBitTmp

list(int, ...) StaExttapmea::SetStatusBitTmp(int)

ResetStatusBit

list(int, ...) StaExttapmea::ResetStatusBit(int)

ResetStatusBitTmp

list(int, ...) StaExttapmea::ResetStatusBitTmp(int)

IsStatusBitSet
no signature available
list(int, ...) StaExttapmea::IsStatusBitSet(int)

IsStatusBitSetTmp

list(int, ...) StaExttapmea::IsStatusBitSetTmp(int)

CopyExtMeaStatusToStatusTmp

None StaExttapmea::CopyExtMeaStatusToStatusTmp()

InitTmp

int StaExttapmea::InitTmp()

CreateEvent
no signature available

Python Function Reference (Python) 111

4 DataObject class

4.6.57 StaSwitch

Close

int StaSwitch::Close()

Open

int StaSwitch::Open()

SoftClose

int StaSwitch::SoftClose()

SoftOpen

int StaSwitch::SoftOpen()

IsOpen

int StaSwitch::IsOpen()

IsClosed

int StaSwitch::IsClosed()

IsBusCoupler

int StaSwitch::IsBusCoupler()

IsTieBreaker

int StaSwitch::IsTieBreaker()

GetCalBusIndex

list(int, ...) StaSwitch::GetCalBusIndex(DataObject)

4.6.58 StoMaint

SetElms

list(None, ...) StoMaint::SetElms(DataObject)

SetElms

list(None, ...) StoMaint::SetElms(list)

Python Function Reference (Python) 112

4 DataObject class

4.6.59 VisBdia

SetScaleY

list(None, ...) VisBdia::SetScaleY(float,

float,
[float]
)

4.6.60 VisDraw

AddRelays

list(None, ...) VisDraw::AddRelays(DataObject,

[float,]
[float,]
[float]
)

AddRelays

list(None, ...) VisDraw::AddRelays(list)

4.6.61 VisFft

SetCrvDesc

None VisFft::SetCrvDesc(int,
str,
[str]*)

SetDefScaleY

None VisFft::SetDefScaleY()

SetAutoScaleX

list(None, ...) VisFft::SetAutoScaleX(float)

SetAutoScaleY

list(None, ...) VisFft::SetAutoScaleY(float)

GetScaleObjX

DataObject VisFft::GetScaleObjX()

Python Function Reference (Python) 113

4 DataObject class

GetScaleObjY

DataObject VisFft::GetScaleObjY()

4.6.62 VisHrm

SetCrvDesc

None VisHrm::SetCrvDesc(int,
str,
[str]*)

SetDefScaleX

None VisHrm::SetDefScaleX()

SetDefScaleY

None VisHrm::SetDefScaleY()

SetAutoScaleX

list(None, ...) VisHrm::SetAutoScaleX(float)

SetAutoScaleY

list(None, ...) VisHrm::SetAutoScaleY(float)

GetScaleObjX

DataObject VisHrm::GetScaleObjX()

GetScaleObjY

DataObject VisHrm::GetScaleObjY()

4.6.63 VisOcplot

AddRelays

list(None, ...) VisOcplot::AddRelays(DataObject,

[float,]
[float,]
[float]
)

Python Function Reference (Python) 114

4 DataObject class

AddRelays

list(None, ...) VisOcplot::AddRelays(list)

AddRelay

list(None, ...) VisOcplot::AddRelay(DataObject)

4.6.64 VisPath

SetScaleY

list(None, ...) VisPath::SetScaleY(float,

float,
[float]
)

4.6.65 VisPdc

AddObjs
no signature available

AddResObjs
no signature available

SetCrvDesc

None VisPdc::SetCrvDesc(int,
str,
[str]*)

SetScaleX

None VisPdc::SetScaleX()

SetScaleX

list(None, ...) VisPdc::SetScaleX(float,

float,
[float]
)

SetScaleY

list(None, ...) VisPdc::SetScaleY(float,

float
)

Python Function Reference (Python) 115

4 DataObject class

SetScaleY

None VisPdc::SetScaleY()

SetDefScaleX

None VisPdc::SetDefScaleX()

SetDefScaleY

None VisPdc::SetDefScaleY()

GetScaleObjX

DataObject VisPdc::GetScaleObjX()

GetScaleObjY

DataObject VisPdc::GetScaleObjY()

SetAdaptX

list(None, ...) VisPdc::SetAdaptX(float,

[float]
)

SetAdaptY

list(None, ...) VisPdc::SetAdaptY(float,

[float]
)

4.6.66 VisPlot

AddVars
no signature available

AddResVars
no signature available

SetCrvDesc

None VisPlot::SetCrvDesc(int,
str,
[str]*)

SetXVar

None VisPlot::SetXVar()

Python Function Reference (Python) 116

4 DataObject class

SetXVar

list(None, ...) VisPlot::SetXVar(DataObject,

str
)

SetScaleX

None VisPlot::SetScaleX()

SetScaleX

list(None, ...) VisPlot::SetScaleX(float,

float,
[float]
)

SetScaleY

list(None, ...) VisPlot::SetScaleY(float,

float,
[float]
)

SetScaleY

None VisPlot::SetScaleY()

SetDefScaleX

None VisPlot::SetDefScaleX()

SetDefScaleY

None VisPlot::SetDefScaleY()

SetAutoScaleX

list(None, ...) VisPlot::SetAutoScaleX(float)

SetAutoScaleY

list(None, ...) VisPlot::SetAutoScaleY(float)

GetScaleObjX

DataObject VisPlot::GetScaleObjX()

GetScaleObjY

Python Function Reference (Python) 117

4 DataObject class

DataObject VisPlot::GetScaleObjY()

SetAdaptX

list(None, ...) VisPlot::SetAdaptX(float,

[float]
)

SetAdaptY

list(None, ...) VisPlot::SetAdaptY(float,

[float]
)

4.6.67 VisPlot2

AddVars
no signature available

AddResVars
no signature available

Clear

list(None, ...) VisPlot2::Clear([float])

SetCrvDesc
no signature available

SetXVar

None VisPlot2::SetXVar()

SetXVar

list(None, ...) VisPlot2::SetXVar(DataObject,

str
)

SetScaleX
no signature available

SetScaleY
no signature available

SetDefScaleY

list(None, ...) VisPlot2::SetDefScaleY([float])

SetAutoScaleY

Python Function Reference (Python) 118

4 DataObject class

list(None, ...) VisPlot2::SetAutoScaleY(float,

[float]
)

GetScaleObjY

list(DataObject, ...) VisPlot2::GetScaleObjY([float])

SetAdaptX

list(None, ...) VisPlot2::SetAdaptX(float,

[float]
)

SetAdaptY

list(None, ...) VisPlot2::SetAdaptY(float,

[float,]
[float]
)

ShowY2

list(None, ...) VisPlot2::ShowY2([float])

4.6.68 VisPlottz

AddRelays

list(None, ...) VisPlottz::AddRelays(DataObject,

[float,]
[float,]
[float]
)

AddRelays

list(None, ...) VisPlottz::AddRelays(list)

4.6.69 VisXyplot

SetCrvDescX

None VisXyplot::SetCrvDescX(int,
str,
[str]*)

SetCrvDescY

Python Function Reference (Python) 119

6 Matrix class

None VisYyplot::SetCrvDescY(int,
str,
[str]*)

5 Vector class

getitem
no signature available

setitem
no signature available

len
no signature available

SetLenght
no signature available

str
no signature available

repr
no signature available

6 Matrix class

getitem
no signature available

setitem
no signature available

len
no signature available

SetLenght
no signature available

GetShape
no signature available

SetShape
no signature available

str
no signature available

repr
no signature available

Python Function Reference (Python) 120

7 Method class

7 Method class

call
no signature available

str
no signature available

repr
no signature available

Python Function Reference (Python) 121