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]	period	Index of reporting time period
[out]	days	Date/time value

Implementation arguments

• period (in): Index of reporting time period

• days (out): Date/time value

output_readLinkResults()

void output_readLinkResults	(	long	period,
		int	index )

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

Parameters

[in]	period	Index of reporting time period
[in]	index	Link index in binary output file

Implementation arguments

• period (in): Index of reporting time period

• index (in): Link 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]	period	Index of reporting time period
[in]	index	Node index in binary output file

Implementation arguments

• period (in): Index of reporting time period

• index (in): Node 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]	period	Index of reporting time period
[in]	index	Subcatchment index in binary output file

Implementation arguments

• period (in): Index of reporting time period

• index (in): Subcatchment index in binary output file

output_saveResults()

void output_saveResults

(

double

reportTime

)

Writes computed results for current report time to binary file.

Parameters

[in]

reportTime

Elapsed simulation time (millisec)

Implementation arguments

• reportTime (in): Elapsed simulation time (millisec)

Here is the call graph for this function:

output_updateAvgResults()

void output_updateAvgResults

(

void

)

Updates average results for current time period.

Updates average results for current time period.

Postcondition

Accumulates AvgNodeResults/AvgLinkResults in authored report units and increments Nsteps. For nonconduits, the latest setting/capacity is preserved rather than averaged.

Precondition

Output average buffers and scratch result arrays are allocated and reportable counts match the model's rptFlag selections.

Here is the call graph for this function: