Summary¶
-
class
NetworkSim.simulation.tools.summary.
Summary
(simulator)[source]¶ Summary class to generate summaries for a given simulator.
- Parameters
simulator (BaseSimulator) – The simulator used in the simulation.
-
latency_summary
(data_range, latency_type)[source]¶ Summary of transmission latency.
- Parameters
data_range (str, optional) – The range of data selected for latency summary, chosen from the following:
- all or a
All simulation data.
- extended or e
Extended simulation data in convergence mode.
- batch or b
Last batch data in convergence mode.
Default is
None
, which is extended data for convergence mode and all data for non-convergence mode.- Returns
average_latency_summary – A DataFrame of average latencies from one node to another. The columns represent destination nodes while the index values represent source nodes.
- Return type
pandas DataFrame
-
packet_count_summary
()[source]¶ Summary of transmission packet count.
- Returns
count_summary – A DataFrame of transmitted packet count. The columns represent destination nodes while the indices represent source nodes.
- Return type
pandas DataFrame
-
packet_delay_summary
(normalised=False, std=False)[source]¶ Summary of packet delay / queueing delay. Packet Delay (also refer as Queueing Delay) = successful transmission time - generation time of the packet
- Returns
average_latency_summary – A DataFrame of average latencies from one node to another. The columns represent destination nodes while the index values represent source nodes.
- Return type
pandas DataFrame
-
ram_queue_summary
()[source]¶ Summary of queue size in the RAMs.
- Returns
overall_mean (float) – Overall mean value of the recorded queue size in the RAMs.
overall_max (float) – Overall maximum value of the recorded queue size in the RAMs.
queue_size_summary (pandas DataFrame) – A pandas DataFrame containing the following columns for each RAM in the simulator:
For unidirectional transmission:
Mean Queue Size
Maximum Queue Size
For bidirectional transmission:
Mean Queue Size (Upstream)
Mean Queue Size (Downstream)
Maximum Queue Size (Upstream)
Maximum Queue Size (Downstream)
-
ram_summary
()[source]¶ Summary of the transmitter RAMs.
- Returns
ram_summary – A DataFrame with the packet generation information of each RAM, containing the columns:
- RAM ID
The RAM ID.
- Total Number of Data Packet Generated
The total number of data packets generated at each RAM.
- Percentage of Data Packet Generated (%)
Percentage of data packets generated at each RAM, compared to the total number of data packets generated in all RAMs in the network.
- Return type
pandas DataFrame
-
receiver_summary
()[source]¶ Summary of receivers.
- Returns
receiver_summary – A DataFrame with the information on control and data packets received at each receiver, containing the columns:
- Receiver ID
The receiver ID.
- Total Number of Control Packet Received
Total number of control packets received at each receiver.
- Percentage of Control Packet Received (%)
Percentage of control packets received at each receiver, compared to the total number of control packets received in the network.
- Total Number of Data Packet Received
Total number of data packets received at each receiver.
- Percentage of Data Packet Received (%)
Percentage of data packets received at each receiver, compared to the total number of data packets received in the network.
- Return type
pandas DataFrame
-
simulation_summary
()[source]¶ Overall summary of the simulation.
- Returns
simulation_summary – A DataFrame containing a few key parameters in the simulation.
- Return type
pandas DataFrame
-
transmitter_summary
()[source]¶ Summary of transmitters.
- Returns
transmitter_summary – A DataFrame with the information on control and data packets transmitted from each transmitter, containing the columns:
- Transmitter ID
The transmitter ID.
- Total Number of Control Packet Transmitted
Total number of control packets transmitted from each transmitter.
- Percentage of Control Packet Transmitted (%)
Percentage of control packets transmitted from each transmitter, compared to the total number of control packets transmitted in the network.
- Total Number of Data Packet Transmitted
Total number of data packets transmitted from each transmitter.
- Percentage of Data Packet Transmitted (%)
Percentage of data packets transmitted from each transmitter, compared to the total number of data packets transmitted in the network.
- Return type
pandas DataFrame