Overview of $Date functions - Revision history

JAL: minor cleanup

2015-10-06T20:26:07Z

minor cleanup

JAL: misc formatting

2015-09-25T22:38:17Z

misc formatting

← Older revision		Revision as of 22:38, 25 September 2015
Line 1:		Line 1:
	==Syntax==		==Syntax==
	<p>		<p>
	~~All~~ <var>$Date</var> functions ~~(for example,~~ <var>[[$Date]]</var>, <var>[[$DateJ]]</var>, <var>[[$DateP]]</var> — accept two input arguments:</p>		The <var>$Date</var> functions — <var>[[$Date]]</var>, <var>[[$DateJ]]</var>, <var>[[$DateP]]</var> — accept two input arguments:</p>
	<p class="syntax">$Date(<span class="term">year-format</span>, <span class="term">fill-character</span>)		<p class="syntax">$Date(<span class="term">year-format</span>, <span class="term">fill-character</span>)
	</p>		</p>
Line 34:		Line 34:
	</table>		</table>
	<p>		<p>
	~~<var>~~CYY~~</var>~~ represents the century-year format. The first digit represents the century since 1900. The ~~<var>~~CYY~~</var>~~ format can be manipulated using the <var>[[CUSTOM parameter\|CUSTOM]]</var> parameter. </p>		CYY represents the century-year format. The first digit represents the century since 1900. The CYY format can be manipulated using the <var>[[CUSTOM parameter\|CUSTOM]]</var> parameter. </p>
	</li>		</li>

JAL: misc formatting

2015-09-25T22:21:06Z

misc formatting

← Older revision		Revision as of 22:21, 25 September 2015
Line 1:		Line 1:
			==Syntax==
	<p>		<p>
	All $Date functions ~~—~~ <var>$Date</var>, <var>$~~DATEJ~~</var>, <var>$~~DATEP~~</var> — accept two input arguments.</p>		All <var>$Date</var> functions (for example, <var>[[$Date]]</var>, <var>[[$DateJ]]</var>, <var>[[$DateP]]</var> — accept two input arguments:</p>

	~~==Syntax==~~
	<p class="syntax">$Date(<span class="term">year-format</span>, <span class="term">fill-character</span>)		<p class="syntax">$Date(<span class="term">year-format</span>, <span class="term">fill-character</span>)
	</p>		</p>
	Where::		Where:
	<ul>		<ul>
	<li>The <var class="term">year-format</var> argument controls the format of the year based on the following input values:</li>		<li>The <var class="term">year-format</var> argument controls the format of the year based on the following input values:</li>
Line 35:		Line 34:
	</table>		</table>
	<p>		<p>
	CYY represents the century-year format. The first digit represents the century since 1900. The CYY format can be manipulated using the <var>[[CUSTOM parameter\|CUSTOM]]</var> parameter. </p>		<var>CYY</var> represents the century-year format. The first digit represents the century since 1900. The <var>CYY</var> format can be manipulated using the <var>[[CUSTOM parameter\|CUSTOM]]</var> parameter. </p>
	</li>		</li>

Line 75:		Line 74:
	==Usage==		==Usage==
	<p>		<p>
	$DateChg, $DateChk, $DateCnv, and $DateDif recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>		<var>[[$DateChg]]</var>, <var>[[$DateChk]]</var>, <var>[[$DateCnv]]</var>, and <var>[[$DateDif]]</var> recognize a format of <var>CYY</var> as representing the century-year format as returned from the <var>$Date</var> function. Conversion to and from the <var>CYY</var> format is fully supported. </p>
	<p>		<p>
	In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECENT parameter\|BASECENT]]</var> parameters. </p>		In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the <var>RESET</var> command, the following occurs: If a <var>CYY</var> date format is specified for conversion and only a <var>YY</var> input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECENT parameter\|BASECENT]]</var> parameters. </p>

	==Examples==		==Examples==
	<ul>		<ul>
	<li>IF CUSTOM=1, BASECENT=19, and CENTSPLT=95, then:~~</li>~~		<li>IF CUSTOM=1, BASECENT=19, and CENTSPLT=95, then:
	<table>		<table>
	<tr class="head">		<tr class="head">
Line 111:		Line 110:
	</li>		</li>

	<li>If CUSTOM=1 is omitted, BASECENT=19, and CENTSPLT=95, then:~~</li>~~		<li>If CUSTOM=1 is omitted, BASECENT=19, and CENTSPLT=95, then:
	<table>		<table>
	<tr class="head">		<tr class="head">
Line 147:		Line 146:

	==Julian dates==		==Julian dates==
	<p>The Julian date is a 4-byte, packed decimal formatted as follows:</p>		<p>
			The Julian date is a 4-byte, packed decimal formatted as follows:</p>
	<p class="code">0CYYDDDF		<p class="code">0CYYDDDF
	</p>		</p>
Line 170:		Line 170:
	==Routines available for user-written date $functions==		==Routines available for user-written date $functions==
	<p>		<p>
	CCALL entry points ~~have been~~ added: DATE, DATE3, and DATE4. All routines must be called with T1 pointing to a 26-byte answer area. [[Contacting Rocket Software Technical Support\|Technical Support]] recommends that you allocate the answer area using the VARS=(name, len) pushdown list variable of the ENTER macro. (See [[Customizing functions and translation tables]] for more information on the ENTER macro.) </p>		CCALL entry points are added: <code>DATE</code>, <code>DATE3</code>, and <code>DATE4</code>. All routines must be called with T1 pointing to a 26-byte answer area. [[Contacting Rocket Software Technical Support\|Technical Support]] recommends that you allocate the answer area using the <code>VARS=(name, len)</code> pushdown list variable of the ENTER macro. (See [[Customizing functions and translation tables]] for more information on the ENTER macro.) </p>
	<p>		<p>
	The current date and time are stored in the area with this format:</p>		The current date and time are stored in the area with this format:</p>
Line 196:		Line 196:

	<p>		<p>
	All registers are returned intact with the exception of the DATE and DATE4 calls. The DATE and DATE4 calls change only the T4 register, returning a number representing the current month (1-12).</p>		All registers are returned intact with the exception of the <code>DATE</code> and <code>DATE4</code> calls. The <code>DATE</code> and <code>DATE4</code> calls change only the T4 register, returning a number representing the current month (1-12).</p>
	<p>		<p>
	DATE returns 24 bytes, DATE3 returns 25 bytes, and DATE4 returns 26 bytes. </p>		<code>DATE</code> returns 24 bytes, <code>DATE3</code> returns 25 bytes, and <code>DATE4</code> returns 26 bytes. </p>
	<p class="note"><b>Note:</b> There are two spaces before and after <code>MON DD</code>.</p>		<p class="note"><b>Note:</b> There are two spaces before and after <code>MON DD</code>.</p>


	[[Category:SOUL]]		[[Category:SOUL]]

ELowell at 19:40, 11 November 2014

2014-11-11T19:40:55Z

← Older revision		Revision as of 19:40, 11 November 2014
Line 65:		Line 65:

	<tr>		<tr>
	<td>$DATEJ(1,'')</td>		<td>$DATEJ(1,'')</td>
	<td>'YYYYDDD'</td>		<td>'YYYYDDD'</td>
	<td>2013192</td>		<td>2013192</td>

JAL: /* Routines available for user-written date $functions */

2014-10-30T17:47:37Z

Routines available for user-written date $functions

← Older revision		Revision as of 17:47, 30 October 2014
Line 170:		Line 170:
	==Routines available for user-written date $functions==		==Routines available for user-written date $functions==
	<p>		<p>
	CCALL entry points have been added: DATE, DATE3, and DATE4. All routines must be called with T1 pointing to a 26-byte answer area. [[Contacting Rocket Software Technical Support\|Technical Support]] recommends that you allocate the answer area using the VARS=(name, len) pushdown list variable of the ENTER macro. (See [[Customizing ~~function~~ and translation tables]] for more information on the ENTER macro.) </p>		CCALL entry points have been added: DATE, DATE3, and DATE4. All routines must be called with T1 pointing to a 26-byte answer area. [[Contacting Rocket Software Technical Support\|Technical Support]] recommends that you allocate the answer area using the VARS=(name, len) pushdown list variable of the ENTER macro. (See [[Customizing functions and translation tables]] for more information on the ENTER macro.) </p>
	<p>		<p>
	The current date and time are stored in the area with this format:</p>		The current date and time are stored in the area with this format:</p>

JAL at 18:42, 18 August 2014

2014-08-18T18:42:48Z

← Older revision		Revision as of 18:42, 18 August 2014
Line 2:		Line 2:
	All $Date functions — <var>$Date</var>, <var>$DATEJ</var>, <var>$DATEP</var> — accept two input arguments.</p>		All $Date functions — <var>$Date</var>, <var>$DATEJ</var>, <var>$DATEP</var> — accept two input arguments.</p>

	====Syntax====		==Syntax==
	<p class="syntax">$Date(<span class="term">year-format</span>, <span class="term">fill-character</span>)		<p class="syntax">$Date(<span class="term">year-format</span>, <span class="term">fill-character</span>)
	</p>		</p>
Line 73:		Line 73:
	</ul>		</ul>

	====Usage====		==Usage==
	<p>		<p>
	$DateChg, $DateChk, $DateCnv, and $DateDif recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>		$DateChg, $DateChk, $DateCnv, and $DateDif recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>
Line 79:		Line 79:
	In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECENT parameter\|BASECENT]]</var> parameters. </p>		In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECENT parameter\|BASECENT]]</var> parameters. </p>

	====Examples====		==Examples==
	<ul>		<ul>
	<li>IF CUSTOM=1, BASECENT=19, and CENTSPLT=95, then:</li>		<li>IF CUSTOM=1, BASECENT=19, and CENTSPLT=95, then:</li>
Line 146:		Line 146:
	</ul>		</ul>

	====Julian dates====		==Julian dates==
	<p>The Julian date is a 4-byte, packed decimal formatted as follows:</p>		<p>The Julian date is a 4-byte, packed decimal formatted as follows:</p>
	<p class="code">0CYYDDDF		<p class="code">0CYYDDDF
Line 168:		Line 168:
	</ul>		</ul>

	====Routines available for user-written date $functions====		==Routines available for user-written date $functions==
	<p>		<p>
	CCALL entry points have been added: DATE, DATE3, and DATE4. All routines must be called with T1 pointing to a 26-byte answer area. [[Contacting Rocket Software Technical Support\|Technical Support]] recommends that you allocate the answer area using the VARS=(name, len) pushdown list variable of the ENTER macro. (See [[Customizing function and translation tables]] for more information on the ENTER macro.) </p>		CCALL entry points have been added: DATE, DATE3, and DATE4. All routines must be called with T1 pointing to a 26-byte answer area. [[Contacting Rocket Software Technical Support\|Technical Support]] recommends that you allocate the answer area using the VARS=(name, len) pushdown list variable of the ENTER macro. (See [[Customizing function and translation tables]] for more information on the ENTER macro.) </p>

JAL at 18:41, 18 August 2014

2014-08-18T18:41:22Z

← Older revision		Revision as of 18:41, 18 August 2014
Line 139:		Line 139:
	</li>		</li>

	<li>If <code>CUSTOM=2</code> is added to the User 0 CCAIN stream or set later using the <var>RESET</var> command, the following occurs: If a CYY-format is specified for output conversion and the C indicator is zero, then C is eliminated. This is true for all $Date function calls. For example:		<li>If <code>CUSTOM=2</code> is added to the User 0 CCAIN stream or set later using the <var>RESET</var> command, the following occurs: If a <var>CYY</var>-format is specified for output conversion and the <var>C</var> indicator is zero, then <var>C</var> is eliminated. This is true for all <var>$Date</var> function calls. For example:
	<p>		<p>
	If CUSTOM=2, then: <code>PRINT $DATEJ(2)</code> prints 97.001.</p>		If <code>CUSTOM=2</code>, then: <code>PRINT $DATEJ(2)</code> prints 97.001.</p>
	<p>But if CUSTOM=2 is omitted, then <code>PRINT $DATEJ(2)</code> prints 097.001.</p>		<p>But if <code>CUSTOM=2</code> is omitted, then <code>PRINT $DATEJ(2)</code> prints 097.001.</p>
	</li>		</li>
	</ul>		</ul>
Line 152:		Line 152:
	<p>Where:</p>		<p>Where:</p>
	<ul>		<ul>
	<li>0 is a reserved filler</li>		<li>0 is a reserved filler.</li>

	<li>C represents the century since 1900. For example:		<li><code>C</code> represents the century since 1900. For example:
	<p>		<p>
	C=0 represents years 1900-1999</p>		<code>C=0</code> represents years 1900-1999.</p>
	<p>		<p>
	C=1 represents years 2000-2099</p>		<code>C=1</code> represents years 2000-2099.</p>
	</li>		</li>

	<li>YY is 2-byte year</li>		<li><code>YY</code> is 2-byte year.</li>

	<li>DDD is 3-byte day</li>		<li><code>DDD</code> is 3-byte day.</li>

	<li>F is positive sign nibble for packed decimal		<li><code>F</code> is positive-sign nibble for packed decimal </li>
	</li>
	</ul>		</ul>

	====Routines available for user-written date $functions====		====Routines available for user-written date $functions====
	<p>		<p>
	CCALL entry points have been added: DATE, DATE3, and DATE4. All routines must be called with T1 pointing to a 26-byte answer area. Technical Support recommends that you allocate the answer area using the VARS=(name, len) pushdown list variable of the ENTER macro. (See ~~the <var class="book">Rocket Model 204 System Manager's Guide</var> chapter on customizing~~ function and translation tables for more information on the ENTER macro.) </p>		CCALL entry points have been added: DATE, DATE3, and DATE4. All routines must be called with T1 pointing to a 26-byte answer area. [[Contacting Rocket Software Technical Support\|Technical Support]] recommends that you allocate the answer area using the VARS=(name, len) pushdown list variable of the ENTER macro. (See [[Customizing function and translation tables]] for more information on the ENTER macro.) </p>
	<p>		<p>
	The current date and time are stored in the area with this format:</p>		The current date and time are stored in the area with this format:</p>
Line 182:		Line 181:
	<tr>		<tr>
	<td>DATE</td>		<td>DATE</td>
	<td>'YY.DDD  MON DD  HH.MM.SS'</td>		<td>YY.DDD  MON DD  HH.MM.SS</td>
	</tr>		</tr>

	<tr>		<tr>
	<td>DATE3</td>		<td>DATE3</td>
	<td>'CYY.DDD  MON DD  HH.MM.SS'</td>		<td>CYY.DDD  MON DD  HH.MM.SS</td>
	</tr>		</tr>

	<tr>		<tr>
	<td>DATE4</td>		<td>DATE4</td>
	<td>'YYYY.DDD  MON DD  HH.MM.SS'</td>		<td>YYYY.DDD  MON DD  HH.MM.SS</td>
	</tr>		</tr>
	</table>		</table>

	<p>All registers are returned intact with the exception of the DATE and DATE4 calls. The DATE and DATE4 calls change only the T4 register, returning a number representing the current month (1-12).</p>		<p>
	<p>DATE returns 24 bytes, DATE3 returns 25 bytes, and DATE4 returns 26 bytes.<br>Note ~~that there~~ are ~~double SPACEs~~ before and after ~~the '~~MON DD'.</p>		All registers are returned intact with the exception of the DATE and DATE4 calls. The DATE and DATE4 calls change only the T4 register, returning a number representing the current month (1-12).</p>
			<p>
			DATE returns 24 bytes, DATE3 returns 25 bytes, and DATE4 returns 26 bytes. </p>
			<p class="note"><b>Note:</b> There are two spaces before and after <code>MON DD</code>.</p>


	[[Category:SOUL]]		[[Category:SOUL]]

JAL: /* Usage */

2014-07-23T19:57:19Z

Usage

← Older revision		Revision as of 19:57, 23 July 2014
Line 77:		Line 77:
	$DateChg, $DateChk, $DateCnv, and $DateDif recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>		$DateChg, $DateChk, $DateCnv, and $DateDif recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>
	<p>		<p>
	In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[~~BASECNT~~ parameter\|BASECENT]]</var> parameters. </p>		In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECENT parameter\|BASECENT]]</var> parameters. </p>

	====Examples====		====Examples====

Mlarocca: /* Usage */

2014-07-16T14:30:33Z

Usage

← Older revision		Revision as of 14:30, 16 July 2014
Line 75:		Line 75:
	====Usage====		====Usage====
	<p>		<p>
	$DateChg, $~~DATECHK~~, $~~DATECNV~~, and $~~DATEDIF~~ recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>		$DateChg, $DateChk, $DateCnv, and $DateDif recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>
	<p>		<p>
	In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECNT parameter\|BASECENT]]</var> parameters. </p>		In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECNT parameter\|BASECENT]]</var> parameters. </p>

Mlarocca: /* Usage */

2014-07-16T14:28:04Z

Usage

← Older revision		Revision as of 14:28, 16 July 2014
Line 75:		Line 75:
	====Usage====		====Usage====
	<p>		<p>
	$~~DATECHG~~, $DATECHK, $DATECNV, and $DATEDIF recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>		$DateChg, $DATECHK, $DATECNV, and $DATEDIF recognize a format of CYY as representing the century-year format as returned from the $Date function. Conversion to and from the CYY format is fully supported. </p>
	<p>		<p>
	In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECNT parameter\|BASECENT]]</var> parameters. </p>		In addition, if <code>CUSTOM=1</code> is added to the User 0 CCAIN stream or set later using the RESET command, the following occurs: If a CYY date format is specified for conversion and only a YY input is supplied, the conversion is successfully completed by using the <var>[[CENTSPLT parameter\|CENTSPLT]]</var> and <var>[[BASECNT parameter\|BASECENT]]</var> parameters. </p>