TmmT_Path_Loss_Calc_Method
Note: Requires Terrain Modeling Module functionality
Abstract
Callback: Called as needed to perform path loss calculations for a propagation model.
Syntax
<path_loss_calc_method_name> (model_ptr, tda_state_ptr, tx_position_ptr, rx_position_ptr, center_frequency, bandwidth, verbose, status_ptr, message_buffer_v)
| Argument | Type | Description |
|---|---|---|
model_ptr |
TmmT_Propagation_Model * |
The propagation model with which this method is associated. |
tda_state_ptr |
void * |
Arguments passed from the pipeline stage (see Details). |
tx_position_ptr |
TmmT_Position * |
Position of the transmitter (latitude, longitude, and meters above sea level). |
rx_position_ptr |
TmmT_Position * |
Position of the receiver (latitude, longitude, and meters above sea level). |
center_frequency |
double |
Center frequency for the path loss calculation, in Hertz (Hz). |
bandwidth |
double |
Signal bandwidth for the path loss calculation, in Hertz (Hz). |
verbose |
int |
Verbose mode to use for error messages, either OPC_TRUE (be verbose) or OPC_FALSE. |
status_ptr |
TmmT_Loss_Status * |
Status of path loss calculation, either TmmC_Loss_Valid, TmmC_Loss_Error, or TmmC_Loss_No_Closure. |
message_buffer_v |
char |
Area to be filled with text messages (see Details). |
Return Value
double
Calculated path loss, expressed as signal gain in decibels (dB). This value is 0.0 (in the near field) or negative.
Header
tmm.h
Details
This callback performs path loss calculations for the propagation model specified by model_ptr. It should be specified as a propagation model’s path_loss_calc_method when the model is initialized.
The tda_state_ptr argument is intended to be used, when needed, by your pipeline stage to pass arguments to the path loss calculation function (much in the same way that simulation packets provide TDAs). This argument will be OPC_NIL when the Project Editor makes calls to the propagation model.
The message_buffer_v argument provides a location for the path loss calculation to report text messages about any problems or errors in calculating a loss value. This variable is a two-dimensional array comprising five arrays of 512-character buffers.
Purpose
Callback used to perform path loss calculations for a propagation model.