OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
Global Output File Methods

Global output file methods. More...

Collaboration diagram for Global Output File Methods:

Functions

int output_open (void)
 Writes basic project data to binary output file.
 
void output_end (void)
 Writes closing records to binary file.
 
void output_close (void)
 Frees memory used for accessing the binary file.
 
void output_saveResults (double reportTime)
 Writes computed results for current report time to binary file.
 
void output_updateAvgResults (void)
 Updates average results for current time period.
 
void output_readDateTime (long period, DateTime *days)
 Retrieves the date/time for a specific reporting period from the binary output file.
 
void output_readSubcatchResults (long period, int index)
 Reads computed results for a subcatchment at a specific time period.
 
void output_readNodeResults (long period, int index)
 Reads computed results for a node at a specific time period.
 
void output_readLinkResults (long period, int index)
 Reads computed results for a link at a specific time period.
 

Detailed Description

Global output file methods.

Function Documentation

◆ output_close()

void output_close ( void  )

Frees memory used for accessing the binary file.

◆ output_end()

void output_end ( void  )

Writes closing records to binary file.

Here is the call graph for this function:

◆ output_open()

int output_open ( void  )

Writes basic project data to binary output file.

Here is the call graph for this function:

◆ output_readDateTime()

void output_readDateTime ( long  period,
DateTime days 
)

Retrieves the date/time for a specific reporting period from the binary output file.

Parameters
[in]periodIndex of reporting time period
[out]daysDate/time value

◆ output_readLinkResults()

void output_readLinkResults ( long  period,
int  index 
)

Reads computed results for a link at a specific time period.

Parameters
[in]periodIndex of reporting time period
[in]indexLink index in binary output file

◆ output_readNodeResults()

void output_readNodeResults ( long  period,
int  index 
)

Reads computed results for a node at a specific time period.

Parameters
[in]periodIndex of reporting time period
[in]indexNode index in binary output file

◆ output_readSubcatchResults()

void output_readSubcatchResults ( long  period,
int  index 
)

Reads computed results for a subcatchment at a specific time period.

Parameters
[in]periodIndex of reporting time period
[in]indexSubcatchment index in binary output file

◆ output_saveResults()

void output_saveResults ( double  reportTime)

Writes computed results for current report time to binary file.

Parameters
[in]reportTimeElapsed simulation time (millisec)
Here is the call graph for this function:

◆ output_updateAvgResults()

void output_updateAvgResults ( void  )

Updates average results for current time period.

Here is the call graph for this function: