master:pgb parametersPSCAD Output Channel
Every parameter of the PSCAD Output Channel (master:pgb): 11 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:pgb is
The output channel: what makes a signal recorded in the run's output files and plottable on a graph. Its title is the name a script reads the channel by.
- Definition
master:pgb- PSCAD name
- Output Channel
- Category
- Meters and output
- Parameters
- 11, in 1 group
- Read from
- PSCAD 5.0.0, 2026-11-07
Most used master:pgb parameters
| Parameter | Unit | Description |
|---|---|---|
Name | · | Titlethe title, which is the channel name a script reads |
Units | · | Unit |
Scale | · | Scale Factormultiplies the signal before it is recorded |
enab | · | Transfer Data?NO: not written to the output files |
mrun | · | Multiple Run Savewhat is kept across a multiple run |
Read and write master:pgb 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:pgb"): # the exact definition, namespace first
params = comp.parameters() # every parameter, as PSCAD holds it
print(str(params["Name"])) # Title
comp = project.find_all("master:pgb")[0]
comp.parameters(Name="Vbus") # write one parameter- 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 withoutmaster:comes back empty; the Builder'spx_findwalks the pages for those.
The Builder's runtime does the same with the unit handled for you: px_get(comp, "Name") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.
Configuration
| Parameter | Unit | Default | Description |
|---|---|---|---|
DisplayChoice | · | YES | Display Title on Icon?Select Yes or No to display the Title directly on the component graphic.Written as NO (No), YES (Yes) |
GroupText | · | · | GroupEnter the name of the Runtime Object Group, to which this component is to belong (default is blank). |
MaxReal | · | 2.0 | Default Maximum Display LimitEnter a value to control the maximum display limit on devices. |
MinReal | · | -2.0 | Default Minimum Display LimitEnter a value to control the minimum display limit on devices |
NameText | · | Value | TitleTitle is used for display on plots, meters,...Used when UseSignalName==0 |
PolChoice | · | NO | Is Input in Polar Form?Paired array with an even dimension (i.e. 2, 4, 6, etc.) Scaling is applied only to the odd elements.Written as NO (No), YES (Yes) |
ScaleReal | · | 1.0 | Scale FactorThe input is multiplied by this value before it is recorded. |
UnitsText | · | · | UnitUnit is used for display on plots and meters: pu,kA,... |
UseSignalNameChoice | · | YES | Use Signal Name as Title?If enabled, the output channel will assume the name of the signal, to which it is connected. The signal name is generic and is assigned by the upon compilation of the module. Note that if left enabled, the output channel name will continue to dynamically change with the signal name.Written as NO (No), YES (Yes) |
enabChoice | · | YES | Transfer Data?Enable or disable the transfer of plotting data between EMTDC and PSCAD. If No is selected, this output channel will not request data transfer from EMTDC. Disabling helps to reduce redundant memory usage during runtime. It will still be saved if recording output files, although on-line plotting is disabled.Written as NO (No), YES (Yes) |
mrunChoice | · | LAST_RUN_ONLY | Multiple Run SaveSave output during multiple run for each run or only the last run.Written as LAST_RUN_ONLY (Last run only), ALL_RUNS (All runs) |
Related
- All 345 definitions in the component reference
- Build and run a PSCAD case from Python
- PSCAD automation with Python: getting started
← master:nodeloop Node Loop · master:phasediff Phase Difference →