op_radio_antenna_point_info_get()
Note: Requires Wireless functionality
Abstract
Gets the geocentric pointing angles from an antenna to its target.
Syntax
op_radio_antenna_point_info_get (antenna_id, point_polar_ptr, point_azimuth_ptr)
| Argument | Type | Description |
|---|---|---|
antenna_id |
Objid |
Antenna of interest. |
point_polar_ptr |
double * |
Area to be filled with pointing polar value. |
point_azimuth_ptr |
double * |
Area to be filled with pointing azimuth value. |
Return Type
Compcode
OPC_COMPCODE_SUCCESS if the antenna pointing information was successfully obtained; OPC_COMPCODE_FAILURE otherwise.
Example
Objid ant_id;
double point_polar, point_azimuth;
/* Discover the Antenna module id associated with this transmitter. */
ant_id = op_topo_assoc (tx_id, OPC_TOPO_ASSOC_OUT, OPC_OBJTYPE_ANT, 0);
/* Check to make sure that the returned Object ID is valid. */
if (ant_id == OPC_OBJID_INVALID)
op_sim_end ("There is no antenna module connected to this xmtr.", "", "", "");
op_radio_antenna_point_info_get (ant_id, &point_polar, &point_azimuth);
Details
Pointing angles are given in the geocentric coordinate system. The polar angle ranges from +90° (positive z axis) to -90°. Azimuth ranges from 0° (east) to 360°, increasing in either the north or south direction depending on whether a right-hand or left-hand system is being used (“geocentric_model“ preference).
Purpose
Provides a mechanism for getting the pointing angles of an antenna.
Errors
- Recoverable Error: Object ID (
<antenna_id>) is out of range. - Recoverable Error: Object ID (
<antenna_id>) refers to a restricted object.
Reference
- Use the KP op_radio_antenna_angles_to_location_get() to get the pointing angles (in antenna coordinates) to a specified location.