master:impulse parametersPSCAD Impulse Generator

Every parameter of the PSCAD Impulse Generator (master:impulse): 6 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:impulse is

Impulse Generator (Impulse Generator /w Interpolation), a component of PSCAD's Master Library, filed under control blocks.

Definition
master:impulse
PSCAD name
Impulse Generator
Category
Control blocks
Parameters
6, in 1 group; 2 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:impulse in Python

import mhi.pscad

pscad = mhi.pscad.connect()              # the PSCAD that is open; launch() starts one
project = pscad.project("my_case")       # a case loaded in the workspace

for comp in project.find_all("master:impulse"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["F"]))              # Frequency of Impulse Train, in Hz

comp = project.find_all("master:impulse")[0]
comp.parameters(F="4 [Hz]")              # a value that carries a unit is written with it
  • A parameter is named exactly as in the table, letter case included: parameters() gives every one of them in a dictionary, and a name the component does not have is refused.
  • A value that carries a unit comes back as a number whose unit is only in its text, so read it as text first (str(...)) or the unit is lost. PSCAD keeps a written unit as it is given: "2500 [mohm]" stays in mohm.
  • A Choice is read and written as its symbol (the capitals in "Written as"), not as the words PSCAD shows in the dialog.
  • find_all() takes the exact definition only. A wildcard or a bare name without master: comes back empty; the Builder's px_find walks the pages for those.

The Builder's runtime does the same with the unit handled for you: px_get(comp, "F") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.

Configuration

ParameterUnitDefaultDescription
CnfgChoice·UNITSHeight inIf Heignt in impulses selected, the height will be given as the height of impulse divided by time step. Otherwise simply as the height of impulse.Written as UNITS (Units), IMPULSES (Impulses)
FRealHz2Frequency of Impulse TrainNumber of impulses per second. A value of zero will result in only one impulse at the time of the first impulse.At least 1E-307
INTRChoice·DISABLEDInterpolation CompatibilityWritten as DISABLED (Disabled), ENABLED (Enabled)
MagReal·1.0Height of ImpulseEnter the magnitude of the impulseAt least 0
NameText··Name for IdentificationEnter a name for identification
StartReals0Time of First ImpulseEnter the time at which the first impulse will occurAt least 0

Related

← master:hysteresis_reactor Hysteresis Reactor · master:consti Integer Constant →