master:stop parametersPSCAD Programmable stop

Every parameter of the PSCAD Programmable stop (master:stop): 2 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:stop is

Programmable stop, a component of PSCAD's Master Library, filed under other components.

Definition
master:stop
PSCAD name
Programmable stop
Category
Other components
Parameters
2, in 1 group
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:stop 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:stop"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["FINTYPE"]))        # stop method

comp = project.find_all("master:stop")[0]
comp.parameters(FINTYPE="SIMULATION")    # a Choice is written as its symbol
  • 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, "FINTYPE") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.

Configuration

ParameterUnitDefaultDescription
FINTYPEChoice·THIS_RUN_AND_CONTINUEstop methodChoose to stop a single run in a multiple run situation (if applicable) or stop the simulationWritten as THIS_RUN_AND_CONTINUE (Stop this run and continue), SIMULATION (Stop simulation)
NameText··Name for IdentificationEnter a name for identification

Related

← master:pi-section pi-section · master:pt1 PT - Lucas Model →