UnitDiskRadioMedium

Package: inet.physicallayer.wireless.common.medium

UnitDiskRadioMedium

compound module

This radio medium model provides a very simple but fast and predictable physical layer behavior. The idea behind this analog model is to describe transmissions with a few distance-based parameters: communication range, interference range, and detection range. Whether the reception is successful or not depends on the distance between the transmitter and the receiver.

<b>See also:</b> UnitDiskMediumAnalogModel, UnitDiskTransmitterAnalogModel, UnitDiskReceiverAnalogModel.

<b>See also:</b> DimensionalRadioMedium, ScalarRadioMedium

propagation : like IPropagation

ConstantSpeedPropagation: This propagation model computes the propagation time to be proportional to the traveled distance,...

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

Source:
propagation: <default("ConstantSpeedPropagation")> like IPropagation {
    parameters:
        @display("p=100,100");
} analogModel : like IMediumAnalogModel

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

Source:
analogModel: <default(signalAnalogRepresentation == "unitDisk" ? "UnitDiskMediumAnalogModel" : signalAnalogRepresentation == "scalar" ? "ScalarMediumAnalogModel" : signalAnalogRepresentation == "dimensional" ? "DimensionalMediumAnalogModel" : "")> like IMediumAnalogModel {
    parameters:
       ... backgroundNoise : like IBackgroundNoise

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

Source:
backgroundNoise: <default(signalAnalogRepresentation == "scalar" ? "IsotropicScalarBackgroundNoise" : signalAnalogRepresentation == "dimensional" ? "IsotropicDimensionalBackgroundNoise" : "")> like IBackgroundNoise if typename != "" {
    parameters:
        @display("p=100,300");
} pathLoss : like IPathLoss

FreeSpacePathLoss: Implements the free space path loss model, which models signal attenuation over distance according...

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

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

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

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

MediumLimitCache: Caches various limits and constraints of the radio medium to optimize performance.

IMediumLimitCache: Module interface for caching various limits and constraints of the radio medium to optimize...

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

VectorCommunicationCache: This communication cache model stores radio, transmission and reception related intermediate...

ICommunicationCache: Module interface for communication caches that store and manage radio and transmission data in...

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

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

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

Inheritance diagram

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

Used in

Name Type Description
AODVNetwork network (no description)
AODVNetwork network

AODV network with an external Ethernet-connected host that can receive traffic from the wireless AODV network. The router acts as the gateway between the wireless AODV network and the wired Ethernet network.

HiddenNodeShowcase network (no description)
NeighborCacheTest network (no description)
Net network (no description)
ShortestPath network (no description)
SimpleRREQ network (no description)
SimpleRREQ2 network (no description)

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
displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

physicalEnvironmentModule string "physicalEnvironment"

Module path of the physical environment model

signalAnalogRepresentation string "unitDisk"
rangeFilter string ""

filter parameters that control when signals are sent to receiver radios

radioModeFilter bool false

When enabled, the radio medium doesn't send signals to a radio if it's neither in receiver nor in transceiver mode

listeningFilter bool false

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

macAddressFilter bool false

When enabled, the radio medium doesn't send signals to a radio if the destination MAC address differs

recordTransmissionLog bool false

logging parameters

recordReceptionLog bool false

When enabled, the medium writes one line per reception into the communication log file

sameTransmissionStartTimeCheck string "error"

Specifies what should happen if two transmissions start at the same moment

Properties

Name Value Description
class RadioMedium
display i=misc/sun

Signals

Name Type Unit Description
radioRemoved
signalDepartureStarted
radioAdded
signalArrivalStarted
signalAdded
signalDepartureEnded
signalRemoved
signalArrivalEnded

Unassigned submodule parameters

Name Type Default value Description
neighborCache.refillPeriod double

Source code

//
// This radio medium model provides a very simple but fast and predictable
// physical layer behavior. The idea behind this analog model is to describe
// transmissions with a few distance-based parameters: communication range,
// interference range, and detection range. Whether the reception is successful
// or not depends on the distance between the transmitter and the receiver.
//
// @see UnitDiskMediumAnalogModel, UnitDiskTransmitterAnalogModel, UnitDiskReceiverAnalogModel.
// @see DimensionalRadioMedium, ScalarRadioMedium
//
module UnitDiskRadioMedium extends RadioMedium
{
    parameters:
        signalAnalogRepresentation = default("unitDisk");
}

File: src/inet/physicallayer/wireless/common/medium/UnitDiskRadioMedium.ned