/[ascend]/trunk/pygtk/interface/module.h
ViewVC logotype

Annotation of /trunk/pygtk/interface/module.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 180 - (hide annotations) (download) (as text)
Thu Jan 12 03:20:58 2006 UTC (18 years, 6 months ago) by johnpye
File MIME type: text/x-chdr
File size: 1009 byte(s)
Adding a little documentation
1 johnpye 132 #ifndef SWIG_MODULE_H
2     #define SWIG_MODULE_H
3    
4     extern "C"{
5     #include <utilities/ascConfig.h>
6     #include <compiler/compiler.h>
7     #include <general/list.h>
8     #include <compiler/module.h>
9     }
10    
11     #include "type.h"
12    
13 johnpye 180 /**
14     A Module in ASCEND is an opened version of an A4L or A4C file. You
15     can have multiple versions of a file active in memory at a time,
16     theoretically, although no serious effort to support this in the
17     PyGTK interface has yet been made.
18    
19     To view what types are present in a given Module, you currently
20     need to query the Library object.
21     */
22 johnpye 132 class Module{
23     private:
24     const module_t *t;
25    
26     public:
27     Module();
28     Module(const module_t *t);
29    
30     /// Name of the current module (as identified by ASCEND)
31     const char *getName() const;
32    
33     /// Modification time (see <time.h>) for the current module
34     const struct tm* getMtime() const;
35    
36     /// Filename for the current module
37     const char *getFilename() const;
38    
39     /// Return the internal representation of the module
40     const struct module_t *getInternalType() const;
41     };
42    
43     #endif

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