help.txt

it is very important

See shortcuts for SPID, SPAK, ACK explanations.

2.10. Round Trip Times between current and other node
-----------------------------------------------------
Round Trip Time (RTT) for a packet = time when ACK (acknowlegde) packet sent by Other node was received by Current node - 
                                     time when the packet was sent by Current node
SOURCE AND DESTINATION TRACE LEVEL options are used for the calculations (wireless, mixed and Trace graph formats only), i.e.
only packets sent at source trace level and received at destination trace level are considered.
Trace level (AGT, RTR, MAC) at the source node (Current node) can be chosen from the list. 
SENT PACKET and ACK PACKET options are used to select sent packet type at Current node and ACK packet type at Other node.
See shortcuts for SPID, SPAK, ACK explanations.


3. OPTIONS MENU
===============

3.1. Overlay graphs
-------------------
Up to 7 graphs can be plotted in the window when this option is on.
Default is OFF.

3.2. Automatically refresh information
--------------------------------------
When this option is ON (default) all the information from the Network information menu refreshes when
for example PACKET TYPE is changed (see 7. Other options). Works similar to 3.2. Automatically change graphs.
Default is OFF.

3.3. Automatically refresh graphs
---------------------------------
When this option is on all the plotted graphs refresh if for example 
PACKET TYPE is changed (see 7. Other options).
Default is OFF.

3.4. Direct connection
----------------------
This option specifies connection type between CURRENT NODE and OTHER NODE.
It works if OTHER NODE is checked. It only concerns receiving and dropping events.
When this option is ON analysis is done as if CURRENT NODE was directly connected to OTHER NODE.
When this option is OFF analysis is done as if CURRENT NODE was the source connected to OTHER NODE 
(destination node) via intermediate nodes.
If there's no connection between CURRENT NODE and OTHER NODE calculations results are equal zero.
Default is OFF.

3.5. Count packets IDs only once
---------------------------------
When this option is ON packets IDs are counted only once. When it's OFF the same packets are counted as many times
as they are received (number of receive events), forwarded (number of forward events) or dropped (number of drop events). 
For example a node can receive the same packet 5 times, so when this option is ON the packet is counted only once not 5 times.
This option works with the following network information and graphs:
* Simulation information: 
  - Number of forwarded packets
  - Number of dropped packets
* Current node information: 
  - Number of received packets
  - Number of forwarded packets
  - Number of dropped packets
* 2D graphs:
  - Throughput of receiving packets at current node
  - Throughput of forwarding packets at current node
  - Throughput of dropping packets at current node
  - Throughput of receiving packets
  - Throughput of forwarding packets
  - Throughput of dropping packets
* 3D graphs:
  - Numbers of forwarded packets at all the nodes
  - Numbers of received packets at all the nodes
  - Numbers of dropped packets at all the nodes.
If packets IDs are not unique results will be wrong. See 8 for shortcuts.
Default is OFF.

3.6. Time interval
------------------
Simulated network can be analysed in a selected time interval.
START TIME is the beginning of the time interval. END TIME is the end of the time interval.
When this option is on trace file lines with time between START TIME and END TIME are selected.
Default is OFF.
See also 1.1.

3.7 Use specified edges for histograms
--------------------------------------
When this option is ON edges specified in the field Hist. egdes (see 7. Other options) are used when plotting histograms. 
For example the field can be: 0.03 0.05 0.07. See 6. Histograms for calculations details.

3.8. Save information
---------------------
When this option is ON all the visible information from Network information window are saved to text files.
A saved file name format:
'trace file or mat file name'-'information name' 'options'.trg
for example:
DoS.tr-node 0 info.trg
DoS.tr-node 5 delays ON_0.trg
Saved files have 'trg' extensions.
Files are saved to a trace file or a mat file directory.
Default is OFF.

3.9. Save graphs
----------------
When this option is ON all the plotted graphs data is saved into separated text files.
A saved file name format:
'trace file or mat file name'-'graph legend'.trg
for example:
dos.mat-Throughput at current node (sending) X_time TIL_0,016499 CN_0.trg
There is a change in the description: ':' is changed to '_'.
Saved files have 'trg' extensions.
Saved files contain 1 or 2 or 3 columns (X Y Z coordinates).
When there is an empty plot only '0' is saved into a file.
Files are saved to a trace file or a mat file directory.
Default is OFF.

3.10. Mark each plotted point
----------------------------
When this option is ON all the plotted data points are marked with a circle.
Default is OFF.

3.11. Add minor grid to the axes
--------------------------------
Adds minor grid to the current axes in the graphs windows.
Default is OFF.

3.12. Add major grid to the axes
--------------------------------
Adds major grid to the current axes in the graphs windows.
Default is OFF.

3.13. Zoom on
------------
Turns zoom ON/OFF when 2D graphs or histograms are plotted.
When zoom is OFF legend can be moved holding left mouse button.
Default is ON.

3.14. Legend on
---------------
Turns legend ON/OFF when 2D graphs or histograms are plotted.
Legend can be edited by double click on it with left mouse button
when zoom is OFF.
Default is ON.

3.15. Flow ID
-------------
When this option is ON flow ID is used in wired trace files analysis.
Default is OFF.

3.16. Turbo mode
----------------
This option is used only for delays and jitter calculations.
Analysis results are in most cases wrong but sometimes they are the same as if the option was OFF.
The results depend on the trace file.
Default is OFF.

3.17. Save graphs statistics
----------------------------
When this option is ON all the plotted graphs statistics are saved into separated text files.
A saved file name format:
'trace file or mat file name'-STATS-'graph legend'.trg
for example:
dos.mat-STATS-Throughput at current node (sending) X_time TIL_0,016499 CN_0.trg
There is a change in the description: ':' is changed to '_'.
Saved files have 'trg' extensions.
Saved files contain statistics for X, Y and Z axes values.
Files are saved to a trace file or a mat file directory.
Default is OFF.

3.18. Log scaling on X, Y, Z axes
---------------------------------
When this option is ON natural logarithm of X/Y/Z axis values is calculated and plotted. 
Only values greater than zero are plotted. Log scaling on X and Y axes works only with 2D graphs.
Log scaling on Z axis works only with 3D graphs.
Default is OFF.

3.19. Load a graph
------------------
This option loads graphs from .trg files saved using Save graphs option (3.9). There's only legend 
(file name without .trg), no axes labels. Text file with graph data should have 2 (X Y) or 3 (X Y Z) columns separated with space.
All files in this format should be read.


4. 2D GRAPHS
============

* 2D graphs can be zoomed in/out. An area to zoom can be marked in with left mouse button.
  To zoom out press right mouse button.
* 'simulation' in the graphs names means the graphs concern the whole network.
* 'CN2ON' and 'between CN and ON' in the graphs names means the graphs concern only CURRENT NODE 
  and OTHER NODE (DIRECT CONNECTION option is used, see 3.4). 
  NOTE! DON'T FORGET TO CHECK OTHER NODE WHEN PLOTTING GRAPHS FOR CURRENT AND OTHER NODE.
* Graphs concerning 'r' events in the whole network use DIRECT CONNECTION option (see 3.4).
  When DIRECT CONNECTION is ON all the 'r' events are counted. When DIRECT CONNECTION is OFF
  only 'r' events where CURRENT NODE=DESTINATION NODE are counted. This option should be used 
  only if OTHER NODE is checked.
* There is a legend for each graph. It shows the name of a graph and contains additional 
  description (see chapter 8). 
* When there are no packets transmitted an empty graph is plotted (Y values are equal zero). 
* 'all', 'simulation' or lack of 'at current node' in the names of the graphs 
  means that the whole simulation events are analysed (not only events at the CURRENT NODE).
* When THROUGHPUT graph is plotted TIME INTERVAL LENGTH option is used. To plot a THROUGHPUT graph
  sum of sizes (... bits) or number (... packets) of generated/sent/forwarded/received packets 
  is calculated every TIME INTERVAL and divided by it's LENGTH. THROUGHPUT (... bits) is shown in BITS. 
  THROUGHPUT (... packets) shows numbers of packets in every TIME INTERVAL. TIME INTERVAL LENGTH 
  is equal 1 second by default. See 3.5 for details about some THROUGHPUT graphs.
* THROUGHPUT VS DELAY graph shows throughput (bits) on X axis and delay on Y axis. Throughput and delays 
  (minimal/average/maximal) are calculated every TIME INTERVAL. 'throughput of sending' means
  throughput of sending or forwarding at CURRENT NODE. 'throughput of receiving' means
  throughput of receiving at OTHER NODE. For 'throughput of sending...' graphs delays of sent packets 
  are calculated in the same time intervals as throughput is calculated. For 'throughput of receiving...' 
  graphs delays of received packets are calculated in the same time intervals as throughput is calculated. 
  When DIRECT CONNECTION is ON throughput of sending bits from CURRENT NODE to OTHER NODE means throughput 
  of forwarding bits from CN to ON. See 2.3, 2.4 for delays calculations. After throughput and delays