AnalysisResultSchema.SetUnits
Method
Description:
Sets names and multipliers of all units for result visualization
Sets names and multipliers of all units for result visualization
Examples
IList<string> unitNames = new List<string>();
unitNames.Add("Feet");
unitNames.Add("Inches");
IList<double> multipliers = new List<double>();
multipliers.Add(1);
multipliers.Add(12);
AnalysisResultSchema resultSchema = new AnalysisResultSchema("Schema Name", "Description");
resultSchema.SetUnits(unitNames, multipliers);
Parameters
Parameter | Type | Description |
---|---|---|
names | IList | Unit names for all units (e.g., "Lb" and "Kg") |
multipliers | IList | Numerical coefficients mapped to unit names. They adjust measurement values shown in the legend and display (e.g., 1.0 and 0.451 - if actual measurements are in Lb) |
Return Value
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | A non-optional argument was null |
ArgumentsInconsistentException | names is zero-length or contains duplicate or empty names -or- multipliers contains non-positive numbers, or its length is not equal to the length of names |