uves_parameters.h

00001 /*
00002  * This file is part of the ESO UVES Pipeline
00003  * Copyright (C) 2004,2005 European Southern Observatory
00004  *
00005  * This program is free software; you can redistribute it and/or modify
00006  * it under the terms of the GNU General Public License as published by
00007  * the Free Software Foundation; either version 2 of the License, or
00008  * (at your option) any later version.
00009  *
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License
00016  * along with this program; if not, write to the Free Software
00017  * Foundation, 51 Franklin St, Fifth Floor, Boston, MA  02111-1307  USA
00018  */
00019 
00020 /*
00021  * $Author: amodigli $
00022  * $Date: 2007/06/06 08:17:33 $
00023  * $Revision: 1.9 $
00024  * $Name: uves-3_3_1 $
00025  * $Log: uves_parameters.h,v $
00026  * Revision 1.9  2007/06/06 08:17:33  amodigli
00027  * replace tab with 4 spaces
00028  *
00029  * Revision 1.8  2007/03/15 12:34:08  jmlarsen
00030  * Added missing include directive
00031  *
00032  * Revision 1.7  2006/10/24 14:04:46  jmlarsen
00033  * Defined macros to provide minimal syntax for parameter creation
00034  *
00035  * Revision 1.6  2006/08/17 13:56:53  jmlarsen
00036  * Reduced max line length
00037  *
00038  * Revision 1.5  2006/08/07 11:35:35  jmlarsen
00039  * Disabled parameter environment variable mode
00040  *
00041  * Revision 1.4  2005/12/19 16:17:56  jmlarsen
00042  * Replaced bool -> int
00043  *
00044  */
00045 #ifndef UVES_PARAMETERS_H
00046 #define UVES_PARAMETERS_H
00047 
00048 /*-----------------------------------------------------------------------------
00049                     Includes
00050  -----------------------------------------------------------------------------*/
00051 
00052 #include <uves_utils_wrappers.h>
00053 
00054 #include <cpl.h>
00055 /*-----------------------------------------------------------------------------
00056                             Typedefs
00057  -----------------------------------------------------------------------------*/
00058 /*-----------------------------------------------------------------------------
00059                              Defines
00060  -----------------------------------------------------------------------------*/
00061 /*-----------------------------------------------------------------------------
00062                                    Prototypes
00063  -----------------------------------------------------------------------------*/
00064 
00065 cpl_error_code
00066 uves_define_global_parameters(cpl_parameterlist *parlist);
00067 
00068 int
00069 uves_invoke_recipe(const char *recipe_id, const cpl_parameterlist *parameters, 
00070            cpl_frameset *frames,
00071            const char *caller_id, const char *context);
00072 
00073 int
00074 uves_propagate_parameters_step(const char *step_id,
00075                    cpl_parameterlist *parameters,
00076                    const char *recipe_id, const char *context);
00077 
00078 int
00079 uves_propagate_parameters(const char *subrecipe_id, 
00080               cpl_parameterlist *parameters,
00081               const char *recipe_id, const char *context);
00082 
00083 /*----------------------------------------------------------------------------*/
00093 /*----------------------------------------------------------------------------*/
00094 #define uves_parameter_new_value(p, name, type, description, context, default) \
00095       do {                                                                     \
00096             p = cpl_parameter_new_value(                                       \
00097                          name, type, description, context, default);           \
00098             cpl_parameter_disable(p, CPL_PARAMETER_MODE_ENV);                  \
00099       } while(false)
00100 
00101 /*----------------------------------------------------------------------------*/
00110 /*----------------------------------------------------------------------------*/
00111 #define uves_parameter_new_range(p, name, type, description, context,          \
00112                  default, min, max)                            \
00113       do {                                                                     \
00114             p = cpl_parameter_new_range(                                       \
00115                          name, type, description, context, default, min, max); \
00116             cpl_parameter_disable(p, CPL_PARAMETER_MODE_ENV);                  \
00117       } while(false)
00118 
00119 /*----------------------------------------------------------------------------*/
00129 /*----------------------------------------------------------------------------*/
00130 #define uves_parameter_new_enum(p, name, type, description, context, nopt, ...)\
00131       do {                                                                     \
00132             p = cpl_parameter_new_enum(                                        \
00133                          name, type, description, context, nopt, __VA_ARGS__); \
00134             cpl_parameter_disable(p, CPL_PARAMETER_MODE_ENV);                  \
00135       } while(false)
00136 
00137 
00138 
00139 /*----------------------------------------------------------------------------*/
00150 /*----------------------------------------------------------------------------*/
00151 #define uves_par_new_value(name, type, description, default)               \
00152     do {                                                                   \
00153         cpl_parameter *p;                                                  \
00154         char *context   = uves_sprintf("%s%s%s", recipe_id,                \
00155                                        subcontext != NULL ? "." : "",      \
00156                                        subcontext != NULL ? subcontext: "");\
00157         char *full_name = uves_sprintf("%s.%s", context, name);            \
00158         uves_parameter_new_value(p, full_name,                             \
00159                  type,                                     \
00160                  description,                              \
00161                                  context,                                  \
00162                  default);                                 \
00163        cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, name);           \
00164        cpl_parameterlist_append(parameters, p);                            \
00165        cpl_free(context);                                                  \
00166        cpl_free(full_name);                                                \
00167     } while(false)
00168 
00169 /*----------------------------------------------------------------------------*/
00182 /*----------------------------------------------------------------------------*/
00183 #define uves_par_new_range(name, type, description, default, min, max)     \
00184     do {                                                                   \
00185         cpl_parameter *p;                                                  \
00186         char *context   = uves_sprintf("%s%s%s", recipe_id,                \
00187                                        subcontext != NULL ? "." : "",      \
00188                                        subcontext != NULL ? subcontext: "");\
00189         char *full_name = uves_sprintf("%s.%s", context, name);            \
00190         uves_parameter_new_range(p, full_name,                             \
00191                  type,                                     \
00192                  description,                              \
00193                                  context,                                  \
00194                  default, min, max);                       \
00195        cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, name);           \
00196        cpl_parameterlist_append(parameters, p);                            \
00197        cpl_free(context);                                                  \
00198        cpl_free(full_name);                                                \
00199     } while(false)
00200 
00201 
00202 /*----------------------------------------------------------------------------*/
00214 /*----------------------------------------------------------------------------*/
00215 #define uves_par_new_enum(name, type, description, default, nopt, ...)       \
00216     do {                                                                     \
00217         cpl_parameter *p;                                                    \
00218         char *context   = uves_sprintf("%s%s%s", recipe_id,                \
00219                                        subcontext != NULL ? "." : "",      \
00220                                        subcontext != NULL ? subcontext: "");\
00221         char *full_name = uves_sprintf("%s.%s", context, name);              \
00222         uves_parameter_new_enum(p, full_name,                                \
00223                  type,                                       \
00224                  description,                                \
00225                                  context,                                    \
00226                  default, nopt, __VA_ARGS__);                \
00227        cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, name);             \
00228        cpl_parameterlist_append(parameters, p);                              \
00229        cpl_free(context);                                                    \
00230        cpl_free(full_name);                                                  \
00231     } while(false)
00232 
00233 #endif  /* UVES_PARAMETERS_H */

Generated on Tue Jun 19 14:39:16 2007 for UVES Pipeline Reference Manual by  doxygen 1.4.6