master:trip_polygon parametersPSCAD Trip Polygon
Every parameter of the PSCAD Trip Polygon (master:trip_polygon): 18 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:trip_polygon is
Trip Polygon (Trip polygon), a component of PSCAD's Master Library, filed under control blocks.
- Definition
master:trip_polygon- PSCAD name
- Trip Polygon
- Category
- Control blocks
- Parameters
- 18, in 2 groups
- Read from
- PSCAD 5.0.0, 2026-11-07
Read and write master:trip_polygon 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:trip_polygon"): # the exact definition, namespace first
params = comp.parameters() # every parameter, as PSCAD holds it
print(str(params["x1"])) # Point 1 - X coordinate
comp = project.find_all("master:trip_polygon")[0]
comp.parameters(x1="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 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, "x1") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.
Main Data
| Parameter | Unit | Default | Description |
|---|---|---|---|
NameText | · | · | Name for IdentificationEnter a name for identification |
NptsChoice | · | 4 | Number of Points in the PolygonWritten as 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8 |
(X,Y) coordinates of the points
| Parameter | Unit | Default | Description |
|---|---|---|---|
x1Real | · | 1.0 | Point 1 - X coordinateRange -1000 to 1000 |
x2Real | · | 1.0 | Point 2 - X coordinateRange -1000 to 1000 |
x3Real | · | 1.0 | Point 3 - X coordinateRange -1000 to 1000 |
x4Real | · | 1.0 | Point 4 - X coordinateRange -1000 to 1000Used when (Npts>3) |
x5Real | · | 1.0 | Point 5 - X coordinateRange -1000 to 1000Used when (Npts>4) |
x6Real | · | 1.0 | Point 6 - X coordinateRange -1000 to 1000Used when (Npts>5) |
x7Real | · | 1.0 | Point 7 - X coordinateRange -1000 to 1000Used when (Npts>6) |
x8Real | · | 1.0 | Point 8 - X coordinateRange -1000 to 1000Used when (Npts>7) |
y1Real | · | 1.0 | Point 1 - Y coordinateRange -1000 to 1000 |
y2Real | · | 1.0 | Point 2 - Y coordinateRange -1000 to 1000 |
y3Real | · | 1.0 | Point 3 - Y coordinateRange -1000 to 1000 |
y4Real | · | 1.0 | Point 4 - Y coordinateRange -1000 to 1000Used when (Npts>3) |
y5Real | · | 1.0 | Point 5 - Y coordinateRange -1000 to 1000Used when (Npts>4) |
y6Real | · | 1.0 | Point 6 - Y coordinateRange -1000 to 1000Used when (Npts>5) |
y7Real | · | 1.0 | Point 7 - Y coordinateRange -1000 to 1000Used when (Npts>6) |
y8Real | · | 1.0 | Point 8 - Y coordinateRange -1000 to 1000Used when (Npts>7) |
Related
← master:trig Trignometric Functions · master:trv TRV Envelope Generator →