Tracer (UnetStack 3.4.0 API)

org.arl.unet.sim.Tracer

All Implemented Interfaces and Traits:

Closeable
```
public abstract class Tracer
```
A superclass that should be extended by tracers. This class provides basic functionality to collate events and compute statistics. A subclass must provide the methods to appopriately format the data in the trace file.

Field Summary

Fields
Modifiers	Name	Description
`protected static int`	`DROP`	Event indicating that a packet has been dropped.
`protected static int`	`ENQUEUE`	Event indicating a packet has been queued.
`protected static int`	`RECEIVE`	Event indicating that a packet has been received.
`protected static int`	`SEND`	Event indicating that a packet has been sent.
`protected PrintStream`	`out`	The output stream to write trace file output to.

Properties Summary

Properties
Type	Name and description
`double`	`warmup`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`begin(String msg)` Marks the beginning of a simulation.
	`void`	`close()` Closes the trace file.
	`void`	`comment(String msg)` Logs a comment to the trace file.
	`void`	`dropped(int node, Transmission rx, String msg)` Indicates that a packet has been dropped.
	`void`	`end(String msg)` Marks the end of a simulation.
	`void`	`enqueued(Transmission tx, String msg)` Indicates that a packet has been queued for transmission.
	`protected void`	`finalize()`
	`int`	`getDropCount()` Gets the number of packets dropped since warmup.
	`int`	`getEnqueueCount()` Gets the number of packets queued since warmup.
	`double`	`getLoad()` Gets the normalized actual network load.
	`double`	`getMeanDelay()` Gets the mean delay between queuing and reception.
	`double`	`getOfferedLoad()` Gets the normalized offered network load.
	`int`	`getRxCount()` Gets the number of packets received since warmup.
	`double`	`getThroughput()` Gets the normalized network throughput.
	`protected double`	`getTime()` Gets the current time as per the timestamp provider.
	`int`	`getTxCount()` Gets the number of packets sent since warmup.
	`double`	`getWarmup()` Gets the amount of time in seconds to ignore (for statistics computation) at the beginning of each simulation.
	`boolean`	`isOpen()` Check if trace file is open.
	`void`	`moved(int node, double[] location, String msg)` Indicates that a node has moved to a new location.
	`void`	`open(String filename)` Opens a trace file to write to.
	`void`	`open(File file)` Opens a trace file to write to.
	`protected void`	`print(String msg)` Log a comment.
	`void`	`received(int node, Reception rx, String msg)` Indicates that a packet has been received.
	`void`	`resetStats()` Resets all statistics.
	`void`	`sent(Transmission tx, String msg)` Indicates that a packet has been sent.
	`void`	`setTimestampProvider(TimestampProvider platform)` Sets the time provider used to get current time for logging.
	`void`	`setWarmup(double seconds)` Sets the amount of time in seconds to ignore (for statistics computation) at the beginning of each simulation.
	`protected void`	`trace(int event, int node, Transmission tx, String msg)` Log a trace event.
	`protected void`	`track(int node, double[] location, String msg)` Log a location of a node.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected static final int DROP
    
    Event indicating that a packet has been dropped.
  - protected static final int ENQUEUE
    
    Event indicating a packet has been queued.
  - protected static final int RECEIVE
    
    Event indicating that a packet has been received.
  - protected static final int SEND
    
    Event indicating that a packet has been sent.
  - protected PrintStream out
    
    The output stream to write trace file output to.
- Property Detail
  - double warmup
- Method Detail
  - public void begin(String msg)
    
    Marks the beginning of a simulation.
    Parameters:
    msg - message to log
  - @Override public void close()
    
    Closes the trace file.
  - public void comment(String msg)
    
    Logs a comment to the trace file.
    Parameters:
    msg - comment to log
  - public void dropped(int node, Transmission rx, String msg)
    
    Indicates that a packet has been dropped.
    Parameters:
    node - node address at which the drop occurred
    rx - details of the packet
    msg - message to log
  - public void end(String msg)
    
    Marks the end of a simulation.
    Parameters:
    msg - message to log
  - public void enqueued(Transmission tx, String msg)
    
    Indicates that a packet has been queued for transmission.
    Parameters:
    tx - details of the packet
    msg - message to log
  - @Override protected void finalize()
  - public int getDropCount()
    
    Gets the number of packets dropped since warmup.
    Returns:
    number of packets
  - public int getEnqueueCount()
    
    Gets the number of packets queued since warmup.
    Returns:
    number of packets
  - public double getLoad()
    
    Gets the normalized actual network load.
    Returns:
    actual load
  - public double getMeanDelay()
    
    Gets the mean delay between queuing and reception.
    Returns:
    mean delay in seconds
  - public double getOfferedLoad()
    
    Gets the normalized offered network load.
    Returns:
    offered load
  - public int getRxCount()
    
    Gets the number of packets received since warmup.
    Returns:
    number of packets
  - public double getThroughput()
    
    Gets the normalized network throughput.
    Returns:
    throughput
  - protected double getTime()
    
    Gets the current time as per the timestamp provider. This method should be used by subclasses to determine timestamp for logging.
    Returns:
    current time in seconds
  - public int getTxCount()
    
    Gets the number of packets sent since warmup.
    Returns:
    number of packets
  - public double getWarmup()
    
    Gets the amount of time in seconds to ignore (for statistics computation) at the beginning of each simulation.
    Returns:
    warmup time
  - public boolean isOpen()
    
    Check if trace file is open.
    Returns:
    true if open, false otherwise
  - public void moved(int node, double[] location, String msg)
    
    Indicates that a node has moved to a new location.
    Parameters:
    node - node address
    location - array of 2-3 coordinates (x,y or x,y,z) in meters
    msg - message to log
  - public void open(String filename)
    
    Opens a trace file to write to.
    Parameters:
    filename - name of trace file
  - public void open(File file)
    
    Opens a trace file to write to.
    Parameters:
    file - trace file
  - protected void print(String msg)
    
    Log a comment. This method should be overridden by a subclass to provide appropriate formatting.
    Parameters:
    msg - message to log
  - public void received(int node, Reception rx, String msg)
    
    Indicates that a packet has been received.
    Parameters:
    node - receiving node's address
    rx - details of the packet
    msg - message to log
  - public void resetStats()
    
    Resets all statistics.
  - public void sent(Transmission tx, String msg)
    
    Indicates that a packet has been sent.
    Parameters:
    tx - details of the packet
    msg - message to log
  - public void setTimestampProvider(TimestampProvider platform)
    
    Sets the time provider used to get current time for logging.
    Parameters:
    platform - time provider.
  - public void setWarmup(double seconds)
    
    Sets the amount of time in seconds to ignore (for statistics computation) at the beginning of each simulation.
    Parameters:
    seconds - warmup time
  - protected void trace(int event, int node, Transmission tx, String msg)
    
    Log a trace event. This method should be overridden by a subclass to provide appropriate formatting.
    Parameters:
    event - type of event (ENQUEUE/SEND/RECEIVE/DROP)
    node - node address where the event occurred
    tx - details of the packet related to the event
    msg - message to log along with the event
  - protected void track(int node, double[] location, String msg)
    
    Log a location of a node. This method should be overridden by a subclass to provide appropriate formatting.
    Parameters:
    node - node address
    location - array of 2-3 coordinates (x,y or x,y,z) denoting the location of the node
    msg - message to log along with the location

Summary:
Field
Property
Method

| Detail:
Field
Property
Method

[Java] Class Tracer

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final int DROP

protected static final int ENQUEUE

protected static final int RECEIVE

protected static final int SEND

protected PrintStream out

Property Detail

double warmup

Method Detail

public void begin(String msg)

@Override public void close()

public void comment(String msg)

public void dropped(int node, Transmission rx, String msg)

public void end(String msg)

public void enqueued(Transmission tx, String msg)

@Override protected void finalize()

public int getDropCount()

public int getEnqueueCount()

public double getLoad()

public double getMeanDelay()

public double getOfferedLoad()

public int getRxCount()

public double getThroughput()

protected double getTime()

public int getTxCount()

public double getWarmup()

public boolean isOpen()

public void moved(int node, double[] location, String msg)

public void open(String filename)

public void open(File file)

protected void print(String msg)

public void received(int node, Reception rx, String msg)

public void resetStats()

public void sent(Transmission tx, String msg)

public void setTimestampProvider(TimestampProvider platform)

public void setWarmup(double seconds)

protected void trace(int event, int node, Transmission tx, String msg)

protected void track(int node, double[] location, String msg)