[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Sand 1, D-72076 Tübingen, Germany
[Uni logo]


cafegetparam Source code in cafegetparam.pro

cafegetparam

Name
           cafegetparam
Purpose
           retrieve  parameter
Category
           cafe
SUBCATEGORY:
           parameter change
SYNTAX:
           cafegetparam, param, item, list, default
Input Parameters
           item    - string (key) defining the parameter.
                     If the string consists of "topic:key" first for
                     exact matching string will be searched. If none
                     found the search is repeated with "key" (without
                     topic).
                     This handling allows to set up command specific
                     configurations by prepending a key with the
                     command name.
Example
                     > set,pfold:period= 5000.
                     -> cafegetparam returns the period for the pfold
                     -> command only.
           list    - newline separated list of items (the database).
           default - default value if item not found.
OPTIONS:
           verbose - Report result on terminal also.
Output Parameters
           result  - The resulting (found) value. Remains undefined
                     if not found.
Side Effects
           none.
Revision History
           $Id: cafegetparam.pro,v 1.5 2005/02/15 10:40:40 goehler Exp $
 $Log: cafegetparam.pro,v $
 Revision 1.5  2005/02/15 10:40:40  goehler
 verbose report of settings
 Revision 1.4  2005/01/04 10:56:05  goehler
 fix: make shure all (internal) routines are properly documented
 Revision 1.3  2003/06/06 13:30:33  goehler
 updated docu
 Revision 1.2  2003/05/16 18:44:47  goehler
 added parameter setting facility
 Revision 1.1  2003/05/06 13:16:21  goehler
 moved read/write of settings into separate procedures/functions.
 these also will be used for global settings.

Last modified by pro2html on 2005 February 16 at 04:24 UTC

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically