Package org.eclipse.mosaic.fed.sns.ambassador

Class TransmissionSimulator

java.lang.Object

org.eclipse.mosaic.fed.sns.ambassador.TransmissionSimulator

public class TransmissionSimulator
extends Object

Constructor Summary

Constructors

Constructor	Description
TransmissionSimulator(RandomNumberGenerator randomNumberGenerator, CSns config)	Constructor for TransmissionSimulator, sets the configuration, transmission models & RNG.

Method Summary

Modifier and Type	Method	Description
static Map<String,SimulationNode>	getEntitiesInArea(Map<String,SimulationNode> relevantEntities, Area<CartesianPoint> range)	This method collects all entities, that are within the given GeoArea.
protected Map<String,TransmissionResult>	sendMessageAsGeocast(String senderName, DestinationAddressContainer dac)	Simulates geocast routing transmission, either broadcast or unicast.
protected Map<String,TransmissionResult>	sendMessageAsTopocast(String senderName, DestinationAddressContainer dac)	Simulates topolocically-scoped Unicast (singlehop or multihop transmissions) or Broadcast (only singlehop).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TransmissionSimulator

public TransmissionSimulator(RandomNumberGenerator randomNumberGenerator,
 CSns config)
                      throws InternalFederateException

Constructor for TransmissionSimulator, sets the configuration, transmission models & RNG.

Parameters:

randomNumberGenerator - the RandomNumberGenerator to be used for transmission calculations

Throws:

InternalFederateException - if config couldn't be read or was malformed

Method Details

sendMessageAsTopocast

protected Map<String,TransmissionResult> sendMessageAsTopocast(String senderName,
 DestinationAddressContainer dac)

Simulates topolocically-scoped Unicast (singlehop or multihop transmissions) or Broadcast (only singlehop).

Parameters:

senderName - The Sender of the message.

dac - DestinationAddressContainer containing information about the destination for the message.

Returns:

a Map containing the summarized transmission results

sendMessageAsGeocast

protected Map<String,TransmissionResult> sendMessageAsGeocast(String senderName,
 DestinationAddressContainer dac)

Simulates geocast routing transmission, either broadcast or unicast.

Parameters:

senderName - The Sender of the message.

dac - DestinationAddressContainer containing information about the destination for the message.

Returns:

a Map containing the summarized transmission results

getEntitiesInArea

public static Map<String,SimulationNode> getEntitiesInArea(Map<String,SimulationNode> relevantEntities,
 Area<CartesianPoint> range)

This method collects all entities, that are within the given GeoArea. It is static because it is also required in some of the AdhocTransmissionModels.

Parameters:

relevantEntities - a map of all entities and their names, which should be checked against the area

range - the GeoArea within which the entities should be. It is called "range" because it reflects the communication range

Returns:

A map of the given entities, which are in the destination area.