TMM Package
Function List
Note: The TMM package is available only with Terrain Modeling Module functionality.
The TMM package contains the following functions.
- tmm_all_propagation_model_names_list_get() Obtains a list of all installed propagation models.
- tmm_all_propagation_spec_names_list_get() Obtains a list of the names of all defined propagation specifications.
- tmm_available_propagation_model_names_list_get() Obtains a list of all propagation models that are available for use.
- tmm_cache_create() Creates a data structure to store path loss values for future lookup and possible reuse.
- tmm_cache_destroy() Destroys the contents of an existing cache, as well as the cache itself.
- tmm_cache_entry_add() Adds data about a position pair into the cache, as well as the status of the path loss calculation and the value of the path loss, if calculated.
- tmm_cache_entry_find() Determines if there is an entry in a TmmT_Cache data structure that matches the specified positions and returns the entry.
- tmm_default_propagation_spec_get() Returns the name of the default propagation specification.
- tmm_elev_point_get() Returns the height of the terrain at a specified position.
- tmm_elev_profile_destroy() Frees the TmmT_Elev_Profile data structure created by tmm_elev_profile_get().
- tmm_elev_profile_get() Returns the terrain height at specified intervals along a path.
- Tmm_Elev_Profile_Get_With_Dist() Returns the terrain height at specified intervals along a path and the distance between points.
- tmm_position_valid() Determines if a geographic position is valid.
- tmm_propagation_model_get() Loads the shared object library that implements a specific propagation model.
- tmm_propagation_spec_calc_pathloss() Performs a path loss calculation using a specified propagation specification.
- tmm_propagation_spec_get() Returns a pointer to the requested propagation specification.
- tmm_terrain_model_get() Loads the shared object library that implements a specific terrain model.
- tmm_verbose_get() Returns the current verbose mode setting.
- tmm_verbose_set() Sets the TMM verbose mode.
- tmm_zone_valid() Reports whether a propagation zone is valid.
Callbacks
The TMM package defines the following callback types.
- TmmT_Catalog_Prepare_Step_Notify_Proc Called when loading terrain data in multiple steps.
- TmmT_Parameters_Configure_Method Called as needed to set or update the parameters of a propagation model.
- TmmT_Path_Loss_Calc_Method Called as needed to perform path loss calculations for a propagation model.
- TmmT_Path_Loss_Init_Proc Called to initialize a propagation model.
- TmmT_Terrain_Reader_Coverage_Proc Called to obtain coverage information for a given source of terrain data.
- TmmT_Terrain_Reader_Elevation_Proc Called to obtain the elevation of a given location.
- TmmT_Terrain_Reader_Elevation_Profile_Fill_Proc Called to obtain elevations along a path of predetermined points (a terrain profile).
- TmmT_Terrain_Reader_Exit_Proc Called at program termination to close out a terrain handler.
- TmmT_Terrain_Reader_Init_Proc() Entry point for the code library used to read a specific terrain format.
- TmmT_Terrain_Reader_Load_Proc Called to load a given terrain source.
- TmmT_Terrain_Reader_Num_Source_Steps_Proc Called to obtain the number of steps required to load a particular data source.
- TmmT_Terrain_Reader_Resolution_Proc Called to obtain the resolution of the source data.
- TmmT_Terrain_Reader_Unload_Proc Called to unload a given terrain source.
See Package Overview for a general description of this package.