carga.h

   1 /* vim: set et ts=4 sw=4 fdm=indent fdl=1 fdn=1 fo+=t:
   2  *
   3  * Taller de Programación (75.42).
   4  *
   5  * Trabajo Práctico Número 1:
   6  * Graficador de la solución de una ecuación diferencial por el método
   7  * de Euler (explícito).
   8  *
   9  * Copyleft 2003 - Leandro Lucarella <llucare@fi.uba.ar>
  10  * Puede copiar, modificar y distribuir este programa bajo los términos de
  11  * la licencia GPL (http://www.gnu.org/).
  12  *
  13  * Creado: sáb ago 23 16:59:01 ART 2003
  14  *
  15  * $Id$
  16  */
  17
  18 #ifndef H_CARGA
  19 #define H_CARGA
  20
  21 #include "tipos.h"
  22
  23 /**
  24  * Carga (validando) un dato real en una variable.
  25  * Si al validar hay algún error, muestra un mensaje por la salida de error y
  26  * devuelve false.
  27  *
  28  * \param arg Argumento a cargar (y validar).
  29  * \param var Variable en donde cargar el real.
  30  * \param nom Nombre de la variable que se quiere cargar (para el mensaje de
  31  *            error, en caso de haberlo).
  32  *
  33  * \return TRUE si se cargó bien, FALSE si no.
  34  */
  35 int argtod(const char* arg, Real* var, const char* nom);
  36
  37 /**
  38  * Carga los datos necesarios por el \ref main "programa".
  39  * Obtiene los datos desde los parámetros de la línea de comandos, validándolos
  40  * y mostrando un mensaje de error en caso de haberlo.
  41  *
  42  * \param argc Cantidad de parámetros de línea de comandos ingresados.
  43  * \param argv Parámetros de línea de comandos.
  44  * \param paso Paso utilizado para las iteraciones.
  45  * \param t0   Tiempo inicial.
  46  * \param tf   Tiempo final.
  47  * \param f0   Valor inicial de la función.
  48  *
  49  * \return TRUE si se cargaron bien, FALSE si no.
  50  */
  51 int cargar_datos(int argc, const char** argv, Real* paso, Real* t0, Real* tf,
  52         Real* f0);
  53
  54 #endif