SWMM-Docs  5.2.0.dev4
Stormwater Management Model
Functions
swmm5.h File Reference

Prototypes for SWMM5 functions exported to swmm5.dll. More...

Go to the source code of this file.

Functions

int DLLEXPORT swmm_run (char *f1, char *f2, char *f3)
 Opens SWMM input file, reads in network data, runs, and closes. More...
 
int DLLEXPORT swmm_open (char *f1, char *f2, char *f3)
 Opens SWMM input file & reads in network data. More...
 
int DLLEXPORT swmm_start (int saveFlag)
 Start SWMM simulation. More...
 
int DLLEXPORT swmm_step (double *elapsedTime)
 Step SWMM simulation forward. More...
 
int DLLEXPORT swmm_end (void)
 End SWMM simulation. More...
 
int DLLEXPORT swmm_report (void)
 Write text report file. More...
 
int DLLEXPORT swmm_getMassBalErr (float *runoffErr, float *flowErr, float *qualErr)
 Get routing errors. More...
 
int DLLEXPORT swmm_close (void)
 Frees all memory and files used by SWMM. More...
 
int DLLEXPORT swmm_getVersion (void)
 Get Legacy SWMM version number. More...
 
void DLLEXPORT swmm_getSemVersion (char *semver)
 Get full semantic version number. More...
 
void DLLEXPORT swmm_getVersionInfo (char *major, char *minor, char *patch)
 Get full semantic version number info. More...
 

Detailed Description

Prototypes for SWMM5 functions exported to swmm5.dll.

See also
http://github.com/openwateranalytics/stormwater-management-model

swmm5.h

Date
03/24/14 (Build 5.1.001)
08/01/16 (Build 5.1.011)
Version
5.1
Authors
L. Rossman, OpenWaterAnalytics members: see AUTHORS.

Definition in file swmm5.h.

Function Documentation

◆ swmm_close()

int DLLEXPORT swmm_close ( void  )

Frees all memory and files used by SWMM.

Returns
Error code

Definition at line 685 of file swmm5.c.

◆ swmm_end()

int DLLEXPORT swmm_end ( void  )

End SWMM simulation.

Returns
error code

Definition at line 626 of file swmm5.c.

◆ swmm_getMassBalErr()

int DLLEXPORT swmm_getMassBalErr ( float *  runoffErr,
float *  flowErr,
float *  qualErr 
)

Get routing errors.

Parameters
[out]runoffErrRunoff routing error
[out]flowErrFlow routing error
[out]qualErrQuality routing error
Returns
error code

Definition at line 709 of file swmm5.c.

◆ swmm_getSemVersion()

void DLLEXPORT swmm_getSemVersion ( char *  semver)

Get full semantic version number.

Parameters
[out]semversematic version (char array)

Definition at line 749 of file swmm5.c.

◆ swmm_getVersion()

int DLLEXPORT swmm_getVersion ( void  )

Get Legacy SWMM version number.

Returns
Version

Definition at line 735 of file swmm5.c.

◆ swmm_getVersionInfo()

void DLLEXPORT swmm_getVersionInfo ( char *  major,
char *  minor,
char *  patch 
)

Get full semantic version number info.

Parameters
[out]majorsematic version major number
[out]minorsematic version minor number
[out]patchsematic version patch number

Definition at line 759 of file swmm5.c.

◆ swmm_open()

int DLLEXPORT swmm_open ( char *  f1,
char *  f2,
char *  f3 
)

Opens SWMM input file & reads in network data.

Parameters
f1pointer to name of input file (must exist)
f2pointer to name of report file (to be created)
f3pointer to name of binary output file (to be created)
Returns
error code

Definition at line 348 of file swmm5.c.

◆ swmm_report()

int DLLEXPORT swmm_report ( void  )

Write text report file.

Returns
error code

Definition at line 666 of file swmm5.c.

◆ swmm_run()

int DLLEXPORT swmm_run ( char *  f1,
char *  f2,
char *  f3 
)

Opens SWMM input file, reads in network data, runs, and closes.

Parameters
f1pointer to name of input file (must exist)
f2pointer to name of report file (to be created)
f3pointer to name of binary output file (to be created)
Returns
error code

Definition at line 287 of file swmm5.c.

◆ swmm_start()

int DLLEXPORT swmm_start ( int  saveFlag)

Start SWMM simulation.

Parameters
saveFlagTRUE or FALSE to save timeseries to report file
Returns
error code

Definition at line 410 of file swmm5.c.

◆ swmm_step()

int DLLEXPORT swmm_step ( double *  elapsedTime)

Step SWMM simulation forward.

Parameters
[out]elapsedTimeelapsed simulation time [milliseconds]
Returns
error code

Definition at line 500 of file swmm5.c.