SIToScaledString(Double, 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.147 -- Release Build+759c9d29b79c81f10905de8f58b653be932045f0

C#View Source Request Example

public static string ToScaledString(
	double totalUnits,
	string format,
	string unitName,
	double minimumFactor = 1E-24,
	double maximumFactor = 1E+24
)

VBView Source Request Example

Public Shared Function ToScaledString ( 
	totalUnits As Double,
	format As String,
	unitName As String,
	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, 
	String^ format, 
	String^ unitName, 
	double minimumFactor = 1E-24, 
	double maximumFactor = 1E+24
)

JavaScriptView Source Request Example

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

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).
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

Symbols array is used for displaying SI symbol prefix for unitName.

Exceptions

ArgumentOutOfRangeException

minimumFactor or maximumFactor is not defined in Factors array.