2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team,
6 * check out http://www.gromacs.org for more information.
7 * Copyright (c) 2012, by the GROMACS development team, led by
8 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
9 * others, as listed in the AUTHORS file in the top-level source
10 * directory and at http://www.gromacs.org.
12 * GROMACS is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 2.1
15 * of the License, or (at your option) any later version.
17 * GROMACS is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with GROMACS; if not, see
24 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * If you want to redistribute modifications to GROMACS, please
28 * consider that scientific software is very special. Version
29 * control is crucial - bugs must be traceable. We will be happy to
30 * consider code for inclusion in the official distribution, but
31 * derived work must not be called official GROMACS. Details are found
32 * in the README & COPYING files - if they are missing, get the
33 * official version at http://www.gromacs.org.
35 * To help us fund GROMACS development, we humbly ask that you cite
36 * the research papers on the package. Check out http://www.gromacs.org.
41 #include "visibility.h"
47 #if 0 /* avoid screwing up indentation */
52 /* output_env member functions */
54 /* The output_env structure holds information about program name, cmd line,
57 There are still legacy functions for the program name, and the command
58 line, but the output_env versions are now preferred.*/
62 timeNULL, time_fs, time_ps, time_ns, time_us, time_ms, time_s
64 /* the time units. For the time being, ps means no conversion. */
66 typedef enum { exvgNULL, exvgXMGRACE, exvgXMGR, exvgNONE } xvg_format_t;
67 /* the xvg output formattings */
72 time_unit_t time_unit; /* the time unit, enum defined in statuti.h */
73 gmx_bool view; /* view of file requested */
74 xvg_format_t xvg_format; /* xvg output format, enum defined in statutil.h */
75 int verbosity; /* The level of verbosity for this program */
76 int debug_level; /* the debug level */
78 char *program_name; /* the program name */
79 char *cmd_line; /* the re-assembled command line */
83 void output_env_init(output_env_t oenv, int argc, char *argv[],
84 time_unit_t tmu, gmx_bool view, xvg_format_t xvg_format,
85 int verbosity, int debug_level);
86 /* initialize an output_env structure, setting the command line,
87 the default time value a gmx_boolean view that is set to TRUE when the
88 user requests direct viewing of graphs,
89 the graph formatting type, the verbosity, and debug level */
91 void output_env_init_default(output_env_t oenv);
92 /* initialize an output_env structure, with reasonable default settings.
93 (the time unit is set to time_ps, which means no conversion). */
95 void output_env_done(output_env_t oenv);
96 /* free memory allocated for an output_env structure. */
99 int output_env_get_verbosity(const output_env_t oenv);
100 /* return the verbosity */
102 int output_env_get_debug_level(const output_env_t oenv);
103 /* return the debug level */
106 const char *output_env_get_time_unit(const output_env_t oenv);
107 /* return time unit (e.g. ps or ns) */
110 const char *output_env_get_time_label(const output_env_t oenv);
111 /* return time unit label (e.g. "Time (ps)") */
114 const char *output_env_get_xvgr_tlabel(const output_env_t oenv);
115 /* retrun x-axis time label for xmgr */
118 real output_env_get_time_factor(const output_env_t oenv);
119 /* return time conversion factor from ps (i.e. 1e-3 for ps->ns) */
122 real output_env_get_time_invfactor(const output_env_t oenv);
123 /* return inverse time conversion factor from ps (i.e. 1e3 for ps->ns) */
126 real output_env_conv_time(const output_env_t oenv, real time);
127 /* return converted time */
130 void output_env_conv_times(const output_env_t oenv, int n, real *time);
131 /* convert array of times */
133 gmx_bool output_env_get_view(const output_env_t oenv);
134 /* Return TRUE when user requested viewing of the file */
138 xvg_format_t output_env_get_xvg_format(const output_env_t oenv);
139 /* Returns enum (see above) for xvg output formatting */
141 const char *output_env_get_program_name(const output_env_t oenv);
142 /* return the program name */
144 const char *output_env_get_cmd_line(const output_env_t oenv);
145 /* return the command line */
147 const char *output_env_get_short_program_name(const output_env_t oenv);
148 /* get the short version (without path component) of the program name */