!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! SDDL Name:	QGFORMAT.SDDL
!
! Purpose:      This SDDL file defines the qgformat relation.
!
! Modification History:
!
!   Date        PR     Who                       Reason
! --------   -------   ---   -------------------------------------------------
! 11/03/94   27329     SXT   Original implementation
! 08/13/96   29960     MRB   Add C output and refinements 
! 12/13/99   39695     bao   Remove obsolete fields from qgformat and 
!			     qginstruct relations
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!

LANGUAGE	C, FORTRAN, SQL

INCLUDE         ZSPSS_USER_TYPES.SDDL

RECORD  QGFOR_TYPE

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

    DESCRIPTION       

	"This relation stores the format of tables from the PDB table library
	 (as stored in qgblibrary).  This information includes the number of 
	 parameters in the table, addressing information, etc. as described 
         in the field descriptions below.

	 During instruction expansion (in SMSG/GEN or INSTRUCT/EXPAND),
	 when an instruction of type 'TBL' (i.e. table) is encountered, the
	 Expander retrieves format information from qgformat.  This includes 
         the address of the table (within on-board computers) and whether the 
         table should be included in the SMS.

         IMTOOL IMTPZG reads in the table format defintion file, called TFPF.DAT
 	 from the ST PDB tape and creates an IMTPZA.SQL file of SQL appends and 
 	 deletes to update this relation. 

	 This is a read-only relation."

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

    FIELD  tbl_fmt_name
        TYPE            TABLE_NAME_TYPE
        RELATED_FIELDS  "qginstruct.tbl_fmt",
			"qgblibrary.table_name"
    END_FIELD

    FIELD  tbl_address
        TYPE            C11
        DESCRIPTION     "The table address may have the following types of
                         values:
                           - characters representing an address specified in 
                             the symbol of interest file of the PDB.
                           - a numeric representing the address of the start 
                             of the table in either the NSSC-1 or the DF-224
                             computer."
    END_FIELD

    FIELD  obc_dest
        TYPE            C4
        DESCRIPTION     "This is the OBC (On-Board Computer) flag specifying 
                        the table destination. It has the following valid
                        values:
                             NSSC = NSSC-1, Science Instrument Control and 
                                    Data Handler
                              224 = DF-224 computer
                              FOC = Faint Object Camera
                              FOS = Faint Object Spectrograph
                             FOSM = FOS Mechanism Calibration Table
                             WFII = Wide Field Planetary Camera 2."
        DISCRETE        "NSSC", "224", "FOC", "FOS", "FOSM", "WFII"
    END_FIELD

    FIELD  intrlck_flg
        TYPE            YES_NO_FLAG_TYPE
        DESCRIPTION     "If this field is 'Y', an interlock word is assumed as 
			the first word of the table. If this first word 
			contains a '1', the table is being updated. If this
                        word contains a '2', the update has been completed.
                        This field is not used by SOGS."
    END_FIELD

    FIELD  history_flag
        TYPE            YES_NO_FLAG_TYPE
        DESCRIPTION     "This flag denotes whether or not a history of the 
			 table is to be kept from update to update.  It is not
			 used by the software."
    END_FIELD

    FIELD  access_code
        TYPE            C1
        DESCRIPTION     "The access code is used to indicate whether the table 
			 should be included in the SMS.  'S' means the table 
			 should be included in the SMS.  ' ' is the opposite."
    END_FIELD

    FIELD  num_param
        TYPE            C4
        DESCRIPTION     "This field contains the number of parameters contained
			 in the table."
    END_FIELD

END_RECORD

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

RELATION  qgformat

    TYPE             QGFOR_TYPE

    DESCRIPTION      "Instruction PDB Table Format Relation" 

    SUBSYSTEM_USING  "SPSS", "SCS", "IM"

    RELATED_FIELDS   "qginstruct.*",
		     "qgblibrary.*",
		     "qgsym_inter.*",
                     "command_cnt.*"

    INDEX  qgformat_1
        TYPE         unique, clustered
        FIELDS       tbl_fmt_name
    END_INDEX

END_RELATION

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

INSTANCE  qgformat

    GLOBAL

    TYPE        QGFOR_TYPE

END_INSTANCE