Simulation Options

Functions
void DLLEXPORT	swmm_getAPIError (int errcode, char *s)
	Get the text of an error code. More...
int DLLEXPORT	swmm_getSimulationUnit (int type, int *value)
	Gets Simulation Unit. More...
int DLLEXPORT	swmm_getSimulationAnalysisSetting (int type, int *value)
	Gets Simulation Analysis Setting. More...
int DLLEXPORT	swmm_getSimulationParam (int type, double *value)
	Gets Simulation Analysis Setting. More...
int DLLEXPORT	swmm_getSimulationDateTime (int timetype, int *year, int *month, int *day, int *hour, int *minute, int *second)
	Get the current simulation datetime information. More...
int DLLEXPORT	swmm_setSimulationDateTime (int timetype, char *dtimestr)
	Set simulation datetime information. More...

Detailed Description

Function Documentation

swmm_getAPIError()

void swmm_getAPIError	(	int	errcode,
		char *	s
	)

Get the text of an error code.

Parameters

	errcode	The error code
[out]	s	The error string represented by the code

Input: errcode = error code Output: errmessage String Return: API Error Purpose: Get an error message

Definition at line 42 of file toolkitAPI.c.

swmm_getSimulationAnalysisSetting()

int swmm_getSimulationAnalysisSetting	(	int	type,
		int *	value
	)

Gets Simulation Analysis Setting.

Parameters

	type	Option code (see SM_SimOption)
[out]	value	Option value

Returns

Error code

Input: type = analysis type Output: setting True or False Returns: API Error Purpose: get simulation analysis setting

Definition at line 202 of file toolkitAPI.c.

swmm_getSimulationDateTime()

int swmm_getSimulationDateTime	(	int	timetype,
		int *	year,
		int *	month,
		int *	day,
		int *	hour,
		int *	minute,
		int *	second
	)

Get the current simulation datetime information.

Parameters

	timetype	The property type code (See SM_TimePropety)
[out]	year	The year
[out]	month	The month
[out]	day	The day
[out]	hour	The hour
[out]	minute	The minute
[out]	second	The seconds

Returns

Error code

Input: timetype = time type to return Output: year, month, day, hours, minutes, seconds = int Return: API Error Purpose: Get the simulation start, end and report date times

Definition at line 69 of file toolkitAPI.c.

swmm_getSimulationParam()

int swmm_getSimulationParam	(	int	type,
		double *	value
	)

Gets Simulation Analysis Setting.

Parameters

	type	Option code (see SM_SimSetting)
[out]	value	Option value

Returns

Error code

Input: type = analysis type Output: Simulation Parameter Returns: error code Purpose: Get simulation analysis parameter

Definition at line 243 of file toolkitAPI.c.

swmm_getSimulationUnit()

int swmm_getSimulationUnit	(	int	type,
		int *	value
	)

Gets Simulation Unit.

Parameters

	type	Option code (see SM_Units)
[out]	value	Option value

Returns

Error code

Input: type = simulation unit type Output: enum representation of units Returns: API Error Purpose: get simulation unit types

Definition at line 170 of file toolkitAPI.c.

swmm_setSimulationDateTime()

swmm_setSimulationDateTime	(	int	timetype,
		char *	dtimestr
	)

Set simulation datetime information.

Parameters

	timetype	The property type code (See SM_TimePropety)
[out]	dtimestr	The current datetime. dtimestr must be pre-allocated by the caller. This will copy 19 characters.

Returns

Error code

Input: timetype = time type to return DateTime String Return: API Error Purpose: Get the simulation start, end and report date times

Definition at line 110 of file toolkitAPI.c.