Instance Method インスタンスメソッド

unitString(fromJoules:usedUnit:)

Returns the unit string for the provided value. 提供された値に対する単位文字列を返します。

Declaration 宣言 

func unitString(fromJoules numberInJoules: Double, 
       usedUnit unitp: UnsafeMutablePointer<EnergyFormatter.Unit>?) -> String

Parameters パラメータ

numberInJoules

The energy value in joules. ジュールでのエネルギー値。

unitp

An output parameter. This will hold the EnergyFormatter.Unit value that corresponds to the returned units. 出力パラメータ。これは返される単位に対応する、EnergyFormatter.Unit値を保持します。

Return Value 戻り値

A localized string representing the unit. 単位を表しているローカライズされた文字列。

Discussion 議論

This method selects the correct unit based on the formatter’s locale, the magnitude of the value, and the isForFoodEnergyUse property. このメソッドは、フォーマッタの持つロケール、値の規模、そしてisForFoodEnergyUseプロパティに基づいて正しい単位を選択します

See Also 参照

Formatting Energy Strings エネルギー文字列を書式設定する

var isForFoodEnergyUse: Bool
A Boolean value that indicates whether the energy value is used to measure food energy. エネルギー値が食物エネルギーを測定するために使われるかどうかを指し示すブール値。
func getObjectValue(AutoreleasingUnsafeMutablePointer<AnyObject?>?, for: String, errorDescription: AutoreleasingUnsafeMutablePointer<NSString?>?) -> Bool
This method is not supported for the NSEnergyFormatter class. このメソッドは、NSEnergyFormatterクラスに対してサポートされません。
var numberFormatter: NumberFormatter!
The number formatter used to format the numbers in energy strings. エネルギー文字列の中の数値を書式設定するために使われる数値フォーマッタ。
func string(fromJoules: Double) -> String
Returns an energy string for the provided value. 提供された値に対するエネルギー文字列を返します。
func string(fromValue: Double, unit: EnergyFormatter.Unit) -> String
Returns a properly formatted energy string for the given value and unit. 与えられた値と単位に対して適切に書式設定されたエネルギー文字列を返します。
func unitString(fromValue: Double, unit: EnergyFormatter.Unit) -> String
Returns the unit string based on the provided value and unit. 提供された値と単位に基づく単位文字列を返します。
var unitStyle: Formatter.UnitStyle
The unit style used by this formatter. フォーマッタによって使われる単位スタイル。