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

ordinality(of:in:for:)

Returns, for a given absolute time, the ordinal number of a smaller calendar unit (such as a day) within a specified larger calendar unit (such as a week). 与えられた絶対時間に対して、指定されたより大きいカレンダー単位(例えば週)内のより小さいカレンダー単位(例えば日にち)の順序数を返します。

Declaration 宣言

func ordinality(of smaller: NSCalendar.Unit, 
             in larger: NSCalendar.Unit, 
            for date: Date) -> Int

Parameters パラメータ

smaller

The smaller calendar unit より小さいカレンダー単位

larger

The larger calendar unit より大きいカレンダー単位

date

The absolute time for which the calculation is performed それに対して計算が実行される絶対時間。

Return Value 戻り値

The ordinal number of smaller within larger at the time specified by date. Returns NSNotFound if larger is not logically bigger than smaller in the calendar, or the given combination of units does not make sense (or is a computation which is undefined). dateによって指定された時間でのlargerの内部のsmallerの順序数。NSNotFoundを返します、もしそのカレンダーにおいてlargersmallerより論理的に大きくない、または与えられた単位の組み合わせが意味をなさない(またははっきりしない計算結果である)ならば。

Discussion 議論

The ordinality is in most cases not the same as the decomposed value of the unit. Typically return values are 1 and greater. For example, the time 00:45 is in the first hour of the day, and for units Hour and Day respectively, the result would be 1. An exception is the week-in-month calculation, which returns 0 for days before the first week in the month containing the date. 順序性は、たいていの場合はその単位の分解された値と同じではありません。一般的に戻り値は1以上です。例えば、時刻00:45はその日の最初の1時間の中です、そして単位HourとDayそれぞれに対して、結果は1になるでしょう。1つの例外は、月の中の週の計算です、それは、日付を含んでいる月の最初の週の前のいく日かに対して0を返します。

Note that some computations can take a relatively long time. いくつかの計算は比較的長い時間をとる可能性があることに注意してください。

See Also 参照

Getting Calendar Information カレンダー情報を取得する