/*
- *
- * This source code is part of
- *
- * G R O M A C S
- *
- * GROningen MAchine for Chemical Simulations
- *
- * VERSION 3.2.0
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
+ * This file is part of the GROMACS molecular simulation package.
+ *
* Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2004, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
+ * Copyright (c) 2001-2004, The GROMACS development team.
+ * Copyright (c) 2012,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
+ *
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
- *
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
- *
+ *
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
+ *
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
- *
- * And Hey:
- * Gromacs Runs On Most of All Computer Systems
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
#ifndef _oenv_h
#define _oenv_h
-#include "types/simple.h"
-#include "types/oenv.h"
+#include "gromacs/legacyheaders/types/oenv.h"
+#include "gromacs/legacyheaders/types/simple.h"
#ifdef __cplusplus
extern "C" {
/* output_env member functions */
-/* The output_env structure holds information about program name, cmd line,
- default times, etc.
+/* The output_env structure holds information about program name, cmd line,
+ default times, etc.
- There are still legacy functions for the program name, and the command
+ There are still legacy functions for the program name, and the command
line, but the output_env versions are now preferred.*/
-typedef enum
-{
- timeNULL, time_fs, time_ps, time_ns, time_us, time_ms, time_s
+typedef enum
+{
+ timeNULL, time_fs, time_ps, time_ns, time_us, time_ms, time_s
} time_unit_t;
/* the time units. For the time being, ps means no conversion. */
-typedef enum { exvgNULL, exvgXMGRACE, exvgXMGR, exvgNONE } xvg_format_t;
+typedef enum {
+ exvgNULL, exvgXMGRACE, exvgXMGR, exvgNONE
+} xvg_format_t;
/* the xvg output formattings */
-void output_env_init(output_env_t *oenvp, int argc, char *argv[],
- time_unit_t tmu, gmx_bool view, xvg_format_t xvg_format,
- int verbosity, int debug_level);
-/* initialize an output_env structure, setting the command line,
- the default time value a gmx_boolean view that is set to TRUE when the
- user requests direct viewing of graphs,
- the graph formatting type, the verbosity, and debug level */
-
void output_env_init_default(output_env_t *oenvp);
/* initialize an output_env structure, with reasonable default settings.
(the time unit is set to time_ps, which means no conversion). */
int output_env_get_verbosity(const output_env_t oenv);
/* return the verbosity */
-int output_env_get_debug_level(const output_env_t oenv);
-/* return the debug level */
-
const char *output_env_get_time_unit(const output_env_t oenv);
/* return time unit (e.g. ps or ns) */
/* return time conversion factor from ps (i.e. 1e-3 for ps->ns) */
real output_env_get_time_invfactor(const output_env_t oenv);
-/* return inverse time conversion factor from ps (i.e. 1e3 for ps->ns) */
+/* return inverse time conversion factor to ps (i.e. 1e3 for ns->ps) */
real output_env_conv_time(const output_env_t oenv, real time);
/* return converted time */
xvg_format_t output_env_get_xvg_format(const output_env_t oenv);
/* Returns enum (see above) for xvg output formatting */
-const char *output_env_get_program_name(const output_env_t oenv);
-/* return the program name */
-
-const char *output_env_get_cmd_line(const output_env_t oenv);
-/* return the command line */
-
-const char *output_env_get_short_program_name(const output_env_t oenv);
-/* get the short version (without path component) of the program name */
+/*! \brief
+ * Returns display name for the currently running program.
+ */
+const char *output_env_get_program_display_name(const output_env_t oenv);
#ifdef __cplusplus
}
+
+namespace gmx
+{
+class ProgramContextInterface;
+} // namespace gmx
+
+void output_env_init(output_env_t *oenvp,
+ const gmx::ProgramContextInterface &context,
+ time_unit_t tmu, gmx_bool view, xvg_format_t xvg_format,
+ int verbosity);
+/* initialize an output_env structure, setting the command line,
+ the default time value a gmx_boolean view that is set to TRUE when the
+ user requests direct viewing of graphs,
+ the graph formatting type, the verbosity, and debug level */
+
+/*! \brief
+ * Returns gmx::ProgramContextInterface from an output_env structure.
+ */
+const gmx::ProgramContextInterface &
+output_env_get_program_context(const output_env_t oenv);
+
#endif
#endif
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff