Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Routine: XBARRAY0

XBARRAY0.m

Go to the documentation of this file. 
XBARRAY0 ; IHS/ADC/GTH - Documentation for XBARRAY ; [ 02/07/97   3:02 PM ]

 ;;3.0;IHS/VA UTILITIES;;FEB 07, 1997

 ;

 ; This utility provides a word processing format of free

 ; text and local variable references to build an array.

 ;

 ; A file is necessary that has a .01 field for the form

 ; name and a WP field to hold the WP form.

 ;

 ; Two Entry points

 ;

 ; EDIT^XBARRAY(.NAME,DIC,FIELD)  Edits and Displays the

 ;        form.  Place the call to EDIT in the code where

 ;        the data or variables have been gathered.

 ;        Typically this is one line previous to the call

 ;        to $$GEN^XBARRAY.  Once the form is designed the

 ;        EDIT call is commented out.

 ;                             

 ; $$GEN^XBARRAY(.NAME,DIC,FIELD,ROOT,FORMAT,LINE)

 ;        Generates the form into the ARRAY indicated by

 ;        the ROOT.  The call to $$GEN must have all

 ;        variables used gathered.  The return value of

 ;        $$GEN is equal to the last line set in the array.

 ;

 ; VARIABLES

 ;     .NAME - The name space variable that holds the name

 ;     of the form to be used.  A pass by reference is

 ;     needed for efficiency so that the pre-compilation of

 ;     the form is held for repetitive use. The compilation

 ;     is stored in the sub array as NAME(@NAME,line,.....,).

 ;     IE one local variable can be used for all form

 ;     references.

 ;             Ex: S BARFORM="A/R BILL"  will store and use

 ;     the form compilation in BARFORM("A/R BILL",line,....,)

 ;     When finished KILL BARFORM(BARFORM) will retrieve the

 ;     local variable space from the last form used.

 ;

 ;     DIC - The root or file number of the file holding the

 ;     forms.

 ;

 ;     FIELD ; The field number of the WP field holding the

 ;     form.

 ;

 ;     ROOT - The root of the target array to be built.

 ;     Either a global or a variable root as in the format

 ;     used for a %XY^%RCR call. (%RCR is actually used)

 ;

 ;     FORMAT

 ;       null or zero  The array is built ROOT(line)="...

 ;       1             The array is built ROOT(line,0)="....

 ;

 ;     LINE - The offset in line numbers in building the

 ;     array.  The array will start construction at LINE +1.

 ;     The value of the last line created is returned $$GEN.

 ;

 ; WP FORMAT INSTRUCTIONS

 ;

 ;     Free Text:  Free text is key striked in where desired.

 ;                 Do not use ~ as it is used to mark variables.

 ;

 ;     Variables:  The reference to a variable is marked with

 ;         a beginning ~ and a trailing ~. The trailing ~ is

 ;         always required even if the variable is last item

 ;         on the line.

 ;

 ;     Mnemonics: A short hand for variables is available.

 ;

 ;     Comments:  Programmers comments can be put into the form

 ;         which are ignored by the generator.

 ;

 ;     Output Transform:  Mumps output transforms can be

 ;         indicated for execution upon selected variables.

 ;

 ; WP SPECIAL FUNCTIONS  Located at the top of the form.

 ;

 ; Comment line          Begin the line with a ';'

 ;

 ; Variable Mneumonic Reference:  Name spaced variables can

 ;         be long.  A mnemonic reference is available to make

 ;         life simple.  Multiple mnemonic lines can be used

 ;         if desired.

 ;

 ;     SETUP

 ;

 ;     #mnemonic1|variable1*mnemonic2|variable2*...

 ;     #mnemonicZ|variableZ*.....

 ;

 ;     Example:     #D|DUZ*V|BARVPT

 ;                  #I|BARIPT   

 ;             

 ;         (BARIPT array is storing IHS Patient Information)

 ;         (BARVPT array is storing  VA Patient Information)

 ;    

 ;

 ;         '#'         Marker placed in the first column

 ;

 ;         mnemonic1  User's choice  

 ;                     ex: D to denote DUZ

 ;         '|'         Separator

 ;

 ;         variable1   User's choice of the local variable

 ;                     ex: DUZ

 ;         '*'         Repetative marker if more than one

 ;                     mnemonic is indicated

 ;

 ;     USE        The mnemonic reference can be used any where

 ;                in the WP form.

 ;

 ;          Format     ~mnemonic|variable subscript~

 ;

 ;         '~'         Beginning marker for the variable

 ;

 ;         mnemonic1  User's mnemonic

 ;

 ;         '|'         Separator

 ;

 ;         subscript   The subscript of the variable to be used

 ;

 ;         '~'         Ending marker for the variable

 ;

 ;                     ex:  ~D|~      for DUZ

 ;                          ~D|0~     for DUZ(0)

 ;                          ~I|.01~   for BARIPT(.01)

 ;

 ;  MUMPS OUTPUT TRANSFORM

 ;  A simple mumps output transform is also provided to aid

 ;  in form design.  A variable or mnemonic indicated will

 ;  have its output transformed prior to being put into the

 ;  form.

 ;

 ;  SETUP   

 ;

 ;      *var1!mumps code1*var2!mumps code2

 ;      *mnemonic3!mumps code3*mnemonic4!mumps code4

 ;

 ;    Ex:     *DUZ(2)!$J(X,10,2)  will output $J(DUZ(2),10,2)

 ;            *D | 2!$J(X,10,2)     mnemonic notation of same

 ;

 ;    '*'          Output Transform marker in column one. At TOF

 ;

 ;    Variable/    Variable or mnemonic as it would appear in the

 ;    Mneumonic    form between '~'s.

 ;

 ;    '!'          Separator

 ;

 ;    mumps code   Mumps code expression as a function of x.

 ;                 Do not state 'S X=f(x)'

 ;                 Enter the function only, f(x).

 ;

 ;    '*'          Separator if more than one is put on one line.

 ;

 ; SPECIAL OUTPUT TRANSFORMS provided by XBARRAY

 ;

 ;  xxx!$$MDY(X)    a literal ~"NOW"~ or    variable ~IT|9~

 ;      ex:         *"NOW"!$$MDY(X)   or    *IT|9!$$MDY(X)

 ;                  returns mm/dd/yy

 ;

 ;  xxx!$$WP("X")   for a word processing field

 ;  NOTE:    "X"    IS ABSOLUTELY NECESSARY

 ;                  The variable array must have the form

 ;                  VAR(subcript,n) where n = 1:1

 ;

DOCE ;

 ;

TEST ; If you have A/R installed, uncomment the following lines for a

 ; demonstration.

 ; D INIT^BARUTL

 ; D ENP^XBDIQ1(200,DUZ,".01:.116","BARU(")

 ; S BARFORM="PW TEST"

 ; D EDIT^XBARRAY(.BARFORM,90053.01,1000)

 ; S Y=$$GEN^XBARRAY(.BARFORM,90053.01,1000,"BARFM",0,10)

 ; KILL BARFORM(BARFORM)

 ; Q

 ;