INHUTC2A.m

INHUTC2A ;bar; 20 May 97 22:07; Interface Criteria date help

 ;;3.01;BHL IHS Interfaces with GIS;;JUL 01, 2001

 ;COPYRIGHT 1991-2000 SAIC

 ;;COPYRIGHT 1997 SAIC

 Q

 ;

HELP ; display help screens

 N X

 D HELP1("HELPX1")

 R !!?25,"Press Return to continue",X:$S($D(DTIME):DTIME,1:300)

 D HELP1("HELPX2")

 Q

 ;

HELP1(INLINE) ; Display help message and quit

 ;

 ; Input: INLINE = line tag entry for the help section

 ;

 N INI,INL

 F INI=1:1 S INL=$T(@INLINE+INI) Q:'$L($P(INL,";;",2))  D

 .S INL=$P(INL,";;",2) W !,INL

 Q

 ;

HELPX1 ; Insert help lines here for page 1

 ;;$$RELDT^INHUTC2 converts a text string containing date mnemonics and

 ;;modifiers to FileMan internal date format. This function allows a

 ;;date to be set relative to the current date based on a set of

 ;;instructions. This can be used to recalculate the date for a task

 ;;on the fly rather than asking the user to input dates or hard-code a routine.

 ;;For example, use 'BM-1' as a start date and 'EM-1' as the end date

 ;;for all of last month.

 ;; 

 ;;Call:       Set FMdate=$$RELDT^INHUTC2(text_string,opt_string,prompt)

 ;;Parameters: text_string: base_date[(+-) integer [date_modifier][@hhmmss]

 ;;            Multiple date_modifiers can be used. Example: LSA-7D+4H

 ;;                                 Base Date Formats

 ;; Mnemonic                 Description

 ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ;; MM/DD/YY, etc.           Standard date input formats available with ^%DT

 ;; NOW                      Current date and time

 ;; TODAY or T               Current date

 ;; BY or EY                 Beginning or end of the current Year

 ;; BM or EM                 Beginning or end of current Month

 ;; BD or ED                 Beginning or end of current Day

 ;; SA,SU,MO,TU,WE,TH,FR     Day of the week.

 ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ;;

HELPX2 ; Insert help lines here for page 2

 ;;                                 Date Modifier Formats

 ;; Mnemonic                 Description

 ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ;;@hhmmss                   Standard time input formats available with ^%DT

 ;; Y                        Years.

 ;; MO                       Months.

 ;; D                        Days. This is the default.

 ;; H                        Hours.

 ;; MI                       Minutes.

 ;; S                        Seconds.

 ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ;; opt_string: Optional string of characters. Same format as ^%DT

 ;;                                 opt_string Characters

 ;; Mnemonic                 Description

 ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 ;; A                        Ask for input.

 ;; E                        Echo the answer.

 ;; F                        Future dates are assumed.

 ;; N                        Pure numeric input is not allowed.

 ;; O                        Time-only is allowed.

 ;; P                        Past dates are assumed.

 ;; R                        Require time input.

 ;; S                        Seconds are returned.

 ;; T                        Time input is allowed.

 ;; X                        Exact month and day is required.

 ;; U                        Return user readable date/time.

 ;;

INHUTC2A  ;bar; 20 May 97 22:07; Interface Criteria date help

 +1       ;;3.01;BHL IHS Interfaces with GIS;;JUL 01, 2001

 +2       ;COPYRIGHT 1991-2000 SAIC

 +3       ;;COPYRIGHT 1997 SAIC

 +4        QUIT 

 +5       ;

HELP      ; display help screens

 +1        NEW X

 +2        DO HELP1("HELPX1")

 +3        READ !!?25,"Press Return to continue",X:$SELECT($DATA(DTIME):DTIME,1:300)

 +4        DO HELP1("HELPX2")

 +5        QUIT 

 +6       ;

HELP1(INLINE) ; Display help message and quit

 +1       ;

 +2       ; Input: INLINE = line tag entry for the help section

 +3       ;

 +4        NEW INI,INL

 +5        FOR INI=1:1

               SET INL=$TEXT(@INLINE+INI)

               IF '$LENGTH($PIECE(INL,";;",2))

                   QUIT 

               Begin DoDot:1

 +6                SET INL=$PIECE(INL,";;",2)

                   WRITE !,INL

               End DoDot:1

 +7        QUIT 

 +8       ;

HELPX1    ; Insert help lines here for page 1

 +1       ;;$$RELDT^INHUTC2 converts a text string containing date mnemonics and

 +2       ;;modifiers to FileMan internal date format. This function allows a

 +3       ;;date to be set relative to the current date based on a set of

 +4       ;;instructions. This can be used to recalculate the date for a task

 +5       ;;on the fly rather than asking the user to input dates or hard-code a routine.

 +6       ;;For example, use 'BM-1' as a start date and 'EM-1' as the end date

 +7       ;;for all of last month.

 +8       ;; 

 +9       ;;Call:       Set FMdate=$$RELDT^INHUTC2(text_string,opt_string,prompt)

 +10      ;;Parameters: text_string: base_date[(+-) integer [date_modifier][@hhmmss]

 +11      ;;            Multiple date_modifiers can be used. Example: LSA-7D+4H

 +12      ;;                                 Base Date Formats

 +13      ;; Mnemonic                 Description

 +14      ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 +15      ;; MM/DD/YY, etc.           Standard date input formats available with ^%DT

 +16      ;; NOW                      Current date and time

 +17      ;; TODAY or T               Current date

 +18      ;; BY or EY                 Beginning or end of the current Year

 +19      ;; BM or EM                 Beginning or end of current Month

 +20      ;; BD or ED                 Beginning or end of current Day

 +21      ;; SA,SU,MO,TU,WE,TH,FR     Day of the week.

 +22      ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 +23      ;;

HELPX2    ; Insert help lines here for page 2

 +1       ;;                                 Date Modifier Formats

 +2       ;; Mnemonic                 Description

 +3       ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 +4       ;;@hhmmss                   Standard time input formats available with ^%DT

 +5       ;; Y                        Years.

 +6       ;; MO                       Months.

 +7       ;; D                        Days. This is the default.

 +8       ;; H                        Hours.

 +9       ;; MI                       Minutes.

 +10      ;; S                        Seconds.

 +11      ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 +12      ;; opt_string: Optional string of characters. Same format as ^%DT

 +13      ;;                                 opt_string Characters

 +14      ;; Mnemonic                 Description

 +15      ;;-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

 +16      ;; A                        Ask for input.

 +17      ;; E                        Echo the answer.

 +18      ;; F                        Future dates are assumed.

 +19      ;; N                        Pure numeric input is not allowed.

 +20      ;; O                        Time-only is allowed.

 +21      ;; P                        Past dates are assumed.

 +22      ;; R                        Require time input.

 +23      ;; S                        Seconds are returned.

 +24      ;; T                        Time input is allowed.

 +25      ;; X                        Exact month and day is required.

 +26      ;; U                        Return user readable date/time.

 +27      ;;