TerrestrialStatisticalModel.cpp File Reference

Implements top-level functions for running the Terrestrial Statistical Model. More...

Functions
ReturnCode	CallTerrestrialStatisticalModel (TSMParams &tsm_params, std::vector< double > &L_ctt__db)
	Top-level control function for Terrestrial Statistical Model operation.
DrvrReturnCode	ParseTSMInputStream (std::istream &stream, TSMParams &tsm_params)
	Parse input stream (file or string stream) to TSM parameter struct.
DrvrReturnCode	ParseTSMInputFile (const std::string &in_file, TSMParams &tsm_params)
	Parse Terrestrial Statistical Model input parameter file.
void	WriteTSMInputs (std::ofstream &fp, const TSMParams &params)
	Write Terrestrial Statistical Model inputs to the report file.

Detailed Description

Implements top-level functions for running the Terrestrial Statistical Model.

Function Documentation

CallTerrestrialStatisticalModel()

ReturnCode CallTerrestrialStatisticalModel	(	TSMParams &	tsm_params,
		std::vector< double > &	L_ctt__db )

Top-level control function for Terrestrial Statistical Model operation.

Parameters

[in]	tsm_params	Terrestrial Statistical Model input parameter struct
[out]	L_ctt__db	Additional loss (clutter loss), in dB

Returns

Return code

ParseTSMInputFile()

DrvrReturnCode ParseTSMInputFile	(	const std::string &	in_file,
		TSMParams &	tsm_params )

Parse Terrestrial Statistical Model input parameter file.

Parameters

[in]	in_file	Path to TSM input parameter file
[out]	tsm_params	TSM input parameter struct

Returns

Return code

ParseTSMInputStream()

DrvrReturnCode ParseTSMInputStream	(	std::istream &	stream,
		TSMParams &	tsm_params )

Parse input stream (file or string stream) to TSM parameter struct.

Parameters

[in]	stream	Input stream containing TSM parameters
[out]	tsm_params	TSM input parameter struct

Returns

Return code

WriteTSMInputs()

void WriteTSMInputs	(	std::ofstream &	fp,
		const TSMParams &	params )

Write Terrestrial Statistical Model inputs to the report file.

Parameters

[in]	fp	Output stream, a text file open for writing
[in]	params	TSM input parameter struct