CST-Read Model

This section describes the CST-Read model, which is used to create the read subprogram for a model. The read subprogram reads the specifications for the model.

This section covers the following topics:

Introduction
Parameters for the CST-Read Model
User Exits for the CST-Read Model

Introduction

After defining the model PDA and clear subprogram, you must create a subprogram to read the specifications from a previously-generated module. The generated subprogram has one INPUT statement for each #PDAX variable in the model PDA.

A read subprogram generated by the CST-Read model contains a series of INPUT statements that accept the data previously placed in the Natural stack. The read subprogram is invoked when the developer invokes the Read Specifications function on the Generation main menu.

Before the read subprogram is invoked, all **SAG parameter values are placed on the Natural stack. The read subprogram repeats a series of INPUT statements to accept the stacked parameters and assign them to the correct PDA variables. This subprogram must correspond to the save subprogram that writes the **SAG parameter lines. The read subprogram can also read common parameters from a different model.

Notes:

Natural Construct invokes the clear subprogram before invoking the read subprogram. It is not necessary to save null parameter values.
For an example of a generated read subprogram, refer to CUMNR in the SYSCST library.

Parameters for the CST-Read Model

Use the CST-Read model to create the read subprogram. This model has one specification panel, Standard Parameters.

Standard Parameters Panel

  CUGRMA                       CST-Read Subprogram                       CUG-MA1
  Nov 28                       Standard Parameters                        1 of 1
                                                                                
   Module name ........ CXMNR___                                                
   Parameter data area  CXMNPDA_ *                                              
                                                                                
   Title .............. _________________________                               
   Description ........ Read parameter specification.__________________________ 
                        _______________________________________________________ 
                        _______________________________________________________ 
                        _______________________________________________________ 
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       help  retrn quit                                            userX main

The input fields on the Standard Parameters panel are:

Field	Description
Module name	Name specified on the Generation main menu. The name of the read subprogram must be alphanumeric and no more than eight characters in length. Use the following naming convention: CX`xx`R where `xx` uniquely identifies your model.
Parameter data area	Name of the parameter data area (PDA) for your model. Natural Construct determines the name of the PDA based on the Module name specified on the Generation main menu. For example, if you enter "CXMNR", Natural Construct assumes the PDA name is CXMNPDA. Use the following naming convention: CX`xx`PDA where `xx` uniquely identifies your model.
Title	Title for the generated subprogram. The title identifies the subprogram for the List Generated Modules function on the Generation main menu and is used internally for program documentation.
Description	Brief description of the subprogram. The description is inserted in the banner at the beginning of the subprogram and is used internally for program documentation.

User Exits for the CST-Read Model

 CSGSAMPL                     CST-Read Subprogram                        CSGSM0 
 Nov 28                            User Exits                            1 of 1 
                                                                                
                User Exits             Exists    Sample   Required Conditional  
     -------------------------------- -------- ---------- -------- ------------ 
  _  CHANGE-HISTORY                            Subprogram                       
  _  PARAMETER-DATA                                                             
  _  LOCAL-DATA                                 Example                         
  _  INPUT-ADDITIONAL-PARAMETERS               Subprogram                       
  _  BEFORE-CHECK-ERROR                         Example                         
  _  ADDITIONAL-INITIALIZATIONS                                                 
  _  END-OF-PROGRAM

For information about these user exits, see Supplied User Exits. For information about using the User Exit editor, refer to User Exit Editor, Natural Construct Generation.