generic/compiler/plot.h

/*  ASCEND modelling environment
    Copyright (C) 1990 Thomas Guthrie Epperly, Karl Michael Westerberg
    Copyright (C) 1994 Kirk Andre Abbott, Benjamin Andrew Allan
    Copyright (C) 2006 Carnegie Mellon University

    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, or (at your option)
    any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*//**
    @file
    This module defines the plot generation auxillaries for Ascend.

    Requires:
    #include "utilities/ascConfig.h"
    #include "compiler/instance_enum.h"
*//*
    Version: $Revision: 1.1 $
    Version control file: $RCSfile: plot.h,v $
    Date last modified: $Date: 1997/07/18 11:47:38 $
    Last modified by: $Author: mthomas $
*/

#ifndef ASC_PLOT_H
#define ASC_PLOT_H

/** addtogroup compiler Compiler
    @{
*/

/** addtogroup compiler Compiler
    @{
*/

#include <utilities/ascConfig.h>

/** Plot types. */
enum PlotTypes {
  PLAIN_PLOT,
  GNU_PLOT,
  XGRAPH_PLOT
};

ASC_DLLSPEC enum PlotTypes g_plot_type;
/**<
 *  These are the plot types recognized by the code in plot.c
 *  Parameterized equivalents are also recognized.
 *  <pre>
 *  MODEL plt_point;
 *      x, y IS_A real;
 *  END plt_point;
 *
 *  MODEL plt_curve;
 *      npnts             IS_A set of integer_constant;
 *      pnt[npnts]        IS_A plt_point;
 *      legend            IS_A symbol; (* or symbol_constant *)
 *  END plt_curve;
 *
 *  MODEL plt_plot_symbol;
 *     curve_set            IS_A set OF symbol_constant;
 *     curve[curve_set]     IS_A plt_curve;
 *
 *     title, XLabel, YLabel IS_A symbol; (* or symbol_constant *)
 *     Xlow,Xhigh,Ylow,Yhigh IS_A real;
 *     Xlog, Ylog IS_A boolean;
 *  END plt_plot_symbol;
 *
 *  MODEL plt_plot_integer;
 *      curve_set                IS_A set of  integer_constant;
 *      curve[curve_set]      IS_A plt_curve;
 *
 *      title, XLabel, YLabel IS_A symbol; (* or symbol_constant *)
 *      Xlow,Xhigh,Ylow,Yhigh IS_A real;
 *      Xlog, Ylog IS_A boolean;
 *  END plt_plot_integer;
 *  </pre>
 *  @todo Support for all the attributes of a plt_plot_*
 *        is good only for xgraph. gnuplot has been neglected.
 */

ASC_DLLSPEC void plot_prepare_file(struct Instance *inst, char *plotfilename);
/**<
 *  Writes data points for the given plot instance to the given plot file.
 */

ASC_DLLSPEC boolean plot_allowed(struct Instance *inst);
/**<
 *  Determines whether or not the given instance is allowed to be plotted
 *  (i.e. whether it is a refinement of plt_plot).
 */

#endif  /* ASCTK_PLOT_H */

1	johnpye	485	/* 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	jds	54
6	johnpye	485	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	aw0a	1
11	johnpye	485	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	johnpye	170	#ifndef ASC_PLOT_H
35			#define ASC_PLOT_H
36	aw0a	1
37	johnpye	1066	/** addtogroup compiler Compiler
38			@{
39			*/
40
41			/** addtogroup compiler Compiler
42			@{
43			*/
44
45	johnpye	485	#include <utilities/ascConfig.h>
46
47	jds	54	/** Plot types. */
48	aw0a	1	enum PlotTypes {
49			PLAIN_PLOT,
50			GNU_PLOT,
51			XGRAPH_PLOT
52			};
53
54	johnpye	1063	ASC_DLLSPEC enum PlotTypes g_plot_type;
55	jds	54	/**<
56	aw0a	1	* These are the plot types recognized by the code in plot.c
57			* Parameterized equivalents are also recognized.
58	jds	54	* <pre>
59	aw0a	1	* MODEL plt_point;
60			* x, y IS_A real;
61			* END plt_point;
62			*
63			* MODEL plt_curve;
64			* npnts IS_A set of integer_constant;
65			* pnt[npnts] IS_A plt_point;
66			* legend IS_A symbol; (* or symbol_constant *)
67			* END plt_curve;
68			*
69			* MODEL plt_plot_symbol;
70			* curve_set IS_A set OF symbol_constant;
71			* curve[curve_set] IS_A plt_curve;
72			*
73			* title, XLabel, YLabel IS_A symbol; (* or symbol_constant *)
74			* Xlow,Xhigh,Ylow,Yhigh IS_A real;
75			* Xlog, Ylog IS_A boolean;
76			* END plt_plot_symbol;
77			*
78			* MODEL plt_plot_integer;
79			* curve_set IS_A set of integer_constant;
80			* curve[curve_set] IS_A plt_curve;
81			*
82			* title, XLabel, YLabel IS_A symbol; (* or symbol_constant *)
83			* Xlow,Xhigh,Ylow,Yhigh IS_A real;
84			* Xlog, Ylog IS_A boolean;
85			* END plt_plot_integer;
86	jds	54	* </pre>
87			* @todo Support for all the attributes of a plt_plot_*
88			* is good only for xgraph. gnuplot has been neglected.
89	aw0a	1	*/
90
91	johnpye	1063	ASC_DLLSPEC void plot_prepare_file(struct Instance inst, char plotfilename);
92	jds	54	/**<
93	aw0a	1	* Writes data points for the given plot instance to the given plot file.
94			*/
95
96	johnpye	1063	ASC_DLLSPEC boolean plot_allowed(struct Instance *inst);
97	jds	54	/**<
98	aw0a	1	* Determines whether or not the given instance is allowed to be plotted
99			* (i.e. whether it is a refinement of plt_plot).
100			*/
101	jds	54
102	johnpye	170	#endif /* ASCTK_PLOT_H */
103	jds	54