openswmm_output.h

Go to the documentation of this file.

 
#ifndef OPENSWMMCORE_OUTPUT_H_
#define OPENSWMMCORE_OUTPUT_H_
 
#define MAXFILENAME 259
 
#define MAXELENAME 31
 
typedef void *SMO_Handle;
 
#include "openswmm_output_export.h"
#include "openswmm_output_enums.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_init(SMO_Handle *p_handle);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_close(SMO_Handle *p_handle);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_open(SMO_Handle p_handle, const char *path);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getVersion(SMO_Handle p_handle, int *version);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getProjectSize(SMO_Handle p_handle, int **elementCount, int *length);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getUnits(SMO_Handle p_handle, int **unitFlag, int *length);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getFlowUnits(SMO_Handle p_handle, int *unitFlag);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getPollutantUnits(SMO_Handle p_handle, int **unitFlag, int *length);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getStartDate(SMO_Handle p_handle, double *date);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getTimes(SMO_Handle p_handle, SMO_time code, int *time);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getElementName(
    SMO_Handle p_handle, 
    SMO_elementType type, 
    int elementIndex, 
    char **elementName, 
    int *size
);
 
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getNumVars(
    SMO_Handle p_handle,
    SMO_elementType type, 
    int *count
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getVarCode(SMO_Handle p_handle, SMO_elementType type, int varIndex, int *varCode);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getVarCodes(SMO_Handle p_handle, SMO_elementType type, int **varCodes, int *size);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getNumProperties(SMO_Handle p_handle, SMO_elementType type, int *count);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getPropertyCode(SMO_Handle p_handle, SMO_elementType type, int propertyIndex, int *propertyCode);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getPropertyCodes(SMO_Handle p_handle, SMO_elementType type, int **propertyCodes, int *size);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getPropertyValue(
    SMO_Handle p_handle, 
    SMO_elementType type, 
    int propertyIndex, 
    int elementIndex, 
    float *value
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getPropertyValues(
    SMO_Handle p_handle, 
    SMO_elementType type, 
    int elementIndex, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getSubcatchSeries(
    SMO_Handle p_handle, 
    int subcatchIndex, 
    SMO_subcatchAttribute attr, 
    int startPeriod, 
    int endPeriod, 
    float **outValueArray,
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getNodeSeries(
    SMO_Handle p_handle, 
    int nodeIndex, 
    SMO_nodeAttribute attr, 
    int startPeriod, 
    int endPeriod, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getLinkSeries(
    SMO_Handle p_handle, 
    int linkIndex, 
    SMO_linkAttribute attr, 
    int startPeriod, 
    int endPeriod, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getSystemSeries(
    SMO_Handle p_handle, 
    SMO_systemAttribute attr, 
    int startPeriod, 
    int endPeriod, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getSubcatchAttribute(
    SMO_Handle p_handle, 
    int timeIndex, 
    SMO_subcatchAttribute attr, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getNodeAttribute(
    SMO_Handle p_handle, 
    int timeIndex, 
    SMO_nodeAttribute attr, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getLinkAttribute(
    SMO_Handle p_handle, 
    int timeIndex, 
    SMO_linkAttribute attr, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getSystemAttribute(
    SMO_Handle p_handle, 
    int timeIndex, 
    SMO_systemAttribute attr, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getSubcatchResult(
    SMO_Handle p_handle,
    int timeIndex, 
    int subcatchIndex,
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getNodeResult(
    SMO_Handle p_handle, 
    int timeIndex, 
    int nodeIndex, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getLinkResult(
    SMO_Handle p_handle, 
    int timeIndex, 
    int linkIndex, 
    float **outValueArray, 
    int *length
);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_getSystemResult(
    SMO_Handle p_handle, 
    int timeIndex, 
    int dummyIndex, 
    float **outValueArray, 
    int *length
);
 
void EXPORT_OPENSWMMCORE_OUTPUT_API SMO_free(void **array);
 
void EXPORT_OPENSWMMCORE_OUTPUT_API SMO_clearError(SMO_Handle p_handle_in);
 
int EXPORT_OPENSWMMCORE_OUTPUT_API SMO_checkError(SMO_Handle p_handle_in, char **msg_buffer);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OPENSWMMCORE_OUTPUT_H_ */