Header file for SWMM output API. More...

#include "swmm_output_export.h"
#include "swmm_output_enums.h"

Include dependency graph for swmm_output.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	MAXFILENAME 259
	Maximum number of characters in a file path.

#define	MAXELENAME 31
	Maximum number of characters in a element name.

Typedefs
typedef void *	SMO_Handle
	Opaque pointer to struct. Do not access variables.

Functions
int EXPORT_SWMM_OUTPUT_API	SMO_init (SMO_Handle *p_handle)
	Initializes the SWMM output file handle.

int EXPORT_SWMM_OUTPUT_API	SMO_close (SMO_Handle *p_handle)
	Closes the SWMM output file handle.

int EXPORT_SWMM_OUTPUT_API	SMO_open (SMO_Handle p_handle, const char *path)
	Opens a SWMM output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getVersion (SMO_Handle p_handle, int *version)
	Retrieves the model version number that created the output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getProjectSize (SMO_Handle p_handle, int *elementCount, int length)
	Get project size.

int EXPORT_SWMM_OUTPUT_API	SMO_getUnits (SMO_Handle p_handle, int *unitFlag, int length)
	Retrieves the unit system used in the SWMM model.

int EXPORT_SWMM_OUTPUT_API	SMO_getFlowUnits (SMO_Handle p_handle, int *unitFlag)
	Returns unit flag for flow.

int EXPORT_SWMM_OUTPUT_API	SMO_getPollutantUnits (SMO_Handle p_handle, int *unitFlag, int length)
	Returns unit flag for pollutant. Concentration units are located after the pollutant ID names and before the object properties start, and are stored for each pollutant. They're stored as 4-byte integers with the following codes: 0: mg/L 1: ug/L 2: count/L.

int EXPORT_SWMM_OUTPUT_API	SMO_getStartDate (SMO_Handle p_handle, double *date)
	Retrieves the start date of the simulation.

int EXPORT_SWMM_OUTPUT_API	SMO_getTimes (SMO_Handle p_handle, SMO_time code, int *time)
	Retrieves the number of reporting periods in the simulation.

int EXPORT_SWMM_OUTPUT_API	SMO_getElementName (SMO_Handle p_handle, SMO_elementType type, int elementIndex, char *elementName, int size)
	Retrieves the element name by index and type from the SWMM output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getNumVars (SMO_Handle p_handle, SMO_elementType type, int *count)
	Retrieves the number of variables for a given element type that are stored in the output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getVarCode (SMO_Handle p_handle, SMO_elementType type, int varIndex, int *varCode)
	Retrieves the variable code for a given element type and variable index that is stored in the output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getVarCodes (SMO_Handle p_handle, SMO_elementType type, int *varCodes, int size)
	Retrieves the variable codes for a given element type that are stored in the output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getNumProperties (SMO_Handle p_handle, SMO_elementType type, int *count)
	Retrieves the number of properties for a given element type that are stored in the output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getPropertyCode (SMO_Handle p_handle, SMO_elementType type, int propertyIndex, int *propertyCode)
	Retrieves the property code for a given element type and property index that is stored in the output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getPropertyCodes (SMO_Handle p_handle, SMO_elementType type, int *propertyCodes, int size)
	Retrieves the property codes for a given element type that are stored in the output file.

int EXPORT_SWMM_OUTPUT_API	SMO_getPropertyValue (SMO_Handle p_handle, SMO_elementType type, int propertyIndex, int elementIndex, float *value)
	Retrieves the value of a property for a given element type, property index, and element index.

int EXPORT_SWMM_OUTPUT_API	SMO_getPropertyValues (SMO_Handle p_handle, SMO_elementType type, int elementIndex, float *outValueArray, int length)
	Retrieves all property values for a given element type and element index.

int EXPORT_SWMM_OUTPUT_API	SMO_getSubcatchSeries (SMO_Handle p_handle, int subcatchIndex, SMO_subcatchAttribute attr, int startPeriod, int endPeriod, float *outValueArray, int length)
	Retrieves subcatchment attribute values for a given time period and attribute type.

int EXPORT_SWMM_OUTPUT_API	SMO_getNodeSeries (SMO_Handle p_handle, int nodeIndex, SMO_nodeAttribute attr, int startPeriod, int endPeriod, float *outValueArray, int length)
	Retrieves node attribute values for a given time period and attribute type.

int EXPORT_SWMM_OUTPUT_API	SMO_getLinkSeries (SMO_Handle p_handle, int linkIndex, SMO_linkAttribute attr, int startPeriod, int endPeriod, float *outValueArray, int length)
	Retrieves link attribute values for a given time period and attribute type.

int EXPORT_SWMM_OUTPUT_API	SMO_getSystemSeries (SMO_Handle p_handle, SMO_systemAttribute attr, int startPeriod, int endPeriod, float *outValueArray, int length)
	Retrieves system attribute values for a given time period and attribute type.

int EXPORT_SWMM_OUTPUT_API	SMO_getSubcatchAttribute (SMO_Handle p_handle, int timeIndex, SMO_subcatchAttribute attr, float *outValueArray, int length)
	Retrieves subcatchment attribute values for a given time period and attribute type.

int EXPORT_SWMM_OUTPUT_API	SMO_getNodeAttribute (SMO_Handle p_handle, int timeIndex, SMO_nodeAttribute attr, float *outValueArray, int length)
	Retrieves node attribute values for a given time period and attribute type.

int EXPORT_SWMM_OUTPUT_API	SMO_getLinkAttribute (SMO_Handle p_handle, int timeIndex, SMO_linkAttribute attr, float *outValueArray, int length)
	Retrieves link attribute values for a given time period and attribute type.

int EXPORT_SWMM_OUTPUT_API	SMO_getSystemAttribute (SMO_Handle p_handle, int timeIndex, SMO_systemAttribute attr, float *outValueArray, int length)
	Retrieves system attribute values for a given time period and attribute type.

int EXPORT_SWMM_OUTPUT_API	SMO_getSubcatchResult (SMO_Handle p_handle, int timeIndex, int subcatchIndex, float *outValueArray, int length)
	Retrieves subcatchment result values for a given time period.

int EXPORT_SWMM_OUTPUT_API	SMO_getNodeResult (SMO_Handle p_handle, int timeIndex, int nodeIndex, float *outValueArray, int length)
	Retrieves node result values for a given time period.

int EXPORT_SWMM_OUTPUT_API	SMO_getLinkResult (SMO_Handle p_handle, int timeIndex, int linkIndex, float *outValueArray, int length)
	Retrieves link result values for a given time period.

int EXPORT_SWMM_OUTPUT_API	SMO_getSystemResult (SMO_Handle p_handle, int timeIndex, int dummyIndex, float *outValueArray, int length)
	Retrieves system result values for a given time period.

void EXPORT_SWMM_OUTPUT_API	SMO_free (void **array)
	Frees memory allocated by the API for the outValueArray.

void EXPORT_SWMM_OUTPUT_API	SMO_clearError (SMO_Handle p_handle_in)
	Clears the error status of the SMO_Handle.

int EXPORT_SWMM_OUTPUT_API	SMO_checkError (SMO_Handle p_handle_in, char **msg_buffer)
	Checks for error in the error handle and copies the error message to the message buffer.

Detailed Description

Header file for SWMM output API.

Author: Colleen Barr (US EPA - ORD/NHEERL); Michael Tryby (US EPA) (Modified); Bryant McDonnell (Modified)

Date: Created: 2017-08-25; Last edited: 2024-10-17

Macro Definition Documentation

◆ MAXELENAME

#define MAXELENAME 31

Maximum number of characters in a element name.

◆ MAXFILENAME

#define MAXFILENAME 259

Maximum number of characters in a file path.

Typedef Documentation

◆ SMO_Handle

SMO_Handle

Opaque pointer to struct. Do not access variables.

Function Documentation

◆ SMO_checkError()

int EXPORT_SWMM_OUTPUT_API SMO_checkError	(	SMO_Handle	p_handle,
		char **	msg_buffer
	)

Checks for error in the error handle and copies the error message to the message buffer.

Parameters

[in]	p_handle	Pointer to opaque SMO_Handle
[out]	msg_buffer	Error message buffer

Returns: Error code

Checks for error in the error handle and copies the error message to the message buffer.

Parameters

[in]	p_handle	Pointer to opaque SMO_Handle
[out]	msg_buffer	Error message buffer

Returns: Error code

Checks for error in the error handle and copies the error message to the message buffer.

Here is the call graph for this function:

◆ SMO_clearError()

void EXPORT_SWMM_OUTPUT_API SMO_clearError ( SMO_Handle p_handle )

Clears the error status of the SMO_Handle.

Parameters

[in] p_handle Opaque pointer to SWMM output file handle

Clears the error status of the SMO_Handle.

Parameters

[in] p_handle Opaque pointer to SWMM output file handle

Clears the error status of the SMO_Handle.

Here is the call graph for this function:

◆ SMO_close()

int EXPORT_SWMM_OUTPUT_API SMO_close ( SMO_Handle * p_handle )

Closes the SWMM output file handle.

Parameters

[in] p_handle Opaque pointer to SWMM output file handle

Returns: Error code 0 if successful or -1 if an error occurs

Closes the SWMM output file handle.

Parameters

[in] p_handle Opaque pointer to SWMM output file handle

Returns: Error code 0 if successful or -1 if an error occurs

Closes the SWMM output file handle.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SMO_free()

void EXPORT_SWMM_OUTPUT_API SMO_free ( void ** array )

Frees memory allocated by the API for the outValueArray.

Parameters

[in] array Pointer to the outValueArray

Frees memory allocated by the API for the outValueArray.

◆ SMO_getElementName()

int EXPORT_SWMM_OUTPUT_API SMO_getElementName	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int	index,
		char **	name,
		int *	length
	)

Retrieves the element name by index and type from the SWMM output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	elementIndex	The index of the element
[out]	elementName	Pointer to the element name
[out]	length	Pointer to the size of the elementName array

Returns: Error code

Retrieves the element name by index and type from the SWMM output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	elementIndex	The index of the element
[out]	elementName	Pointer to the element name
[out]	length	Pointer to the size of the elementName array

Returns: Error code

Retrieves the element name by index and type from the SWMM output file.

Here is the call graph for this function:

◆ SMO_getFlowUnits()

int EXPORT_SWMM_OUTPUT_API SMO_getFlowUnits	(	SMO_Handle	p_handle,
		int *	unitFlag
	)

Returns unit flag for flow.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	unitFlag	Flow unit flag 0: CFS (cubic feet per second), 1: GPM (gallons per minute), 2: MGD (million gallons per day), 3: CMS (cubic meters per second), 4: LPS (liters per second), 5: MLD (million liters per day)

Returns: Error code

Returns unit flag for flow.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	unitFlag	Flow unit flag 0: CFS (cubic feet per second), 1: GPM (gallons per minute), 2: MGD (million gallons per day), 3: CMS (cubic meters per second), 4: LPS (liters per second), 5: MLD (million liters per day)

Returns: Error code

Returns unit flag for flow.

Here is the call graph for this function:

◆ SMO_getLinkAttribute()

int EXPORT_SWMM_OUTPUT_API SMO_getLinkAttribute	(	SMO_Handle	p_handle,
		int	periodIndex,
		SMO_linkAttribute	attr,
		float **	outValueArray,
		int *	length
	)

Retrieves link attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	attr	The link attribute type to retrieve
[out]	outValueArray	Pointer to the link attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves link attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	attr	The link attribute type to retrieve
[out]	outValueArray	Pointer to the link attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves link attribute values for a given time period and attribute type.

Here is the call graph for this function:

◆ SMO_getLinkResult()

int EXPORT_SWMM_OUTPUT_API SMO_getLinkResult	(	SMO_Handle	p_handle,
		int	periodIndex,
		int	linkIndex,
		float **	outValueArray,
		int *	arrayLength
	)

Retrieves link result values for a given time period.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	linkIndex	The index of the link
[out]	outValueArray	Pointer to the link result values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves link result values for a given time period.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	linkIndex	The index of the link
[out]	outValueArray	Pointer to the link result values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves link result values for a given time period.

Here is the call graph for this function:

◆ SMO_getLinkSeries()

int EXPORT_SWMM_OUTPUT_API SMO_getLinkSeries	(	SMO_Handle	p_handle,
		int	linkIndex,
		SMO_linkAttribute	attr,
		int	startPeriod,
		int	endPeriod,
		float **	outValueArray,
		int *	length
	)

Retrieves link attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	linkIndex	The index of the link
[in]	attr	The link attribute type to retrieve
[in]	startPeriod	The starting time period to retrieve data from
[in]	endPeriod	The ending time period to retrieve data from
[out]	outValueArray	Pointer to the link attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves link attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	linkIndex	The index of the link
[in]	attr	The link attribute type to retrieve
[in]	startPeriod	The starting time period to retrieve data from
[in]	endPeriod	The ending time period to retrieve data from
[out]	outValueArray	Pointer to the link attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves link attribute values for a given time period and attribute type.

Here is the call graph for this function:

◆ SMO_getNodeAttribute()

int EXPORT_SWMM_OUTPUT_API SMO_getNodeAttribute	(	SMO_Handle	p_handle,
		int	periodIndex,
		SMO_nodeAttribute	attr,
		float **	outValueArray,
		int *	length
	)

Retrieves node attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	attr	The node attribute type to retrieve
[out]	outValueArray	Pointer to the node attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves node attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	attr	The node attribute type to retrieve
[out]	outValueArray	Pointer to the node attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves node attribute values for a given time period and attribute type.

Here is the call graph for this function:

◆ SMO_getNodeResult()

int EXPORT_SWMM_OUTPUT_API SMO_getNodeResult	(	SMO_Handle	p_handle,
		int	periodIndex,
		int	nodeIndex,
		float **	outValueArray,
		int *	arrayLength
	)

Retrieves node result values for a given time period.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	nodeIndex	The index of the node
[out]	outValueArray	Pointer to the node result values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves node result values for a given time period.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	nodeIndex	The index of the node
[out]	outValueArray	Pointer to the node result values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves node result values for a given time period.

Here is the call graph for this function:

◆ SMO_getNodeSeries()

int EXPORT_SWMM_OUTPUT_API SMO_getNodeSeries	(	SMO_Handle	p_handle,
		int	nodeIndex,
		SMO_nodeAttribute	attr,
		int	startPeriod,
		int	endPeriod,
		float **	outValueArray,
		int *	length
	)

Retrieves node attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	nodeIndex	The index of the node
[in]	attr	The node attribute type to retrieve
[in]	startPeriod	The starting time period to retrieve data from
[in]	endPeriod	The ending time period to retrieve data from
[out]	outValueArray	Pointer to the node attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves node attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	nodeIndex	The index of the node
[in]	attr	The node attribute type to retrieve
[in]	startPeriod	The starting time period to retrieve data from
[in]	endPeriod	The ending time period to retrieve data from
[out]	outValueArray	Pointer to the node attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves node attribute values for a given time period and attribute type.

Here is the call graph for this function:

◆ SMO_getNumProperties()

int EXPORT_SWMM_OUTPUT_API SMO_getNumProperties	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int *	count
	)

Retrieves the number of properties for a given element type that are stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[out]	count	Pointer to the number of properties

Returns: Error code

Retrieves the number of properties for a given element type that are stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[out]	count	Pointer to the number of properties

Returns: Error code

Retrieves the number of properties for a given element type that are stored in the output file.

Here is the call graph for this function:

◆ SMO_getNumVars()

int EXPORT_SWMM_OUTPUT_API SMO_getNumVars	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int *	count
	)

Retrieves the number of variables for a given element type that are stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[out]	count	Pointer to the number of variables

Returns: Error code

Retrieves the number of variables for a given element type that are stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[out]	count	Pointer to the number of variables

Returns: Error code

Retrieves the number of variables for a given element type that are stored in the output file.

Here is the call graph for this function:

◆ SMO_getPollutantUnits()

int EXPORT_SWMM_OUTPUT_API SMO_getPollutantUnits	(	SMO_Handle	p_handle,
		int **	unitFlag,
		int *	length
	)

Returns unit flag for pollutant. Concentration units are located after the pollutant ID names and before the object properties start, and are stored for each pollutant. They're stored as 4-byte integers with the following codes: 0: mg/L 1: ug/L 2: count/L.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	unitFlag	Array of unit flags
[out]	length	Length of unitFlag array

Returns: Error code

Note: Valid values are 0 to Npolluts-1

Returns unit flag for pollutant. Concentration units are located after the pollutant ID names and before the object properties start, and are stored for each pollutant. They're stored as 4-byte integers with the following codes: 0: mg/L 1: ug/L 2: count/L.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	unitFlag	Array of unit flags
[out]	length	Length of unitFlag array

Returns: Error code

Note: Valid values are 0 to Npolluts-1

Returns unit flag for pollutant. Concentration units are located after the pollutant ID names and before the object properties start, and are stored for each pollutant. They're stored as 4-byte integers with the following codes: 0: mg/L 1: ug/L 2: count/L.

Here is the call graph for this function:

◆ SMO_getProjectSize()

int EXPORT_SWMM_OUTPUT_API SMO_getProjectSize	(	SMO_Handle	p_handle,
		int **	elementCount,
		int *	length
	)

Get project size.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	elementCount	Array of element counts
[out]	length	Length of elementCount array

Returns: Error code 0 on success, -1 on failure or error code

Get project size.

Here is the call graph for this function:

◆ SMO_getPropertyCode()

int EXPORT_SWMM_OUTPUT_API SMO_getPropertyCode	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int	propertyIndex,
		int *	propertyCode
	)

Retrieves the property code for a given element type and property index that is stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	propertyIndex	The index of the property
[out]	propertyCode	Pointer to the property code

Returns: Property code or error code

Retrieves the property code for a given element type and property index that is stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	propertyIndex	The index of the property
[out]	propertyCode	Pointer to the property code

Returns: Property code or error code

Retrieves the property code for a given element type and property index that is stored in the output file.

Here is the call graph for this function:

◆ SMO_getPropertyCodes()

int EXPORT_SWMM_OUTPUT_API SMO_getPropertyCodes	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int **	propertyCodes,
		int *	size
	)

Retrieves the property codes for a given element type that are stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[out]	propertyCodes	Pointer to the property codes
[out]	size	Pointer to the size of the propertyCodes array

Returns: Error code

Retrieves the property codes for a given element type that are stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[out]	propertyCodes	Pointer to the property codes
[out]	size	Pointer to the size of the propertyCodes array

Returns: Error code

Retrieves the property codes for a given element type that are stored in the output file.

Here is the call graph for this function:

◆ SMO_getPropertyValue()

int EXPORT_SWMM_OUTPUT_API SMO_getPropertyValue	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int	propertyIndex,
		int	elementIndex,
		float *	value
	)

Retrieves the value of a property for a given element type, property index, and element index.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	propertyIndex	The index of the property
[in]	elementIndex	The index of the element
[out]	value	Pointer to the property value

Returns: Error code

Retrieves the value of a property for a given element type, property index, and element index.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	propertyIndex	The index of the property
[in]	elementIndex	The index of the element
[out]	value	Pointer to the property value

Returns: Error code

Retrieves the value of a property for a given element type, property index, and element index.

Here is the call graph for this function:

◆ SMO_getPropertyValues()

int EXPORT_SWMM_OUTPUT_API SMO_getPropertyValues	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int	elementIndex,
		float **	outValueArray,
		int *	length
	)

Retrieves all property values for a given element type and element index.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	elementIndex	The index of the element
[out]	outValueArray	Pointer to the property values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code

Retrieves all property values for a given element type and element index.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	propertyIndex	The index of the property
[in]	elementIndex	The index of the element
[out]	value	Pointer to the property value

Returns: Error code

Retrieves the value of a property for a given element type, property index, and element index.

Here is the call graph for this function:

◆ SMO_getStartDate()

int EXPORT_SWMM_OUTPUT_API SMO_getStartDate	(	SMO_Handle	p_handle,
		double *	date
	)

Retrieves the start date of the simulation.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	date	Pointer to the start date

Returns: Error code 0 on success, -1 on failure

Retrieves the start date of the simulation.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	date	Pointer to the start date

Returns: Error code 0 on success, -1 on failure

Retrieves the start date of the simulation.

Here is the call graph for this function:

◆ SMO_getSubcatchAttribute()

int EXPORT_SWMM_OUTPUT_API SMO_getSubcatchAttribute	(	SMO_Handle	p_handle,
		int	periodIndex,
		SMO_subcatchAttribute	attr,
		float **	outValueArray,
		int *	length
	)

Retrieves subcatchment attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	attr	The subcatchment attribute type to retrieve
[out]	outValueArray	Pointer to the subcatchment attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves subcatchment attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	attr	The subcatchment attribute type to retrieve
[out]	outValueArray	Pointer to the subcatchment attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves subcatchment attribute values for a given time period and attribute type.

Here is the call graph for this function:

◆ SMO_getSubcatchResult()

int EXPORT_SWMM_OUTPUT_API SMO_getSubcatchResult	(	SMO_Handle	p_handle,
		int	periodIndex,
		int	subcatchIndex,
		float **	outValueArray,
		int *	arrayLength
	)

Retrieves subcatchment result values for a given time period.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	subcatchIndex	The index of the subcatchment
[out]	outValueArray	Pointer to the subcatchment result values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves subcatchment result values for a given time period.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	subcatchIndex	The index of the subcatchment
[out]	outValueArray	Pointer to the subcatchment result values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves subcatchment result values for a given time period.

Here is the call graph for this function:

◆ SMO_getSubcatchSeries()

int EXPORT_SWMM_OUTPUT_API SMO_getSubcatchSeries	(	SMO_Handle	p_handle,
		int	subcatchIndex,
		SMO_subcatchAttribute	attr,
		int	startPeriod,
		int	endPeriod,
		float **	outValueArray,
		int *	length
	)

Retrieves subcatchment attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	subcatchIndex	The index of the subcatchment
[in]	attr	The subcatchment attribute type to retrieve
[in]	startPeriod	The starting time period to retrieve data from
[in]	endPeriod	The ending time period to retrieve data from
[out]	outValueArray	Pointer to the subcatchment attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves subcatchment attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	subcatchIndex	The index of the subcatchment
[in]	attr	The subcatchment attribute type to retrieve
[in]	startPeriod	The starting time period to retrieve data from
[in]	endPeriod	The ending time period to retrieve data from
[out]	outValueArray	Pointer to the subcatchment attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves subcatchment attribute values for a given time period and attribute type.

Here is the call graph for this function:

◆ SMO_getSystemAttribute()

int EXPORT_SWMM_OUTPUT_API SMO_getSystemAttribute	(	SMO_Handle	p_handle,
		int	periodIndex,
		SMO_systemAttribute	attr,
		float **	outValueArray,
		int *	length
	)

Retrieves system attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	attr	The system attribute type to retrieve
[out]	outValueArray	Pointer to the system attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves system attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	attr	The system attribute type to retrieve
[out]	outValueArray	Pointer to the system attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves system attribute values for a given time period and attribute type.

Here is the call graph for this function:

◆ SMO_getSystemResult()

int EXPORT_SWMM_OUTPUT_API SMO_getSystemResult	(	SMO_Handle	p_handle,
		int	periodIndex,
		int	dummyIndex,
		float **	outValueArray,
		int *	arrayLength
	)

Retrieves system result values for a given time period.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	dummyIndex	The index of the system
[out]	outValueArray	Pointer to the system result values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves system result values for a given time period.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	timeIndex	The index of the time period
[in]	dummyIndex	The index of the system
[out]	outValueArray	Pointer to the system result values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

Retrieves system result values for a given time period.

Here is the call graph for this function:

◆ SMO_getSystemSeries()

int EXPORT_SWMM_OUTPUT_API SMO_getSystemSeries	(	SMO_Handle	p_handle,
		SMO_systemAttribute	attr,
		int	startPeriod,
		int	endPeriod,
		float **	outValueArray,
		int *	length
	)

Retrieves system attribute values for a given time period and attribute type.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	attr	The system attribute type to retrieve
[in]	startPeriod	The starting time period to retrieve data from
[in]	endPeriod	The ending time period to retrieve data from
[out]	outValueArray	Pointer to the system attribute values
[out]	length	Pointer to the length of the outValueArray array

Returns: Error code 0 on success, -1 on failure or error code

\Copydoc SMO_getSystemSeries

Here is the call graph for this function:

◆ SMO_getTimes()

int EXPORT_SWMM_OUTPUT_API SMO_getTimes	(	SMO_Handle	p_handle,
		SMO_time	code,
		int *	time
	)

Retrieves the number of reporting periods in the simulation.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	code	The type of reporting attribute to retrieve
[out]	time	Pointer to the reporting attribute value

Returns: Error code 0 on success, -1 on failure or error code

Retrieves the number of reporting periods in the simulation.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	code	The type of reporting attribute to retrieve
[out]	time	Pointer to the reporting attribute value

Returns: Error code 0 on success, -1 on failure or error code

Retrieves the number of reporting periods in the simulation.

Here is the call graph for this function:

◆ SMO_getUnits()

int EXPORT_SWMM_OUTPUT_API SMO_getUnits	(	SMO_Handle	p_handle,
		int **	unitFlag,
		int *	length
	)

Retrieves the unit system used in the SWMM model.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	unitSystem	Pointer to the unit system
[out]	length	Length of unitFlag array

Returns: Error code

Retrieves the unit system used in the SWMM model.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	unitSystem	Pointer to the unit system
[out]	length	Length of unitFlag array

Returns: Error code

Retrieves the unit system used in the SWMM model.

Here is the call graph for this function:

◆ SMO_getVarCode()

int EXPORT_SWMM_OUTPUT_API SMO_getVarCode	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int	varIndex,
		int *	varCode
	)

Retrieves the variable code for a given element type and variable index that is stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	varIndex	The index of the variable
[out]	varCode	Pointer to the variable code

Returns: Variable code or error code

Retrieves the variable code for a given element type and variable index that is stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[in]	varIndex	The index of the variable
[out]	varCode	Pointer to the variable code

Returns: Variable code or error code

Retrieves the variable code for a given element type and variable index that is stored in the output file.

Here is the call graph for this function:

◆ SMO_getVarCodes()

int EXPORT_SWMM_OUTPUT_API SMO_getVarCodes	(	SMO_Handle	p_handle,
		SMO_elementType	type,
		int **	varCodes,
		int *	size
	)

Retrieves the variable codes for a given element type that are stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[out]	varCodes	Pointer to the variable codes
[out]	size	Pointer to the size of the varCodes array

Returns: Error code

Retrieves the variable codes for a given element type that are stored in the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	type	The type of element
[out]	varCodes	Pointer to the variable codes
[out]	size	Pointer to the size of the varCodes array

Returns: Error code

Retrieves the variable codes for a given element type that are stored in the output file.

Here is the call graph for this function:

◆ SMO_getVersion()

int EXPORT_SWMM_OUTPUT_API SMO_getVersion	(	SMO_Handle	p_handle,
		int *	version
	)

Retrieves the model version number that created the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	version	Pointer to the version number

Returns: Error code 0 if successful or -1 if an error occurs

Retrieves the model version number that created the output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[out]	version	Pointer to the version number

Returns: Error code 0 if successful or -1 if an error occurs

Retrieves the model version number that created the output file.

Here is the call graph for this function:

◆ SMO_init()

int EXPORT_SWMM_OUTPUT_API SMO_init ( SMO_Handle * p_handle )

Initializes the SWMM output file handle.

Parameters

[out] p_handle Opaque pointer to SWMM output file handle

Returns: Error code 0 if successful or -1 if an error occurs

Initializes the SWMM output file handle.

Parameters

[out] p_handle Opaque pointer to SWMM output file handle

Returns: Error code 0 if successful or -1 if an error occurs

Initializes the SWMM output file handle.

Here is the call graph for this function:

◆ SMO_open()

int EXPORT_SWMM_OUTPUT_API SMO_open	(	SMO_Handle	p_handle,
		const char *	path
	)

Opens a SWMM output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	path	Path to the SWMM output file

Returns: Error code 0 if successful or -1 if an error occurs

Opens a SWMM output file.

Parameters

[in]	p_handle	Opaque pointer to SWMM output file handle
[in]	path	Path to the SWMM output file

Returns: Error code 0 if successful or -1 if an error occurs

Opens a SWMM output file.

Here is the call graph for this function:

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ MAXELENAME

◆ MAXFILENAME

Typedef Documentation

◆ SMO_Handle

Function Documentation

◆ SMO_checkError()

◆ SMO_clearError()

◆ SMO_close()

◆ SMO_free()

◆ SMO_getElementName()

◆ SMO_getFlowUnits()

◆ SMO_getLinkAttribute()

◆ SMO_getLinkResult()

◆ SMO_getLinkSeries()

◆ SMO_getNodeAttribute()

◆ SMO_getNodeResult()

◆ SMO_getNodeSeries()

◆ SMO_getNumProperties()

◆ SMO_getNumVars()

◆ SMO_getPollutantUnits()

◆ SMO_getProjectSize()

◆ SMO_getPropertyCode()

◆ SMO_getPropertyCodes()

◆ SMO_getPropertyValue()

◆ SMO_getPropertyValues()

◆ SMO_getStartDate()

◆ SMO_getSubcatchAttribute()

◆ SMO_getSubcatchResult()

◆ SMO_getSubcatchSeries()

◆ SMO_getSystemAttribute()

◆ SMO_getSystemResult()

◆ SMO_getSystemSeries()

◆ SMO_getTimes()

◆ SMO_getUnits()

◆ SMO_getVarCode()

◆ SMO_getVarCodes()

◆ SMO_getVersion()

◆ SMO_init()

◆ SMO_open()