UserManual en 1051 1100
UserManual en 1051 1100
UserManual en 1051 1100
A Variation defines an expansion plan composed of one or more expansion stages, and which are
chronologically activated. Variations, like all other network data, are stored inside the Network Data
folder.
Virtual Instrument
A virtual instrument is a graphical representation of calculation results. It may be a line or bar graph, a
gauge, a vector diagram, etc. A virtual instrument gets its values from a result object.
Virtual instrument panels are one of the possible types of pages in a graphics board window. Virtual
instrument panels are used to create and show virtual instruments. Each virtual instrument panel may
contain one or more virtual instruments.
Hotkeys Reference
Combination Description
F10 Perform Load Flow calculation
F11 Perform Short-Circuit calculation
Ctrl + F10 Edit Load Flow calculation options
Ctrl + F11 Edit Short-Circuit calculation options
F12 Reset Calculation
The technical references of models in PowerFactory are organized according to categories as shown in
the following table. Follow the links in the table to jump to the corresponding section.
Category Device
2-Winding Transformer (ElmTr2)
3-Winding Transformer (ElmTr3)
Autotransformers
Booster Transformer (ElmTrb)
Overhead Lines Systems
Cables Systems
Branch Elements Series Capacitor (ElmScap)
Series Reactor (ElmSind)
Series RLC-Filter (ElmSfilt)
Common Impedance (ElmZpu)
Asynchronous Machine (ElmAsm)
Doubly Fed Induction Machine (ElmAsmsc)
Static Generator (ElmGenstat)
PV System (ElmPvsys)
Synchronous Machine (ElmSym)
Loads (ElmLod)
Generators & Loads Low Voltage Load (ElmLodlv )
Partial Loads (ElmLodlvp)
Motor Driven Machine (ElmMdm__X )
DC Machine (ElmDcm)
External Grid (ElmXnet)
PWM AC/DC Converter
Rectifier/Inverter
Power Electronic Devices Soft Starter (ElmVar )
DC/DC Converter (ElmDcdc)
Shunt/Filter Element (ElmShnt)
Reactive Power Compensation
Static Var System (ElmSvs)
Station Controller (ElmStactrl)
Controllers
Power Frequency Control (ElmSecctrl)
Category Device
AC Voltage Source (ElmVac)
DC Voltage Source (ElmVdc)
AC Current Source (ElmIac)
DC Current Source (ElmDci)
Sources Impulse Source (ElmImpulse)
DC Battery (ElmBattery )
Fourier Source (ElmFsrc)
Current Measurement (StaImea)
Power Measurement (StaPqmea)
Voltage Measurement (StaVmea)
Measurement Devices
Phase Measurement Device (Phase Locked Loop, ElmPhi__pll)
Measurement File (ElmFile)
Digital Clock (ElmClock)
Digital Register (ElmReg)
Digital Devices Sample and Hold Model (ElmSamp)
Trigger Model (ElmTrigger )
Analysis Functions Fast Fourier Transform (ElmFft)
Neutral Earthing Element (ElmNec)
Miscellaneous
Surge Arrester (StaSua)
Table C.0.1: Technical References of Models
The 2-winding transformer supports a wide range of transformer types with various vector groups, phase
technologies, tap control, neutral connection options etc.
As the calculation model of the 2-winding transformer changes with the phase technology, there are
dedicated technical references for three-phase and single-phase 2-winding transformers:
• Single phase and single wire 2-winding transformer: Technical Reference ElmTr2 1Phase
The 3-winding transformer model in PowerFactory is a 3-phase element. It requires a 3-winding trans-
former type (TypTr3) where the user specifies the rated data, vector groups, tap changer, etc.
For a detailed description of the model the reader is referred to the Technical Reference TypTr3 of the
3-winding transformer type.
C.1.3 Autoransformers
The autotransformer models in PowerFactory build on the 3- and 2-winding transformer models de-
scribed in the previous sections. Hence an autotransformer is defined using the same elements (i.e.
the same icons in the toolbox) as used for the standard 3- and 2-winding transformers.
As soon as the connection group in the transformer type is set to YNyn, the option Auto Transformer will
be available in the transformer element. If the user enables this option, then the model will consider an
autotransformer winding connection instead of the galvanic separated winding.
For the details of the calculation model used in that case, the reader is referred to the technical
references of the 2-winding C.1.1 and 3-winding C.1.2.
The description of the booster transformers, presenting the relations among the input parameters is
given in the Technical Reference ElmTrb.
The 3-phase booster transformer model requires a reference to a booster transformer type (TypTrb).
PowerFactory handles both DC and AC lines, including all phase technologies (3ph, 2ph and single
phase), with/without neutral conductor and ground wires, for both single circuit and mutually coupled
parallel circuits.
All these options are handled by a suitable selection of element-type combinations as summarized in
Table C.1.1. The technical reference document Overhead Line Models provides a detailed description
of all available line models for both the steady-state and the transient simulations.
The line element ElmLne is the constituent element of transmission lines. When referring to a type, the
line element can be used to define single-circuit lines of any phase technology according to table C.1.1.
Besides, the element parameter Number of Parallel Lines lets represent parallel lines without mutual
coupling between each other.
If the mutual coupling between parallel lines is to be modelled, then a line coupling element ElmTow
shall be used. In that case, the line element ElmLne points to a line coupling element ElmTow which in
turns refers to the corresponding tower type TypTow or tower geometry type TypGeo.
Constant parameters models, i.e. non frequency-dependent, are those defined in term of electrical data
per unit-length. In that case, the user enters the impedance and admittance per unit-length of the line
in an element type (TypLne), as explained in the technical reference.
Frequency-dependent parameters model are defined instead in terms of geometrical data, i.e. the
tower geometries, conductor types, etc. The user enters the configuration of the transmission system
in a tower type (TypTow) or tower geometry type (TypGeo). In that case, a overhead line constant
routine will calculate the electrical parameters at a given frequency or frequency range. For the details
of the line constant calculation function, the reader is referred to the technical reference Overhead Line
Constants.
The ElmLne is element used to represent transmission lines/cables. It requires a reference either to a
line type TypLne, or a tower type TypTow or a tower geometry type TypGeo. The ElmLne can contain
line sections as presented in Chapter 9 Network Graphics, Section 9.3.2 (Defining Line Sections).
The description of the line model, is given in the attached Technical Reference Paper: Overhead Line
Models.
Object used to represent sections of lines or cables. It can refer to any of the types defined for
transmission lines or cables.
The ElmTow is used to represent electromagnetic coupling between transmission lines. In order to
define the line coupling, a TypTow/TeyGeo object determining the geometrical characteristics and the
conductor type of the structure where the coupled lines are located, is required.
The description of the line coupling model, presenting the relations among the input parameters is given
in the attached Technical Reference Paper: Overhead Line Models.
Type used to define transmission lines/cables, whose electrical parameters are known (no electromag-
netic coupling between conductors is calculated in this type).
The description of the line type model, presenting the relations among the input parameters is given in
the attached Technical Reference Paper: Overhead Line Models.
Both types are used to define the tower structure of a transmission line. If TypTow or TypGeo are
referred in an ElmLne, the coupling impedances and admittances of the line are calculated according
to the given geometrical distribution of the conductors. The tower type requires additionally a reference
to the conductor type.
While a tower type TypTow completely defines the overhead transmission system (i.e. defines the tower
geometry and the conductors), a tower geometry type TypGeo only contains information about the
It means then, the TypTow object contains the input data relevant for the calculation of the electrical
parameters (impedances and admittances) of the system, like the number of circuits, position of the
conductor at tower height -i.e. tower geometry-, transposition of the circuits if applicable and the data
of the phase and earth wires (if any) conductors (solid or tubular conductor, DC resistances, skin effect,
etc.).
It follows then that two overhead lines having the same tower geometry but different conductor types
would required two different TypTow objects in the library. This is likely to happen in distribution networks
where few different tower geometries are used in combination with a considerable amount of different
conductor types. To simplify the data input and handling in those cases, a tower geometry type can be
used instead.
Then the tower geometry type TypGeo contains the definition of the tower geometry only; hence the type
does not include any information about the conductor types. The user assigns the conductor types later
in the element, either in the line element ElmLne or line coupling element ElmTow. These combination
minimizes the data entry and allows for a flexible combination of tower geometries and conductor
types. Apart from the data entry, the resulting calculation model, hence the electrical parameters of
the transmission system, are in both case identical.
The description of the tower models, presenting the relations among the input parameters is given in
the attached Technical Reference Paper: Overhead Line Constants.
Type used to define conductor objects. A reference to a conductor type is required in the tower types
TypTow/TypGeo to define the conductors of the transmission line.
The description of the conductor type model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper:Overhead Line Constants.
The model of a cable system in PowerFactory builds on two types: firstly, a single-core cable type
(TypCab) defines the cross-section geometry, conducting and insulating layers and properties of the
materials of the single-core cable and secondly, a cable system type (TypCabsys) specifies the total
number of single-core cables in the system, hence the number of coupled cables, and the installation
characteristics, either buried directly underground or laid in pipes (a pipe-type cable).
The description of the cable system, presenting the relations among the input parameters and the
required types is given in the attached Technical Reference Paper: Cable Systems.
The description of the cable type model, presenting the relations among the input parameters is given
in the attached Technical Reference Paper: Cable Systems.
The ElmScap object represents series capacitances in PowerFactory . It can be used for various
applications, e.g.
The description of the Series Capacitor model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: Series Capacitor
The description of the series reactor model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: Series Reactor.
The description of the series RLD-filter model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: Series RLC-Filter.
The Common Impedance is a per unit impedance model including an ideal transformer. The main usage
is for branches used for network reduction.
The description of the common impedance model, presenting the relations among the input parameters
is given in the attached Technical Reference Paper: Common Impedance.
Object used to represent asynchronous machine models, requires a reference to a TypAsmo or TypAsm
(obsolete) object.
The description of the asynchronous machine model, presenting the relations among the input param-
eters is given in the attached Technical Reference Paper: Asynchronous Machine
Object used to represent doubly fed induction generators, requires a reference to a TypAsmo object.
Input parameters
The description of the double feed asynchronous machine model, presenting the relations among the
input parameters is given in the attached Technical Reference Paper: Doubly Fed Induction Machine
The Static Generator (ElmGenstat, ) is an easy-to-use model to represent any kind of non-rotating
generators. The common characteristic of these generators is that they are all connected to the grid
through a static converter and hence the name static generator. Typical applications are:
• Photovoltaic Generators
• Fuel Cells
• Storage devices
• HVDC Terminals
• Reactive Power Compensations
Wind generators, which are connected with a full-size converter to the grid, can be modelled as a static
generator as well, because the behaviour of the plant (from the view of the grid side) is determined by
the converter:
• Wind Generators
For a detailed description of the static generator model the reader is referred to the technical reference:
Static Generator
The Photovoltaic System element (ElmPvsys) is an easy-to-use model based on the Static Generator
element (ElmGenstat). The PV System element models an array of photovoltaic panels, connected to
the grid through a single inverter. The main difference with the static generator, is that the PV System
provides an option to automatically estimate the active power set point, given the geographical location,
date and time.
For a detailed description of the static generator model the reader is referred to the technical reference:
PV System
Object used to represent synchronous machine models, requires a reference to a TypSym object.
The description of the synchronous machine model, presenting the relations among the input parame-
ters is given in the attached Technical Reference Paper: Synchronous Machine
Object used to represent load models. Two different models are supported depending on the type
selection:
• General loads: requires a reference to a TypLod object (see technical reference: General Load
Model)
• Complex loads: requires a reference to a TypLodind object (see technical reference: Complex
Load Model)
The description of the low voltage load model, presenting the relations among the input parameters and
the required types is given in the attached Technical Reference Paper: Low Voltage Load
The description of the partial load model, presenting the relations among the input parameters and the
required types is given in the attached Technical Reference Paper: Partial Loads.
Objects used to represent motor driven machines. Three types of driven machine models are defined
in PowerFactory :
• ElmMdm__1 (Type 1)
• ElmMdm__3 (Type 3)
• ElmMdm__5 (Type 5)
All types of motor driven machine models may be used in connection with a synchronous or an asyn-
chronous motor.
The description of the motor driven machine models, presenting the relations among the parameters
and the connection to a motor, are given in the attached Technical Reference Paper: Motor Driven
Machine
The DC Machine element (ElmDcm) can be used to represent a direct-current generator or a direct-
current motor. This one-port element can be connected to dc terminals only. The DC Machine can be
used for Load Flow and DC Short-Circuit calculations and RMS and EMT simulations.
For a detailed description of the DC machine model the reader is referred to the technical reference:
DC Machine.
The description of the external network model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: External Grid
Object used for a PWM converter model. Represents a self-commutated, voltage sourced AC/DC
converter (capacitive DC circuit).
There are two rectifier/inverter models available in PowerFactory which differentiate from each other in
the number of DC connections:
The description of the PWM converter model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: PWM Converter
C.3.2 Rectifier/Inverter
There are two rectifier/inverter models available in PowerFactory which differentiate from each other in
the number of DC connections:
Rectifier models with a single DC connection, requires a reference to a Rectifier Type (TypRec) used to
define a 6 pulse bridge rectifier/inverter element with both 1-DC or 2-DC connections.
The description of the rectifier model, presenting the relations among the input parameters is given in
the attached Technical Reference Paper: 6-Pulse Bridge
The ElmVar object is used to represent voltage control, soft starter devises for induction motors. The
ElmVar does not require a type object.
The description of the soft starter model, presenting the relations among the input parameters is given
in the attached Technical Reference Paper: Soft Starter
The description of the DC/DC converter model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: DC/DC Converter
The description of the shunt/filter model, presenting the relations among the input parameters is given
in the attached Technical Reference Paper: Filter/Shunt
The description of the Tap Adjustment for this element is given in the attached Technical Reference
Paper: Tap Adjustment
The static var compensator system (ElmSvc) is a combination of a switched shunt capacitor bank and
a thyristor controlled inductive shunt reactance.
The description of the static var compensator, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: Static Var System
C.5 Controllers
The description of the Station Controller is given in the attached Technical Reference Paper: Station
Controller
The Station Controller is used for steady-state analysis. For time-domain simulation please use Com-
mon Models as described in Chapter 26: Stability and EMT Simulations, Section 26.8 (Models for
Stability Analysis).
The description of the Power Frequency Control is given in the attached Technical Reference Paper:
Power Frequency Control
C.6 Sources
The ElmVac is used to represent AC Voltage sources (single phase or three phase).
The description of the AC voltage source model, presenting the relations among the input parameters
and the possible types is given in the attached Technical Reference Paper: AC Voltage Source
The ElmVdc is used to represent DC Voltage sources (single phase or three phase).
The description of the AC voltage source model, presenting the relations among the input parameters
and the possible types is given in the attached Technical Reference Paper: DC Voltage Source
The ElmIac is used to represent AC Current sources (only three phase model is supported). The
description of the AC current source model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: AC Current Source
The description of the DC current source model, presenting the relations among the input parameters
is given in the attached Technical Reference Paper: DC Current Source
The Impulse Source element (ElmImpulse) is used to represent a lightning strike current waveform.
It is modelled in PowerFactory as a current impulse source. It is a single-phase, single-port element
and it can be connected to any AC terminal. The Impulse Source element is relevant mainly for EMT
(instantaneous values) simulations and for Unbalanced Load Flow calculation.
For a detailed description of the Impulse source model the reader is referred to the technical reference:
Impulse Source.
The DC battery element is based on the DC Voltage source element and provides additional features
specific for DC batteries (e.g. support to DC Short Circuit calculations, etc).
For a detailed description of the DC battery the reader is referred to the technical reference: DC Battery.
Fourier source element, used to generate periodical signals in the frequency domain.
The description of the Fourier source model, presenting the relations among the input parameters is
given in the attached Technical Reference Paper: Fourier Source
The description of the current measurement model, presenting the relations among the input parame-
ters is given in the attached Technical Reference Paper: Current Measurement
The description of the power measurement model, presenting the relations among the input parameters
is given in the attached Technical Reference Paper: Power Measurement
The description of the voltage measurement model, presenting the relations among the input parame-
ters is given in the attached Technical Reference Paper: Voltage Measurement
The description of the phase measurement device model, presenting the relations among the input
parameters is given in the attached Technical Reference Paper: Phase Measurement Device
The description of the measurement file element, presenting the functionality of the input parameters is
given in the attached Technical Reference Paper: Measurement File
The description of the clock model, presenting the relations among the input parameters is given in the
attached Technical Reference Paper: Clock
The ’Register’ (ElmReg) model in PowerFactory is a digital shifting register. With every rising edge of
the clock signal the values are shifted by one, then the output is set and the input is read and stored in
the register.
The complete description of the Register model is given in the attached Technical Reference Paper:
Register
The ’Sample and Hold’ model of PowerFactory (ElmSamp) samples a signal, setting the output at the
rising edge of a clock. The output value is constant up to the next clock pulse.
The complete description of the Sample and Hold model is given in the attached Technical Reference
Paper: Sample and Hold
The trigger model (ElmTrigger ) is used to monitor the value of a signal. If certain trigger conditions are
met the model will start a trigger event.
The complete description of the Trigger model is given in the attached Technical Reference Paper:
Trigger
The description of the fast Fourier transform model, presenting the relations among the input parameters
is given in the attached Technical Reference Paper: Fast Fourier Transformation
C.10 Miscellaneous
The NEC/NER (Neutral Earthing Conductor/Neutral Earthing Reactor) is the grounding element in
PowerFactory , does not require any type.
The description of the NEC/NER model, presenting the relations among the input parameters is given
in the attached Technical Reference Paper: Neutral Earthing Element
The complete description of the Surge Arrester model is given in the attached Technical Reference
Paper: Surge Arrester
DPL Reference
This table the list of all the Classes with the corresponding DPL Methods available for each Class. Each
method has a link to where it is declared and documented.
Class Index
ComDpl Execute
EchoOn
ComEcho
EchoOff
GetCreatedObjects
ComImport
GetModificdObjects
ComInc Execute
ReciveData
ComLink
SendData
CheckAssignments
Compare
CompareActive
ExecuteRecording
ExecuteWithActiveProject
GetCorrespondingObject
GetModification
GetModificationResult
GetmodifiedObjects
Merge
ComMerge PrintComparisionReport
PrintModifications
Reset
SetAutoAssignmentForAll
SetObjectsToCompare
ShowBrowser
WereModificationsFound
Class Method
AddRef
ComNmink Clear
GetAll
GetObject
ComOutage RemoveEvents
SetObjs
AnalyseElmRes
CreateFaultCase
RemoveEvents
ComRel3
RemoveOutage
Execute
ExportFullRange
ComRes
FileNmResNm
ComShc Execute
AddCntcy
Execute
ExecuteCntcy
ComSimoutage ReportObjs
Reset
SetLimits
Class Method
AddColumn
AddCurve
AddHeader
AddInvisibleFilter
AddListFilter
AddListFilterEntires
AddPlot
AddRow
AddTable
AddTextFilter
AddXLabel
DisableAutomaticRowNumbering
EnableAutomaticRowNumbering
SetBarLimits
SetCellAccess
SetCellEdit
SetCellValueToBar
SetCellValueToCheckbox
SetCellValueToDate
SetCellValueToDouble
ComTablereport SetCellValueToInt
SetCellValueToObject
SetCellValueToString
SetColumnHeader
SetCurveValue
SetDialogSize
SetListFilterSelection
SetNumberFormatForPlot
SetSorting
SetStatusText
SetTextAxisDistForPlot
SetTicksForPlot
SetTitle
ComUcteexp BuildNodeNames
ElmAsm GetAvailableGenPower
ElmAsmsc GetAvailableGenPower
ElmBay GetAll
IsSplitting
AddCubicle
ElmBoundary Clear
GetInterior
ElmComp Slotupd
Class Method
Close
GetRemoteBreakers
IsBreaker
ElmCoup IsClosed
IsOpen
Open
GetAll
GetBranches
GetBuses
ElmFeeder
GetNodesBranches
GetObjs
CreateFeederWithRoutes
FitParams
GetType
GetY0m
GetY1m
GetZ0m
GetZ1m
HasRoutes
ElmLne
HastFoutesOrSec
IsCable
IsNetCoupling
SetCorr
SetDetailed
Activate
ElmNet CalculateInterchangeTo
Deactivate
AddVars
Clear
Draw
Flush
GetObj
GetResData
Init
LoadResData
ReleaseResData
ResFirstValidObject
ResFirstValidObjectVar
ResFirstValidVar
ResIndex
ElmRes ResNextValidObject
ResNextValidObjectVar
ResNextValidVar
ResNval
ResNvars
SetAsDefault
Write
Class Method
WriteDraw
GetControlledHVNode
ElmStactrl GetControlledLVNode
GetSetupTransformer
GetSplit
GetSplitCal
GetSplitIndex
OverwriteRA
ElmSubstat ResetRA
SaveAsRA
SetRA
Disconnect
GetAvailableGenPower
ElmSym IsConnected
Reconnect
GetMinDistance
GetNextHVBus
ElmTerm IsElectrEquivalent
IsEquivalent
FitParams
ElmTow
PrintFreqDepParams
ElmTr IsQuadBooster
GetAll
GetBranches
GetBuses
ElmZone
GetNodes
GetObjs
Activate
IntCase Deactivate
Reduce
Clear
Contains
First
GetValue
Insert
IntDplmap Next
Remove
Size
Update
Class Method
Clear
Get
IndexOf
Insert
IntDplvec Remove
Size
Sort
IntEvt CreateCBEvents
SetText
IntForm
WriteOut
ColLbl
Get
Init
Invert
Multiply
NCol
IntMat NRow
Resize
RowLbl
Set
SortToColumn
AddVar
ClearVars
GetVar
NVars
IntMon PrintAllVal
PrintVal
RemoveVar
SetAdaptY
IntPlot SetAutoScaleY
SetScaleY
Activate
Deactivate
GetLatestVersion
HasExternalReferences
IntPrj Migrate
Purge
UpdateStatistics
GetProjectFolderType
IntPrjfolder
IsProjectFolderType
Class Method
Activate
Apply
Deactivate
IntScenario
GetObjects
Save
IntSstage Activate
GetCriticalTimePhase
IntThrating
GetRating
Purge
IntUser
SetPassword
CreateGroup
CreateUser
IntUseman GetGroups
GetUsers
Activate
IntVariant Deactivate
Reduce
Get
Init
Resize
IntVec
Set
Size
CreateDerivedProject
IntVersion
Rollback
Class Method
AddCopy
CreateObject
Delete
Edit
GetChildren
GetClass
GetConnectedElms
GetConnectionCount
GetContents
GetControlledNode
GetCubicle
GetFullName
GetNet
GetNode
GetOperator
GetOwner
GetParent
GetReferences
GetSize
GetUserAttribute
GetVal
HasResults
Inom
IsClass
IsEarthed
IsEnergized
IsInFeeder
IsNode
Object IsOutOfService
IsReducible
IsRelevant
lnm
MarkInGraphics
Move
PasteCopy
GetSystemGround
SetSize
SetVal
ShowFullName
ShowModalSelectTree
snm
StochEvt
unm
Unom
VarExists
Class Method
Add
Clear
Count
First
FirstFilt
Firstmatch
IsIn
MarkInGraphics
Next
NextFilt
Nextmatch
Obj
Set OutputFlexibleData
Remove
ShowModalBrowser
ShowModalSelectBrowser
ShowModelessBrowser
SortToClass
SortToName
SortToVar
AddPage
DoAutoScaleX
GetPage
SetAdaptX
SetAutoScaleX
SetResults
SetDesktop SetScaleX
SetXVar
Show
WriteWMF
GetAll
SetFeeder GetBranches
GetBuses
SetFilt Get
AdaptWidth
Aling
ChangeFont
ChangeFrameAndWidth
ChangeLayer
SetLevelvis
ChangeRefPoints
Mark
Reset
Class Method
AllBreakers
AllClosedBreakers
AllOpenBreakers
SetPath GetAll
GetBranches
GetBuses
AddRef
All
AllAsm
AllBars
AllBreakers
AllClosedBreakers
AllElm
AllLines
SetSelect AllLoads
AllOpenBreakers
AllSym
AllTypLne
Clear
GetAll
Date
SetTime
SetTime SetTimeUTC
Time
DoAutoScaleX
DoAutoScaleY
GetScaleObjX
GetVI
SetAdaptX
SetAutoScaleX
SetDefScaleX
SetVipage SetResults
SetScaleX
SetStyle
SetTile
SetXVar
AddBreaker
RemoveBreaker
StaCubic GetAll
GetConnectedMajorNodes
Close
IsClosed
StaSwitch IsOpen
Open
TypAsm CalcElParams
TypAsmo CalcElParams
Class Method
IsCable
TypLne
SetNomCur
Activate
Deactivate
NewStage
Variations
CreateStageObject
GetActiveScheduler
VisFft DoAutoScaleX
AddResVar
AddVars
Clear
DoAutoScaleX
DoAutoScaleY
GetScaleObjX
GetScaleObjY
SetAdaptX
SetAdaptY
SetAutoScaleX
VisPlot SetAutoScaleY
SetCrvDesc
SetDefScaleX
SetDefScaleY
SetScaleX
SetScaleY
SetXVar
VisPlot2 DoAutoScaleY2
This is the list of all documented methods and global functions in DPL. Each method is linked to the
class or header file where it is documented.
Function Class
AddCntcy ComSimoutage
AddColumn ComTablereport
AddCopy Object
AddCubicle ElmBoundary
AddCurve ComTablereport
AddHeader ComTablereport
AddInvisibleFilter ComTablereport
AddListFilter ComTablereport
AddListFilterEntires ComTablereport
AddPage ActiveCase
AddPlot ComTablereport
ComNmink
AddRef
SetSelect
AddResVars VisPlot
ElmRes
AddVars
VisPlot
AddXLabel ComTablereport
Aling SetLevelvis
All SetSelect
AllAsm SetSelect
AllBars SetSelect
SetPath
AllBreakers
SetSelect
SetPath
AllClosedBreakers
SetSelect
AllElm SetSelect
AllLines SetSelect
AllLoads SetSelect
SetPath
AllOpenBreakers
SetSelect
AllRelevant AllRelevant
AllSym SetSelect
AllTypLne SetSelect
AnalyseElmRes ComRel3
Apply IntScenario
BuildNodeNames ComUcteexp
TypAsm
CalcElParams
TypAsmo
CalculateInterchangeTo ElmNet
ChangeFont SetLevelvis
ChangeFrameAndWidth SetLevelvis
ChangeLayer SetLevelvis
ChangeRefPoints SetLevelvis
CheckAssignments SetLevelvis
Function Class
ComNmink
ElmRes
IntDplmap
IntDplvec
Set
Clear
SetSelect
VisPlot
ElmBoundary
ClearCommands Global
ClearOutput Global
ClearVars IntMon
ElmCoup
Close
StaSwitch
ColLbl IntMat
Compare ComMerge
CompareActive ComMerge
Contains IntDplmap
Count Set
CreateCBEvents IntEvt
CreateDerivedProject IntVersion
CreateFaultCase ComRel3
CreateFeederWithRoutes ElmLne
CreateGroup IntUserman
CreateObject Object
CreateStageObject Variations
CreateUser IntUserman
Date SetTime
ElmNet
IntCase
IntPrj
Deactivate IntScenario
IntScheme
IntVariant
Delete Object
DisableAutomaticRowNumbering ComTablereport
Disconnect ElmSym
SetDesktop
SetVisPage
DoAutoScaleX VisFft
VisPlot
SetVisPage
DoAutoScaleY
VisPlot
DoAutoScaleY2 VisPlot2
Draw ElmRes
EnableAutomaticRowNumbering ComTablereport
Error Global
Exe Global
Function Class
ComDpl
ComInc
ComLdf
Execute ComRel3
ComShc
ComSimoutage
ExecuteCntcy ComSimoutage
ExecuteRecording ComMerge
ExecuteWithActiveProject ComMerge
Exit Global
ExportFullRange ComRes
fclose Global
fflush Global
FileNmResNm ComRes
IntDplmap
First
Set
FirstFilt Set
Firstmatch Set
ElmLne
FitParams
ElmTow
Flush ElmRes
fopen Global
FormatDateLT FormatDateLT
FormatDateUCT FormatDateUCT
fprintf fprintf
fRand Global
fscanf Global
fscanfsep Global
fWrite Global
IntDplvec
IntMat
Get IntVec
SetFilt
GetActiveNetworkVariations GetActiveNetworkVariations
GetActiveProject GetActiveProject
GetActiveScenario GetActiveScenario
GetActiveScheduler Variations
GetActiveStages GetActiveStages
GetActiveStudyCase GetActiveStudyCase
Function Class
ComNmink
ElmBay
ElmFeeder
ElmZone
SetFeeder
GetAll
SetPath
SetSelect
StaCubic
ElmAsm
GetAvailableGenPower ElmAsmsc
ElmSym
GetBorderCubicles GetBorderCubicles
ElmFeeder
ElmZone
GetBranches SetFeeder
SetPath
ElmFeeder
ElmZone
GetBuses SetFeeder
SetPath
GetCaseCommand Global
GetCaseObject Global
GetChildren Object
GetClass Object
GetConnectedElms Object
GetConnectedMajorNodes StaCubic
GetConnectionCount Object
GetContents Object
GetControlledHVNode ElmStactrl
GetControlledLVNode ElmStactrl
GetControlledNode Object
GetCorrespondingObject ComMerge
GetCreatedObjects ComImport
GetCriticalTimePhase IntThrating
GetCubicle Object
GetDataFolder GetDataFolder
GetFlowOrientation Global
GetFullName Object
GetGlobalLib Global
GetGraphBoard GetGraphBoard
GetGroups IntUserman
GetInterior ElmBoundary
GetLanguage Global
GetLatestVersion IntPrj
GetLocalLib Global
GetMinDistance ElmTerm
GetModification ComMerge
Function Class
GetModificationResult ComMerge
ComImport
GetModifiedObjects
ComMerge
GetNet Object
GetNextHVBus ElmTerm
GetNode Object
GetNodes ElmZone
GetNodesBranches ElmFeeder
GetObj ElmRes
GetObject ComOutage
GetObjects InScenario
ElmFeeder
GetObjs
ElmZone
GetOperator Object
GetOwner Object
GetPage SetDesktop
GetPageLen Global
GetParent Object
GetPFVersion Global
GetProjectFolder Global
GetProjectFolderType IntPrjfolder
GetRating IntThrating
GetRecordingStage Global
GetReferences Object
GetRemoteBreakers ElmCoup
GetResData ElmRes
SetVisPage
GetScaleObjX
VisPlot
GetScaleObjY VisPlot
GetSettings Global
GetSystemGround Object
GetSize Object
GetSplit ElmSubstat
GetSplitCal ElmSubstat
GetSplitIndex ElmSubstat
GetSetupTransformer ElmStactrl
GetSystemTime Global
GetTime Global
GetType ElmLne
GetUserAttribute Object
GetUserManager Global
GetUsers IntUserman
GetVal Object
GetValue IntDplmap
GetVar IntMon
GetVersions IntPrj
GetVI SetVisPage
Function Class
GetY0m ElmLne
GetY1m ElmLne
GetZ0m ElmLne
GetZ1m ElmLne
HasExternalReferences IntPrj
HasResults Object
HasRoutes ElmLne
HastFoutesOrSec ElmLne
IndexOf IntDplvec
Info Global
ElmRes
Init IntMat
IntVec
Inom Object
IntDplmap
Insert
IntDplvec
Invert IntMat
IsBreaker ElmCoup
ElmLne
IsCable
TypLne
IsClass Object
ElmCoup
IsClosed
StaSwitch
IsConnected ElmSym
IsEarthed Object
IsElectrEquivalent ElmTerm
IsEnergized Object
IsEquivalent ElmTerm
IsIn Set
IsInFeeder Object
IsNetCoupling ElmLne
IsNode Object
ElmCoup
IsOpen
StaSwitch
IsOutOfService Object
IsProjectFolderType IntPrjfolder
IsQuadBooster ElmTr
IsReducible Object
IsRelevant Object
IsSplitting ElmBoundary
Inm Object
LoadResData ElmRes
Mark SetLevelvis
Object
MarkInGraphics
Set
Merge ComMerge
Migrate IntPrj
Function Class
Move Object
Multiply IntMat
NCol IntMat
IntDplmap
Next
Set
NewStage IntScheme
NextFilt Set
NextMatch Set
NoFinalUpdate NoFinalUpdate
NRow IntMat
NVars IntMon
Obj Set
ElmCoup
Open
StaSwitch
OutputFlexibleData Set
OverwriteRA ElmSubstat
ParseDateLT Global
ParseDateUTC Global
PasteCopy Object
PostCommand Global
PrintAllVal IntMon
PrintComparisionReport ComMerge
printf Global
PrintFreqDepParams ElmTow
PrintModifications ComMerge
PrintVal IntMon
IntPrj
Purge
IntUser
Random Random
Rebuild Rebuild
ReceiveData ComLink
Reconnect ElmSym
IntCase
Reduce
IntVariant
ReleaseResData ElmRes
IntDplmap
Remove IntDplvec
Set
ComOutage
RemoveEvents
ComRel3
RemoveBreaker StaCubic
RemoveOutages ComRel3
RemoveVar IntMon
ReportObjs ComSimoutage
ComMerge
Reset ComSimoutage
SetLevelvis
Function Class
ResetCalculation Global
ResetRA ElmSubstat
ResFirstValidObject ElmRes
ResFirstValidObjectVar ElmRes
ResFirstValidVar ElmRes
ResIndex ElmRes
IntMat
Resize
IntVec
ResNextValidObject ElmRes
ResNextValidObjectVar ElmRes
ResNextValidVar ElmRes
ResNvar ElmRes
ResNvars ElmRes
Rollback IntVersion
RowLbl IntMat
Save IntScenario
SaveAsRA ElmSubstat
SaveScenarioAs Global
SearchObjectByForeignKey Global
SendData ComLink
IntMat
Set
IntVec
SetDesktop
SetAdaptX SetVisPage
VisPlot
IntPlot
SetAdaptY
VisPlot
SetAsDefault ComRes
SetAutoAssignmentForAll ComMerge
SetDesktop
SetAutoScaleX SetVisPage
VisPlot
IntPlot
SetAutoScaleY
VisPlot
SetBarLimits ComTablereport
SetCellAccess ComTablereport
SetCellEdit ComTablereport
SetCellValueToBar ComTablereport
SetCellValueToCheckbox ComTablereport
SetCellValueToDate ComTablereport
SetCellValueToDouble ComTablereport
SetCellValueToInt ComTablereport
SetCellValueToObject ComTablereport
SetCellValueToString ComTablereport
SetColumnHeader ComTablereport
SetConsistencyCheck SetConsistencyCheck
SetCorr ElmLne
Function Class
SetCrvDesc VisPlot
SetCurvevalue ComTablereport
SetVisPage
SetDefScaleX
VisPlot
SetDefScaleY VisPlot
SetDetailed ElmLne
SetDialogSize ComTablereport
SetDiffMode Global
SetGraphicUpdate Global
SetLimits ComSimoutage
SetLineFeed Global
SetListFilterSelection ComTablereport
SetNomCurr TypLne
SetNumberFormatForPlot ComTablereport
SetObjectsToCompare ComMerge
SetObjs ComOutage
SetOutputWindowState Global
SetPassword IntUser
SetRA ElmSubstat
SetRandSeed Global
SetDesktop
SetResults
SetVisPage
SetDesktop
SetScaleX SetVisPage
VisPlot
IntPlot
SetScaleY
VisPlot
SetShowAllUsers Global
SetSize Object
SetSorting ComTablereport
SetStatusText ComTablereport
SetStyle SetVisPage
SetText IntForm
SetTextAxisDistForPlot ComTablereport
SetTicksForPlot ComTablereport
SetTile SetVisPage
SetTime Global
SetTimeUTC SetTime
SetTitle ComTablereport
SetVal Object
SetDesktop
SetXVar SetVisPage
VisPlot
Show SetDesktop
ShowBrowser ComMerge
ShowFullName Object
ShowModalBrowser Set
Function Class
ShowModalSelectBrowser Set
ShowModalSelectTree Object
ShowModelessBrowser Set
IntDplmap
Size IntDplvec
IntVec
Slotupd ComMerge
snm Object
Sort IntDplvec
SortToClass Set
SortToColumn IntMat
SortToName Set
SortToVar Set
sprintf Global
sscanf Global
sscanfsep Global
StochEvt Object
strchg Global
strcmp Global
strcpy Global
strftime Global
strlen Global
strstr Global
strtok Global
SummaryGrid SummaryGrid
SetTime Time
ToStr Global
unm Object
Unom Object
Update IntDplmap
UpdateStatistics IntPrj
validLDF Global
validLDF Global
validRMS Global
validSHC Global
validSIM Global
VarExists Object
Warn Global
WereModificationsFound ComMerge
ElmRes
Write
Output Window
WriteDraw ElmRes
WriteOut IntForm
WriteWMF SetDesktop
D.3.1 Object
The following list is an overview of all functions and methods which are available for all objects.
D.3.1.1 object.AddCopy
object object.AddCopy (set aSet | object aObj [, string | int NM1, ...])
Copies a single object or a set of objects to the target object. “Fold.AddCopy(aObj)" copies object
'aObj'into the target object 'Fold', “Fold.AddCopy(aSet)" copies all objects in 'aSet'to “Fold".
“Fold.AddCopy(aObj, nm1, nm2, ...)" will copy aObj and rename it to the result of the concatenation of
'nm1', 'nm2', etc.
The target object must be able to receive a copy of the objects. The function “Fold.AddCopy(aObj,...)"
returns the copy of “aObj", “Fold.AddCopy(aSet)" returns “Fold", when the copy operation was success-
ful. A “NULL" object is returned otherwise.
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.
Arguments:
Return value:
Example:
The following example copies a fuse to a set of cubicles. The copies will be named “Fuse Nr.0", “Fuse
Nr.1", etc.
while (target) {
copy = target.AddCopy(aFuse, 'Fuse Nr', n);
if (copy) copy.ShowFullName();
target = Cubs.Next();
}
D.3.1.2 object.CreateObject
Creates a new object of class 'ClassNm'in the target object. The target object must be able to receive an
object of the given class. A fatal DPL error will occur when this is not the case, causing the running DPL
command to exit. “Fold.CreateObject(aClass, nm1, nm2, ...)" will create a new object of class aClass
and name it to the result of the concatenation of 'nm1', 'nm2', etc.
Arguments:
Return value:
Example:
The following example creates a fuse in a set of cubicles. The new fuses will be named “Fuse Nr.0",
“Fuse Nr.1", etc.
object target;
set Cubs;
int n;
Cubs = SEL.GetAll('StaCubic');
target = Cubs.First();
n = 0;
while (target) {
target.CreateObject('RelFuse', 'Fuse Nr', n);
target = Cubs.Next();
n+=1;
}
D.3.1.3 Delete
Deletes an object or a set of objects from the database. The objects are not destroyed but are moved
to the recycle bin.
Arguments:
Return value: