get_file_details.F90

Go to the documentation of this file.

!------------------------------------------------------------------------
! Copyright 2006-2010, CERFACS, Toulouse, France.
! All rights reserved. Use is subject to license terms.
!------------------------------------------------------------------------
!BOP
!
!======================================================================
!
  SUBROUTINE get_file_details ( id_XML_doc,  &
     cda_xpath,         &
     cda_var_name,      &
     sd_file,           &
     id_error )
! !DESCRIPTION
! This routine extracts, from a CIM XML file, the informations about a connection or a coupling
! at the target endpoint
!
!----------------------------------------------------------------------
!
    USE PSMILe_smioc
    IMPLICIT NONE
!
!EOP
!----------------------------------------------------------------------
!
! 0. Declaration
!
! handle of XML content of the CIM file
    INTEGER, INTENT(In) :: id_XML_doc

! XPath character string = where to search in the XML document
    CHARACTER(len=*), INTENT(In)  :: cda_xpath

! NetCDF variable name we are looking for
    CHARACTER(len=*), INTENT(In)  :: cda_var_name

! Data structure to fill in
    TYPE (PSMILe_file_struct), INTENT(InOut) :: sd_file

! returned error code
    INTEGER, INTENT(Out):: id_error

! temporary character string
    CHARACTER(LEN=max_name) :: cla_char
    INTEGER :: il_test, il_length
    DOUBLE PRECISION  :: dl_test
    
    INTEGER :: sasa_c_get_number_3rd_level 
    INTEGER :: sasa_c_get_element_3rd_level_c, sasa_c_get_element_4th_level_c
    INTEGER :: sasa_c_get_element_4th_level_i
    INTEGER :: sasa_c_get_element_4th_level_d 
    INTEGER :: sasa_c_get_attri_3rd_level
    INTEGER :: sasa_c_convert_char2int

    ! File name
    il_length = 0
    ! *** Get the file name
    id_error = &
        sasa_c_get_element_3rd_level_c (id_XML_doc, cda_xpath, 0,   &
        "storage", 0, "fileStorage", 0, "fileName", 0,              &
        cla_char, il_length)
    IF (il_length == 0) THEN
        PRINT *, '*******************************************'
        PRINT *, 'a name must be specified for each file     '
        PRINT *, '*******************************************'
        CALL PSMILe_Flushstd
        CALL MPI_Abort(MPI_COMM_WORLD, 1, id_error)
    ELSE
       sd_file%cg_file_name = cla_char(1:il_length)
    ENDIF

    ! *** Get the file format : if specified, must be NetCDF 
    il_length = 0
    id_error = &
        sasa_c_get_attri_3rd_level (id_XML_doc, cda_xpath, 0,   &
        "distribution", 0, "distributionFormat", 0, "value",    &
        cla_char, il_length)
    IF (cla_char(1:il_length) == "NetCDF") THEN
        sd_file%ig_file_format = PSMILe_mpp_netcdf
    ELSE
        PRINT *, '**********************************************'
        PRINT *, ' Distribution format must be NetCDF for file: ', sd_file%cg_file_name
        PRINT *, '**********************************************'
        CALL PSMILe_Flushstd
        CALL MPI_Abort(MPI_COMM_WORLD, 1, id_error)
    ENDIF

    ! Read options related to the NetCDF variable whose name is given in "cda_var_name"
    ! fot that purpose, look for a child dataObject 
    ! with <hierarchyLevelValue> subelement equals to "cda_var_name"
    id_error = &
        sasa_c_get_number_3rd_level (id_XML_doc, cda_xpath, 0,   &
        "childObject", 0,                                        &
        'dataObject[normalize-space(hierarchyLevelValue)="'//cda_var_name//'"]', &
        il_test)
        
    ! if there is such an XML element
    if (il_test .ne. 0) then
        ! Look at content of this XML element
    
        ! *** Get the suffix option
        id_error = &
            sasa_c_get_element_4th_level_c (id_XML_doc, cda_xpath, 0,   &
            "childObject", 0,                                           &
            'dataObject[normalize-space(hierarchyLevelValue)="'//cda_var_name//'"]', 0,    &
            'dataProperty[name="suffix"]', 0, "value", 0, cla_char, il_length)
        if (il_length .ne. 0) then
            sd_file%ig_suffix = sasa_c_convert_char2int(cla_char(1:il_length))
            IF (sd_file%ig_suffix .eq. PSMILe_undef)  sd_file%ig_suffix = 0
        endif
        
        ! *** Get the io_mode
        id_error = &
            sasa_c_get_element_4th_level_c (id_XML_doc, cda_xpath, 0,   &
            "childObject", 0,                                           &
            'dataObject[normalize-space(hierarchyLevelValue)="'//cda_var_name//'"]', 0,    &
            'dataProperty[name="io_mode"]', 0, "value", 0, cla_char, il_length)
        if (il_length .ne. 0) then
            sd_file%ig_file_iomode = sasa_c_convert_char2int(cla_char(1:il_length))
        endif

        ! *** Get the "packing" option
        id_error = &
            sasa_c_get_element_4th_level_i (id_XML_doc, cda_xpath, 0,   &
            "childObject", 0,                                           &
            'dataObject[normalize-space(hierarchyLevelValue)="'//cda_var_name//'"]', 0,    &
            'dataProperty[name="packing"]', 0, "value", 0, sd_file%ig_file_pack)

        ! *** Get the "scale_factor" option
        id_error = &
            sasa_c_get_element_4th_level_d (id_XML_doc, cda_xpath, 0,   &
            "childObject", 0,                                           &
            'dataObject[normalize-space(hierarchyLevelValue)="'//cda_var_name//'"]', 0,    &
            'dataProperty[name="scale_factor"]', 0, "value", 0, sd_file%dg_file_scal)

        ! *** Get the "add_offset" option
        id_error = &
            sasa_c_get_element_4th_level_d (id_XML_doc, cda_xpath, 0,   &
            "childObject", 0,                                           &
            'dataObject[normalize-space(hierarchyLevelValue)="'//cda_var_name//'"]', 0,    &
            'dataProperty[name="add_offset"]', 0, "value", 0, sd_file%dg_file_add)

        ! *** Get the "fill_value" option
        id_error = &
            sasa_c_get_element_4th_level_d (id_XML_doc, cda_xpath, 0,   &
            "childObject", 0,                                           &
            'dataObject[normalize-space(hierarchyLevelValue)="'//cda_var_name//'"]', 0,    &
            'dataProperty[name="_FillValue"]', 0, "value", 0, sd_file%dg_fill_val)
    endif

  END SUBROUTINE get_file_details

!
!======================================================================