/[ascend]/trunk/base/generic/compiler/plot.h
ViewVC logotype

Contents of /trunk/base/generic/compiler/plot.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1063 - (show annotations) (download) (as text)
Sun Jan 7 07:54:06 2007 UTC (17 years, 9 months ago) by johnpye
File MIME type: text/x-chdr
File size: 2932 byte(s)
Changed ASC_DLLSPEC(TYPE) to ASC_DLLSPEC TYPE, because it was causing havoc with doxygen and ctags.
1 /* ASCEND modelling environment
2 Copyright (C) 1990 Thomas Guthrie Epperly, Karl Michael Westerberg
3 Copyright (C) 1994 Kirk Andre Abbott, Benjamin Andrew Allan
4 Copyright (C) 2006 Carnegie Mellon University
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.
20 *//**
21 @file
22 This module defines the plot generation auxillaries for Ascend.
23
24 Requires:
25 #include "utilities/ascConfig.h"
26 #include "compiler/instance_enum.h"
27 *//*
28 Version: $Revision: 1.1 $
29 Version control file: $RCSfile: plot.h,v $
30 Date last modified: $Date: 1997/07/18 11:47:38 $
31 Last modified by: $Author: mthomas $
32 */
33
34 #ifndef ASC_PLOT_H
35 #define ASC_PLOT_H
36
37 #include <utilities/ascConfig.h>
38
39 /** Plot types. */
40 enum PlotTypes {
41 PLAIN_PLOT,
42 GNU_PLOT,
43 XGRAPH_PLOT
44 };
45
46 ASC_DLLSPEC enum PlotTypes g_plot_type;
47 /**<
48 * These are the plot types recognized by the code in plot.c
49 * Parameterized equivalents are also recognized.
50 * <pre>
51 * MODEL plt_point;
52 * x, y IS_A real;
53 * END plt_point;
54 *
55 * MODEL plt_curve;
56 * npnts IS_A set of integer_constant;
57 * pnt[npnts] IS_A plt_point;
58 * legend IS_A symbol; (* or symbol_constant *)
59 * END plt_curve;
60 *
61 * MODEL plt_plot_symbol;
62 * curve_set IS_A set OF symbol_constant;
63 * curve[curve_set] IS_A plt_curve;
64 *
65 * title, XLabel, YLabel IS_A symbol; (* or symbol_constant *)
66 * Xlow,Xhigh,Ylow,Yhigh IS_A real;
67 * Xlog, Ylog IS_A boolean;
68 * END plt_plot_symbol;
69 *
70 * MODEL plt_plot_integer;
71 * curve_set IS_A set of integer_constant;
72 * curve[curve_set] IS_A plt_curve;
73 *
74 * title, XLabel, YLabel IS_A symbol; (* or symbol_constant *)
75 * Xlow,Xhigh,Ylow,Yhigh IS_A real;
76 * Xlog, Ylog IS_A boolean;
77 * END plt_plot_integer;
78 * </pre>
79 * @todo Support for all the attributes of a plt_plot_*
80 * is good only for xgraph. gnuplot has been neglected.
81 */
82
83 ASC_DLLSPEC void plot_prepare_file(struct Instance *inst, char *plotfilename);
84 /**<
85 * Writes data points for the given plot instance to the given plot file.
86 */
87
88 ASC_DLLSPEC boolean plot_allowed(struct Instance *inst);
89 /**<
90 * Determines whether or not the given instance is allowed to be plotted
91 * (i.e. whether it is a refinement of plt_plot).
92 */
93
94 #endif /* ASCTK_PLOT_H */
95

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22