This module interface defines the contract for traffic generator modules within the BackgroundTrafficGenerator module. This interface can be implemented by other modules to create a custom traffic generator; see TrafficGeneratorCbr as an example.

Inheritance diagram

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

Implemented by

Name	Type	Description
TrafficGeneratorBase	simple module	This module provides the basic functions and parameters that a traffic generator submodule (implementing the ITrafficGenerator interface) can utilize. It enables the configuration of parameters such as the starting time of the traffic, the size and inter-generation timing of packets, the rate of retransmissions, and so on. Custom background traffic generators can be implemented by extending this module.
TrafficGeneratorCbr	simple module	This module specializes the TrafficGeneratorBase module to provide a Constant Bit Rate (CBR) background traffic generator. This generator produces fixed-size packets at regular intervals in either downlink or uplink bands, or both.

Used in compound modules

Name	Type	Description
BackgroundUe	compound module	This module implements a lightweight model for 4G or 5G User Equipment (UE). It is used to simulate the generation of background traffic in both uplink and downlink bandwidths, according to the logic specified by its ITrafficGenerator submodule. The generated traffic is not actually transmitted or received by this module, making it more efficient from a simulation complexity perspective. Instead, such traffic modifies the buffer status information that is used by the BackgroundScheduler to allocate resources. Each background UE has a mobility submodule to configure its position in the simulation floor plan. This allows for realistic channel status information to be computed for the background UE and used by the BackgroundScheduler. Since this module does not send or receive actual traffic, application-level statistics are not produced.

Properties

Name	Value	Description
display	i=block/source

Source code

//
// This module interface defines the contract for traffic generator modules
// within the ~BackgroundTrafficGenerator module. This interface can be implemented
// by other modules to create a custom traffic generator; see ~TrafficGeneratorCbr as
// an example.
//
moduleinterface ITrafficGenerator
{
    parameters:
        @display("i=block/source");
}

File: src/stack/backgroundTrafficGenerator/generators/ITrafficGenerator.ned

---

This documentation is released under the Creative Commons license