ds.funnel.traffic.component.timedistribution

Class RegularTimeDistribution

java.lang.Object

ds.funnel.traffic.component.timedistribution.RegularTimeDistribution

All Implemented Interfaces:

PacketTimeDistribution

public class RegularTimeDistribution
extends java.lang.Object
implements PacketTimeDistribution

RegularTimeDistribution defines a packet distribution pattern in which packets are sent at evenly spaced intervals. If no interval or an invalid interval is specified, a RegularTimeDistribution will be created with a default interval of 10 ms.

Author:

Kira Lindburg

Constructor Summary

Constructors

Constructor and Description
RegularTimeDistribution() Constructs a new RegularTimeDistribution with a default interval.
RegularTimeDistribution(int interval) Constructs a new RegularTimeDistribution with the specified interval.

Method Summary

Modifier and Type	Method and Description
int	getInterval()
int	getType()
int	nextInterval() Since a RegularTimeDistribution describes evenly spaced packets, this method simply returns the value of this RegularTimeDistribution's interval.
int[]	prediction(int size) Generates an array containing predicted packet transmission times, in terms of number of ms from this instant.
void	setInterval(int newInterval) If the interval specified is a valid interval (greater than 0), sets the value of interval to newInterval.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegularTimeDistribution

public RegularTimeDistribution()

Constructs a new RegularTimeDistribution with a default interval.

RegularTimeDistribution

public RegularTimeDistribution(int interval)

Constructs a new RegularTimeDistribution with the specified interval. If the interval is invalid (0 or negative), then the interval will be set to the default value instead.

Method Detail

getInterval

public int getInterval()

setInterval

public void setInterval(int newInterval)

If the interval specified is a valid interval (greater than 0), sets the value of interval to newInterval. Otherwise, the value is unchanged.

Parameters:

newInterval - the new value for interval

getType

public int getType()

Specified by:

getType in interface PacketTimeDistribution

Returns:

an integer id number specifying the type of distribution. This should be a unique identifier for the type of time distribution generated by a given PacketTimeDistribution.

nextInterval

public int nextInterval()

Since a RegularTimeDistribution describes evenly spaced packets, this method simply returns the value of this RegularTimeDistribution's interval.

Specified by:

nextInterval in interface PacketTimeDistribution

Returns:

interval

prediction

public int[] prediction(int size)

Description copied from interface: PacketTimeDistribution

Generates an array containing predicted packet transmission times, in terms of number of ms from this instant.

Specified by:

prediction in interface PacketTimeDistribution

Parameters:

size - the number of predictions contained in the returned array

Returns:

an array of the specified size, containing predicted packet transmission times in numbers of ms after this method was called