op_tbl_pat_state_get()
Abstract
Obtains the state associated with an antenna pattern library.
Syntax
op_tbl_pat_gain (pattern)
| 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().] |
Return Type
void *
State associated with the pattern library, or OPC_NIL if no library is used.
Details
The antenna pattern library state is the information provided by the external library in its _open call. The caller should cast the return value to an appropriate structure matching the library state.
Purpose
Provides a mechanism for a process model or pipeline stage to read or modify the antenna pattern library state. This could, for example, be used to account for any smart-antenna changes.
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_pat_gain_ext() to get an antenna pattern gain value and additional information from an antenna pattern model