!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! SDDL Name:	ZQGTIME.SDDL
!
! Purpose:      This file defines the qgtime relation.
!
! Modification History:
!
!   Date        PR     Who                       Reason
! --------   -------   ---   -------------------------------------------------
! 10/19/94   27329     SXT   Original implementation
! 08/13/96   29960     MRB   Added C output and refinements
! 03/12/99   38555     MRB   Remove instruction versions (version_num field)
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!

LANGUAGE  C, FORTRAN, SQL

INCLUDE  ZSPSS_USER_TYPES.SDDL

RECORD  QGTIME_TYPE

!------------------------------------------------------------------------------
!
!   RECORD INFORMATION
!
!------------------------------------------------------------------------------


    DESCRIPTION

	"The relation QGTIME gets populated in Pass 3 of INSTRUCT/CLP, during 
    the process of storing time specifications. 

	A time specification is a special parameter to an instruction. 
    It consists of a time modifier and a time value. For example:
                   TIME  = 10:25:52.221
                   START = 1994.200:00:00:01.001

	The base time is the Expander's means of telling time. This base time 
    gets altered through the use of these different time specifications(from
    qgtime). After initialization by the Expander, the base time is maintained
    and used to determine where, in time, expanded results are placed in the 
    SMS.

	When command INSTRUCT/EXPAND or SMSG/GEN is run, after all activity and
    instruction processing is complete, the statements written to the Logical
    SMS are sorted by the time associated with each statement. This time is 
    referred to as the SMS sort time (also called SMSTIME) of the statement.
    In SMSG/FORMAT this time is written to the SMS file following each 
    statement. In most cases, the SMS sort time (SMSTIME) is the same as the 
    Expander base time.

	The SMS sort time described above is determined by the time 
    specification of the instruction. It is updated by one of the following 
    time modifiers: TIME, DELTA,START,LOADBY,LOADAFTER,DUMPBY and DUMPAFTER. 
    Only one of these types of time modifiers may appear in any instruction's 
    time specifications. The possible three cases are the following:

    a. If none of these time modifiers is specified, 
       	      SMS sort time = Expander base time

    b. If a TIME, START or DELTA time modifier was specified, SMSG/GEN calls
       routine QXBTIM to update the Expander base time according to the
       time specification and we can use:
              SMS sort time = updated Expander base time

    c. If a  LOADBY, LOADAFTER, DUMPBY, or DUMPAFTER time modifier was
       specified with time value:
              SMS sort time = time specification value"

       
!------------------------------------------------------------------------------
!
!   FIELD INFORMATION
!
!------------------------------------------------------------------------------


    FIELD  instr_name
        TYPE            C12
        DESCRIPTION     "This is the name of the instruction to which the 
                        time specification applies.  This field is used to 
                        index into this relation."
    END_FIELD


    FIELD  seq_no
        TYPE            I4
        DESCRIPTION     "This is the component number to which the time applies.
                        A Component is defined as a statement of an SCPL 
                        instruction. A component of a defined instruction is 
                        accessed by instruction name and component number."
        RANGE           
    END_FIELD


    FIELD  order_no
        TYPE            I2
        DESCRIPTION     "The order number is the index for each time 
                        specification since a component may have more than one 
                        time specification."
        RANGE           
    END_FIELD


    FIELD  time_mod
        TYPE            C10
        DESCRIPTION     "This is the time modifier. A time specification 
                        consists of a time modifier and a time value. The
                        time modifier indicates the purpose of the time value.
                        For example, a DELTA time modifier indicates the time
                        value is to be used as an adjustment to the current 
                        basetime, while a time modifier of TIME indicates the 
                        basetime should be set to the time value. Legal values 
                        of time modifiers are shown in ST-ICD-11 Figure A-1, 
                        plus two expander internal use modifiers: DURATION 
                        and BASETIME."
    END_FIELD


    FIELD  sms_flag
        TYPE            YES_NO_FLAG_TYPE
        DESCRIPTION     "This is the flag to determine whether a time 
                        specification should be used by SMS to be sent out to 
                        PASS (default=Y).
                        Y = used by SMS generation,
                        N = not used by SMS generation."
    END_FIELD


    FIELD  time_val
        TYPE            C72
        DESCRIPTION     "This is the field containing the variable or value 
                        of the time specification entered by the user. The 
                        following are valid time values:
                               delta    time
                               absolute time
                               orbital  time 
                        Time value formats are as shown in ST-ICD-11, Fig A-1."
    END_FIELD


    FIELD  time_desc
        TYPE            C62
        DESCRIPTION     "This is a description for the time specification."
    END_FIELD


END_RECORD


!------------------------------------------------------------------------------
!
!   RELATION DECLARATION
!
!------------------------------------------------------------------------------


RELATION  qgtime

    TYPE             QGTIME_TYPE

    DESCRIPTION      "Instruction Time Relation"

    SUBSYSTEM_USING  "SPSS", "IM"

    INDEX  qgtime_1
        TYPE         unique, clustered
        FIELDS       instr_name, seq_no, time_mod
    END_INDEX

END_RELATION

!------------------------------------------------------------------------------
!
!   INSTANCE DECLARATION
!
!------------------------------------------------------------------------------


INSTANCE  qgtime

    GLOBAL

    TYPE        QGTIME_TYPE

END_INSTANCE