Package: inet.common
Module
compound moduleBase module for all INET compound modules.
Inheritance diagram
The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.
Known subclasses
| Name | Type | Description |
|---|---|---|
| AdditiveScrambler | compound module |
The Scrambler module converts an input string into a seemingly random output string of the same length. |
| AntennaBase | compound module |
Serves as the base module for antenna models. |
| ApskDecoder | compound module |
Part of a simple hypothetical layered receiver. It computes the packet domain representation from the bit domain representation by applying the configured descrambling, forward error correction decoding, and deinterleaving. |
| ApskEncoder | compound module |
Part of a simple hypothetical layered transmitter. It computes the bit domain representation from the packet domain representation by applying the configured scrambling, forward error correction encoding, and interleaving. |
| ApskLayeredTransmitter | compound module |
This transmitter model is part of a simple hypothetical layered radio. It produces detailed transmissions that have a separate representation for all simulated domains. The levelOfDetail parameter controls which domains are actually simulated, but all parameters relevant to the error model are always set on the transmission. |
| BreakpointPathLoss | compound module |
Path loss model that uses a dual-slope approach with different path loss exponents for different distance ranges. Models signal attenuation with a breakpoint distance that divides propagation into two regions, each with its own path loss characteristics. Particularly useful for environments where propagation behavior changes significantly at a certain distance, such as indoor/outdoor transitions or urban scenarios with varying obstacle densities. |
| BvhObjectCache | compound module |
This object cache model organizes closely positioned physical objects into a tree data structure. |
| ClockBase | compound module |
Base module for clocks. |
| ClockServoBase | compound module |
Base module for clock servos. |
| ConvolutionalCoder | compound module |
Implements convolutional coding, a type of error-correcting code that generates parity symbols via the sliding application of a boolean polynomial function to a data stream. |
| Dcaf | compound module |
Implements the DCAF (Distributed Channel Access Function) for IEEE 802.11. |
| Dcf | compound module |
Implements the DCF (Distributed Coordination Function) for IEEE 802.11. |
| DimensionalBackgroundNoise | compound module |
Background noise model for wireless communications that represents ambient noise as a power spectral density function of time and frequency. Supports configurable time-varying and frequency-varying gain patterns with various interpolation methods. Used to model realistic noise conditions in wireless channel simulations. |
| DimensionalMediumAnalogModel | compound module |
This analog model computes with dimensional analog power representation. In other words, the signal power may change over time and/or frequency. |
| DimensionalTransmitterAnalogModel | compound module | (no description) |
| Edca | compound module |
Implements EDCA (Enhanced Distributed Channel Access) for IEEE 802.11. The implementation allows for a configurable number of access categories, not just four as defined by the standard. |
| Edcaf | compound module |
Implements EDCAF (Enhanced Distributed Channel Access Function) for IEEE 802.11. EDCAF represents one access category within EDCA. |
| ErrorModelBase | compound module |
Serves as the base module for error models. |
| EthernetCsmaMacPhy | compound module |
Ethernet MAC layer. MAC performs transmission and reception of frames. See the ~IEtherMac for the Ethernet MAC layer general information. Doesn't do encapsulation/decapsulation; see ~Ieee8022Llc and ~EthernetEncapsulation for that. |
| EthernetMacLayer | compound module | (no description) |
| EthernetMacPhy | compound module |
Ethernet MAC which supports full-duplex operation ONLY. See the ~IEtherMac for general information. |
| FlatGround | compound module |
Models a flat ground surface with a configurable elevation. Provides methods to compute the ground projection of a 3D position by setting its z-coordinate to the elevation value, and to compute the ground normal which is always pointing upward (0,0,1) for a flat surface. |
| FreeSpacePathLoss | compound module |
Implements the free space path loss model, which models signal attenuation over distance according to the Friis transmission equation. Calculates signal power loss as a function of distance, wavelength, and configurable parameters. The alpha parameter controls the path loss exponent (default 2), while the systemLoss parameter accounts for hardware inefficiencies. Provides an ideal baseline model for wireless propagation in environments with line-of-sight and no obstacles. |
| Gptp | compound module |
Implements the generalized Precision Time Protocol (gPTP) as defined in the IEEE 802.1AS-2020 standard. |
| GridNeighborCache | compound module |
This neighbor cache model organizes radios in a three-dimensional grid with a constant cell size and updates periodically. |
| GridObjectCache | compound module |
This object cache model stores physical objects in a spatial grid. Each cell maintains a list of intersecting physical objects. The grid is aligned with the coordinate axes and it has a configurable cell size in all dimensions. The cell size parameters take precedence over the cell count parameters. |
| Hcf | compound module |
Implements the HCF (Hybrid Coordination Function) for IEEE 802.11. |
| Ieee80211LayeredOfdmTransmitter | compound module |
The level of detail parameter determines which submodules of the transmitter will be used: |
| Ieee80211OfdmDecoder | compound module |
This is the decoder module for the layered IEEE 802.11 OFDM PHY infrastructure (IEEE 802.11-2012, Clause 18). |
| Ieee80211OfdmEncoder | compound module |
This is the encoder module for the layered IEEE 802.11 OFDM PHY infrastructure (IEEE 802.11-2012, Clause 18). |
| Ieee80211OfdmInterleaver | compound module |
The ~Ieee80211OfdmInterleaver is defined by a two-step permutation. The first permutation ensures that adjacent coded bits are mapped onto nonadjacent subcarriers. The second ensures that adjacent coded bits are mapped alternately onto less and more significant bits of the constellation and, thereby, long runs of low reliability (LSB) bits are avoided. (IEEE 802.11, 18.3.5.7 Data interleaving) |
| Ieee802154UwbIrReceiver | compound module | (no description) |
| Ieee802154UwbIrTransmitter | compound module | (no description) |
| Ipv4NetworkLayer | compound module | |
| IsotropicDimensionalBackgroundNoise | compound module |
This background noise model describes noise that does not change over space, time and frequency. It produces dimensional noise signals that can be further used in dimensional computations. |
| IsotropicScalarBackgroundNoise | compound module |
This background noise model describes noise that does not change over space, time, and frequency. It produces scalar noise signals that can be further used in scalar computations. |
| MapCommunicationCache | compound module |
This communication cache model stores radio, transmission and reception related intermediate computation results in map data structures. It's primarily useful for simulations with both static <b>and</b> dynamic radios, and with both short <b>and</b> long transmission durations. |
| Mcf | compound module |
IEEE 802.11 Mesh Coordination Function |
| MediumLimitCache | compound module |
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. |
| MultiClock | compound module |
Multi-clock aggregator and switch. |
| NeighborListNeighborCache | compound module |
This neighbor cache model maintains a separate periodically updated neighbor list for each radio. |
| NetworkBase | network | (no description) |
| NetworkInterface | compound module |
Serves as the base module for all network interfaces. |
| NodeBase | compound module |
The fundamental infrastructure for all network nodes focusing on non-communication aspects of network nodes. |
| NoiseSource | compound module |
A network node that generates periodic noise transmissions that can interfere with wireless communications. Alternates between sleep and transmission states based on configurable intervals. Uses a ~NoiseTransmitter to create noise signals with specified duration, frequency, bandwidth, and power parameters. Useful for testing protocol robustness against interference in wireless networks. |
| OmittedEthernetEncapsulation | compound module |
Implements the given module interface and can be used as an optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8021dQosClassifier | compound module |
Implements the given module interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8021qTagEpdHeaderChecker | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8021qTagEpdHeaderInserter | compound module |
Implements the module given by the interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8021qTagTpidHeaderChecker | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize. |
| OmittedIeee8021qTagTpidHeaderInserter | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8022Llc | compound module |
Implements the given module interface and can be used as an optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8022LlcChecker | compound module |
Implements the given module interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8022LlcInserter | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize. |
| OmittedIeee8022LlcLayer | compound module |
Implements the module given an interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8022SnapChecker | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedIeee8022SnapInserter | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedMeasurementLayer | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedPacketDelayer | compound module |
Implements the given module interface and can be used as an optional module that removes itself from the module hierarchy during initialization. |
| OmittedPacketFilter | compound module |
Implements the given module interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedPacketFlow | compound module |
Implements the given module interface and can be used as an optional module that removes itself from the module hierarchy during initialization. |
| OmittedPacketGate | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedPacketMeter | compound module |
Implements the module given interface and can be used as an optional module that removes itself from the module hierarchy during initialize. |
| OmittedPacketQueue | compound module |
Implements the given module interface and can be used as an optional module that removes itself from the module hierarchy during initialization. |
| OmittedPacketServer | compound module |
Implements the given interface and can be used as an optional module that removes itself from the module hierarchy during initialization. |
| OmittedProcessingDelayLayer | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedProtocolLayer | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedSocketLayer | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize. |
| OmittedTrafficConditioner | compound module |
Implements the given module interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OmittedTrafficConditionerLayer | compound module |
Implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialization. |
| OriginatorMacDataService | compound module |
Implements the MAC data service for the originator (sender) side in non-QoS IEEE 802.11 networks. Processes outgoing frames by assigning sequence numbers and performing fragmentation based on the configured policy. Follows the MAC data plane architecture described in IEEE 802.11 standard to prepare frames for transmission. |
| OriginatorQosMacDataService | compound module |
Implements the MAC data service for the originator (sender) side in IEEE 802.11 QoS networks. Extends the basic MAC data service with QoS capabilities including MSDU aggregation (A-MSDU) and MPDU aggregation (A-MPDU). Processes outgoing frames by assigning sequence numbers, performing aggregation, and fragmentation based on configured policies. Follows the MAC data plane architecture described in IEEE 802.11 standard. |
| OsgEarthGround | compound module |
Models a ground surface using OsgEarth's elevation data. Provides methods to compute ground projections and normals based on real-world terrain information. Requires OsgEarth integration to be enabled during compilation and depends on a SceneOsgEarthVisualizer for accessing the map and a coordinate system for geographic conversions. |
| Pcf | compound module |
IEEE 802.11 Point Coordination Function |
| PhysicalEnvironment | compound module |
The propagation of communication signals, the movement of communicating agents, or battery exhaustion depends on the surrounding physical environment. For example, signals can be absorbed by objects, can pass through objects, can be refracted by surfaces, can be reflected from surfaces, etc. |
| Pim | compound module |
Implements the Protocol Independent Multicast (PIM) routing protocol for IP multicast. This module integrates both PIM-DM (Dense Mode) and PIM-SM (Sparse Mode) implementations, using a splitter to direct packets to the appropriate mode based on interface configuration. PIM builds distribution trees for efficient multicast data delivery across IP networks. |
| PropagationBase | compound module |
Serves as a base module for propagation models. |
| QuadTreeNeighborCache | compound module |
This neighbor cache model organizes radios in a two-dimensional quad tree (ignoring the Z axis) with a constant node size and updates periodically. |
| 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. |
| ReceiverBase | compound module | (no description) |
| RecipientMacDataService | compound module |
Implements the MAC data service for the recipient side in non-QoS IEEE 802.11 networks. Processes received frames by performing defragmentation and duplicate detection. |
| RecipientQosMacDataService | compound module |
Implements the QoS MAC data service for the recipient side in IEEE 802.11 networks. Extends the basic recipient MAC data service with QoS capabilities including A-MPDU deaggregation, A-MSDU deaggregation, and block ACK reordering. Processes received frames according to the MAC data plane architecture described in the IEEE 802.11 standard. |
| ReferenceCommunicationCache | compound module |
This communication cache model allows validation of other implementations. It can be used to provide a reference for communication logs, simulation fingerprints, and statistical results that can be compared with the results of other communication cache implementations. |
| ScalarMediumAnalogModel | compound module |
This analog model computes with scalar analog power representation. In other words, the signal power does not change over time or frequency, except for the boundaries of the signal. |
| ScalarTransmitterAnalogModel | compound module | (no description) |
| SuiPathLoss | compound module |
Implements the Stanford University Interim (SUI) path loss model, an empirical model used to predict radio signal attenuation over various terrain types. Path loss is calculated based on distance, frequency, and antenna heights, with parameter sets defined for different environments. |
| TimeAwareShapingShowcaseNetwork | network | (no description) |
| TracingObstacleLossBase | compound module |
Serves as a base module for tracing obstacle loss models. |
| TransmitterBase | compound module | (no description) |
| TwoRayInterference | compound module |
Path loss model that accounts for interference between direct and ground-reflected signal paths. Considers phase differences, polarization effects (horizontal or vertical), and ground permittivity to accurately model constructive and destructive interference patterns, yielding a more accurate approximation than ~TwoRayGroundReflection even on short distances. |
| UnitDiskMediumAnalogModel | compound module |
This analog model provides a very simple and predictable physical layer behaviour. It determines the reception power by categorizing transmissions based on the distance between the transmitter and the receiver. |
| UnitDiskTransmitterAnalogModel | compound module |
This transmitter analog model produces signals which are described with a few distance-based parameters. |
| UwbIrStochasticPathLoss | compound module |
This is a statistical path-loss model for UWB propagation in residential environments, for both line-of-sight (LOS) and non-line-ofsight (NLOS) cases. It implements the Ghassmezadeh stochastic UWB channel path loss model. |
| VectorCommunicationCache | compound module |
This communication cache model stores radio, transmission and reception related intermediate computation results in vector data structures. It's primarily useful for simulations with <b>either</b> static <b>or</b> short lived dynamic radios, and with only short transmission durations. |
Extends
| Name | Type | Description |
|---|---|---|
| ModuleMixin | simple module |
Base module for all INET 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 |
Properties
| Name | Value | Description |
|---|---|---|
| class | Module |
Source code
// // Base module for all INET compound modules. // module Module extends ModuleMixin { parameters: @class(Module); }File: src/inet/common/Module.ned