!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! SDDL Name:	QGARRAY_PAR.SDDL
!
! Purpose:      This SDDL file defines the qgarray_par relation.
!
! Modification History:
!
!   Date       PR      Who                       Reason
! --------   -------   ---   -------------------------------------------------
! 11/14/94   27329     SXT   Original implementation
! 05/08/98   36870     MRB   Add C output
! 03/12/99   38555     MRB   Remove instruction versions (version_num field)
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
 
LANGUAGE  C, FORTRAN, SQL

INCLUDE  ZSPSS_USER_TYPES.SDDL
 
RECORD  QGAPAR_TYPE
 
!------------------------------------------------------------------------------
!
!   RECORD INFORMATION
!
!------------------------------------------------------------------------------
 
 
    DESCRIPTION       

	 "In this relation the array indices are provided through the 
    specification of the array element number. The indices are determined by 
    using an algorithm that requires the array dimensions and array order 
    code (i.e. the order of subscript progression). The array element values 
    are specified for particular indices. The capability provided is limited 
    to the specification of single array element values corresponding to 
    fixed indices.                     

         Array parameters can be used as table parameters when the instruction
    type is table. They are not currently used by SOGS.

        When array parameters are specified for a table, INSTRUCT/EXPAND 
    or SMSG/GEN calls a special routine(QXUBTB) to resolve the table array 
    parameter values so the table may be written to the Logical SMS later.
 
 	For an array parameter, in addition to the parameter name and value, 
    the index value is required to uniquely identify the array element. Two 
    relations are provided for this task. The first is this relation 
    QGARRAY_PAR and the other relation is QGARRAY_INDX.              

         This relation is populated with table array parameters in Pass3 of 
    command INSTRUCT/CLP. This is during the process of storing component 
    parameter values for an instruction." 

 


!------------------------------------------------------------------------------
!
!   FIELD INFORMATION
!
!------------------------------------------------------------------------------
 
 
    FIELD  instr_name
        TYPE            INSTRUCTION_NAME_TYPE
        DESCRIPTION     "This is the name of the instruction to which the
                        array data applies."
    END_FIELD


    FIELD  param_name
        TYPE            C8
        DESCRIPTION     "This field is the name of the parameter of the 
                        component for which its array element is defined here."
    END_FIELD


    FIELD  comp_seq
        TYPE            I4
        DESCRIPTION     "This field contains the component sequence number to 
                        which this array element belongs. A component is 
                        defined as a statement of SCPL instruction. A component
                        of a defined instruction is accessed by instruction 
                        name and component sequence number."    
    END_FIELD


    FIELD  arg_no
        TYPE            I2
        DESCRIPTION     "This field contains the argument number for a list 
                        parameter. A list parameter is a single parameter that
                        contains a list of one or more values to be passed into
                        a PDB-defined primitive command, data block or table. 
                        If this is a list parameter, this field contains the 
                        number of the argument within the list.  

                        The various values of a list parameter are stored in
                        this relation with the same parameter name and order 
                        number, but a different argument number. The argument 
                        number indicates the position of the value within the 
                        list.
 
                        This field is set to zero if this is not a list 
                        parameter."
    END_FIELD

 
    FIELD  element
        TYPE            I4
        DESCRIPTION     "This field is the array element number. INSTRUCT/EXPAND
                        and SMSG/GEN use an algorithm to translate this 
                        element number into the correct array indices and
                        associate them with the table array parameter name." 
    END_FIELD
 
 
    FIELD  param_value
        TYPE            C32
        DESCRIPTION     "This field holds the value of this array parameter, 
                        which is the value to be assigned to array elements by 
                        the expander."
    END_FIELD
 
END_RECORD
 
 
!------------------------------------------------------------------------------
!
!   RELATION DECLARATION
!
!------------------------------------------------------------------------------
 
 
RELATION  qgarray_par
 
    TYPE             QGAPAR_TYPE
 
    DESCRIPTION      "Array Parameter Value Description Relation"
 
    SUBSYSTEM_USING  "SPSS", "SCS", "IM"
 
    RELATED_FIELDS   "qgarray_indx.*"

    INDEX  qgarray_par_1
        TYPE         unique, clustered
        FIELDS       instr_name, comp_seq, param_name, element, arg_no
    END_INDEX
 
END_RELATION
 
!------------------------------------------------------------------------------
!
!   INSTANCE DECLARATION
!
!------------------------------------------------------------------------------
 
 
INSTANCE  qgarray_par
 
    GLOBAL
 
    TYPE        QGAPAR_TYPE
 
END_INSTANCE