routing.util

Class EnergyModel

java.lang.Object

routing.util.EnergyModel

All Implemented Interfaces:

ModuleCommunicationListener

public class EnergyModel
extends java.lang.Object
implements ModuleCommunicationListener

Energy model for routing modules. Handles power use from scanning (device discovery), scan responses, and data transmission. If scanning is done more often than 1/s, constant scanning is assumed (and power consumption does not increase from scanEnergy value).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_ENERGY_S Base energy usage per second -setting id ("baseEnergy").
static java.lang.String	ENERGY_VALUE_ID ModuleCommunicationBus identifier for the "current amount of energy left" variable.
static java.lang.String	INIT_ENERGY_S Initial units of energy -setting id ("initialEnergy").
static java.lang.String	SCAN_ENERGY_S Energy usage per scanning (device discovery) -setting id ("scanEnergy").
static java.lang.String	SCAN_RSP_ENERGY_S Energy usage per scanning (device discovery) response -setting id ("scanResponseEnergy").
static java.lang.String	TRANSMIT_ENERGY_S Energy usage per second when sending -setting id ("transmitEnergy").
static java.lang.String	WARMUP_S Energy update warmup period -setting id ("energyWarmup").

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnergyModel(EnergyModel proto) Copy constructor.
	EnergyModel(Settings s) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
double	getEnergy() Returns the current energy level
void	moduleValueChanged(java.lang.String key, java.lang.Object newValue) Called by the combus if the energy value is changed
void	reduceDiscoveryEnergy() Reduces the energy reserve for the amount that is used when another host connects (does device discovery)
protected void	reduceEnergy(double amount) Updates the current energy so that the given amount is reduced from it.
EnergyModel	replicate()
protected void	setEnergy(double[] range) Sets the current energy level into the given range using uniform random distribution.
void	update(NetworkInterface iface, ModuleCommunicationBus comBus) Reduces the energy reserve for the amount that is used by sending data and scanning for the other nodes.

Methods inherited from class java.lang.Object

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

Field Detail

INIT_ENERGY_S

public static final java.lang.String INIT_ENERGY_S

Initial units of energy -setting id ("initialEnergy"). Can be either a single value, or a range of two values. In the latter case, the used value is a uniformly distributed random value between the two values.

See Also:

Constant Field Values

SCAN_ENERGY_S

public static final java.lang.String SCAN_ENERGY_S

Energy usage per scanning (device discovery) -setting id ("scanEnergy").

See Also:

Constant Field Values

SCAN_RSP_ENERGY_S

public static final java.lang.String SCAN_RSP_ENERGY_S

Energy usage per scanning (device discovery) response -setting id ("scanResponseEnergy").

See Also:

Constant Field Values

TRANSMIT_ENERGY_S

public static final java.lang.String TRANSMIT_ENERGY_S

Energy usage per second when sending -setting id ("transmitEnergy").

See Also:

Constant Field Values

BASE_ENERGY_S

public static final java.lang.String BASE_ENERGY_S

Base energy usage per second -setting id ("baseEnergy").

See Also:

Constant Field Values

WARMUP_S

public static final java.lang.String WARMUP_S

Energy update warmup period -setting id ("energyWarmup"). Defines the simulation time after which the energy level starts to decrease due to scanning, transmissions, etc. Default value = 0. If value of "-1" is defined, uses the value from the report warmup setting Report.WARMUP_S from the namespace "Report".

See Also:

Constant Field Values

ENERGY_VALUE_ID

public static final java.lang.String ENERGY_VALUE_ID

ModuleCommunicationBus identifier for the "current amount of energy left" variable. Value type: double

See Also:

Constant Field Values

Constructor Detail

EnergyModel

public EnergyModel(Settings s)

Constructor. Creates a new message router based on the settings in the given Settings object.

Parameters:

s - The settings object

EnergyModel

protected EnergyModel(EnergyModel proto)

Copy constructor.

Parameters:

proto - The model prototype where setting values are copied from

Method Detail

replicate

public EnergyModel replicate()

setEnergy

protected void setEnergy(double[] range)

Sets the current energy level into the given range using uniform random distribution.

Parameters:

range - The min and max values of the range, or if only one value is given, that is used as the energy level

getEnergy

public double getEnergy()

Returns the current energy level

Returns:

the current energy level

reduceEnergy

protected void reduceEnergy(double amount)

Updates the current energy so that the given amount is reduced from it. If the energy level goes below zero, sets the level to zero. Does nothing if the warmup time has not passed.

Parameters:

amount - The amount of energy to reduce

reduceDiscoveryEnergy

public void reduceDiscoveryEnergy()

Reduces the energy reserve for the amount that is used when another host connects (does device discovery)

update

public void update(NetworkInterface iface,
          ModuleCommunicationBus comBus)

Reduces the energy reserve for the amount that is used by sending data and scanning for the other nodes.

moduleValueChanged

public void moduleValueChanged(java.lang.String key,
                      java.lang.Object newValue)

Called by the combus if the energy value is changed

Specified by:

moduleValueChanged in interface ModuleCommunicationListener

Parameters:

key - The energy ID

newValue - The new energy value