nl.tudelft.simulation.messaging.devices.components
Interface DeviceInterface

All Superinterfaces:

nl.tudelft.simulation.event.EventProducerInterface

All Known Subinterfaces:

ReceivingDeviceInterface, SendingDeviceInterface

All Known Implementing Classes:

Device, ReceivingDevice, SendingDevice, SendingReceivingDevice

public interface DeviceInterface

extends nl.tudelft.simulation.event.EventProducerInterface

A DeviceInterface
Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information www.simulation.tudelft.nl . The source code and binary code of this software is proprietary information of Delft University of Technology.

Version:

$$Revision: 1.2 $$ $$Date: 2005/04/08 10:56:36 $$

Author:

Peter Jacobs , Stijn-Pieter van Houten , Alexander Verbraeck

Field Summary

static nl.tudelft.simulation.event.EventType

STATE_CHANGE_EVENT STATE_CHANGE_EVENT

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Method Summary

DeviceType	getDeviceType() returns the device type
java.lang.String	getName() returns the name of the device
DeviceState	getState() returns the state of the device
int	getTransmissionDelay() The transmission delay is defined on a log-10 scale, indicating the time it takes averagely in seconds to reach the other Actor.
double	getTransmissionFrequency() The maximum transmission frequency indicates the average number of messages (say 1 page with data) that can be sent per second over the communication channel.

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface

addListener, addListener, addListener, addListener, getEventTypes, removeListener

Field Detail

STATE_CHANGE_EVENT

public static final nl.tudelft.simulation.event.EventType STATE_CHANGE_EVENT

STATE_CHANGE_EVENT

Method Detail

getName

public java.lang.String getName()

returns the name of the device

Returns:

the name

getDeviceType

public DeviceType getDeviceType()

returns the device type

Returns:

Returns the deviceType.

getState

public DeviceState getState()

returns the state of the device

Returns:

the state

getTransmissionDelay

public int getTransmissionDelay()

The transmission delay is defined on a log-10 scale, indicating the time it takes averagely in seconds to reach the other Actor.

Returns:

the transmission delay of the device

getTransmissionFrequency

public double getTransmissionFrequency()

The maximum transmission frequency indicates the average number of messages (say 1 page with data) that can be sent per second over the communication channel.

Returns:

the maximum transmission frequency of the device