master:datatap parametersPSCAD Scalar/Array Tap

Every parameter of the PSCAD Scalar/Array Tap (master:datatap): 6 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:datatap is

Scalar/Array Tap, a component of PSCAD's Master Library, filed under meters and output.

Definition
master:datatap
PSCAD name
Scalar/Array Tap
Category
Meters and output
Parameters
6, in 1 group
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:datatap 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:datatap"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["Dim"]))            # Dimension (Enter 1 for Scalar)

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

Configuration

ParameterUnitDefaultDescription
DimInteger·1Dimension (Enter 1 for Scalar)Range 1 to 999
DispChoice·YESDisplay Index?Select Yes to display indexWritten as NO (No), YES (Yes)
IndexInteger·1Start at Index NumberStarting index of sub-array or the index of the scalar outputRange 1 to 999
NameText··Name for IdentificationEnter a name for identification
StyleChoice·STRAIGHT_LINELine StyleSelect straight line or arcWritten as STRAIGHT_LINE (Straight Line), ARC (Arc)
TypeChoice·REALInput Data TypeSelect from Logical, Integer, Real or ComplexWritten as LOGICAL (Logical), INTEGER (Integer), REAL (Real), COMPLEX (Complex)

Related

← master:sig_gen Sawtooth Generator · master:rms-inst Single Phase RMS Meter →