dm_geocom_type_validated Function

public function dm_geocom_type_validated(type, value, default, verbose, error) result(n)

Uses

  • proc~~dm_geocom_type_validated~~UsesGraph proc~dm_geocom_type_validated dm_geocom_type_validated module~dm_error dm_error proc~dm_geocom_type_validated->module~dm_error module~dm_util dm_util proc~dm_geocom_type_validated->module~dm_util module~dm_ascii dm_ascii module~dm_error->module~dm_ascii module~dm_kind dm_kind module~dm_error->module~dm_kind module~dm_util->module~dm_error module~dm_util->module~dm_kind iso_fortran_env iso_fortran_env module~dm_kind->iso_fortran_env

Parameterisation function for GeoCOM enumeration types.

Returns argument value if it is a valid enumerator of enumeration type, else the default value of that type. If argument type is not found or not supported, the function returns 0 and E_TYPE in error. If argument default is passed, it is returned instead on error.

The dummy argument value has been made optional for convenience. If not passed, the default value of the given type is returned, or default.

If argument type is valid, argument value is invalid, and argument default is not passed, the default value from the following table is returned:

Type Default Value
GEOCOM_AUT_ADJMODE GEOCOM_AUT_NORM_MODE
GEOCOM_AUT_ATRMODE GEOCOM_AUT_POSITION
GEOCOM_AUT_POSMODE GEOCOM_AUT_NORMAL
GEOCOM_BAP_ATRSETTING GEOCOM_BAP_ATRSET_NORMAL
GEOCOM_BAP_MEASURE_PRG GEOCOM_BAP_DEF_DIST
GEOCOM_BAP_PRISMTYPE GEOCOM_BAP_PRISM_ROUND
GEOCOM_BAP_REFLTYPE GEOCOM_BAP_REFL_UNDEF
GEOCOM_BAP_TARGET_TYPE GEOCOM_BAP_REFL_USE
GEOCOM_BAP_USER_MEASPRG GEOCOM_BAP_SINGLE_REF_STANDARD
GEOCOM_COM_BAUD_RATE GEOCOM_COM_BAUD_19200
GEOCOM_COM_TPS_STARTUP_MODE GEOCOM_COM_STARTUP_REMOTE
GEOCOM_COM_TPS_STOP_MODE GEOCOM_COM_STOP_SHUT_DOWN
GEOCOM_EDM_EGLINTENSITY_TYPE GEOCOM_EDM_EGLINTEN_OFF
GEOCOM_EDM_MODE GEOCOM_EDM_MODE_NOT_USED
GEOCOM_FTR_DEVICETYPE GEOCOM_FTR_DEVICE_INTERNAL
GEOCOM_FTR_FILETYPE GEOCOM_FTR_FILE_UNKNOWN
GEOCOM_IMG_MEM_TYPE GEOCOM_IMG_INTERNAL_MEMORY
GEOCOM_MOT_MODE GEOCOM_MOT_MANUPOS
GEOCOM_MOT_STOPMODE GEOCOM_MOT_NORMAL
GEOCOM_TMC_INCLINE_PRG GEOCOM_TMC_MEA_INC
GEOCOM_TMC_MEASURE_PRG GEOCOM_TMC_DEF_DIST

The function returns the following error codes in error:

  • E_TYPE if the type is not found or not supported.
  • E_INVALID if the value is not a valid enumerator.

If verbose is .true., an error message is printed to standard error.

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: type

GeoCOM enumeration type.
integer, intent(in), optional :: value

Enumerator to validate.
integer, intent(in), optional :: default

Value to return on error.
logical, intent(in), optional :: verbose

Print error messages.
integer, intent(out), optional :: error

Error code.

Return Value integer


Calls

proc~~dm_geocom_type_validated~~CallsGraph proc~dm_geocom_type_validated dm_geocom_type_validated interface~dm_present dm_present proc~dm_geocom_type_validated->interface~dm_present proc~dm_error_out dm_error_out proc~dm_geocom_type_validated->proc~dm_error_out proc~dm_is_error dm_is_error proc~dm_geocom_type_validated->proc~dm_is_error proc~dm_error_out->proc~dm_is_error proc~dm_ascii_escape dm_ascii_escape proc~dm_error_out->proc~dm_ascii_escape proc~dm_error_message dm_error_message proc~dm_error_out->proc~dm_error_message proc~dm_is_ok dm_is_ok proc~dm_error_out->proc~dm_is_ok proc~dm_stop dm_stop proc~dm_error_out->proc~dm_stop c_exit c_exit proc~dm_stop->c_exit