ApskRadio

Package: inet.physicallayer.wireless.apsk.packetlevel

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.

See also: ApskScalarRadio, ApskScalarRadioMedium.

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.

Known subclasses

Name Type Description
ApskDimensionalRadio 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 ApskDimensionalRadioMedium model.

ApskLayeredDimensionalRadio compound module

This radio model is part of a simple hypothetical layered radio. It produces detailed transmissions that have separate representation for all simulated domains. It must be used in conjunction with the ApskLayeredDimensionalRadioMedium model.

ApskLayeredScalarRadio compound module

This radio model is part of a simple hypothetical layered radio. It produces detailed transmissions that have separate representation for all simulated domains. It must be used in conjunction with the ApskLayeredScalarRadioMedium model.

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.

Extends

Name Type Description
FlatRadioBase compound module

This module servces as a base module for flat radio models.

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
AckingMacinet::AckingMac::receiveSignaltransmissionStateChanged
ApskDimensionalRadioMediuminet::physicallayer::RadioMedium::addRadioaddRadio
ApskDimensionalRadioMediuminet::physicallayer::RadioMedium::listenOnMediumlistenOnMedium
ApskDimensionalRadioMediuminet::physicallayer::RadioMedium::receivePacketreceivePacket
ApskDimensionalRadioMediuminet::physicallayer::RadioMedium::transmitPackettransmitPacket
RadioMediuminet::physicallayer::RadioMedium::addRadioaddRadio
RadioMediuminet::physicallayer::RadioMedium::listenOnMediumlistenOnMedium
RadioMediuminet::physicallayer::RadioMedium::receivePacketreceivePacket
RadioMediuminet::physicallayer::RadioMedium::transmitPackettransmitPacket

Called methods (observed)

functioninfocall from
inet::physicallayer::ApskRadio::setRadioModesetRadioModeAckingMac

Incoming messages (observed)

gatemsgkindctrlsrcModuletags
radioInWirelessSignal0ApskRadio
upperLayerInPacket0AckingMacDispatchProtocolInd, InterfaceReq, MacAddressInd, MacAddressReq, NetworkProtocolInd, PacketProtocolTag, SocketReq

Outgoing messages (observed)

gatemsgkindctrldestModuletags
upperLayerOutPacket0AckingMacErrorRateInd, PacketProtocolTag, SignalPowerInd, SignalTimeInd, SnirInd

Packet operations (observed)

chunkTypepacketAction
ApskPhyHeaderinsertAtFront, popAtFront

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.
//
// @see ~ApskScalarRadio, ~ApskScalarRadioMedium.
//
module ApskRadio extends FlatRadioBase
{
    parameters:
        string protocol = default("");
        string signalAnalogRepresentation @enum("scalar","dimensional") = default("scalar");
        transmitter.typename = default(signalAnalogRepresentation == "scalar" ? "ApskScalarTransmitter" : signalAnalogRepresentation == "dimensional" ? "ApskDimensionalTransmitter" : "");
        receiver.typename = default(signalAnalogRepresentation == "scalar" ? "ApskScalarReceiver" : signalAnalogRepresentation == "dimensional" ? "ApskDimensionalReceiver" : "");
        @class(ApskRadio);
        @signal[packetDropped](type=inet::Packet);
        @statistic[packetDropped](title="packets dropped"; record=count,sum(packetBytes),vector(packetBytes); interpolationmode=none);
}

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