nml_string Function

public function nml_string(name, tgt, doc, units, required, dead_on_ocean_path) result(key)

Construct a string key, capturing the current target as default.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: name
character(len=:), intent(in), pointer :: tgt
character(len=*), intent(in) :: doc
character(len=*), intent(in), optional :: units
logical, intent(in), optional :: required
character(len=*), intent(in), optional :: dead_on_ocean_path

Return Value type(nml_string_key_t)


Called by

proc~~nml_string~~CalledByGraph proc~nml_string nml_string proc~add_dataovr_entry add_dataovr_entry proc~add_dataovr_entry->proc~nml_string proc~register_ocean_bt register_ocean_bt proc~register_ocean_bt->proc~nml_string proc~register_ocean_cavity_dyn register_ocean_cavity_dyn proc~register_ocean_cavity_dyn->proc~nml_string proc~register_ocean_diag register_ocean_diag proc~register_ocean_diag->proc~nml_string proc~register_ocean_grid register_ocean_grid proc~register_ocean_grid->proc~nml_string proc~register_ocean_tides register_ocean_tides proc~register_ocean_tides->proc~nml_string proc~register_ocean_zinit register_ocean_zinit proc~register_ocean_zinit->proc~nml_string proc~register_output register_output proc~register_output->proc~nml_string proc~register_time register_time proc~register_time->proc~nml_string proc~build_rdb_schema build_rdb_schema proc~build_rdb_schema->proc~register_ocean_bt proc~build_rdb_schema->proc~register_ocean_cavity_dyn proc~build_rdb_schema->proc~register_ocean_diag proc~build_rdb_schema->proc~register_ocean_grid proc~build_rdb_schema->proc~register_ocean_tides proc~build_rdb_schema->proc~register_ocean_zinit proc~build_rdb_schema->proc~register_output proc~build_rdb_schema->proc~register_time proc~register_ocean_dataovr register_ocean_dataovr proc~build_rdb_schema->proc~register_ocean_dataovr proc~register_ocean_dataovr->proc~add_dataovr_entry proc~read_config_from_string_impl read_config_from_string_impl proc~read_config_from_string_impl->proc~build_rdb_schema proc~read_config_impl read_config_impl proc~read_config_impl->proc~build_rdb_schema proc~read_config read_config proc~read_config->proc~read_config_impl proc~read_config_from_string read_config_from_string proc~read_config_from_string->proc~read_config_from_string_impl proc~build_pending_handle build_pending_handle proc~build_pending_handle->proc~read_config_from_string

Source Code

   function nml_string(name, tgt, doc, units, required, dead_on_ocean_path) result(key)
      !! Construct a string key, capturing the current target as default.
      character(len=*), intent(in) :: name, doc
      character(len=:), pointer, intent(in) :: tgt
      character(len=*), intent(in), optional :: units
      logical, intent(in), optional :: required
      character(len=*), intent(in), optional :: dead_on_ocean_path
      type(nml_string_key_t) :: key

      key%name = name
      key%doc = doc
      key%units = ""
      if (present(units)) key%units = units
      if (present(required)) key%required = required
      key%dead_reason = ""
      if (present(dead_on_ocean_path)) key%dead_reason = dead_on_ocean_path
      key%tgt => tgt
      key%default = tgt
   end function nml_string