tmm_elev_profile_destroy()
Note: Requires Terrain Modeling Module functionality
Abstract
Frees the TmmT_Elev_Profile data structure created by tmm_elev_profile_get().
Syntax
tmm_elev_profile_destroy (elev_profile_ptr)
| Argument | Type | Description |
|---|---|---|
elev_profile_ptr |
TmmT_Elev_Profile* |
pointer to the elevation profile to destroy |
Return Value:
void
No return value.
Header
tmm.h
Example
elevation_profile_ptr = tmm_elev_profile_get (
tx_lat, tx_long, rx_lat, rx_long, TMMC_RESOLUTION_BEST);
if ((elevation_profile_ptr == OPC_NIL) ||
(elevation_profile_ptr->data_status != TmmC_Elev_Data_All_Good))
{
/* No terrain */
/* Use freespace */
power_freespace (pkptr);
}
else
{
calculate_loss (elevation_profile_ptr, tx_height, rx_height, tx_frequency);
}
tmm_elev_profile_destroy (elevation_profile_ptr);
Details
None.
Purpose
This function must be called to free the data structure created by tmm_elev_profile_get(), when that structure is no longer needed.
Errors
- Attempting to destroy an elevation profile that isn't valid.
Reference
- Use the function tmm_elev_profile_get() to obtain terrain heights at specified intervals along a path.
- Use the function tmm_elev_point_get() to obtain the height of the terrain at a specified point.