Overview   Directory   Index   Search   File   Source   Help   Etc 
   
Produced by IDL 7.1.1
User Documentation
 prev file | next file          view single page | view frames | update routines
SUMMARY: fields | routine          DETAILS: routine

./toolbox/io
getConfigValue.pro

Last modification date:
Wed Sep 28 13:27:11 2016

getConfigValue

function getConfigValue(name, [defaultValue=string], [configFile=string])

Parse a GBT config file (typically system.conf).

Adapted from the getConfigValue.py used in sparrow. This is needed by gbtidl so that the SDFITS_DATA value that the online sdfits daemon uses to decide where to write the sdfits files is the same as that used by GBTIDL to find the online sdfits files.

Returns the value of the named parameter as found in an environment variable having the same name, the config file, or the supplied default value (in that order).

Note : the name value is always converted to upper case before any comparisons are made.

Note : if the path in configFile starts with a / then it is assumed to be the full path. If it starts with any other character than the full path to the config file is + "/etc/config/ + configFile where is the value of the YGOR_TELESCOPE environment variable.

Returns
The value associated with name from an environment variable of the same name, or the named parameter in the config file, or the default value.
Version
$Id$

Parameters
name
in, required
string 		The parameter name.

Keywords
defaultValue
in, optional
string 		The default value to return if name is not found in an environment variable or the config file.
configFile
in, optional
string 		The config file to use. Defaults to "system.conf".

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:41 2016