Click or drag to resize

SIToScaledString(Double, String, String, String, Int32, Double, Double) Method

Turns the given number of units into a textual representation with an appropriate unit scaling given string array of factor names or symbols.

Namespace: GSF.Units
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax
public static string ToScaledString(
	double totalUnits,
	string format,
	string unitName,
	string[] symbolNames,
	int decimalPlaces = -1,
	double minimumFactor = 1E-24,
	double maximumFactor = 1E+24
)
View Source

Parameters

totalUnits  Double
Total units to represent textually.
format  String
A numeric string format for scaled totalUnits.
unitName  String
Name of unit display (e.g., you could use "m/h" for meters per hour).
symbolNames  String
SI factor symbol or name array to use during textual conversion.
decimalPlaces  Int32  (Optional)
Optional number of decimal places to display.
minimumFactor  Double  (Optional)
Optional minimum SI factor. Defaults to Yocto.
maximumFactor  Double  (Optional)
Optional maximum SI factor. Defaults to Yotta.

Return Value

String
A String representation of the number of units.
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionminimumFactor or maximumFactor is not defined in Factors array.
Remarks
The symbolNames array needs one string entry for each defined SI item ordered from least (Yocto) to greatest (Yotta), see Names or Symbols arrays for examples.
See Also