|
SIToScaledString(Double, String, String, Double, Double) Method
|
Turns the given number of units into a textual representation with an appropriate unit scaling.
Namespace: GSF.UnitsAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.248-beta+a497a19de709fd99e2448886199a2c8824265ddf
Syntaxpublic static string ToScaledString(
double totalUnits,
string unitName,
string[] symbolNames = null,
double minimumFactor = 1E-24,
double maximumFactor = 1E+24
)
Public Shared Function ToScaledString (
totalUnits As Double,
unitName As String,
Optional symbolNames As String() = Nothing,
Optional minimumFactor As Double = 1E-24,
Optional maximumFactor As Double = 1E+24
) As String
public:
static String^ ToScaledString(
double totalUnits,
String^ unitName,
array<String^>^ symbolNames = nullptr,
double minimumFactor = 1E-24,
double maximumFactor = 1E+24
)
static member ToScaledString :
totalUnits : float *
unitName : string *
?symbolNames : string[] *
?minimumFactor : float *
?maximumFactor : float
(* Defaults:
let _symbolNames = defaultArg symbolNames null
let _minimumFactor = defaultArg minimumFactor 1E-24
let _maximumFactor = defaultArg maximumFactor 1E+24
*)
-> string
GSF.Units.SI.ToScaledString = function(totalUnits, unitName, symbolNames, minimumFactor, maximumFactor);
View SourceParameters
- totalUnits Double
- Total units to represent textually.
- unitName String
- Name of unit display (e.g., you could use "m/h" for meters per hour).
- symbolNames String (Optional)
- Optional SI factor symbol or name array to use during textual conversion, defaults to Symbols.
- minimumFactor Double (Optional)
- Optional minimum SI factor. Defaults to Yocto.
- maximumFactor Double (Optional)
- Optional maximum SI factor. Defaults to Yotta.
Return Value
StringA
String representation of the number of units.
ExceptionsException | Condition |
---|
ArgumentOutOfRangeException | minimumFactor 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