new name (ealier Standard Radio Medium)

This commit is contained in:
fros4943 2007-01-09 09:47:36 +00:00
parent 286dfe0e54
commit bf7ed8eb41

View file

@ -0,0 +1,592 @@
/*
* Copyright (c) 2006, Swedish Institute of Computer Science.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the Institute nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $Id: UDGM.java,v 1.1 2007/01/09 09:47:36 fros4943 Exp $
*/
package se.sics.cooja.radiomediums;
import java.awt.*;
import java.awt.event.*;
import java.util.*;
import javax.swing.*;
import javax.swing.event.*;
import org.jdom.Element;
import org.apache.log4j.Logger;
import se.sics.cooja.*;
import se.sics.cooja.interfaces.*;
import se.sics.cooja.plugins.Visualizer2D;
/**
* The Unit Disk Graph medium has two different range parameters; one for
* transmitting and one for interfering other transmissions.
*
* Radio data are analysed when all registered motes have ticked once (this
* medium is registered as a tick observer). For every mote in transmission
* range of a sending mote, current listen status is changed from hearing
* nothing to hearing packet, or hearing packet to hearing noise. This way, if a
* mote hears two packets during one tick loop, it will receive none (noise). If
* a mote is in the interference range, the current listen status will be set to
* hears noise immediately.
*
* This radio medium registers a temporary visual plugin class.
* Via this plugin ranges can be viewed and changed. Active connection may also
* be viewed.
*
* @author Fredrik Osterlind
*/
@ClassDescription("Unit Disk Graph Medium (UDGM)")
public class UDGM extends RadioMedium {
private static Logger logger = Logger.getLogger(UDGM.class);
private Vector<Position> registeredPositions = new Vector<Position>();
private Vector<Radio> registeredRadios = new Vector<Radio>();
private Vector<Radio> transmissionEndedRadios = new Vector<Radio>();
private static RadioMedium myRadioMedium;
public static final double SS_NOTHING = -200;
public static final double SS_BAD = -60;
public static final double SS_OK = 0;
/**
* Visualizes radio traffic in the current radio medium. Allows a user to
* change transmission ranges.
*
* Sending motes are blue, receiving motes are green and motes that hear noise
* are painted red. Motes without radios are painted gray, and the rest are
* white.
*
* @author Fredrik Osterlind
*/
@ClassDescription("Radio Medium Visualizer")
@PluginType(PluginType.SIM_PLUGIN)
public static class VisUDGM extends Visualizer2D {
private Mote selectedMote = null;
private JSpinner transmissionSpinner = null;
private JSpinner interferenceSpinner = null;
private Observer radioMediumObserver;
private class ChangeRangesMenuAction implements MoteMenuAction {
public boolean isEnabled(Mote mote) {
return true;
}
public String getDescription(Mote mote) {
return "Change transmission ranges";
}
public void doAction(Mote mote) {
transmissionSpinner.setVisible(true);
interferenceSpinner.setVisible(true);
repaint();
}
};
public VisUDGM(Simulation sim, GUI gui) {
super(sim, gui);
setTitle("Radio Medium Visualizer");
// Create spinners for changing ranges
SpinnerNumberModel transmissionModel = new SpinnerNumberModel();
transmissionModel.setValue(new Double(TRANSMITTING_RANGE));
transmissionModel.setStepSize(new Double(1.0)); // 1m
transmissionModel.setMinimum(new Double(0.0));
SpinnerNumberModel interferenceModel = new SpinnerNumberModel();
interferenceModel.setValue(new Double(INTERFERENCE_RANGE));
interferenceModel.setStepSize(new Double(1.0)); // 1m
interferenceModel.setMinimum(new Double(0.0));
transmissionSpinner = new JSpinner(transmissionModel);
interferenceSpinner = new JSpinner(interferenceModel);
((JSpinner.DefaultEditor) transmissionSpinner.getEditor()).getTextField()
.setColumns(5);
((JSpinner.DefaultEditor) interferenceSpinner.getEditor()).getTextField()
.setColumns(5);
transmissionSpinner.setToolTipText("Transmitting range");
interferenceSpinner.setToolTipText("Interference range");
transmissionSpinner.addChangeListener(new ChangeListener() {
public void stateChanged(ChangeEvent e) {
TRANSMITTING_RANGE = ((SpinnerNumberModel) transmissionSpinner
.getModel()).getNumber().doubleValue();
repaint();
}
});
interferenceSpinner.addChangeListener(new ChangeListener() {
public void stateChanged(ChangeEvent e) {
INTERFERENCE_RANGE = ((SpinnerNumberModel) interferenceSpinner
.getModel()).getNumber().doubleValue();
repaint();
}
});
getCurrentCanvas().add(transmissionSpinner);
getCurrentCanvas().add(interferenceSpinner);
transmissionSpinner.setVisible(false);
interferenceSpinner.setVisible(false);
// Add mouse listener for selecting motes
getCurrentCanvas().addMouseListener(new MouseListener() {
public void mouseExited(MouseEvent e) {
// Do nothing
}
public void mouseEntered(MouseEvent e) {
// Do nothing
}
public void mouseReleased(MouseEvent e) {
// Do nothing
}
public void mousePressed(MouseEvent e) {
Vector<Mote> clickedMotes = findMotesAtPosition(e.getX(), e.getY());
if (clickedMotes == null || clickedMotes.size() == 0) {
selectedMote = null;
transmissionSpinner.setVisible(false);
interferenceSpinner.setVisible(false);
repaint();
return;
}
// Select one of the clicked motes
if (clickedMotes.contains(selectedMote)) {
int pos = clickedMotes.indexOf(selectedMote);
if (pos < clickedMotes.size() - 1)
selectedMote = clickedMotes.get(pos + 1);
else
selectedMote = clickedMotes.firstElement();
} else {
selectedMote = clickedMotes.firstElement();
}
repaint();
}
public void mouseClicked(MouseEvent e) {
}
});
// Register change ranges action
addMoteMenuAction(new ChangeRangesMenuAction());
// Observe our own radio medium
myRadioMedium
.addRadioMediumObserver(radioMediumObserver = new Observer() {
public void update(Observable obs, Object obj) {
getCurrentCanvas().repaint();
}
});
}
public void closePlugin() {
super.closePlugin();
myRadioMedium.deleteRadioMediumObserver(radioMediumObserver);
}
public Color[] getColorOf(Mote mote) {
Radio moteRadio = mote.getInterfaces().getRadio();
if (moteRadio == null)
return new Color[] { Color.GRAY };
if (selectedMote != null && mote == selectedMote)
return new Color[] { Color.CYAN };
if (moteRadio.isTransmitting())
return new Color[] { Color.BLUE };
if (moteRadio.isInterfered())
return new Color[] { Color.RED };
if (moteRadio.isReceiving())
return new Color[] { Color.GREEN };
return new Color[] { Color.WHITE };
}
public void visualizeSimulation(Graphics g) {
// Paint transmission+interference areas for selected mote (if any)
if (selectedMote != null) {
Position motePos = selectedMote.getInterfaces().getPosition();
Point pixelCoord = transformPositionToPixel(motePos);
int x = pixelCoord.x;
int y = pixelCoord.y;
// Fetch current output power indicator (scale with as percent)
// TODO Probably not the best way to use indicator
double moteInterferenceRange = INTERFERENCE_RANGE
* (0.01 * (double) selectedMote.getInterfaces().getRadio()
.getCurrentOutputPowerIndicator());
double moteTransmissionRange = TRANSMITTING_RANGE
* (0.01 * (double) selectedMote.getInterfaces().getRadio()
.getCurrentOutputPowerIndicator());
Point translatedZero = transformPositionToPixel(0.0, 0.0, 0.0);
Point translatedInterference = transformPositionToPixel(
moteInterferenceRange, moteInterferenceRange, 0.0);
Point translatedTransmission = transformPositionToPixel(
moteTransmissionRange, moteTransmissionRange, 0.0);
translatedInterference.x = Math.abs(translatedInterference.x
- translatedZero.x);
translatedInterference.y = Math.abs(translatedInterference.y
- translatedZero.y);
translatedTransmission.x = Math.abs(translatedTransmission.x
- translatedZero.x);
translatedTransmission.y = Math.abs(translatedTransmission.y
- translatedZero.y);
// Interference
g.setColor(Color.DARK_GRAY);
g.fillOval(x - translatedInterference.x, y - translatedInterference.y,
2 * translatedInterference.x, 2 * translatedInterference.y);
// Transmission
g.setColor(Color.GREEN);
g.fillOval(x - translatedTransmission.x, y - translatedTransmission.y,
2 * translatedTransmission.x, 2 * translatedTransmission.y);
}
// Let parent paint motes
super.visualizeSimulation(g);
// Paint last tick connections
if (myRadioMedium != null
&& myRadioMedium.getLastTickConnections() != null) {
for (RadioConnection conn : myRadioMedium.getLastTickConnections()) {
if (conn != null) {
Point sourcePoint = transformPositionToPixel(conn
.getSourcePosition());
// Paint destinations
for (Position destPos : conn.getDestinationPositons()) {
Point destPoint = transformPositionToPixel(destPos);
g.setColor(Color.BLACK);
g
.drawLine(sourcePoint.x, sourcePoint.y, destPoint.x,
destPoint.y);
}
}
}
}
}
}
public UDGM(Simulation simulation) {
// Register this radio medium's plugins
simulation.getGUI().registerTemporaryPlugin(VisUDGM.class);
myRadioMedium = this;
}
private boolean isTickObserver = false;
// Maximum ranges (SS indicator 100)
private static double TRANSMITTING_RANGE = 50;
private static double INTERFERENCE_RANGE = 100;
private class RadioMediumObservable extends Observable {
private void setRadioMediumChanged() {
setChanged();
}
}
private RadioMediumObservable radioMediumObservable = new RadioMediumObservable();
private RadioConnection[] lastTickConnections = null;
private Vector<RadioConnection> pendingConnections = new Vector<RadioConnection>();
private ConnectionLogger myLogger = null;
private Observer radioDataObserver = new Observer() {
public void update(Observable radio, Object obj) {
// This radio changed, let tick loop notify observers
radioMediumObservable.setRadioMediumChanged();
// Register any new transmission
if (((Radio) radio).getLastEvent() == Radio.RadioEvent.TRANSMISSION_STARTED) {
Radio sendingRadio = (Radio) radio;
// If obj is the position, use it directly (speeds up things)
// Otherwise we must search for the position ourselves
Position sendingPosition = (Position) obj;
if (sendingPosition == null) {
if (!registeredRadios.contains(radio)) {
logger.fatal("Sending radio not registered, skipping packet");
return;
}
sendingPosition = registeredPositions.get(registeredRadios
.indexOf(radio));
if (sendingPosition == null) {
logger.fatal("Sending radio not registered, skipping packet");
return;
}
}
byte[] dataToSend = sendingRadio.getLastPacketTransmitted();
RadioConnection newConnection = new RadioConnection();
pendingConnections.add(newConnection);
newConnection.setSource(sendingRadio, sendingPosition, dataToSend);
// Fetch current output power indicator (scale with as percent)
// TODO Probably not the best way to use indicator
double moteInterferenceRange = INTERFERENCE_RANGE
* (0.01 * (double) sendingRadio.getCurrentOutputPowerIndicator());
double moteTransmissionRange = TRANSMITTING_RANGE
* (0.01 * (double) sendingRadio.getCurrentOutputPowerIndicator());
// Loop through all radios that are listening
for (int listenNr = 0; listenNr < registeredPositions.size(); listenNr++) {
Radio listeningRadio = registeredRadios.get(listenNr);
if (sendingRadio == listeningRadio)
continue;
if (sendingRadio.getChannel() != listeningRadio.getChannel())
continue;
// If not the sending radio..
double distance = sendingPosition.getDistanceTo(registeredPositions
.get(listenNr));
if (distance <= moteTransmissionRange) {
newConnection.addDestination(registeredRadios.get(listenNr),
registeredPositions.get(listenNr), dataToSend);
// If close enough to transmit ok..
if (listeningRadio.isReceiving() || listeningRadio.isInterfered()) {
// .. but listening radio already received a packet
listeningRadio.interferReception(sendingRadio
.getTransmissionEndTime());
listeningRadio.setCurrentSignalStrength(SS_BAD);
} else {
// .. send packet
listeningRadio.receivePacket(dataToSend, sendingRadio
.getTransmissionEndTime());
listeningRadio.setCurrentSignalStrength(SS_OK);
}
} else if (distance <= moteInterferenceRange) {
// If close enough to sabotage other transmissions..
listeningRadio.interferReception(sendingRadio
.getTransmissionEndTime());
listeningRadio.setCurrentSignalStrength(SS_BAD);
}
// else too far away
}
}
if (((Radio) radio).getLastEvent() == Radio.RadioEvent.TRANSMISSION_FINISHED) {
transmissionEndedRadios.add((Radio) radio);
}
}
};
private Observer tickObserver = new Observer() {
public void update(Observable obs, Object obj) {
if (lastTickConnections != null)
radioMediumObservable.setRadioMediumChanged();
// Reset last tick connections
lastTickConnections = null;
// Log finished connections if any
Vector<RadioConnection> updatedPendingConnections = new Vector<RadioConnection>();
if (transmissionEndedRadios.size() > 0) {
final int numberFinished = transmissionEndedRadios.size();
Vector<RadioConnection> newTickConnections = new Vector<RadioConnection>();
// Loop through all radios that finished transmitting data
for (int recvNr = 0; recvNr < numberFinished; recvNr++) {
Radio transmittingRadio = transmissionEndedRadios.get(recvNr);
for (RadioConnection pendingConnection : pendingConnections) {
// Log finished connection
if (pendingConnection.getSourceRadio() == transmittingRadio) {
for (Radio destRadio : pendingConnection.getDestinationRadios()) {
if (destRadio.getLastEvent() != Radio.RadioEvent.RECEPTION_FINISHED) {
// Radio was interfered
pendingConnection.removeDestination(destRadio);
}
}
newTickConnections.add(pendingConnection);
}
// Remove connection if old (don't keep)
if (pendingConnection.getSourceRadio().isTransmitting()) {
updatedPendingConnections.add(pendingConnection);
}
}
}
lastTickConnections = new RadioConnection[newTickConnections.size()];
for (int i = 0; i < lastTickConnections.length; i++)
lastTickConnections[i] = newTickConnections.get(i);
transmissionEndedRadios.clear();
pendingConnections = updatedPendingConnections;
if (myLogger != null) {
for (RadioConnection conn : lastTickConnections)
myLogger.logConnection(conn);
}
// Radio medium has changed, notifing below
radioMediumObservable.setRadioMediumChanged();
}
// Set signal strengths on all radios
for (Radio radio : registeredRadios) {
if (radio.isTransmitting())
radio.setCurrentSignalStrength(SS_OK);
else if (radio.isReceiving())
radio.setCurrentSignalStrength(SS_OK);
else if (radio.isInterfered())
radio.setCurrentSignalStrength(SS_BAD);
else
radio.setCurrentSignalStrength(SS_NOTHING);
}
// Notify observers (if anything has changed)
radioMediumObservable.notifyObservers();
}
};
public void registerMote(Mote mote, Simulation sim) {
registerRadioInterface(mote.getInterfaces().getRadio(), mote
.getInterfaces().getPosition(), sim);
}
public void unregisterMote(Mote mote, Simulation sim) {
unregisterRadioInterface(mote.getInterfaces().getRadio(), sim);
}
public void registerRadioInterface(Radio radio, Position position,
Simulation sim) {
if (radio != null && position != null) {
if (!isTickObserver) {
sim.addTickObserver(tickObserver);
isTickObserver = true;
}
registeredPositions.add(position);
registeredRadios.add(radio);
radio.addObserver(radioDataObserver);
// Set initial signal strenth
radio.setCurrentSignalStrength(SS_NOTHING);
} // else logger.warn("Radio Medium not registering mote");
}
public void unregisterRadioInterface(Radio radio, Simulation sim) {
for (int i = 0; i < registeredRadios.size(); i++) {
if (registeredRadios.get(i).equals(radio)) {
registeredRadios.remove(i);
registeredPositions.remove(i);
radio.deleteObserver(radioDataObserver);
return;
}
}
logger.warn("Could not find radio: " + radio + " to unregister");
}
public void addRadioMediumObserver(Observer observer) {
radioMediumObservable.addObserver(observer);
}
public Observable getRadioMediumObservable() {
return radioMediumObservable;
}
public void deleteRadioMediumObserver(Observer observer) {
radioMediumObservable.deleteObserver(observer);
}
public RadioConnection[] getLastTickConnections() {
return lastTickConnections;
}
public void setConnectionLogger(ConnectionLogger connection) {
myLogger = connection;
}
public Collection<Element> getConfigXML() {
Vector<Element> config = new Vector<Element>();
Element element;
// Transmitting range
element = new Element("transmitting_range");
element.setText(Double.toString(TRANSMITTING_RANGE));
config.add(element);
// Interference range
element = new Element("interference_range");
element.setText(Double.toString(INTERFERENCE_RANGE));
config.add(element);
return config;
}
public boolean setConfigXML(Collection<Element> configXML, boolean visAvailable) {
for (Element element : configXML) {
if (element.getName().equals("transmitting_range")) {
TRANSMITTING_RANGE = Double.parseDouble(element.getText());
}
if (element.getName().equals("interference_range")) {
INTERFERENCE_RANGE = Double.parseDouble(element.getText());
}
}
return true;
}
}