HelpSource/Classes/Date.schelp

   1 class:: Date
   2 summary:: an object describing a point in time
   3 related::
   4 categories:: Control
   5
   6
   7 ClassMethods::
   8
   9 method::new
  10 Create a new date with the given properties (all numerical values). These arguments are also the names of instance variables of the date object.
  11
  12 method::getDate
  13 Get current date from system and create a date object from it.
  14 code::
  15 (
  16 var a = Date.getDate;
  17 a.bootSeconds.postln;
  18 a.dayOfWeek.postln;
  19 a
  20 )
  21 ::
  22
  23 method::localtime
  24 Get current localized time from system and create a date object from it.
  25
  26 method::gmtime
  27 Get current strong::Greenwich Mean Time (GMT):: from system and create a date object from it.
  28
  29 method::seed
  30 Get current date and return a value suitable for seeding a random number generator. See also link::Reference/randomSeed##randomSeed::.
  31 code::
  32 (
  33 var a = Date.seed;
  34 thisThread.randSeed = a;
  35 20.do { [1,0].choose.post }; "".postln;
  36 thisThread.randSeed = a;
  37 25.do { [1,0].choose.post }; "".postln;
  38 )
  39 ::
  40
  41 InstanceMethods::
  42
  43 method::localtime
  44 Set the receiver's time to current localtime.
  45
  46 method::gmtime
  47 Set the receiver's time to current strong::Greenwich Mean Time (GMT)::.
  48
  49 method::dayStamp
  50 Obtain a string with the year, month and day in the format strong::YYMMDD::.
  51
  52 method::hourStamp
  53 Obtain a string in the format strong::H:M:S::.
  54
  55 method::secStamp
  56 Obtain a string with the seconds.
  57
  58 method::stamp
  59 Obtain a string in the format strong::YYMMDD_HHMMSS::.
  60
  61 method::asSortableString
  62 Obtain a string in an alphabetically sortable standard database format.
  63
  64 method::asctime
  65 Obtain a string in the format WeekdayName MonthName Time Year.
  66
  67 method::asString
  68 Returns asctime.
  69
  70 method::format
  71 Obtain a date string with a given format. The character % is replaced by the appropriate value, which is derived from the letter that follows.
  72 code::
  73 Date.getDate.format("Today is %A. It is around %I o'clock (%p), in %B.");
  74 Date.getDate.format("%Y-%d-%e-%Hh%m");
  75 ::
  76
  77 discussion::
  78
  79 A list of formats can be found here: http://www.opengroup.org/onlinepubs/009695399/functions/strftime.html
  80
  81
  82 definitionList::
  83
  84 ## %a
  85 || Replaced by the locale's abbreviated weekday name. [ tm_wday]
  86
  87 ## %A
  88 || Replaced by the locale's full weekday name. [ tm_wday]
  89
  90 ## %b
  91 || Replaced by the locale's abbreviated month name. [ tm_mon]
  92
  93 ## %B
  94 || Replaced by the locale's full month name. [ tm_mon]
  95
  96 ## %c
  97 || Replaced by the locale's appropriate date and time representation.
  98
  99 ## %C
 100 || Replaced by the year divided by 100 and truncated to an integer, as a decimal number [00,99]. [ tm_year]
 101
 102 ## %d
 103 || Replaced by the day of the month as a decimal number [01,31]. [ tm_mday]
 104
 105 ## %D
 106 || Equivalent to %m / %d / %y. [ tm_mon, tm_mday, tm_year]
 107
 108 ## %e
 109 || Replaced by the day of the month as a decimal number [1,31]; a single digit is preceded by a space. [ tm_mday]
 110
 111 ## %F
 112 || Equivalent to %Y - %m - %d (the ISO 8601:2000 standard date format). [ tm_year, tm_mon, tm_mday]
 113
 114 ## %g
 115 || Replaced by the last 2 digits of the week-based year (see below) as a decimal number [00,99]. [ tm_year, tm_wday, tm_yday]
 116
 117 ## %G
 118 || Replaced by the week-based year (see below) as a decimal number (for example, 1977). [ tm_year, tm_wday, tm_yday]
 119
 120 ## %h
 121 || Equivalent to %b. [ tm_mon]
 122
 123 ## %H
 124 || Replaced by the hour (24-hour clock) as a decimal number [00,23]. [ tm_hour]
 125
 126 ## %I
 127 || Replaced by the hour (12-hour clock) as a decimal number [01,12]. [ tm_hour]
 128
 129 ## %j
 130 || Replaced by the day of the year as a decimal number [001,366]. [ tm_yday]
 131
 132 ## %m
 133 || Replaced by the month as a decimal number [01,12]. [ tm_mon]
 134
 135 ## %M
 136 || Replaced by the minute as a decimal number [00,59]. [ tm_min]
 137
 138 ## %n
 139 || Replaced by a <newline>.
 140
 141 ## %p
 142 || Replaced by the locale's equivalent of either a.m. or p.m. [ tm_hour]
 143
 144 ## %r
 145 || Replaced by the time in a.m. and p.m. notation;  in the POSIX locale this shall be equivalent to %I :%M :%S%p. [ tm_hour, tm_min, tm_sec]
 146
 147 ## %R
 148 || Replaced by the time in 24-hour notation (%H : %M ). [ tm_hour, tm_min]
 149
 150 ## %S
 151 || Replaced by the second as a decimal number [00,60]. [ tm_sec]
 152
 153 ## %t
 154 || Replaced by a <tab>.
 155
 156 ## %T
 157 || Replaced by the time ( %H : %M : %S ). [ tm_hour, tm_min, tm_sec]
 158
 159 ## %u
 160 || Replaced by the weekday as a decimal number [1,7], with 1 representing Monday. [ tm_wday]
 161
 162 ## %U
 163 || Replaced by the week number of the year as a decimal number [00,53]. The first Sunday of January is the first day of week 1; days in the new year before this are in week 0. [ tm_year, tm_wday, tm_yday]
 164
 165 ## %V
 166 || Replaced by the week number of the year (Monday as the first day of the week) as a decimal number [01,53]. If the week containing 1 January has four or more days in the new year, then it is considered week 1. Otherwise, it is the last week of the previous year, and the next week is week 1. Both January 4th and the first Thursday of January are always in week 1. [ tm_year, tm_wday, tm_yday]
 167
 168 ## %w
 169 || Replaced by the weekday as a decimal number [0,6], with 0 representing Sunday. [ tm_wday]
 170
 171 ## %W
 172 || Replaced by the week number of the year as a decimal number [00,53]. The first Monday of January is the first day of week 1; days in the new year before this are in week 0. [ tm_year, tm_wday, tm_yday]
 173
 174 ## %x
 175 || Replaced by the locale's appropriate date representation.
 176
 177 ## %X
 178 || Replaced by the locale's appropriate time representation.
 179
 180 ## %y
 181 || Replaced by the last two digits of the year as a decimal number [00,99]. [ tm_year]
 182
 183 ## %Y
 184 || Replaced by the year as a decimal number (for example, 1997). [ tm_year]
 185
 186 ## %z
 187 || Replaced by the offset from UTC in the ISO 8601:2000 standard format ( +hhmm or -hhmm ), or by no characters if no timezone is determinable. For example, "-0430" means 4 hours 30 minutes behind UTC (west of Greenwich). If tm_isdst is zero, the standard time offset is used. If tm_isdst is greater than zero, the daylight savings time offset is used. If tm_isdst is negative, no characters are returned. [ tm_isdst]
 188
 189 ## %Z
 190 || Replaced by the timezone name or abbreviation, or by no bytes if no timezone information exists. [ tm_isdst]
 191
 192 ## %%
 193 || Replaced by %.
 194 ::
 195
 196 If a conversion specification does not correspond to any of the above, the behavior is undefined.