Go to the bottom.
!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! SDDL Name: QGPARAMETER.SDDL
!
! Purpose: This SDDL file defines the qgparameter relation.
!
! Modification History:
!
! Date PR Who Reason
! -------- ------- --- -------------------------------------------------
! 12/02/94 27329 SXT Original implementation
! 08/13/96 29960 MRB Add 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 QGPAR_TYPE
!------------------------------------------------------------------------------
!
! RECORD INFORMATION
!
!------------------------------------------------------------------------------
DESCRIPTION
"This relation contains information about the parameters
of instructions. SCPL instructions may be passed data
through parameters like other high leve languages.
This relation stores their static descriptions.
Relation QGVALUE describes actual values which will
be passed to an instruction at run(expansion) time."
!------------------------------------------------------------------------------
!
! FIELD INFORMATION
!
!------------------------------------------------------------------------------
FIELD instr_name
TYPE INSTRUCTION_NAME_TYPE
END_FIELD
FIELD par_name
TYPE C12
DESCRIPTION "This field holds the name of the parameter which
is unique within the instruction."
END_FIELD
FIELD order_no
TYPE I*2
DESCRIPTION "The order number is the index for each parameter.
It is used to determine the order in which instruction
parameters are displayed when the instruction is
displayed or expanded."
END_FIELD
FIELD param_list
TYPE C1
DESCRIPTION "This field is the list parameter flag. It is set to
'Y' if this is a list parameter, otherwise it is set
to 'N'."
END_FIELD
FIELD arg_no
TYPE I2
DESCRIPTION "For a list parameter, this is the argument number.
This field is set to zero if the parameter is
not a list parameter."
END_FIELD
FIELD data_type
TYPE C4
DESCRIPTION "This field contains the data type of the parameter
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 parameter string size. It is set
only if the parameter data type is a string. Otherwise
this field is left blank."
END_FIELD
FIELD par_def_val
TYPE C1
DESCRIPTION "This field holds the default value flag. It
indicates whether a default value is defined for
this parameter, and if not whether the parameter
is required or optional. Valid values of this field
are the following:
D = default value is defined
R = the parameter is required
O or blank = the parameter is optional"
DISCRETE "D", "R", "O", " "
END_FIELD
FIELD time_flag
TYPE YES_NO_FLAG_TYPE
DESCRIPTION "This field holds the parameter time flag.
The purpose of this flag is to identify parameters
that are time specification parameters. For
example LOADBY and LOADAFTER are time
parameters. The value of this field is set to 'Y'
if this is a time parameter, otherwise it is set
to 'N'."
END_FIELD
FIELD par_unit
TYPE C15
DESCRIPTION "This field holds the unit of the parameter data.
See ST-ICD-26 for allowed units values."
END_FIELD
FIELD check_type
TYPE C1
DESCRIPTION "This field holds the check type. Every parameter
defined for an instruction has an associated check
type. Valid values of this field are the following:
D = discrete
R = range
N (or blank) = no check
If the check type is range, a maximum and minimum
value are included in the parameter definition. If the
check type is discrete, a state group name will be
included in the parameter definition. If the parameter
value does not fall into the specified range or match
one of the discrete values, the parameter shall not be
assigned a value."
END_FIELD
FIELD sms_flag
TYPE YES_NO_FLAG_TYPE
DESCRIPTION "This flag is used to determine whether a parameter
is used by an SMS to be sent out to PASS. It is set
to 'Y' if the parameter is used by SMS generation,
otherwise it is set to 'N'. Default value is 'Y'."
END_FIELD
FIELD syntax_type
TYPE C1
DESCRIPTION "This field holds the parameter syntax type, which
indicates the syntax of the parameter in SMS output.
Valid values of this field are the following:
V = value of the parameter (no name included)
D = direct (just name, no value included)
N = normal (name=value)."
DISCRETE "V", "D", "N"
END_FIELD
FIELD pass_type
TYPE C3
DESCRIPTION "This field holds the parameter pass type, which
indicates the form of a parameter passing from a
calling instruction. Valid values of this field
are the following:
VAL = passed by value.
REF = passed by reference
SUB = substitute parameter"
DISCRETE "VAL", "REF", "SUB"
END_FIELD
FIELD state_group
TYPE C26
DESCRIPTION "This field hold the state group name, which is the
name of the group of state values. It is used to
access the allowable values for parameters with value
check type equals to 'D' (discrete). The state group
contains a set of allowable discrete values for the
parameter."
END_FIELD
FIELD par_default
TYPE C18
DESCRIPTION "This field holds the default value of the parameter."
END_FIELD
FIELD par_upp_lim
TYPE C16
DESCRIPTION "This field holds the parameter maximum value if the
parameter check type is 'R'(range)."
END_FIELD
FIELD par_low_lim
TYPE C16
DESCRIPTION "This field holds the parameter minimum value if the
parameter check type is 'R'(range)."
END_FIELD
FIELD val_format
TYPE C8
DESCRIPTION "This field contains the format of the value of the
parameter, which is a FORTRAN-like format specification
that guides the output of parameter value to an SMS.
For example: f12.4."
END_FIELD
FIELD par_descr
TYPE C73
DESCRIPTION "This field contains the description for the
parameter."
END_FIELD
FIELD par_des_con
TYPE C73
DESCRIPTION "This field contains the continuation of the
parameter description."
END_FIELD
END_RECORD
!------------------------------------------------------------------------------
!
! RELATION DECLARATION
!
!------------------------------------------------------------------------------
RELATION qgparameter
TYPE QGPAR_TYPE
DESCRIPTION "Instruction Parameter Description Relation"
SUBSYSTEM_USING "SPSS", "IM"
INDEX qgparameter_1
TYPE unique, clustered
FIELDS instr_name, par_name, arg_no
END_INDEX
END_RELATION
!------------------------------------------------------------------------------
!
! INSTANCE DECLARATION
!
!------------------------------------------------------------------------------
INSTANCE qgparameter
GLOBAL
TYPE QGPAR_TYPE
END_INSTANCE
Go to the top.