1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
|
//******************************************************************************
//
// File: Event.java
// Package: edu.rit.sim
// Unit: Class edu.rit.sim.Event
//
// This Java source file is copyright (C) 2011 by Alan Kaminsky. All rights
// reserved. For further information, contact the author, Alan Kaminsky, at
// ark@cs.rit.edu.
//
// This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
// software; you can redistribute it and/or modify it under the terms of the GNU
// General Public License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// PJ is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
// A PARTICULAR PURPOSE. See the GNU General Public License for more details.
//
// Linking this library statically or dynamically with other modules is making a
// combined work based on this library. Thus, the terms and conditions of the
// GNU General Public License cover the whole combination.
//
// As a special exception, the copyright holders of this library give you
// permission to link this library with independent modules to produce an
// executable, regardless of the license terms of these independent modules, and
// to copy and distribute the resulting executable under terms of your choice,
// provided that you also meet, for each linked independent module, the terms
// and conditions of the license of that module. An independent module is a
// module which is not derived from or based on this library. If you modify this
// library, you may extend this exception to your version of the library, but
// you are not obligated to do so. If you do not wish to do so, delete this
// exception statement from your version.
//
// A copy of the GNU General Public License is provided in the file gpl.txt. You
// may also obtain a copy of the GNU General Public License on the World Wide
// Web at http://www.gnu.org/licenses/gpl.html.
//
//******************************************************************************
package edu.rit.sim;
/**
* Class Event is the abstract base class for an event in a discrete event
* simulation.
*
* @author Alan Kaminsky
* @version 29-Jul-2011
*/
public abstract class Event
{
// Hidden data members.
// Simulation in which this event occurs.
Simulation sim;
// Simulation time of this event.
double time;
// Exported constructors.
/**
* Construct a new event.
*/
public Event()
{
}
// Exported operations.
/**
* Returns the simulation in which this event occurs.
*
* @return Simulation.
*/
public final Simulation simulation()
{
return sim;
}
/**
* Returns this event's simulation time, the time when this event is
* scheduled to take place.
*
* @return Simulation time.
*/
public final double time()
{
return time;
}
/**
* Schedule the given event to be performed at the given time in this
* event's simulation.
*
* @param t Simulation time for <TT>event</TT>.
* @param event Event to be performed.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if <TT>t</TT> is less than the current
* simulation time.
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>event</TT> is null.
*/
public final void doAt
(double t,
Event event)
{
sim.doAt (t, event);
}
/**
* Schedule the given event to be performed at a time <TT>dt</TT> in the
* future (at current simulation time + <TT>dt</TT>) in this event's
* simulation.
*
* @param dt Simulation time delta for <TT>event</TT>.
* @param event Event to be performed.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown if <TT>dt</TT> is less than zero.
* @exception NullPointerException
* (unchecked exception) Thrown if <TT>event</TT> is null.
*/
public final void doAfter
(double dt,
Event event)
{
sim.doAfter (dt, event);
}
/**
* Perform this event. Called by the {@linkplain Simulation} when the
* simulation time equals the time when this event is scheduled to take
* place.
*/
public abstract void perform();
}
|