Radio Transmitter Channel Object
Each radio transmitter manages an arbitrary number of radio transmitter channels which are capable of broadcasting packets into the radio medium. The channels are labeled “channel [0]” through “channel [n-1]”, for transmitters with n channels. Bus transmitter channels are children of a special object called a compound attribute object (CA object). The CA object is the value of the channel attribute of a bus transmitter module.
Radio Transmitter Channel Object Attributes
The built-in attributes of the radio transmitter channel object are listed below, in alphabetical order.
Table 28: Radio Transmitter Channel Object Built-In Attributes
| Name | Data Type |
|---|---|
| bandwidth | double |
| bit capacity | double |
| data rate | double |
| min frequency | double |
| packet formats | string |
| pk capacity | double |
| power | double |
| spreading code | toggle-double |
| wireless domain | object ID |
bandwidth
This attribute specifies the bandwidth of the channel. The value of this attribute is typically used to determine matches and overlaps between transmitter and receiver channels and, together with the min frequency attribute, to compute the center-frequency of the channel, which factors into the link budget performed by the power model stage of the Radio Transceiver Pipeline.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read / write |
| Default Value | 10.0 | |
| Units | kilohertz | |
| Constraints | bandwidth > 0.0 |
bit capacity
This attribute specifies the maximum number of bits that can be held in the transmission queue. The size of the transmission queue in bits is the sum of the packet lengths for all packets presently contained in the queue. Attempts to insert a packet into the queue that would increase the total number of bits beyond the limit specified by this attribute return a failure status, indicating that the transmission queue is full.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write/promote | read/write |
| Default Value | infinity | |
| Units | bits | |
| Constraints | bit capacity >= 0 |
data rate
This attribute specifies the rate at which information can be forwarded over the data transmission channel. The value of this attribute is typically used by the txdel model transceiver pipeline stage to compute transmission delay, and by the chanmatch model transceiver pipeline stage to determine whether the transmitter and receiver channels have matching characteristics.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read / write |
| Default Value | 1024.0 | |
| Units | bits/second | |
| Constraints | data rate > 0.0 |
min frequency
This attribute specifies the base frequency of the channel. The value of this attribute is typically used to determine matches and overlaps between transmitter and receiver channels and, together with the bandwidth attribute, to compute the center-frequency of the channel, which factors into the link budget performed by the power model stage of the transceiver pipeline.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read / write |
| Default Value | 30.0 | |
| Units | megahertz | |
| Constraints | min frequency >= 0.0 |
packet formats
This attribute specifies the types of packets a channel can accept from other modules in its node and successfully transmit. Other types of packets are enqueued by the transmitter channel but are discarded when they reach the head of the queue. This mechanism is called link consistency and its purpose of this attribute is to prevent packets from being sent that cannot be properly processed by the nodes that will receive them.
Note: this attribute is stored as a comma-separated string which concatenates sub-strings for each of the supported packet formats. The special sub-string “unformatted” is used to allow unformatted packets to be sent by the channel.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read / write | read |
| Default Value | all formatted, unformatted | |
| Units | ||
| Constraints |
pk capacity
This attribute specifies the maximum number of packets that can be held in the transmission queue. The size of the transmission queue in packets is the sum of all packets presently contained in the queue. Attempts to insert a packet into the queue that would increase the total number of packets beyond the limit specified by this attribute return a failure status, indicating that the transmission queue is full.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read/write/promote | read/write |
| Default Value | 1000.0 | |
| Units | packets | |
| Constraints | packet capacity >= 0 |
power
This attribute specifies the transmission power allocated to packets transmitted through the channel. The value of this attribute is typically used by the Radio Transceiver Pipeline for a link budget calculation performed in the power model stage.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read / write |
| Default Value | 100.0 | |
| Units | watts | |
| Constraints | power >= 0.0 |
spreading code
This attribute can be used to specify a user-assigned code for the channel. This allows the channel match model within the Radio Transceiver Pipeline to group transmitter and receiver channels into compatibility classes defined by commonality of spreading code. This has the effect of creating radio subnetworks within the overall network model. By default the value of this attribute is “disabled”, meaning that the channel is compatible only with receiver channels whose spreading code attributes are also set to “disabled”.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle-double | toggle-double |
| Access | read / write / promote | read / write |
| Default Value | disabled | |
| Units | ||
| Constraints |
wireless domain
This attribute is used during simulation to assign the channel to a wireless domain.
| Editing | Simulation | |
|---|---|---|
| Data Type | N/A | object ID |
| Access | N/A | read / write |
| Default Value | OPC_OBJID_NULL | |
| Units | ||
| Constraints |
Radio Transmitter Channel Object Statistics
The supported statistics of the radio transmitter channel object are listed below, in alphabetical order.
Table 29: Radio Transmitter Channel Object Statistics
| Name | Units |
|---|---|
| busy | N/A |
| overflows | N/A |
| queue size (bits) | bits |
| queue size (packets) | packets |
| queuing delay | seconds |
| throughput (bits/sec)) | bits/second |
| throughput (packets/sec) | packets/second |
| utilization | N/A |
The following events affect the radio transmitter channel object and cause it to update the indicated statistics.
Table 30: Radio Transmitter Channel Object Statistic Events
| Event | Statistics Updated |
|---|---|
| packet arrival | queue size (bits), queue size (packets), overflows |
| transmission start | busy |
| transmission complete | queue size (bits), throughput (bits/sec), busy, queuing delay, queue size (packets), throughput (packets/sec), utilization |
The following sections describe each radio transmitter channel object statistic. An initial value of “undef” means that a statistic is initially undefined.
busy
This statistic is a Boolean value (0.0 or 1.0) which indicates whether a packet is currently being transmitted on the transmitter channel. This statistic goes high at the instant that a packet first starts to be sent on the transmitter channel, and goes low when the trailing edge of the packet has completed transmission.
| Units | N/A |
| Initial Value | 0.0 |
overflows
This statistic represents a running count of the number of times the transmission queue has had to drop a packet due to lack of capacity. overflows is monotonically increasing and is updated whenever a packet insertion fails.
| Units | not applicable |
| Initial Value | 0.0 |
queue size (bits)
This statistic represents the sum of the lengths (in bits) of the packets currently awaiting transmission in the channel’s transmission queue. The transmitter channel maintains a queue to enforce disciplined utilization of the channel bandwidth while allowing arbitrary arrivals at its input. This statistic includes the bits of the packet currently in service, and is updated every time a new packet is given to the transmitter channel or whenever a packet completes transmission.
| Units | bits |
| Initial Value | 0.0 |
queue size (packets)
This statistic represents the current number of packets awaiting transmission in the channel’s transmission queue. The transmitter channel maintains a queue to enforce disciplined utilization of the channel bandwidth while still allowing arbitrary arrivals at its input. This statistic includes the packet currently in service by the transmitter, and is updated every time a new packet is given to the transmitter channel or whenever a packet completes transmission.
| Units | packets |
| Initial Value | 0.0 |
queuing delay
This statistic represents instantaneous measurements of packet waiting times in the transmitter channel’s queue. Measurements are taken from the time a packet enters the transmitter channel queue to the time the last bit of the packet is transmitted. A new sample of queuing delay is generated whenever a packet ends transmission.
| Units | seconds |
| Initial Value | undef |
throughput (bits/sec)
This statistic has two possible meanings, depending on collection method.
- When collected by statistic probe, this statistic represents the average number of bits forwarded over the transmitter channel in bits per second. It is computed by dividing the total number of bits transmitted to date by the current simulation time.
- When collected by statistic wire, this statistic has one of two values: 0 and the channel data rate. Instantaneous throughput is not accumulated.
New samples of throughput (bits/sec) are generated whenever a packet completes transmission. Packets awaiting transmission in the channel’s queue do not contribute to this statistic until they complete transmission.
| Units | bits/second |
| Initial Value | 0.0 |
throughput (packets/sec)
This statistic has two possible meanings, depending on collection method.
- When collected by statistic probe, this statistic represents the average number of packets forwarded over the transmitter channel per second. It is computed by dividing the total number of packets transmitted to date by the current simulation time.
- When collected by statistic wire, this statistic has one of two values: 0 and the channel data rate. Instantaneous throughput is not accumulated.
New samples of throughput (packets/sec) are generated whenever a packet completes transmission. Packets awaiting transmission in the channel’s queue do not contribute to this statistic until they complete transmission.
| Units | packets/second |
| Initial Value | 0.0 |
utilization
This statistic has two possible meanings, depending on collection method.
- When collected by statistic probe, this statistic is a measure of the consumption to date of available channel bandwidth. It is expressed as a percentage, where 100 indicates full usage. This statistic provides a value equivalent to the running time-average of the busy statistic. utilization is computed by dividing the cumulative amount of time the transmitter has been busy to date by the current simulation time.
- When collected by statistic wire, this statistic has one of two values: 0 and 100. Instantaneous utilization is not accumulated.
New samples of utilization are generated whenever the transmitter channel completes a packet transmission.
| Units | N/A |
| Initial Value | 0.0 |