HeightGainTerminalCorrectionModel.cpp File Reference

Implements functions for running the Height Gain Terminal Correction Model. More...

Functions
ReturnCode	CallHeightGainTerminalCorrectionModel (HGTCMParams &hgtcm_params, std::vector< double > &A_h__db)
	Top-level control function for Height Gain Terminal Correction Model.
DrvrReturnCode	ParseHGTCMInputStream (std::istream &stream, HGTCMParams &hgtcm_params)
	Parse input stream (file or string stream) to HGTCM parameter struct.
DrvrReturnCode	ParseHGTCMInputFile (const std::string &in_file, HGTCMParams &hgtcm_params)
	Parse Height Gain Terminal Correction Model input parameter file.
void	WriteHGTCMInputs (std::ofstream &fp, const HGTCMParams &params)
	Write Height Gain Terminal Correction Model inputs to the report file.

Detailed Description

Implements functions for running the Height Gain Terminal Correction Model.

Function Documentation

CallHeightGainTerminalCorrectionModel()

ReturnCode CallHeightGainTerminalCorrectionModel	(	HGTCMParams &	hgtcm_params,
		std::vector< double > &	A_h__db )

Top-level control function for Height Gain Terminal Correction Model.

Parameters

[in]	hgtcm_params	Height Gain Terminal Correction Model input struct
[out]	A_h__db	Additional loss (clutter loss), in dB

Returns

Return code

ParseHGTCMInputFile()

DrvrReturnCode ParseHGTCMInputFile	(	const std::string &	in_file,
		HGTCMParams &	hgtcm_params )

Parse Height Gain Terminal Correction Model input parameter file.

Parameters

[in]	in_file	Path to HGTCM input parameter file
[out]	hgtcm_params	HGTCM input parameter struct

Returns

Return code

ParseHGTCMInputStream()

DrvrReturnCode ParseHGTCMInputStream	(	std::istream &	stream,
		HGTCMParams &	hgtcm_params )

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

Parameters

[in]	stream	Input stream containing HGTCM parameters
[out]	hgtcm_params	HGTCM input parameter struct

Returns

Return code

WriteHGTCMInputs()

void WriteHGTCMInputs	(	std::ofstream &	fp,
		const HGTCMParams &	params )

Write Height Gain Terminal Correction Model inputs to the report file.

Parameters

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