Global Report Writer Methods

Global report writer methods. More...

Collaboration diagram for Global Report Writer Methods:

Functions
int	report_readOptions (char *tok[], int ntoks)
	Reads reporting options from a line of input data.
void	report_writeLine (const char *line)
	Writes a line of text to the report file.
void	report_writeSysTime (void)
	Writes starting/ending processing times to the report file.
void	report_writeLogo (void)
	Writes report header lines to report file.
void	report_writeTitle (void)
	Writes project title to report file.
void	report_writeOptions (void)
	Writes analysis options in use to report file.
void	report_writeReport (void)
	Writes project title to report file.
void	report_writeRainStats (int gage, TRainStats *rainStats)
	Writes summary of rain data read from input file to report file.
void	report_writeRdiiStats (double totalRain, double totalRdii)
	Writes summary of RDII inflow to report file.
void	report_writeControlActionsHeading (void)
	Writes summary control actions heading to report file.
void	report_writeControlAction (DateTime aDate, char *linkID, double value, char *ruleID)
	Writes control action to report file.
void	report_writeRunoffError (TRunoffTotals *totals, double area)
	Writes runoff continuity error to report file.
void	report_writeLoadingError (TLoadingTotals *totals)
	Writes runoff loading continuity error to report file.
void	report_writeGwaterError (TGwaterTotals *totals, double area)
	Writes groundwater continuity error to report file.
void	report_writeFlowError (TRoutingTotals *totals)
	Writes flow routing continuity error to report file.
void	report_writeQualError (TRoutingTotals *totals)
	Writes quality routing continuity error to report file.
void	report_writeMaxStats (TMaxStats massBalErrs[], TMaxStats CourantCrit[], int nMaxStats)
	Lists nodes and links with highest mass balance errors and courant time step violations to report file.
void	report_writeMaxFlowTurns (TMaxStats flowTurns[], int nMaxStats)
	Lists links with highest number of flow turns to report (i.e., fraction of time periods where the flow is higher (or lower) than the flows in the previous and following periods)
void	report_writeNonconvergedStats (TMaxStats maxNonconverged[], int nMaxStats)
	Writes non-converging nodes to report file.
void	report_writeTimeStepStats (TTimeStepStats *timeStepStats)
	Writes routing time step statistics to report file.
void	report_writeErrorMsg (int code, char *msg)
	Writes error message to report file.
void	report_writeErrorCode (void)
	Writes error message to report file.
void	report_writeInputErrorMsg (int k, int sect, char *line, long lineCount)
	Writes input error message to report file.
void	report_writeWarningMsg (char *msg, char *id)
	Writes a warning message to report file.
void	report_writeTseriesErrorMsg (int code, TTable *tseries)
	Writes the date where a time series' data is out of order.
void	inputrpt_writeInput (void)
	Writes summary of input data to report file.
void	statsrpt_writeReport (void)
	Reports simulation summary statistics.

Detailed Description

Global report writer methods.

Function Documentation

inputrpt_writeInput()

void inputrpt_writeInput

(

void

)

Writes summary of input data to report file.

Here is the call graph for this function:

report_readOptions()

int report_readOptions	(	char *	tok[],
		int	ntoks
	)

Reads reporting options from a line of input data.

Parameters

[in]	tok	Array of string tokens
[in]	ntoks	Number of tokens

Returns

Error code

Here is the call graph for this function:

report_writeControlAction()

void report_writeControlAction	(	DateTime	aDate,
		char *	linkID,
		double	value,
		char *	ruleID
	)

Writes control action to report file.

Parameters

[in]	aDate	Date/time of rule action
[in]	linkID	ID of link being controlled
[in]	value	New status value of link
[in]	ruleID	ID of rule implementing the action

Here is the call graph for this function:

Here is the caller graph for this function:

report_writeControlActionsHeading()

void report_writeControlActionsHeading

(

void

)

Writes summary control actions heading to report file.

report_writeErrorCode()

void report_writeErrorCode

(

void

)

Writes error message to report file.

Here is the call graph for this function:

report_writeErrorMsg()

void report_writeErrorMsg	(	int	code,
		char *	msg
	)

Writes error message to report file.

Parameters

[in]	code	Error code
[in]	msg	Error message text

Here is the call graph for this function:

Here is the caller graph for this function:

report_writeFlowError()

void report_writeFlowError

(

TRoutingTotals *

totals

)

Writes flow routing continuity error to report file.

Parameters

[in]

totals

Accumulated flow routing totals

Here is the call graph for this function:

Here is the caller graph for this function:

report_writeGwaterError()

void report_writeGwaterError	(	TGwaterTotals *	totals,
		double	area
	)

Writes groundwater continuity error to report file.

Parameters

[in]	totals	Accumulated groundwater totals
[in]	area	Total area of all subcatchments with groundwater

Here is the call graph for this function:

Here is the caller graph for this function:

report_writeInputErrorMsg()

void report_writeInputErrorMsg	(	int	k,
		int	sect,
		char *	line,
		long	lineCount
	)

Writes input error message to report file.

Parameters

[in]	k	Error code
[in]	sect	Number of input data section where error occurred
[in]	line	Line of data containing the error
[in]	lineCount	Line number of data file containing the error

Here is the call graph for this function:

Here is the caller graph for this function:

report_writeLine()

void report_writeLine

(

const char *

line

)

Writes a line of text to the report file.

Parameters

[in]

line

Line of text

Here is the caller graph for this function:

report_writeLoadingError()

void report_writeLoadingError

(

TLoadingTotals *

totals

)

Writes runoff loading continuity error to report file.

Parameters

[in]

totals

Accumulated pollutant loading totals

Here is the caller graph for this function:

report_writeLogo()

void report_writeLogo

(

void

)

Writes report header lines to report file.

report_writeMaxFlowTurns()

void report_writeMaxFlowTurns	(	TMaxStats	flowTurns[],
		int	nMaxStats
	)

Lists links with highest number of flow turns to report (i.e., fraction of time periods where the flow is higher (or lower) than the flows in the previous and following periods)

Parameters

[in]	flowTurns	Links with highest number of flow turns
[in]	nMaxStats	Number of links in flowTurns[]

Here is the caller graph for this function:

report_writeMaxStats()

void report_writeMaxStats	(	TMaxStats	massBalErrs[],
		TMaxStats	CourantCrit[],
		int	nMaxStats
	)

Lists nodes and links with highest mass balance errors and courant time step violations to report file.

Parameters

[in]	massBalErrs	Nodes with highest mass balance errors
[in]	CourantCrit	Nodes most often Courant time step critical
[in]	nMaxStats	Number of most critical nodes/links saved

Here is the caller graph for this function:

report_writeNonconvergedStats()

void report_writeNonconvergedStats	(	TMaxStats	maxNonconverged[],
		int	nMaxStats
	)

Writes non-converging nodes to report file.

Parameters

[in]	maxNonconverged	Nodes most often Courant time step critical
[in]	nMaxStats	Number of most critical nodes/links saved

Here is the caller graph for this function:

report_writeOptions()

void report_writeOptions

(

void

)

Writes analysis options in use to report file.

Here is the call graph for this function:

report_writeQualError()

void report_writeQualError

(

TRoutingTotals *

totals

)

Writes quality routing continuity error to report file.

Parameters

[in]

QualTotals

Accumulated quality routing totals for each pollutant

Here is the caller graph for this function:

report_writeRainStats()

void report_writeRainStats	(	int	gage,
		TRainStats *	rainStats
	)

Writes summary of rain data read from input file to report file.

Parameters

[in]	gage	Rain gage index
[in]	rainStats	Rain file summary statistics

Here is the call graph for this function:

report_writeRdiiStats()

void report_writeRdiiStats	(	double	totalRain,
		double	totalRdii
	)

Writes summary of RDII inflow to report file.

Parameters

[in]	totalRain	Total rainfall volume over sewershed
[in]	totalRdii	Total RDII volume produced

Here is the call graph for this function:

report_writeReport()

void report_writeReport

(

void

)

Writes project title to report file.

report_writeRunoffError()

void report_writeRunoffError	(	TRunoffTotals *	totals,
		double	area
	)

Writes runoff continuity error to report file.

Parameters

[in]	totals	Accumulated runoff totals
[in]	totalArea	Total area of all subcatchments

Here is the call graph for this function:

Here is the caller graph for this function:

report_writeSysTime()

void report_writeSysTime

(

void

)

Writes starting/ending processing times to the report file.

Here is the call graph for this function:

report_writeTimeStepStats()

void report_writeTimeStepStats

(

TTimeStepStats *

timeStepStats

)

Writes routing time step statistics to report file.

Parameters

[in]

timeStepStats

Routing time step statistics

Here is the caller graph for this function:

report_writeTitle()

void report_writeTitle

(

void

)

Writes project title to report file.

report_writeTseriesErrorMsg()

void report_writeTseriesErrorMsg	(	int	code,
		TTable *	tseries
	)

Writes the date where a time series' data is out of order.

Parameters

[in]	code	Error code
[in]	tseries	Pointer to a time series

Here is the call graph for this function:

Here is the caller graph for this function:

report_writeWarningMsg()

void report_writeWarningMsg	(	char *	msg,
		char *	id
	)

Writes a warning message to report file.

Parameters

[in]	msg	Text of warning message
[in]	id	ID name of object that message refers to

Here is the caller graph for this function:

statsrpt_writeReport()

void statsrpt_writeReport

(

void

)

Reports simulation summary statistics.

Here is the call graph for this function:

Here is the caller graph for this function: