SimJava
v2.0

eduni.simjava
Class Sim_event

java.lang.Object
  |
  +--eduni.simjava.Sim_event
All Implemented Interfaces:
java.lang.Cloneable

public class Sim_event
extends java.lang.Object
implements java.lang.Cloneable

This class represents events which are passed between the entities in the simulation.

See Also:
Sim_system, Sim_entity

Constructor Summary
Sim_event()
          Create a blank event.
 
Method Summary
 double end_waiting_time()
          Get the simulation time that this event was removed from the queue for service.
 double event_time()
          Get the simulation time that this event was scheduled.
 boolean from_port(Sim_port p)
          Determine if the event was sent from a given port.
 java.lang.Object get_data()
          Get the data passed in this event.
 int get_dest()
          Get the unique id number of the entity which received this event.
 int get_src()
          Get the unique id number of the entity which scheduled this event.
 int get_tag()
          Get the user-defined tag of this event.
 int scheduled_by()
          Get the unique id number of the entity which scheduled this event.
 void set_dest(int d)
          Set the destination entity of this event.
 void set_src(int s)
          Set the source entity of this event.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sim_event

public Sim_event()
Create a blank event. Useful for fetching events using methods such as the sim_wai() methods of entities.
Method Detail

get_dest

public int get_dest()
Get the unique id number of the entity which received this event.
Returns:
the id number

get_src

public int get_src()
Get the unique id number of the entity which scheduled this event.
Returns:
the id number

event_time

public double event_time()
Get the simulation time that this event was scheduled.
Returns:
The simulation time

end_waiting_time

public double end_waiting_time()
Get the simulation time that this event was removed from the queue for service.
Returns:
The simulation time

scheduled_by

public int scheduled_by()
Get the unique id number of the entity which scheduled this event.
Returns:
the id number

get_tag

public int get_tag()
Get the user-defined tag of this event.
Returns:
The tag

get_data

public java.lang.Object get_data()
Get the data passed in this event.
Returns:
A reference to the data

from_port

public boolean from_port(Sim_port p)
Determine if the event was sent from a given port.
Parameters:
p - The port to test
Returns:
true if the event was scheduled through the port

set_src

public void set_src(int s)
Set the source entity of this event.
Parameters:
s - The unique id number of the entity

set_dest

public void set_dest(int d)
Set the destination entity of this event.
Parameters:
d - The unique id number of the entity

SimJava
v2.0

The University of Edinburgh, 2002