master:realpole parametersPSCAD Real Pole

Every parameter of the PSCAD Real Pole (master:realpole): 10 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:realpole is

Real Pole, a component of PSCAD's Master Library, filed under control blocks.

Definition
master:realpole
PSCAD name
Real Pole
Category
Control blocks
Parameters
10, in 3 groups; 1 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

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

comp = project.find_all("master:realpole")[0]
comp.parameters(T="0.002 [s]")           # 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, "T") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.

Configuration

ParameterUnitDefaultDescription
COMText·Real_PoleFortran CommentOptional comment line for the source code generated
DimInteger·1Dimensiondimension of input/output signalsRange 1 to 2147483647
LimitChoice·NOLimit Output?Select Yes to enable non windup limitsWritten as NO (No), YES (Yes)
NameText··Name for IdentificationEnter a name for identification
ResetChoice·NEVERResetable ?Select when to enable resetWritten as NEVER (Never), ANYTIME (Anytime), TIMEZERO (Timezero)
YOReal·0.0Reset ValueOutput when the reset is enabledUsed when Reset!=0

Main Data

ParameterUnitDefaultDescription
GReal·1.0Gain
TReals0.001Time ConstantAt least 1E-20

Limits

ParameterUnitDefaultDescription
MaxReal·10.0MaximumUsed when (Limit==1)
MinReal·-10.0MinumumUsed when (Limit==1)

Related

← master:const Real Constant · master:Zrealpole Real Pole →