MediumLimitCache

Package: inet.physicallayer.wireless.common.medium

compound module MediumLimitCache

Caches various limits and constraints of the radio medium to optimize performance. Maintains information about maximum transmission power, minimum interference and reception power, maximum antenna gain, communication and interference ranges, and other parameters. These limits can be specified directly or computed dynamically based on the radios in the network.

MediumLimitCache

Usage diagram

Inheritance diagram

Used in compound modules

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.

Extends

Name

Type

Description

Module

compound module

Base module for all INET compound modules.

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

centerFrequency

double

nan Hz

TODO rename to maxRangeCenterFrequency?

maxSpeed

double

nan mps

Maximum speed on the medium, NaN means medium computes using mobility models

maxTransmissionPower

double

nan W

TODO @unit(W) + dBm/dBW <–> W

minInterferencePower

double

nan dBm

TODO @unit(W) + dBm/dBW <–> W

minReceptionPower

double

nan dBm

TODO @unit(W) + dBm/dBW <–> W

maxAntennaGain

double

0dB

Maximum antenna gain on the medium, NaN means medium computes using antenna models

minInterferenceTime

double

1ps

Minimum time interval to consider two overlapping signals interfering

maxTransmissionDuration

double

10ms

Maximum duration of a transmission on the medium

maxCommunicationRange

double

nan m

Maximum communication range on the medium, NaN means medium computes using transmitter and receiver models

maxInterferenceRange

double

nan m

Maximum interference range on the medium, NaN means medium computes using transmitter and receiver models

Properties

Name

Value

Description

class

MediumLimitCache

display

i=block/table2

Source code

//
// Caches various limits and constraints of the radio medium to optimize
// performance. Maintains information about maximum transmission power, minimum
// interference and reception power, maximum antenna gain, communication and
// interference ranges, and other parameters. These limits can be specified
// directly or computed dynamically based on the radios in the network.
//
module MediumLimitCache extends Module like IMediumLimitCache
{
    parameters:
        double centerFrequency @unit(Hz) = default(nan Hz);       // TODO rename to maxRangeCenterFrequency?
        double maxSpeed @unit(mps) = default(nan mps);             // Maximum speed on the medium, NaN means medium computes using mobility models
        double maxTransmissionPower @unit(W) = default(nan W);     // TODO @unit(W) + dBm/dBW <--> W
        double minInterferencePower @unit(dBm) = default(nan dBm); // TODO @unit(W) + dBm/dBW <--> W
        double minReceptionPower @unit(dBm) = default(nan dBm);    // TODO @unit(W) + dBm/dBW <--> W
        double maxAntennaGain @unit(dB) = default(0dB);           // Maximum antenna gain on the medium, NaN means medium computes using antenna models
        double minInterferenceTime @unit(s) = default(1ps);       // Minimum time interval to consider two overlapping signals interfering
        double maxTransmissionDuration @unit(s) = default(10ms);  // Maximum duration of a transmission on the medium
        double maxCommunicationRange @unit(m) = default(nan m);    // Maximum communication range on the medium, NaN means medium computes using transmitter and receiver models
        double maxInterferenceRange @unit(m) = default(nan m);     // Maximum interference range on the medium, NaN means medium computes using transmitter and receiver models
        @display("i=block/table2");
        @class(MediumLimitCache);
}

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