LIST_FILE_UTILITY.F90 Subprograms

Last modified: Fri Feb 11 14:23:42 2005.


List of Subprograms


Subprogram Descriptions

READ_LIST_FILE

[Next Subprogram] [List of Subprograms]
 NAME:
       Read_List_File

 PURPOSE:
       Function to read a list file.

 CATEGORY:
       Utility

 LANGUAGE:
       Fortran-95

 CALLING SEQUENCE:
       Error_Status = Read_List_File( List_Filename,           &  ! Input
                                      List,                     &  ! Output
                                      RCS_Id      = RCS_Id,     &  ! Optional output
                                      Message_Log = Message_Log ) ! Error messaging

 INPUT ARGUMENTS:
       List_Filename:  Character string specifying the name of the list file
                       UNITS:      N/A
                       TYPE:       CHARACTER( * )
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( IN )
!
 OPTIONAL INPUT ARGUMENTS:
       Message_Log:    Character string specifying a filename in which any
                       Messages will be logged. If not specified, or if an
                       error occurs opening the log file, the default action
                       is to output Messages to standard output.
                       UNITS:      N/A
                       TYPE:       CHARACTER( * )
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( IN ), OPTIONAL

 OUTPUT ARGUMENTS:
       List:           List file structure containing the list file entries
                       on exit.
                       UNITS:      N/A
                       TYPE:       Character_List_File_type 
                                     OR                     
                                   Integer_List_File_type   
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( IN OUT )

 OPTIONAL OUTPUT ARGUMENTS:
       RCS_Id:         Character string containing the Revision Control
                       System Id field for the module.
                       UNITS:      N/A
                       TYPE:       CHARACTER( * )
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( OUT ), OPTIONAL


 FUNCTION RESULT:
       Error_Status:    The return value is an integer defining the
                        error status. The error codes are defined in
                        the ERROR_HANDLER module. Values returned by
                        this function are:
                          SUCCESS == the list file read was successful.
                          FAILURE == an unrecoverable error occurred.
                        UNITS:      N/A
                        TYPE:       INTEGER
                        DIMENSION:  Scalar

 CALLS:
       Display_Message:   Subroutine to output messages
                          SOURCE: ERROR_HANDLER module

 CONTAINS:
       None.

 SIDE EFFECTS:
       None

 RESTRICTIONS:
       - Maximum line length that can be read is 5000 characters. If there
         is any data beyond this limit, the line is considered blank.

       - Any line in list file with a "!" character in the first column
         is treated as a comment line and is not read. Similarly for
         blank lines.

 COMMENTS:
       Note the INTENT on the output List argument is IN OUT rather than
       just OUT. This is necessary because the argument may be defined upon
       input. To prevent memory leaks, the IN OUT INTENT is a must.

 CREATION HISTORY:
       Written by:     Paul van Delst, CIMSS/SSEC 24-Aug-2004
                       paul.vandelst@ssec.wisc.edu

(See List_File_Utility.f90)


GET_LIST_SIZE

[Previous Subprogram] [Next Subprogram] [List of Subprograms]
 NAME:
       Get_List_Size

 PURPOSE:
       Function to return the size fo a List File structure

 CATEGORY:
       Utility

 LANGUAGE:
       Fortran-95

 CALLING SEQUENCE:
       n_Entries = Get_List_Size( List )

 INPUT ARGUMENTS:
       List:           List file structure.
                       UNITS:      N/A
                       TYPE:       Character_List_File_type 
                                     OR                     
                                   Integer_List_File_type   
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( IN )

 OPTIONAL INPUT ARGUMENTS:
       None.

 OUTPUT ARGUMENTS:
       None.

 OPTIONAL OUTPUT ARGUMENTS:
       None.

 FUNCTION RESULT:
       n_Entries:       The number of entries in the list file structure.
                        UNITS:      N/A
                        TYPE:       INTEGER
                        DIMENSION:  Scalar

 CALLS:
      None.

 CONTAINS:
       None.

 SIDE EFFECTS:
       None

 RESTRICTIONS:
       None

 CREATION HISTORY:
       Written by:     Paul van Delst, CIMSS/SSEC 24-Aug-2004
                       paul.vandelst@ssec.wisc.edu

(See List_File_Utility.f90)


GET_LIST_ENTRY

[Previous Subprogram] [List of Subprograms]
 NAME:
       Get_List_Entry

 PURPOSE:
       Function to return entries from a list file structure.

 CATEGORY:
       Utility

 LANGUAGE:
       Fortran-95

 CALLING SEQUENCE:
       Error_Status = Get_List_Entry( List,                     &  ! Input
                                      n,                        &  ! Input
                                      Entry,                    &  ! Output
                                      RCS_Id      = RCS_Id,     &  ! Optional output
                                      Message_Log = Message_Log ) ! Error messaging

 INPUT ARGUMENTS:
       List:           List file structure.
                       UNITS:      N/A
                       TYPE:       Character_List_File_type 
                                     OR                     
                                   Integer_List_File_type   
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( IN )

       n:              The list file structure entry to retrieve
                       UNITS:      N/A
                       TYPE:       INTEGER
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( IN )

 OPTIONAL INPUT ARGUMENTS:
       Message_Log:    Character string specifying a filename in which any
                       Messages will be logged. If not specified, or if an
                       error occurs opening the log file, the default action
                       is to output Messages to standard output.
                       UNITS:      N/A
                       TYPE:       CHARACTER( * )
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( IN ), OPTIONAL

 OUTPUT ARGUMENTS:
       Entry:          The retrieved list file entry.
                       UNITS:      N/A
                       TYPE:       Depends on List input argument.
                                     If:   List  is TYPE(Character_List_File_type)
                                     Then: Entry is CHARACTER(*)
                                       OR                     
                                     If:   List  is TYPE(Integer_List_File_type)
                                     Then: Entry is INTEGER
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( OUT )

 OPTIONAL OUTPUT ARGUMENTS:
       RCS_Id:         Character string containing the Revision Control
                       System Id field for the module.
                       UNITS:      N/A
                       TYPE:       CHARACTER( * )
                       DIMENSION:  Scalar
                       ATTRIBUTES: INTENT( OUT ), OPTIONAL


 FUNCTION RESULT:
       Error_Status:    The return value is an integer defining the
                        error status. The error codes are defined in
                        the ERROR_HANDLER module. Values returned by
                        this function are:
                          SUCCESS == the list structure retrieval was successful.
                          FAILURE == an unrecoverable error occurred.
                        UNITS:      N/A
                        TYPE:       INTEGER
                        DIMENSION:  Scalar

 CALLS:
      Display_Message:    Subroutine to output messages
                          SOURCE: ERROR_HANDLER module

 CONTAINS:
       None.

 SIDE EFFECTS:
       None

 RESTRICTIONS:
       None

 CREATION HISTORY:
       Written by:     Paul van Delst, CIMSS/SSEC 24-Aug-2004
                       paul.vandelst@ssec.wisc.edu

(See List_File_Utility.f90)