Read access to the value and unit of a parameter of an object. Read/write access to the value and unit of a parameter of the current formula.
Syntax
Object.parameters[Name]
or
this.parameters[Name] = Data
The syntax of the parameters property consists of the following elements:
Part |
Description |
|---|---|
Object |
The object that is accessed. Use this to access the current formula. |
Name |
Required. A string with the name of the parameter. |
Data |
A flexpro.Data object with a scalar value that can have units and is to be assigned to the parameter. |
Availability
FlexPro Professional, Developer Suite
Notes
The parameters property provides a Python dictionary. Its elements are flexpro.PhysValue objects with the properties value and unit.
If a parameter with this name does not yet exist when a parameter is written to, it is created automatically.
Write access to the header information of a data object is only permitted for the formula in which the Python code is located. Instead of using write access, you should preferably edit the attribute on the General tab of the Properties dialog box.
Examples
flexpro.object(r'.\\').parameters["Calibration Value"].value |
Accesses a parameter with the name "Calibration Value", which is saved in the folder in which the formula is located. |
flexpro.object(r'.\\').parameters["Calibration value"].unit |
Accesses the unit of the "Calibration Value" parameter. |
this.parameters["Calibration Value"] = flexpro.Data(1.3, "dB") |
Assigns the value 1.3 dB to the "Calibration Value" parameter. |