ApskScalarRadio

Package: inet.physicallayer.wireless.apsk.packetlevel

ApskScalarRadio

compound module

This radio model provides a hypothetical radio that simply uses one of the well-known modulations without utilizing other techiques such as forward error correction, interleaving, spreading, etc. It must be used in conjunction with the ApskScalarRadioMedium model.

See also: ApskScalarRadioMedium, ScalarAnalogModel, ApskScalarTransmitter, ApskScalarReceiver.

antenna : like IAntenna

IsotropicAntenna: This antenna model describes the theoretical point source which radiates the same intensity of...

IAntenna: The antenna model describes the physical device (a part of the radio) which converts electric...

Source:
antenna: <default("IsotropicAntenna")> like IAntenna {
    parameters:
        @display("p=100,100");
} transmitter : like ITransmitter

ITransmitter: The transmitter model describes the physical process which converts packets into electric signals.

Source:
transmitter: <> like ITransmitter {
    parameters:
        @display("p=100,200");
} receiver : like IReceiver

IReceiver: The receiver model describes the physical process which converts electric signals into packets.

Source:
receiver: <> like IReceiver {
    parameters:
        @display("p=100,300");
} energyConsumer : like IEnergyConsumer

IEnergyConsumer: The energy consumer models describe the energy consumption process of devices over time.

Source:
energyConsumer: <default("")> like IEnergyConsumer if typename != "" {
    parameters:
        @display("p=100,400");
}

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name Type Description
ApskRadio compound module

This radio model provides a hypothetical radio that simply uses one of the well-known modulations without utilizing other techiques such as forward error correction, interleaving, spreading, etc.

Parameters

Name Type Default value Description
radioMediumModule string "radioMedium"

module path of the medium module where this radio communicates

energySourceModule string ""

module path of the energy source module which provides energy to the radio

initialRadioMode string "off"
switchingTimes string "ms 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0"

time parameters to switch between radio modes

sendRawBytes bool false

when true packets are serialized into a sequence of bytes before sending out

separateTransmissionParts bool false

when enabled the transmission of preamble, header and data part are simulated separately

separateReceptionParts bool false

when enabled the reception of preamble, header and data part are simulated separately

displayCommunicationRange bool false

if true communication range is displayed as a blue circle around the node

displayInterferenceRange bool false

if true interference range is displayed as a gray circle around the node

centerFrequency double

center frequency of the band where the radio transmits and receives signals on the medium

bandwidth double

bandwidth of the band where the radio transmits and receives signals on the medium

protocol string ""
signalAnalogRepresentation string "scalar"

Properties

Name Value Description
display i=block/wrxtx
class ApskRadio

Gates

Name Direction Size Description
upperLayerIn input
upperLayerOut output
radioIn input

Signals

Name Type Unit
packetDropped inet::Packet

Statistics

Name Title Source Record Unit Interpolation Mode
packetDropped packets dropped count, sum(packetBytes), vector(packetBytes) none

Scheduled messages (observed)

msgkindctrltagsmsgnamecontext
omnetpp::cMessage0transmissionTimerfilled
omnetpp::cMessage0WirelessSignalreceptionTimer

Direct method calls (observed)

call tofunctioninfo
PcapRecorderinet::PcapRecorder::receiveSignalpacketReceivedFromLower
AckingMacinet::AckingMac::receiveSignaltransmissionStateChanged
BMacinet::BMac::receiveSignalradioModeChanged
BMacinet::BMac::receiveSignaltransmissionStateChanged
CsmaCaMacinet::CsmaCaMac::receiveSignalreceptionStateChanged
CsmaCaMacinet::CsmaCaMac::receiveSignaltransmissionStateChanged
Ieee80211Macinet::ieee80211::Ieee80211Mac::receiveSignalradioModeChanged
Ieee80211Macinet::ieee80211::Ieee80211Mac::receiveSignalreceivedSignalPartChanged
Ieee80211Macinet::ieee80211::Ieee80211Mac::receiveSignalreceptionStateChanged
Ieee80211Macinet::ieee80211::Ieee80211Mac::receiveSignaltransmissionStateChanged
Ieee802154Macinet::Ieee802154Mac::receiveSignaltransmissionStateChanged
LMacinet::LMac::receiveSignalradioModeChanged
LMacinet::LMac::receiveSignaltransmissionStateChanged
XMacinet::XMac::receiveSignalradioModeChanged
XMacinet::XMac::receiveSignaltransmissionStateChanged
ApskLayeredScalarRadioMediuminet::physicallayer::RadioMedium::addRadioaddRadio
ApskLayeredScalarRadioMediuminet::physicallayer::RadioMedium::listenOnMediumlistenOnMedium
ApskLayeredScalarRadioMediuminet::physicallayer::RadioMedium::receivePacketreceivePacket
ApskLayeredScalarRadioMediuminet::physicallayer::RadioMedium::transmitPackettransmitPacket
ApskScalarRadioinet::physicallayer::ApskRadio::setRadioModesetRadioMode
ApskScalarRadioMediuminet::physicallayer::RadioMedium::addRadioaddRadio
ApskScalarRadioMediuminet::physicallayer::RadioMedium::listenOnMediumlistenOnMedium
ApskScalarRadioMediuminet::physicallayer::RadioMedium::receivePacketreceivePacket
ApskScalarRadioMediuminet::physicallayer::RadioMedium::transmitPackettransmitPacket
ApskErrorModelinet::physicallayer::ApskErrorModel::computePacketErrorRatecomputePacketErrorRate
SensorStateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignalradioModeChanged
SensorStateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignalreceivedSignalPartChanged
SensorStateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignalreceptionStateChanged
SensorStateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignaltransmissionStateChanged
SensorStateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignaltransmittedSignalPartChanged
StateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignalradioModeChanged
StateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignalreceivedSignalPartChanged
StateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignalreceptionStateChanged
StateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignaltransmissionStateChanged
StateBasedEpEnergyConsumerinet::physicallayer::StateBasedEpEnergyConsumer::receiveSignaltransmittedSignalPartChanged

Called methods (observed)

functioninfocall from
inet::physicallayer::ApskRadio::setRadioModesetRadioModeAckingMac, BMac, CsmaCaMac, Ieee80211Mac, Ieee802154Mac, LMac, XMac, ApskScalarRadio

Incoming messages (observed)

gatemsgkindctrlsrcModuletags
radioInWirelessSignal0ApskScalarRadio
upperLayerInPacket0AckingMacInterfaceReq, MacAddressInd, MacAddressReq, PacketProtocolTag, DispatchProtocolInd?, NetworkProtocolInd?, SocketReq?
upperLayerInPacket0BMacPacketProtocolTag, DispatchProtocolInd?, InterfaceReq?, MacAddressReq?, MulticastReq?, NetworkProtocolInd?, TransportProtocolInd?
upperLayerInPacket0CsmaCaMacMacAddressInd, PacketProtocolTag, DispatchProtocolInd?, ErrorRateInd?, InterfaceInd?, InterfaceReq?, MacAddressReq?, MulticastReq?, NetworkProtocolInd?, SignalPowerInd?, SignalTimeInd?, SnirInd?, SocketReq?, TransportProtocolInd?, UserPriorityInd?
upperLayerInPacket0Ieee80211MacMacAddressInd, PacketProtocolTag, Ieee80211ModeReq, DispatchProtocolInd?, DispatchProtocolReq?, InterfaceReq?, MacAddressReq?, NetworkProtocolInd?, SocketReq?, LlcProtocolTag?
upperLayerInPacket0Ieee802154MacInterfaceReq, MacAddressReq, PacketProtocolTag, DispatchProtocolInd?, NetworkProtocolInd?, SocketReq?
upperLayerInPacket0LMacPacketProtocolTag
upperLayerInPacket0XMacPacketProtocolTag
upperLayerInPacket192XMacInterfaceReq, MacAddressReq, PacketProtocolTag, DispatchProtocolInd?, MulticastReq?, NetworkProtocolInd?, SocketReq?, TransportProtocolInd?
upperLayerInRequest1ConfigureRadioCommandIeee80211Mac

Outgoing messages (observed)

gatemsgkindctrldestModuletags
upperLayerOutPacket0AckingMacErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd
upperLayerOutPacket0BMacErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd
upperLayerOutPacket0CsmaCaMacErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd
upperLayerOutPacket0Ieee80211MacErrorRateInd, MacAddressInd, PacketProtocolTag, SnirInd, Ieee80211ModeReq, DispatchProtocolInd?, DispatchProtocolReq?, InterfaceReq?, MacAddressReq?, NetworkProtocolInd?, SocketReq?, LlcProtocolTag?
upperLayerOutPacket0Ieee802154MacErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd
upperLayerOutPacket0LMacErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd
upperLayerOutPacket0XMacErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd
upperLayerOutPacket192XMacErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd

Packet operations (observed)

chunkTypepacketAction
ApskPhyHeaderinsertAtFront, popAtFront
BitCountChunkinsertAtBack
ChunkpopAtBack

Shared Tagging operations (observed)

tagTypetagAction
clearTags
ErrorRateIndfindTag
PacketProtocolTagaddTag, addTagIfAbsent, getTag
SnirIndfindTag

Source code

//
// This radio model provides a hypothetical radio that simply uses one of the
// well-known modulations without utilizing other techiques such as forward
// error correction, interleaving, spreading, etc. It must be used in
// conjunction with the ~ApskScalarRadioMedium model.
//
// @see ~ApskScalarRadioMedium, ~ScalarAnalogModel, ~ApskScalarTransmitter,
//  ~ApskScalarReceiver.
//
module ApskScalarRadio extends ApskRadio
{
    parameters:
        transmitter.typename = default("ApskScalarTransmitter");
        receiver.typename = default("ApskScalarReceiver");
}

File: src/inet/physicallayer/wireless/apsk/packetlevel/ApskScalarRadio.ned