added ctypesgen automated wrapping

Author: mauriziocingi

README.md

@@ -1,6 +1,14 @@
 # epanet-python
 python wrapper for epanet library
 
+## epamodule
 A Python module that permits Epanet toolkit library calls from pure Python programs.
+epanet2.py is generated from epanet2.h by ctypesgen
 
 Example2.py is example2.c from toolkit help rewritten in Python as example of epamodule use.
+
+## outbin
+Python module for reading EpanetBinaryOutputFiles in OO mode
+See help of class EpanetOutBin. 
+At present it is a self contained pure Py module: a partial rewriting is planned
+in a near future for use of outputapi C library.

epamodule.py

@@ -7,7 +7,7 @@
 import platform
 import datetime
 
-_plat= platform.system()
+"""_plat= platform.system()
 if _plat=='Linux':
   _lib = ctypes.CDLL("libepanet.so.2")
 elif _plat=='Windows':
@@ -24,14 +24,17 @@
        raise Exception("epanet2.dll not suitable")
 
 else:
-  Exception('Platform '+ _plat +' unsupported (not yet)')
+  Exception('Platform '+ _plat +' unsupported (not yet)')"""
+import epanet2 as _lib  
 
 
 _current_simulation_time=  ctypes.c_long()
 
 _max_label_len= 32
+label = ctypes.create_string_buffer(_max_label_len)
+
 _err_max_char= 80
-  
+errmsg= _lib.String(_err_max_char*"\0")
 
 
 
@@ -87,7 +90,6 @@ def ENgetnodeid(index):
 
     Arguments:
     index: node index"""    
-    label = ctypes.create_string_buffer(_max_label_len)
     ierr= _lib.ENgetnodeid(index, ctypes.byref(label))
     if ierr!=0: raise ENtoolkitError(ierr)
     return label.value
@@ -161,10 +163,9 @@ def ENgetlinkid(index):
 
     Arguments:
     index: link index"""
-    label = ctypes.create_string_buffer(_max_label_len)
-    ierr= _lib.ENgetlinkid(index, ctypes.byref(label))
+    ierr= _lib.ENgetlinkid(index, label)
     if ierr!=0: raise ENtoolkitError(ierr)
-    return label.value
+    return str(label)
 
 
 def ENgetlinktype(index):
@@ -221,10 +222,9 @@ def ENgetpatternid(index):
 
     Arguments:
     index: pattern index"""
-    label = ctypes.create_string_buffer(_max_label_len)
-    ierr= _lib.ENgetpatternid(index, ctypes.byref(label))
+    ierr= _lib.ENgetpatternid(index, label)
     if ierr!=0: raise ENtoolkitError(ierr)
-    return label.value
+    return str(label)
 
 def ENgetpatternindex(patternid):
     """Retrieves the index of a particular time pattern.
@@ -706,9 +706,8 @@ def ENsetstatusreport(statuslevel):
 
 def ENgeterror(errcode):
     """Retrieves the text of the message associated with a particular error or warning code."""
-    errmsg= ctypes.create_string_buffer(_err_max_char)
-    _lib.ENgeterror( errcode,ctypes.byref(errmsg), _err_max_char )
-    return errmsg.value
+    _lib.ENgeterror( errcode, errmsg , _err_max_char )
+    return str(errmsg)
 
 def ENwriteline(line ):
     """Writes a line of text to the EPANET report file."""
@@ -733,12 +732,11 @@ def __str__(self):
 #----------------------------------------------------------------------------------
 if hasattr(_lib,"ENgetcurve"):
    def ENgetcurve(curveIndex):
-       curveid = ctypes.create_string_buffer(_max_label_len)
        nValues = ctypes.c_int()
        xValues= ctypes.POINTER(ctypes.c_float)()
        yValues= ctypes.POINTER(ctypes.c_float)()
        ierr= _lib.ENgetcurve(curveIndex,
-                             ctypes.byref(curveid),
+                             label,
 	     	             ctypes.byref(nValues),
 	     	             ctypes.byref(xValues),
 	     	             ctypes.byref(yValues)
@@ -752,142 +750,71 @@ def ENgetcurve(curveIndex):
        return curve
 
    def ENgetcurveid(curveIndex):
-       curveid = ctypes.create_string_buffer(_max_label_len)
        nValues = ctypes.c_int()
        xValues= ctypes.POINTER(ctypes.c_float)()
        yValues= ctypes.POINTER(ctypes.c_float)()
        ierr= _lib.ENgetcurve(curveIndex,
-                             ctypes.byref(curveid),
+                             label,
 	     	             ctypes.byref(nValues),
 	     	             ctypes.byref(xValues),
 	     	             ctypes.byref(yValues)
 		             )
        # strange behavior of ENgetcurve: it returns also curveID
        # better split in two distinct functions ....
        if ierr!=0: raise ENtoolkitError(ierr)
-       return curveid.value
+       return str(label)
 
 #-----end of functions added from OpenWaterAnalytics ----------------------------------
 
+# /* Node parameters */
+from epanet2 import EN_ELEVATION, EN_BASEDEMAND, EN_PATTERN, EN_EMITTER, EN_INITQUAL, EN_SOURCEQUAL
+from epanet2 import EN_SOURCEPAT,EN_SOURCETYPE,EN_TANKLEVEL, EN_DEMAND, EN_HEAD, EN_PRESSURE      
+from epanet2 import EN_QUALITY, EN_SOURCEMASS, EN_INITVOLUME, EN_MIXMODEL, EN_MIXZONEVOL    
+
+from epanet2 import EN_TANKDIAM,EN_MINVOLUME,EN_VOLCURVE,EN_MINLEVEL,EN_MAXLEVEL,EN_MIXFRACTION,EN_TANK_KBULK
+
+# /* Link parameters */
+from epanet2 import EN_DIAMETER,EN_LENGTH,EN_ROUGHNESS,EN_MINORLOSS,EN_INITSTATUS,EN_INITSETTING
+from epanet2 import EN_KBULK,EN_KWALL,EN_FLOW,EN_VELOCITY,EN_HEADLOSS,EN_STATUS,EN_SETTING,EN_ENERGY
+
+# /* Time parameters */
+from epanet2 import EN_DURATION,EN_HYDSTEP,EN_QUALSTEP,EN_PATTERNSTEP,EN_PATTERNSTART
+from epanet2 import EN_REPORTSTEP,EN_REPORTSTART,EN_RULESTEP,EN_STATISTIC,EN_PERIODS 
+
+# /* Component counts */
+from epanet2 import EN_NODECOUNT,EN_TANKCOUNT,EN_LINKCOUNT,EN_PATCOUNT,EN_CURVECOUNT,EN_CONTROLCOUNT 
+
+# /* Node types */
+from epanet2 import EN_JUNCTION,EN_RESERVOIR,EN_TANK
+
+# /* Link types */
+from epanet2 import EN_CVPIPE,EN_PIPE,EN_PUMP,EN_PRV,EN_PSV,EN_PBV,EN_FCV,EN_TCV,EN_GPV
+
+# /* Quality analysis types */
+from epanet2 import EN_NONE,EN_CHEM,EN_AGE,EN_TRACE
+
+# /* Source quality types */
+from epanet2 import EN_CONCEN,EN_MASS,EN_SETPOINT,EN_FLOWPACED
+
+# /* Flow units types */
+from epanet2 import EN_CFS,EN_GPM,EN_MGD,EN_IMGD,EN_AFD,EN_LPS,EN_LPM,EN_MLD,EN_CMH,EN_CMD 
+
+# /* Misc. options */
+from epanet2 import EN_TRIALS,EN_ACCURACY,EN_TOLERANCE,EN_EMITEXPON,EN_DEMANDMULT
+
+# /* Control types */
+from epanet2 import EN_LOWLEVEL,EN_HILEVEL,EN_TIMER,EN_TIMEOFDAY
+
+# /* Time statistic types.    */
+from epanet2 import EN_AVERAGE,EN_MINIMUM,EN_MAXIMUM,EN_RANGE
+
+# /* Tank mixing models */
+from epanet2 import EN_MIX1,EN_MIX2,EN_FIFO,EN_LIFO
 
-EN_ELEVATION     = 0      # /* Node parameters */
-EN_BASEDEMAND    = 1
-EN_PATTERN       = 2
-EN_EMITTER       = 3
-EN_INITQUAL      = 4
-EN_SOURCEQUAL    = 5
-EN_SOURCEPAT     = 6
-EN_SOURCETYPE    = 7
-EN_TANKLEVEL     = 8
-EN_DEMAND        = 9
-EN_HEAD          = 10
-EN_PRESSURE      = 11
-EN_QUALITY       = 12
-EN_SOURCEMASS    = 13
-EN_INITVOLUME    = 14
-EN_MIXMODEL      = 15
-EN_MIXZONEVOL    = 16
-
-EN_TANKDIAM      = 17
-EN_MINVOLUME     = 18
-EN_VOLCURVE      = 19
-EN_MINLEVEL      = 20
-EN_MAXLEVEL      = 21
-EN_MIXFRACTION   = 22
-EN_TANK_KBULK    = 23
-
-EN_DIAMETER      = 0      # /* Link parameters */
-EN_LENGTH        = 1
-EN_ROUGHNESS     = 2
-EN_MINORLOSS     = 3
-EN_INITSTATUS    = 4
-EN_INITSETTING   = 5
-EN_KBULK         = 6
-EN_KWALL         = 7
-EN_FLOW          = 8
-EN_VELOCITY      = 9
-EN_HEADLOSS      = 10
-EN_STATUS        = 11
-EN_SETTING       = 12
-EN_ENERGY        = 13
-
-EN_DURATION      = 0      # /* Time parameters */
-EN_HYDSTEP       = 1
-EN_QUALSTEP      = 2
-EN_PATTERNSTEP   = 3
-EN_PATTERNSTART  = 4
-EN_REPORTSTEP    = 5
-EN_REPORTSTART   = 6
-EN_RULESTEP      = 7
-EN_STATISTIC     = 8
-EN_PERIODS       = 9
-
-EN_NODECOUNT     = 0      # /* Component counts */
-EN_TANKCOUNT     = 1
-EN_LINKCOUNT     = 2
-EN_PATCOUNT      = 3
-EN_CURVECOUNT    = 4
-EN_CONTROLCOUNT  = 5
-
-EN_JUNCTION      = 0      # /* Node types */
-EN_RESERVOIR     = 1
-EN_TANK          = 2
-
-EN_CVPIPE        = 0      # /* Link types */
-EN_PIPE          = 1
-EN_PUMP          = 2
-EN_PRV           = 3
-EN_PSV           = 4
-EN_PBV           = 5
-EN_FCV           = 6
-EN_TCV           = 7
-EN_GPV           = 8
-
-EN_NONE          = 0      # /* Quality analysis types */
-EN_CHEM          = 1
-EN_AGE           = 2
-EN_TRACE         = 3
-
-EN_CONCEN        = 0      # /* Source quality types */
-EN_MASS          = 1
-EN_SETPOINT      = 2
-EN_FLOWPACED     = 3
-
-EN_CFS           = 0      # /* Flow units types */
-EN_GPM           = 1
-EN_MGD           = 2
-EN_IMGD          = 3
-EN_AFD           = 4
-EN_LPS           = 5
-EN_LPM           = 6
-EN_MLD           = 7
-EN_CMH           = 8
-EN_CMD           = 9
-
-EN_TRIALS        = 0      # /* Misc. options */
-EN_ACCURACY      = 1
-EN_TOLERANCE     = 2
-EN_EMITEXPON     = 3
-EN_DEMANDMULT    = 4
-
-EN_LOWLEVEL      = 0      # /* Control types */
-EN_HILEVEL       = 1
-EN_TIMER         = 2
-EN_TIMEOFDAY     = 3
-
-EN_AVERAGE       = 1      # /* Time statistic types.    */
-EN_MINIMUM       = 2
-EN_MAXIMUM       = 3
-EN_RANGE         = 4
-
-EN_MIX1          = 0      # /* Tank mixing models */
-EN_MIX2          = 1
-EN_FIFO          = 2
-EN_LIFO          = 3
-
-EN_NOSAVE        = 0      # /* Save-results-to-file flag */
-EN_SAVE          = 1
-EN_INITFLOW      = 10     # /* Re-initialize flow flag   */
+# /* Save-results-to-file flag */
+from epanet2 import EN_NOSAVE,EN_SAVE
+# /* Re-initialize flow flag   */
+from epanet2 import EN_INITFLOW