projects/themis/common/
thm_valid_input.pro
function thm_valid_input purpose: for thm_load routines to validate the input keyword and set it to a standard format ('l1', 'l2', etc.). parameters: input: keyword input to be validated from thm_load routine: array or scalar label: name of input keyword that is being validated keywords: vinputs: a space-separated string, like 'l1 l2' definput: a string like 'l2'. Required. include_all: if set will accept multiple values on input, and include 'all' as a valid input. 'all' is equivalent to '*' verbose: to maintain control of verbosity format: format to use to convert numerical input to string. Numerical input disallowed if absent. examples: "('l',I1)" or "('v', I02)" return value: a scalar string, e.g. 'l1' if /include_all: an array of strings on error: empty string: '' example: lvl = thm_valid_input(level,'Level',vinputs='l1 l2',definput='l1',$ foramt="('l', I1)", verbose=verbose) if lvl eq '' then return
Routines
top source thm_valid_input
result = thm_valid_input(input, label, vinputs=vinputs, definput=definput, include_all=include_all, format=format, verbose=verbose, no_download=no_download)
Parameters
- input
- label
Keywords
- vinputs
- definput
- include_all
- format
- verbose
- no_download
File attributes
Modification date: | Thu Feb 13 16:42:33 2014 |
Lines: | 26 |