deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

javadoc update

Browse source
This commit is contained in:
fros4943 2010-02-03 15:49:24 +00:00
parent 3aeaf86b1a
commit 778c14e9e3
11 changed files with 29 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
tools/cooja/java/se/sics/cooja/CoreComm.java
View file

@ -24,7 +24,7 @@
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* *
* $Id: CoreComm.java,v 1.14 2009/03/10 21:05:00 fros4943 Exp $ * $Id: CoreComm.java,v 1.15 2010/02/03 15:49:25 fros4943 Exp $
*/ */
package se.sics.cooja; package se.sics.cooja;
@ -279,15 +279,13 @@ public abstract class CoreComm {
/** /**
* Loads given Java class file from disk. * Loads given Java class file from disk.
* *
* @param classFile * @param className Java class name
* Java class (without extension)
* @return Loaded class * @return Loaded class
* @throws MoteTypeCreationException * @throws MoteTypeCreationException If error occurs
* If error occurs
*/ */
public static Class loadClassFile(String className) public static Class<?> loadClassFile(String className)
throws MoteTypeCreationException { throws MoteTypeCreationException {
Class loadedClass = null; Class<?> loadedClass = null;
try { try {
ClassLoader urlClassLoader = new URLClassLoader( ClassLoader urlClassLoader = new URLClassLoader(
new URL[] { new File(".").toURI().toURL() }, new URL[] { new File(".").toURI().toURL() },

6
tools/cooja/java/se/sics/cooja/GUI.java
View file

@ -24,7 +24,7 @@
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* *
* $Id: GUI.java,v 1.158 2010/01/20 13:27:02 fros4943 Exp $ * $Id: GUI.java,v 1.159 2010/02/03 15:49:25 fros4943 Exp $
*/ */
package se.sics.cooja; package se.sics.cooja;
@ -2334,7 +2334,7 @@ public class GUI extends Observable {
* Reloading a simulation may include recompiling Contiki. * Reloading a simulation may include recompiling Contiki.
* *
* @param autoStart Start executing simulation when loaded * @param autoStart Start executing simulation when loaded
* @param newSeed Change simulation seed * @param randomSeed Simulation's next random seed
*/ */
public void reloadCurrentSimulation(final boolean autoStart, final long randomSeed) { public void reloadCurrentSimulation(final boolean autoStart, final long randomSeed) {
if (getSimulation() == null) { if (getSimulation() == null) {
@ -2437,7 +2437,7 @@ public class GUI extends Observable {
* Reloading a simulation may include recompiling Contiki. * Reloading a simulation may include recompiling Contiki.
* The same random seed is used. * The same random seed is used.
* *
* @see #reloadCurrentSimulation(boolean, boolean) * @see #reloadCurrentSimulation(boolean, long)
* @param autoStart Start executing simulation when loaded * @param autoStart Start executing simulation when loaded
*/ */
public void reloadCurrentSimulation(boolean autoStart) { public void reloadCurrentSimulation(boolean autoStart) {

7
tools/cooja/java/se/sics/cooja/RadioMedium.java
View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
* *
* $Id: RadioMedium.java,v 1.8 2009/11/25 15:26:35 fros4943 Exp $ * $Id: RadioMedium.java,v 1.9 2010/02/03 15:49:25 fros4943 Exp $
*/ */
package se.sics.cooja; package se.sics.cooja;
@ -100,10 +100,9 @@ public abstract class RadioMedium {
/** /**
* Adds an observer which is notified each time a radio connection has finished. * Adds an observer which is notified each time a radio connection has finished.
* *
* @see #getLastTickConnections() * @see #getLastConnection()
* @see #deleteRadioMediumObserver(Observer) * @see #deleteRadioMediumObserver(Observer)
* @param observer * @param observer New observer
* New observer
*/ */
public abstract void addRadioMediumObserver(Observer observer); public abstract void addRadioMediumObserver(Observer observer);

4
tools/cooja/java/se/sics/cooja/Simulation.java
View file

@ -24,7 +24,7 @@
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* *
* $Id: Simulation.java,v 1.60 2010/02/03 15:33:36 fros4943 Exp $ * $Id: Simulation.java,v 1.61 2010/02/03 15:49:25 fros4943 Exp $
*/ */
package se.sics.cooja; package se.sics.cooja;
@ -948,7 +948,7 @@ public class Simulation extends Observable implements Runnable {
* Returns current simulation time rounded to milliseconds. * Returns current simulation time rounded to milliseconds.
* *
* @see #getSimulationTime() * @see #getSimulationTime()
* @return * @return Time rounded to milliseconds
*/ */
public long getSimulationTimeMillis() { public long getSimulationTimeMillis() {
return currentSimulationTime / MILLISECOND; return currentSimulationTime / MILLISECOND;

4
tools/cooja/java/se/sics/cooja/contikimote/interfaces/ContikiRS232.java
View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
* *
* $Id: ContikiRS232.java,v 1.12 2010/02/03 09:27:24 fros4943 Exp $ * $Id: ContikiRS232.java,v 1.13 2010/02/03 15:49:25 fros4943 Exp $
*/ */
package se.sics.cooja.contikimote.interfaces; package se.sics.cooja.contikimote.interfaces;
@ -60,7 +60,7 @@ import se.sics.cooja.interfaces.PolledAfterActiveTicks;
* *
* This observable notifies observers when a serial message is sent from the mote. * This observable notifies observers when a serial message is sent from the mote.
* *
* @see #getSerialMessages() * @see #getLastLogMessage()
* *
* @author Fredrik Osterlind * @author Fredrik Osterlind
*/ */

4
tools/cooja/java/se/sics/cooja/dialogs/ConfigurationWizard.java
View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
* *
* $Id: ConfigurationWizard.java,v 1.6 2010/02/03 09:58:07 fros4943 Exp $ * $Id: ConfigurationWizard.java,v 1.7 2010/02/03 15:49:24 fros4943 Exp $
*/ */
package se.sics.cooja.dialogs; package se.sics.cooja.dialogs;
@ -668,7 +668,7 @@ public class ConfigurationWizard extends JDialog {
testOutput.addMessage("### Loading Java library class: se/sics/cooja/corecomm/" + javaLibraryName); testOutput.addMessage("### Loading Java library class: se/sics/cooja/corecomm/" + javaLibraryName);
Class<? extends CoreComm> javaLibraryClass = null; Class<? extends CoreComm> javaLibraryClass = null;
try { try {
javaLibraryClass = CoreComm.loadClassFile(javaLibraryName); javaLibraryClass = (Class<? extends CoreComm>) CoreComm.loadClassFile(javaLibraryName);
} catch (MoteTypeCreationException e) { } catch (MoteTypeCreationException e) {
e.printStackTrace(errorStream); e.printStackTrace(errorStream);
testOutput.addMessage("### Error: " + e.getMessage(), MessageList.ERROR); testOutput.addMessage("### Error: " + e.getMessage(), MessageList.ERROR);

3
tools/cooja/java/se/sics/cooja/interfaces/Battery.java
View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
* *
* $Id: Battery.java,v 1.11 2009/11/13 08:52:26 fros4943 Exp $ * $Id: Battery.java,v 1.12 2010/02/03 15:49:24 fros4943 Exp $
*/ */
package se.sics.cooja.interfaces; package se.sics.cooja.interfaces;
@ -49,7 +49,6 @@ import se.sics.cooja.MoteInterface;
* The current code does not monitor the energy consumption of simulated motes. * The current code does not monitor the energy consumption of simulated motes.
* *
* @see MoteInterface * @see MoteInterface
* @see MoteInterface#energyConsumption()
* *
* @author Fredrik Osterlind * @author Fredrik Osterlind
*/ */

6
tools/cooja/java/se/sics/cooja/plugins/Visualizer.java
View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
* *
* $Id: Visualizer.java,v 1.12 2010/01/13 12:29:10 nifi Exp $ * $Id: Visualizer.java,v 1.13 2010/02/03 15:49:24 fros4943 Exp $
*/ */
package se.sics.cooja.plugins; package se.sics.cooja.plugins;
@ -112,8 +112,8 @@ import se.sics.cooja.plugins.skins.UDGMVisualizerSkin;
* *
* Observes the simulation and all mote positions. * Observes the simulation and all mote positions.
* *
* @see #registerMoteMenuAction(MoteMenuAction) * @see #registerMoteMenuAction(Class)
* @see #registerSimulationMenuAction(SimulationMenuAction) * @see #registerSimulationMenuAction(Class)
* @see #registerVisualizerSkin(Class) * @see #registerVisualizerSkin(Class)
* @see UDGMVisualizerSkin * @see UDGMVisualizerSkin
* @author Fredrik Osterlind * @author Fredrik Osterlind

5
tools/cooja/java/se/sics/cooja/plugins/VisualizerSkin.java
View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
* *
* $Id: VisualizerSkin.java,v 1.3 2009/08/27 13:57:42 fros4943 Exp $ * $Id: VisualizerSkin.java,v 1.4 2010/02/03 15:49:24 fros4943 Exp $
*/ */
package se.sics.cooja.plugins; package se.sics.cooja.plugins;
@ -52,7 +52,8 @@ public interface VisualizerSkin {
* @param sim Simulation * @param sim Simulation
* @param visualizer Visualizer plugin * @param visualizer Visualizer plugin
* *
* @see #paintSkin(Graphics) * @see #paintBeforeMotes(Graphics)
* @see #paintAfterMotes(Graphics)
* @see #setInactive() * @see #setInactive()
*/ */
public void setActive(Simulation sim, Visualizer visualizer); public void setActive(Simulation sim, Visualizer visualizer);

4
tools/cooja/java/se/sics/cooja/plugins/skins/UDGMVisualizerSkin.java
View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
* *
* $Id: UDGMVisualizerSkin.java,v 1.9 2009/10/27 10:14:58 fros4943 Exp $ * $Id: UDGMVisualizerSkin.java,v 1.10 2010/02/03 15:49:25 fros4943 Exp $
*/ */
package se.sics.cooja.plugins.skins; package se.sics.cooja.plugins.skins;
@ -65,7 +65,7 @@ import se.sics.cooja.radiomediums.UDGM;
* success ratio. * success ratio.
* *
* To also see radio traffic, this skin can be combined with {@link * To also see radio traffic, this skin can be combined with {@link
* TrafficVisualizerSkin()}. * TrafficVisualizerSkin}.
* *
* @see TrafficVisualizerSkin * @see TrafficVisualizerSkin
* @see UDGM * @see UDGM

6
tools/cooja/java/se/sics/cooja/radiomediums/UDGM.java
View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * SUCH DAMAGE.
* *
* $Id: UDGM.java,v 1.29 2009/12/07 11:03:19 fros4943 Exp $ * $Id: UDGM.java,v 1.30 2010/02/03 15:49:25 fros4943 Exp $
*/ */
package se.sics.cooja.radiomediums; package se.sics.cooja.radiomediums;
@ -45,7 +45,6 @@ import se.sics.cooja.Mote;
import se.sics.cooja.RadioConnection; import se.sics.cooja.RadioConnection;
import se.sics.cooja.Simulation; import se.sics.cooja.Simulation;
import se.sics.cooja.SimEventCentral.MoteCountListener; import se.sics.cooja.SimEventCentral.MoteCountListener;
import se.sics.cooja.contikimote.interfaces.ContikiRadio;
import se.sics.cooja.interfaces.Position; import se.sics.cooja.interfaces.Position;
import se.sics.cooja.interfaces.Radio; import se.sics.cooja.interfaces.Radio;
import se.sics.cooja.plugins.Visualizer; import se.sics.cooja.plugins.Visualizer;
@ -77,7 +76,8 @@ import se.sics.cooja.radiomediums.DirectedGraphMedium.DestinationRadio;
* @see #SS_WEAK * @see #SS_WEAK
* @see #SS_NOTHING * @see #SS_NOTHING
* *
* @see DirectedGraphMedium, UDGMVisualizerSkin * @see DirectedGraphMedium
* @see UDGMVisualizerSkin
* @author Fredrik Osterlind * @author Fredrik Osterlind
*/ */
@ClassDescription("Unit Disk Graph Medium (UDGM)") @ClassDescription("Unit Disk Graph Medium (UDGM)")