SWMM-Docs  5.2.0.dev4
Stormwater Management Model
swmm5.h
Go to the documentation of this file.
1 
12 #ifndef SWMM5_H
13 #define SWMM5_H
14 
15 // --- define WINDOWS
16 
17 #undef WINDOWS
18 #ifdef _WIN32
19  #define WINDOWS
20 #endif
21 #ifdef __WIN32__
22  #define WINDOWS
23 #endif
24 
25 // --- define DLLEXPORT
26 
27 //#ifndef DLLEXPORT
28 #ifdef WINDOWS
29  #ifdef __MINGW32__
30  // Seems to be more wrapper friendly
31  #define DLLEXPORT __declspec(dllexport) __cdecl
32  #else
33  #define DLLEXPORT __declspec(dllexport) __stdcall
34  #endif
35 #else
36  #define DLLEXPORT
37 #endif
38 //#endif
39 
40 // --- use "C" linkage for C++ programs
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
53 int DLLEXPORT swmm_run(char* f1, char* f2, char* f3);
54 
62 int DLLEXPORT swmm_open(char* f1, char* f2, char* f3);
63 
69 int DLLEXPORT swmm_start(int saveFlag);
70 
76 int DLLEXPORT swmm_step(double* elapsedTime);
77 
82 int DLLEXPORT swmm_end(void);
83 
88 int DLLEXPORT swmm_report(void);
89 
97 int DLLEXPORT swmm_getMassBalErr(float* runoffErr, float* flowErr,
98  float* qualErr);
99 
104 int DLLEXPORT swmm_close(void);
105 
110 int DLLEXPORT swmm_getVersion(void);
111 
116 void DLLEXPORT swmm_getSemVersion(char* semver);
117 
124 void DLLEXPORT swmm_getVersionInfo(char* major, char* minor, char* patch);
125 
126 int DLLEXPORT swmm_getError(char* errMsg, int msgLen); //(5.1.011)
127 int DLLEXPORT swmm_getWarnings(void); //(5.1.011)
128 int swmm_IsOpenFlag(void);
129 int swmm_IsStartedFlag(void);
130 
131 #ifdef __cplusplus
132 } // matches the linkage specification from above */
133 #endif
134 
135 #endif
void DLLEXPORT swmm_getVersionInfo(char *major, char *minor, char *patch)
Get full semantic version number info.
Definition: swmm5.c:759
int DLLEXPORT swmm_end(void)
End SWMM simulation.
Definition: swmm5.c:626
void DLLEXPORT swmm_getSemVersion(char *semver)
Get full semantic version number.
Definition: swmm5.c:749
int DLLEXPORT swmm_close(void)
Frees all memory and files used by SWMM.
Definition: swmm5.c:685
int DLLEXPORT swmm_report(void)
Write text report file.
Definition: swmm5.c:666
int DLLEXPORT swmm_run(char *f1, char *f2, char *f3)
Opens SWMM input file, reads in network data, runs, and closes.
Definition: swmm5.c:287
int DLLEXPORT swmm_step(double *elapsedTime)
Step SWMM simulation forward.
Definition: swmm5.c:500
int DLLEXPORT swmm_getVersion(void)
Get Legacy SWMM version number.
Definition: swmm5.c:735
int DLLEXPORT swmm_start(int saveFlag)
Start SWMM simulation.
Definition: swmm5.c:410
int DLLEXPORT swmm_getMassBalErr(float *runoffErr, float *flowErr, float *qualErr)
Get routing errors.
Definition: swmm5.c:709
int DLLEXPORT swmm_open(char *f1, char *f2, char *f3)
Opens SWMM input file & reads in network data.
Definition: swmm5.c:348