omnetpypy.front_end

The front end of the omnetpypy package contains all the tools necessary to users to create their own simulations.

class omnetpypy.front_end.__init__.Channel(name, identifier=None, delay=None, loss_prob=None)[source]

Bases: SimulatedEntity

Channels are used to apply operations on messages travelling between connected ports. They can apply noise, delays, losses, and other custom operations to the messages.

Channels always have two ports, named “A” and “B”. The channel forwards messages from port “A” to port “B”, and vice versa, after applying the specified delay and loss probability.

Subclasses can override the methods process_message() to apply more complex and asymmetric operations on the messages passing through the channel.

Parameters:

namestr: The name of the channel. This name should be unique within the simulation.
identifierint or None, optional: The identifier of the channel. This identifier should be unique within the simulation. If None, the identifier will be automatically generated.
delayfloat or None, optional: The delay to be applied to the messages passing through the channel. If None, no delay is applied.
loss_probfloat or None, optional: The probability of loss to be applied to the messages passing through the channel. If None, no loss is applied.

Attributes:

delayfloat or None: The delay to be applied to the messages passing through the channel. If None, no delay is applied.
loss_probfloat or None: The probability of loss to be applied to the messages passing through the channel. If None, no loss is applied.

apply_loss(message, port_name)[source]

Apply loss to the message, based on an arbitrary loss probability distribution.

Parameters:

messageMessage: The message to be delayed.
port_namestr: The port from which the message was received.

Returns:

bool: True if the message should be lost, False otherwise.

generate_delay(message, port_name)[source]

Generate a delay for the message, based on an arbitrary delay distribution.

Parameters:

messageMessage: The message to be delayed.
port_namestr: The port from which the message was received.

Returns:

float or None: The delay to be applied to the message. If None or zero, the message will be sent immediately.

handle_message(message, port_name)[source]

Handle a message received from a port. First, it processes the message by calling the method process_message(), then it applies the optional delay and loss probability, and finally it sends the message out of the other port (if not lost).

Parameters:

messageMessage: The message to be handled.
port_namestr: The port from which the message was received.

process_message(message, port_name)[source]

Process a message received from a port. By default, this method does nothing and returns the message as is. Subclasses can override this method to apply more complex operations on the messages passing through the channel.

Parameters:

messageMessage(): The message to be processed.
port_namestr: The port from which the message was received.

Returns:

Message() or None: The message to be sent to the connected port, or None if the message should be dropped.

class omnetpypy.front_end.__init__.CompoundModule(name, identifier, port_names, **kwargs)[source]

Bases: SimulatedEntity

This class represents a compound module in the simulation model. Compound modules are non-atomic modules that contain other modules and channels. They do not come with a behavior, but they can be used to organize the simulation model with a hierarchical structure. Their behavior is intrinsically defined by the behavior of their submodules and how they are connected.

See SimulatedEntity for inherited attributes. All kwargs passed to the constructor are also stored as attributes of the module.

Parameters:

namestr: The name of the module. This name should be unique within the simulation.
identifierint: The identifier of the module. This identifier should be unique within the simulation.
port_nameslist of str: The names of the ports of the module.
**kwargs: Additional, arbitrary attributes of the module, passed as keyword arguments.

Attributes:

sub_modulesdict of SimulatedEntity: The sub-entities of the module, indexed by their names.

add_sub_module(module)[source]

Add a submodule to this compound module.

Parameters:

moduleSimulatedEntity: The submodule to be added.

Raises:

Exception: If a submodule with the same name already exists.

cancel_scheduled(message)[source]

Cancel a scheduled self message for this entity. Calls internally the method cancel_scheduled().

Parameters:

messageMessage: The message to be cancelled.

connect(local_port, remote_entity, remote_port, channel=None)[source]

Connect a port of this module to a port of another remote entity.

Parameters:

local_portstr: The name of the local port to be connected.
remote_entitySimulatedEntity: The remote entity to which the port will be connected.
remote_portstr: The name of the remote port to be connected.
channelChannel or None, optional: The channel through which the connection will be made, if any. If set, the local port is connected to the “A” port of the channel, and the “B” port of the channel is connected to the remote port.