op_tbl_pattern_get()
Abstract
Obtains an antenna pattern given the antenna module ID.
Syntax
op_tbl_pattern_get (antenna_id)
| Argument | Type | Description |
|---|---|---|
antenna_id |
objid |
antenna module ID |
Return Type
Pattern_Handle
Antenna pattern, or OPC_NIL if the pattern is not found.
Example
/* Discover the Antenna module id associated with this cell. */
cell_ant_id = op_topo_assoc (cell_tx_id, OPC_TOPO_ASSOC_OUT, OPC_OBJTYPE_ANT, 0);
/* Check to make sure that the returned Object ID is valid. */
if (cell_ant_id == OPC_OBJID_INVALID)
op_sim_end ("There is no antenna module connected to this cell.", "", "", "");
/* Obtain the antenna boresight and reference values. */
op_ima_obj_attr_get (cell_ant_id, "pointing ref. theta",
&(global_node_b_params[cell].boresight_theta));
op_ima_obj_attr_get (cell_ant_id, "pointing ref. phi",
&(global_node_b_params[cell].boresight_phi));
global_node_b_params[cell].boresight_phi =
90 - global_node_b_params[cell].boresight_phi;
op_radio_antenna_point_info_get (cell_ant_id,
&(global_node_b_params[cell].pointing_ref_phi),
&(global_node_b_params[cell].pointing_ref_theta));
/* Get a reference to the antenna pattern of this cell. */
global_node_b_params[cell].antenna_model_id =
(void *) op_tbl_pattern_get (cell_ant_id);
Details
None.
Purpose
Provides a way to get a reference to the antenna pattern table for an antenna module. This reference can then be used with op_tbl_pat_gain().
Errors
- Recoverable Error: Object ID (<antenna_id>) is out-of-range.
- Recoverable Error: Object ID (<antenna_id>) refers to a restricted object.
- Recoverable Error: Object id (<antenna_id>, <obj_path>) does not correspond to an antenna module.
Reference
- Use the KP op_tbl_pat_gain() to obtain the antenna pattern gain value corresponding to a specific direction