master:sampler parametersPSCAD Sampler

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

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

Related

• All 345 definitions in the component reference
• PSCAD automation with Python: getting started

← master:sandhdefn Sample and Hold · master:complex Second Order Complex Pole →