master:harmdiffmag parametersPSCAD Harmonics Generator
Every parameter of the PSCAD Harmonics Generator (master:harmdiffmag): 6 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:harmdiffmag is
Harmonics Generator (Harmonics with different magnitudes), a component of PSCAD's Master Library, filed under meters and output.
- Definition
master:harmdiffmag- PSCAD name
- Harmonics Generator
- Category
- Meters and output
- Parameters
- 6, in 1 group; 1 carry a unit
- Read from
- PSCAD 5.0.0, 2026-11-07
Read and write master:harmdiffmag 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:harmdiffmag"): # the exact definition, namespace first
params = comp.parameters() # every parameter, as PSCAD holds it
print(str(params["f"])) # Base Frequency, in Hz
comp = project.find_all("master:harmdiffmag")[0]
comp.parameters(f="120 [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 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, "f") 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 |
|---|---|---|---|
DataEntryChoice | · | THROUGH_PORTS | Data Input FormWritten as THROUGH_PORTS (Through ports), SPECIFIED_IN_FILE (Specified in a file) |
FileText | · | · | FilenameUsed when DataEntry==1 |
FilePathChoice | · | ABSOLUTE | Path to the FileWritten as ABSOLUTE (Absolute), RELATIVE (Relative)Used when DataEntry==1 |
NameText | · | · | Name |
dimInteger | · | 1 | Number of HarmonicsRange 1 to 2147483647 |
fReal | Hz | 60.0 | Base FrequencyAt least 1 |
Related
- All 345 definitions in the component reference
- Harmonics and THD from a PSCAD run
- PSCAD automation with Python: getting started
← master:phasorimp Harmonic Impedance · master:multimeter Multimeter →