!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! SDDL Name:	QGVARIABLE.SDDL
!
! Purpose:      This SDDL file defines the qgvariable relation.
!
! Modification History:
!
!   Date        PR     Who                       Reason
! --------   -------   ---   -------------------------------------------------
! 11/10/94   27329     SXT   Original implementation
! 08/13/96   29960     MRB   C output, refinements  
! 03/12/99   38555     MRB   Remove instruction versions (version_num field)
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
 
LANGUAGE  C, FORTRAN, SQL

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

	"This relation holds information about the variables of user-built 
    instructions. It contains the name, data type, value, initial value, scope, 
    and description of the variables defined for each instruction.

        During the generation of the SMS, the data in this relation is 
    retrieved using the instruction name and instruction version number. 

        This relation is populated during INSTRUCT/CLP."

!------------------------------------------------------------------------------
!
!   FIELD INFORMATION
!
!------------------------------------------------------------------------------
 
 
    FIELD  instr_name
        TYPE            INSTRUCTION_NAME_TYPE
    END_FIELD
 
 
    FIELD  order_no
        TYPE            I*2
        DESCRIPTION     "This field holds the order of the variables of 
                        an instruction to be retrieved or displayed."
    END_FIELD
 
 
    FIELD  vari_name
        TYPE            C12
        DESCRIPTION     "This field holds a variable name which will be 
                        referenced in an instruction or between instructions 
                        within an SMS. A variable shall be unique within the 
                        instruction."
    END_FIELD
 
 
    FIELD  data_type
        TYPE            C4
        DESCRIPTION     "This field contains the data type of the variable 
                        being described. Valid variable types include:
                             STRG = character string
                             INT  = integer
                             REAL = real number
                             DELT = delta time
                             ABST = absolute time
                             ORBT = orbital time
                             TIME = general time specification"
        DISCRETE        "STRG", "INT", "REAL", "DELT", "ABST", "ORBT", "TIME"
    END_FIELD
 
 
    FIELD  strg_size
        TYPE            C2
        DESCRIPTION     "This field holds the variable string size. It is set
                        only if the variable data type is a string. Otherwise
                        this field is left blank."
    END_FIELD
 
 
    FIELD  scope
        TYPE            C1
        DESCRIPTION     "This field is the variable scope, which specifies 
                        the class of the variable. SCPL provides two different
                        classes of variables: local and global. Global
                        variables also have a sub-class called external 
                        variables. The scope of a local variable is limited
                        to the defining instruction. On the other hand, a
                        global variable can be accessed from any instruction
                        in which the global variable is defined. Valid values 
                        of this field are the following:
                              L: for local variable,
                              G: for global variable,
                              E: for externally defined globals."
        DISCRETE        "L", "G", "E"
    END_FIELD
 
 
    FIELD  uniq_flag
        TYPE            YES_NO_FLAG_TYPE
        DESCRIPTION     "This field is the variable unique flag; it can be set 
                        for global variables only. When this flag is set, it
                        indicates the definition of this variable is expected
                        to be the first one, and a global variable having the
                        same name and data type should not exist. If one does 
                        exist, then a warning message is issued, and the first 
                        definition prevails. This field may have the following 
                        values: 
                             Y   = required to be unique.    (global only)
                             N   = not required to be unique (global and local)
                           blank = not required to be unique (global and local)"
    END_FIELD
 
 
    FIELD  init_value
        TYPE            C72
        DESCRIPTION     "This field holds the initial value of the variable." 
    END_FIELD
 
 
    FIELD  remarks
        TYPE            C40
        DESCRIPTION     "This field is a description of the variable of the
                        instruction."
    END_FIELD
 
 
END_RECORD
 
 
!------------------------------------------------------------------------------
!
!   RELATION DECLARATION
!
!------------------------------------------------------------------------------
 
 
RELATION  qgvariable
 
    TYPE             QGVAR_TYPE
 
    DESCRIPTION      "Instruction Variable Definition Relation"
 
    SUBSYSTEM_USING  "SPSS", "SCS", "IM"
 
    INDEX  qgvariable_1
        TYPE         unique, clustered
        FIELDS       instr_name, vari_name
    END_INDEX
 
END_RELATION
 
!------------------------------------------------------------------------------
!
!   INSTANCE DECLARATION
!
!------------------------------------------------------------------------------
 
 
INSTANCE  qgvariable
 
    GLOBAL
 
    TYPE        QGVAR_TYPE
 
END_INSTANCE