op_tbl_pat_gain_ext()
Abstract
Obtains an antenna pattern gain value and additional information from an antenna pattern model.
Syntax
op_tbl_pat_gain_ext (pattern, polar, azimuth, extra_data_ptr)
| Argument | Type | Description |
|---|---|---|
pattern |
Pattern_Handle |
pattern [This value is a pointer to the antenna pattern table, which can be obtained with op_tbl_pattern_get().] |
polar |
double |
polar angle of the direction-of-interest [This value is in units of degrees, and should be in the range 0 to 180.] |
azimuth |
double |
azimuth angle of the direction-of-interest [This value is in units of degrees, and should be in the range 0 to 360.] |
extra_data_ptr |
void * |
Additional user-defined data passed to external library (see Details). |
Return Type
double
Value of the antenna pattern gain corresponding to the specified direction angles.
Details
This KP is similar to op_tbl_pat_gain(), except for the additional extra_data_ptr argument that is passed to the external library (if any) in the _gain call. This provides a mechanism for a pipeline stage or process model to obtain extra information from the library along with the gain value, such as a polarization value. The caller and the library need to have full knowledge of the format of the extra argument, because the library will cast the void * to what it thinks the data should be.
Purpose
Provides a mechanism to convert a particular antenna direction into a gain value corresponding to that direction. If an external library is being used, it can provide additional information as well.
Errors
- Program Abort: Segmentation violation. (due to an invalid table ID)
Reference
- Use the KP op_tbl_pat_gain() to get an antenna pattern gain value from an antenna pattern model
- Use the KP op_tbl_mod_ber() to look up a Bit-Error-Rate value in a modulation format model table
- Use the KP op_tbl_pattern_get() to obtain an antenna pattern table pointer (alternatively, op_td_get_ptr(), applied to the OPC_TDA_RA_RX_PATTERN or OPC_TDA_RA_TX_PATTERN transmission data attribute, will also obtain an antenna pattern table pointer)
- Use the KP op_td_set_dbl(), applied to the OPC_TDA_RA_RX_GAIN or OPC_TDA_RA_TX_GAIN transmission data attributes, to store a computed gain value into a packet’s transmission data