UnitDiskRadioMedium¶

Package: inet.physicallayer.wireless.common.medium

compound module UnitDiskRadioMedium

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.

Inheritance 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
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	“”	When either set to ‘interferenceRange’ or ‘communicationRange’ the radio medium doesn’t send signals to a radio if it’s outside the provided range
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	When enabled, the medium writes one line per transmission into the communication log file
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
radioAdded
radioRemoved
signalAdded
signalArrivalEnded
signalArrivalStarted
signalDepartureEnded
signalDepartureStarted
signalRemoved

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