Reserved Transmission Data Attributes

The Simulation Kernel sets aside a number of TDAs to provide pipeline stages with access to a minimum standard set of values, and to support communication between itself and the pipeline stages as well as between the stages and each other. The TDAs reserved for these purposes in packets transmitted over radio links are defined in Table 66. (For compactness, the symbolic constants in this table are shown in a short form. When used, each symbolic constant appears with OPC_TDA_RA_ prepended to the name given in the table.)

Table 66: Radio Pipeline Reserved TDAs

Symbolic Constant (OPC_TDA_RA_ …) Data Type Definition Assigned By Modifiable by Stages
ACTUAL_BER double proportion of erroneous bits in packet or segment thereof stage 12 yes
BER double expected bit error probability for packet or segment thereof stage 11 yes
BKGNOISE double background noise due to otherwise unmodeled sources (in watts) stage 8 yes
CLOSURE integer ability of tx channel to communicate with rx channel stage 2 yes
ECC_THRESH double maximum proportion of erroneous bits that receiver can correct Kernel yes
END_DIST double distance between tx and rx at time when transmission completes (in meters) Kernel yes
END_PROPDEL double radio signal propagation time between tx and rx at end of transmission (in seconds) stage 5 yes
END_RX double simulation time at which packet completes reception (equal to transmission start time + transmission delay + end propagation delay) Kernel no
END_TX double simulation time at which packet completes transmission Kernel no
MATCH_STATUS integer categorization of compatibility between tx and rx channels as valid, noise, or ignored stage 3 yes
ND_FAIL double earliest simulation time at which rx node failure occurred during reception of packet Kernel (if failure occurs) no
ND_RECOV double latest simulation time at which rx node recovery occurred during reception of packet Kernel (if recovery occurs) no
NOISE_ACCUM double accumulated noise power of interfering transmissions (in watts) for packet or segment thereof stage 9 yes
NUM_COLLS integer number of collisions experienced by packet to date reset by Kernel yes
NUM_ERRORS integer number of bit errors affecting packet to date stage 12 and reset by Kernel yes
PK_ACCEPT integer decision to accept/reject packet stage 13 Yes
PROC_GAIN double processing gain provided by receiver system (in dB); used to compute effective SNR Kernel yes
RCVD_POWER double in-band power of received radio signal (in watts) stage 7 yes
RX_BW double bandwidth of receiver channel (in Hz) Kernel yes
RX_CH_INDEX integer index of receiver channel Kernel no
RX_CH_OBJID integer object ID of radio rx channel Kernel no
RX_CODE double code used to identify receiver spreading technique and/or sequence Kernel yes
RX_DRATE double data rate of receiver channel (in bits per second) Kernel yes
RX_FREQ double base frequency of receiver channel (in Hz) Kernel yes
RX_GAIN double gain provided to signal by receiver’s antenna stage 6 yes
RX_GEO_X,
RX_GEO_Y,
RX_GEO_Z
double receiver node’s geocentric Cartesian coordinates (in meters) Kernel yes
RX_LAT,
RX_LONG,
RX_ALT
double latitude, longitude (in degrees), and altitude (in meters) of receiving node Kernel yes
RX_MOD pointer reference to modulation table object to use in op_tbl_mod_ber() Kernel yes
RX_NOISEFIG double noise figure of receiver Kernel yes
RX_OBJID integer object ID of radio receiver Kernel no
RX_PATTERN pointer reference to antenna pattern object to use in op_tbl_pat_gain() Kernel yes
SNR double ratio of signal power to noise power measured at receiver location (in dB) for packet or segment thereof stage 10 yes
SNR_CALC_TIME double simulation time at which SNR was last calculated stage 10 yes
START_DIST double distance between tx and rx at start of transmission (in meters) Kernel yes
START_PROPDEL double radio signal propagation time between tx and rx at start of transmission (in seconds) stage 5 yes
START_RX double simulation time at which packet begins reception Kernel no
START_TX double simulation time at which packet begins transmission Kernel no
TX_BW double bandwidth of transmitter channel (in Hz) Kernel yes
TX_CH_INDEX integer index of transmitter channel Kernel no
TX_CH_OBJID integer object ID of radio tx channel Kernel no
TX_CODE double code used to identify transmitter spreading technique and/or sequence Kernel yes
TX_DELAY double transmission delay of packet (in seconds) stage 1 yes
TX_DRATE double data rate of transmitter channel (in bits per second) Kernel yes
TX_FREQ double base frequency of transmitter channel (in Hz) Kernel yes
TX_GAIN integer gain provided to signal by transmitter’s antenna stage 4 yes
TX_GEO_X,
TX_GEO_Y,
TX_GEO_Z
double transmitter node’s geocentric Cartesian coordinates (in meters) Kernel yes
TX_LAT,
TX_LONG,
TX_ALT
double latitude, longitude (in degrees), and altitude (in meters) of transmitting node Kernel yes
TX_MOD pointer reference to modulation table object to use in op_tbl_mod_ber() Kernel yes
TX_OBJID integer object ID of radio transmitter Kernel no
TX_PATTERN pointer reference to antenna pattern object to use in op_tbl_pat_gain() Kernel yes
TX_POWER double power of transmission (in watts) Kernel yes

Riverbed Modeler users creating custom pipeline designs can use any higher-numbered TDAs (above the highest predefined TDA) that are not reserved by the Kernel to communicate additional information between stages. The highest reserved TDA index for the Radio Transceiver Pipeline is represented by the symbolic constant OPC_TDA_RA_MAX_INDEX. To get the lowest unreserved TDA index, add one to this constant.