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

Turns the given number of units into a textual representation with an appropriate unit scaling.

Definition

Namespace: Gemstone.Units
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.128 -- Release Build+d050cfc5563c89a1188cc3c6b2d417530856f490

C#View Source Request Example

public static string ToScaledString(
	double totalUnits,
	int decimalPlaces,
	string unitName,
	string[]? symbolNames = null,
	double minimumFactor = 1E-24,
	double maximumFactor = 1E+24
)

VBView Source Request Example

Public Shared Function ToScaledString ( 
	totalUnits As Double,
	decimalPlaces As Integer,
	unitName As String,
	Optional symbolNames As String() = Nothing,
	Optional minimumFactor As Double = 1E-24,
	Optional maximumFactor As Double = 1E+24
) As String

C++View Source Request Example

public:
static String^ ToScaledString(
	double totalUnits, 
	int decimalPlaces, 
	String^ unitName, 
	array<String^>^ symbolNames = nullptr, 
	double minimumFactor = 1E-24, 
	double maximumFactor = 1E+24
)

JavaScriptView Source Request Example

Gemstone.Units.SI.ToScaledString = function(totalUnits, decimalPlaces, unitName, symbolNames, minimumFactor, maximumFactor);

Parameters

totalUnits Double: Total units to represent textually.
decimalPlaces Int32: Number of decimal places to display.
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

String
A String representation of the number of units.

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.

Exceptions

ArgumentOutOfRangeException	decimalPlaces cannot be negative.
ArgumentOutOfRangeException	minimumFactor or maximumFactor is not defined in Factors array.