op_radio_txch_rxch_remove()
Note: Requires Wireless functionality
Abstract
Removes the specified receiver channel from the receiver group of the transmitter channel.
Syntax
op_radio_txch_rxch_remove (txch_objid, rxch_objid)
| Argument | Type | Description |
|---|---|---|
txch_objid |
Objid |
the object ID of the transmitter channel from whose receiver group the receiver channel rxch_objid is to be removed, or OPC_OBJID_UNIVERSAL to remove from all transmitter channels. |
rxch_objid |
Objid |
the object ID of the receiver channel to be removed from the receiver group of the transmitter channel txch_objid. |
Return Type
Compcode
Completion code indicating success or failure in removing the receiver channel. The procedure returns OPC_COMPCODE_SUCCESS if the receiver channel was successfully removed. Otherwise, it returns OPC_COMPCODE_FAILURE.
Example
void prop_del_and_drop (SimT_Packet * pkptr)
{
Objid txch_objid, rxch_objid;
/*... code for computing propagation delay... */
/* Remove receiver once pipeline stage is complete */
/* This does not affect the current transmission */
txch_objid = op_td_get_int (pkptr, OPC_TDA_RA_TX_CH_OBJID);
rxch_objid = op_td_get_int (pkptr, OPC_TDA_RA_RX_CH_OBJID);
op_radio_txch_rxch_remove (txch_objid, rxch_objid);
}
Details
The application generates a diagnostic error if the receiver channel referenced by rxch_objid is not present in the receiver group.
Purpose
Provides a mechanism to remove one receiver channel from a transmitter channel’s receiver group.
Errors
- Recoverable Error: Object ID (
<objid>) does not correspond to a transmitter channel. - Recoverable Error: Transmitter object ID (
<objid>) refers to a restricted object. - Recoverable Error: Object ID (
<objid>) does not correspond to a receiver channel. - Recoverable Error: Receiver object ID (
<objid>) refers to a restricted object. - Recoverable Error: Internal memory allocation error, receiver group unchanged.
- Diagnostic Error: Attempt to remove receiver channel (
<objid>) from receiver group of transmitter channel (<objid>), receiver not present.
Reference
- Use the KP op_radio_txch_rxgroup_get() to obtain the current receiver group
- Use the KP op_radio_txch_rxgroup_set() to set the receiver group to a provided array of object IDs
- Use the KP op_radio_txch_rxgroup_compute() to compute the receiver group using a filter
- Use the KP op_radio_txch_rxch_add() to add one receiver channel to a transmitter channel’s group