TSNschedGateScheduleConfigurator¶

Package: inet.linklayer.configurator.gatescheduling.common

simple module TSNschedGateScheduleConfigurator

Provides a gate scheduling configurator that uses the TSNsched tool which is available at https://github.com/ACassimiro/TSNsched. Tested revision: 3f3bf663d196ec6c03e81a1e1392d4aefd158e3e

In order to be able to use this module, the above tool must be installed along with a Java SDK and all other necessary tools. The module communicates with TSNsched via reading and writing files and using system commands. The TSNsched tool is found using the TSNSCHED_ROOT environment variable, which must be properly set to the installation folder.

Inheritance diagram¶

Extends¶

Name	Type	Description
GateScheduleConfiguratorBase	simple module	Serves as a basis for gate scheduling configurator modules. It provides methods for derived modules to easily extract the input parameters from the network topology and also to carry out the actual configuration of the resulting schedule. The schedule is automatically configured in all of the PeriodicGate submodules of all queue submodules in the network interface MAC layer submodules. Besides, the application start offsets are also configured. This allows the derived modules to focus on the implementation of the actual scheduling algorithm.

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
gateCycleDuration	double		The globally used gate scheduling period in each PeriodicGate module
configuration	object	[]	Array of objects, see GateScheduleConfiguratorBase module documentation for more details

Properties¶

Name	Value	Description
class	TSNschedGateScheduleConfigurator
display	i=block/cogwheel	example: [{name: “s1”, type: “unicast”, application: “app[0]”, pcp: 0, gateIndex: 0, source: “wheel*”, destination: “hud”, packetLength: 100B, packetInterval: 5ms, maxLatency: 100us, maxJitter: 10us, pathFragments: [[“a”, “b”, “c”]]}]

Source code¶

//
// Provides a gate scheduling configurator that uses the TSNsched
// tool which is available at https://github.com/ACassimiro/TSNsched.
// Tested revision: 3f3bf663d196ec6c03e81a1e1392d4aefd158e3e
//
// In order to be able to use this module, the above tool must be installed
// along with a Java SDK and all other necessary tools. The module communicates
// with TSNsched via reading and writing files and using system commands. The
// TSNsched tool is found using the TSNSCHED_ROOT environment variable, which
// must be properly set to the installation folder.
//
simple TSNschedGateScheduleConfigurator extends GateScheduleConfiguratorBase like IGateScheduleConfigurator
{
    parameters:
        @class(TSNschedGateScheduleConfigurator);
}

File: src/inet/linklayer/configurator/gatescheduling/common/TSNschedGateScheduleConfigurator.ned