Add Numeric Parameter Method
- Updated2022-11-22
- 1 minute(s) read
Add Numeric Parameter Method
AddNumericParameter adds a numeric parameter to the metadata object property parameters in the data log. These parameters document test conditions that apply to a measurement taken during the test run. If a parameter with the same name has already been added, the parameter value is replaced.
using (SetMetadata data = run.LogAppendedMetadata())
{
data.AddNumericParameter("Voltage", 5, "V") # with unit;
...
}
Note Specifying the unit of measure is optional when using the
AddNumericParameter
function.
data.AddNumericParameter("IForce", 12) # without unit | Parameter | Required? | Data Type | Description |
|---|---|---|---|
| parameterName | Yes | String | Name of the numeric parameter to add. If parameterName is set to an existing value, this method will overwrite the existing parameter. |
| parameterValue | Yes | Double | Value of the numeric parameter to add. |
| parameterUnit | No | String | Unit of measure for the numeric parameter. |