tmm_propagation_spec_get()
Note: Requires Terrain Modeling Module functionality
Abstract
Returns a pointer to the requested propagation specification.
Syntax
tmm_propagation_spec_get (propagation_spec_name)
| Argument | Type | Description |
|---|---|---|
propagation_spec_name |
const char * |
the name of the propagation specification to obtain |
Return Value
TmmT_Propagation_Spec *
pointer to a data structure with the appropriate propagation specification information.
Header
tmm_prim_prototypes.h
Details
Refer to the tmm.h file for details on the TmmT_Propagation_Spec data structure returned by this function.
Purpose
Used to load a propagation specification for access to the contained propagation models. This function is called in the closure stage of the Radio Transceiver Pipeline (stage 2), when path loss is calculated.
Errors
- Recoverable error: Propagation specification name is NIL.
Reference
- None.