/[ascend]/trunk/tcltk98/generic/interface/BrowWhen_io.h
ViewVC logotype

Contents of /trunk/tcltk98/generic/interface/BrowWhen_io.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 67 - (show annotations) (download) (as text)
Wed Nov 30 16:31:29 2005 UTC (16 years, 5 months ago) by johnpye
File MIME type: text/x-chdr
File size: 3735 byte(s)
Standardised the "if seen" #defines to [ASC|ASCTK|ASCPY|ASCXX]_FILENAME_H
Fixed compile on FC3
1 /*
2 * BrowWhen_io.h
3 * by Kirk Abbott and Ben Allan
4 * Created: 1/94
5 * Version: $Revision: 1.4 $
6 * Version control file: $RCSfile: BrowWhen_io.h,v $
7 * Date last modified: $Date: 2003/08/23 18:43:04 $
8 * Last modified by: $Author: ballan $
9 *
10 * This file is part of the ASCEND Tcl/Tk interface
11 *
12 * Copyright 1997, Carnegie Mellon University
13 *
14 * The ASCEND Tcl/Tk interface is free software; you can redistribute
15 * it and/or modify it under the terms of the GNU General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
18 *
19 * The ASCEND Tcl/Tk interface is distributed in hope that it will be
20 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with the program; if not, write to the Free Software Foundation,
26 * Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
27 * COPYING. COPYING is found in ../compiler.
28 */
29
30 /** @file
31 * Browser When IO Routines
32 * <pre>
33 * To include this header, you must include the following:
34 * #include "tcl.h"
35 * #include "utilities/ascConfig.h"
36 * #include "BrowWhen_io.h"
37 * </pre>
38 */
39
40 #ifndef ASCTK_BROWWHEN_IO_H
41 #define ASCTK_BROWWHEN_IO_H
42
43 extern int Asc_BrowWriteWhenListCmd(ClientData cdata, Tcl_Interp *interp,
44 int argc, CONST84 char *argv[]);
45 /**<
46 * Write a list of when statements to the Tcl interpreter. This option
47 * is active when the current instance is a Model or a WHEN.<br><br>
48 *
49 * If the Instance is a Model, both
50 * the list of WHENs inside the model and
51 * the list of WHENs which include the Model in some CASE
52 * will be send to the Tcl interpreter, differentiating each of the two
53 * list.<br><br>
54 *
55 * If the Instance is a WHEN, both
56 * the WHEN statement by itself and
57 * the WHEN statements which include this WHEN recursively
58 * will be send to the Tcl interpreteer.<br><br>
59 *
60 * If the Instance is an array of WHENs, only the list of WHENs will be
61 * provided (just by simplicity) and send to the Tcl interpreter.<br><br>
62 *
63 * Registered as: bgetwhens ?cur?search? save
64 */
65
66 extern int Asc_BrowWriteWhensForInstanceCmd(ClientData cdata,
67 Tcl_Interp *interp,
68 int argc,
69 CONST84 char *argv[]);
70 /**<
71 * Will return a proper Tcl list of all whens associated
72 * with the given instance. Works on the current or the search instance.
73 * Will return TCL_ERROR if the instance is NULL, or the atom is not
74 * appropriate.<br><br>
75 *
76 * By "associated" I mean:
77 *
78 * -# If the instance is integer, symbol or boolean, this instance
79 * may be part of the list of variables of one/several WHEN statements.
80 * If this is the case, the list of "associated" WHENs will be send to
81 * the Tcl interpreter.
82 *
83 * -# If the instance is a relation, the list of WHENs which include
84 * that relation in some CASE, will be send to the interpreter.
85 * When the instance is a Model or a WHEN, the previous function
86 * Asc_BrowWriteWhenListCmd is used instead.
87 *
88 * IMPORTANT: For the case of relations, this function works if the
89 * WHEN include the equation explicitly. It will not work if the
90 * WHEN inlcude the equation implicitly by including the model which
91 * contains the relation.<br><br>
92 *
93 * Registered as: __brow_whensforinstance ?cur?search.
94 */
95
96 #endif /* ASCTK_BROWWHEN_IO_H */
97

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