APSKScalarRadioMedium

Package: inet.physicallayer.apskradio.packetlevel

APSKScalarRadioMedium

compound module

This radio medium 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 APSKScalarRadio model.

See also APSKScalarRadio, ScalarAnalogModel, APSKScalarTransmitter, and APSKScalarReceiver.

propagation : like IPropagation

IPropagation: The propagation model describes how a radio signal propagates through space over time.

Source:
propagation: <propagationType> like IPropagation {
    parameters:
        @display("p=100,50");
} analogModel : like IAnalogModel

IAnalogModel: The analog model describes how the analog representation of the transmissions is turned into the...

Source:
analogModel: <analogModelType> like IAnalogModel {
    parameters:
        @display("p=100,150");
} backgroundNoise : like IRadioBackgroundNoise

IRadioBackgroundNoise: The background noise model describes the thermal noise, the cosmic background noise, and other...

Source:
backgroundNoise: <backgroundNoiseType> like IRadioBackgroundNoise if backgroundNoiseType != "" {
    parameters:
        @display("p=100,250");
} pathLoss : like IPathLoss

IPathLoss: The path loss model describes the reduction of power as the signal propagates through space.

Source:
pathLoss: <pathLossType> like IPathLoss {
    parameters:
        @display("p=300,50");
} obstacleLoss : like IObstacleLoss

IObstacleLoss: The obstacle loss model describes the reduction of power as the signal passes through physical...

Source:
obstacleLoss: <obstacleLossType> like IObstacleLoss if obstacleLossType != "" {
    parameters:
        @display("p=300,150");
} mediumLimitCache : like IMediumLimitCache

Source:
mediumLimitCache: <mediumLimitCacheType> like IMediumLimitCache {
    parameters:
        @display("p=500,50");
} communicationCache : like ICommunicationCache

Source:
communicationCache: <communicationCacheType> like ICommunicationCache {
    parameters:
        @display("p=500,250");
} neighborCache : like INeighborCache

INeighborCache: The neighbor cache model computes the affected set of receivers on the medium for a given...

Source:
neighborCache: <neighborCacheType> like INeighborCache if neighborCacheType != "" {
    parameters:
        @display("p=500,150");
}

Inheritance diagram

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

Extends

Name Type Description
RadioMedium compound module

The medium model describes the shared physical medium where communication takes place. It keeps track of radios, noise sources, ongoing transmissions, background noise, and other ongoing noises. The medium computes when, where and how transmissions and noises arrive at receivers. It also efficiently provides the set of interfering transmissions and noises for the receivers.

Parameters

Name Type Default value Description
physicalEnvironmentModule string "physicalEnvironment"

module path of the physical environment model

propagationType string "ConstantSpeedPropagation"

submodule type parameters

pathLossType string "FreeSpacePathLoss"

NED type of the path loss model

obstacleLossType string ""

NED type of the obstacle loss model

analogModelType string "ScalarAnalogModel"

NED type of the analog model

backgroundNoiseType string "IsotropicScalarBackgroundNoise"

NED type of the background noise model

mediumLimitCacheType string "MediumLimitCache"

NED type of the medium limit cache model

neighborCacheType string ""

NED type of the neighbor cache model

communicationCacheType string "VectorCommunicationCache"

NED type of the communication cache model

rangeFilter string ""

filter parameters that control when radio frames are sent to receiver radios

radioModeFilter bool false

when enabled the radio medium doesn't send radio frames to a radio if it's neither in receiver nor in transceiver mode

listeningFilter bool false

when enabled the radio medium doesn't send radio frames to a radio if it listens on the channel in incompatible mode (e.g. different carrier frequency and bandwidth, different modulation)

macAddressFilter bool false

when enabled the radio medium doesn't send radio frames to a radio if it the destination mac address differs

recordCommunicationLog bool false

logging parameters

Properties

Name Value Description
class RadioMedium
display i=misc/sun_s

Signals

Name Type Unit
transmissionAdded
radioRemoved
transmissionStarted
receptionEnded
receptionStarted
radioAdded
transmissionRemoved
transmissionEnded

Unassigned submodule parameters

Name Type Default value Description
neighborCache.refillPeriod double

Source code

//
// This radio medium 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 ~APSKScalarRadio model.
//
// See also ~APSKScalarRadio, ~ScalarAnalogModel, ~APSKScalarTransmitter, and
// ~APSKScalarReceiver.
//
module APSKScalarRadioMedium extends RadioMedium
{
    parameters:
        propagationType = default("ConstantSpeedPropagation");
        pathLossType = default("FreeSpacePathLoss");
        analogModelType = default("ScalarAnalogModel");
        backgroundNoiseType = default("IsotropicScalarBackgroundNoise");
}
File: src/inet/physicallayer/apskradio/packetlevel/APSKScalarRadioMedium.ned