public interface SimEventScheduler extends Named
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_ENTITY_NAME |
static java.lang.String |
DEFAULT_EVENT_NAME |
static Priority |
DEFAULT_PRIORITY |
static java.lang.String |
EVENT_METHOD_PREFIX |
static java.lang.String |
NL |
Modifier and Type | Method and Description |
---|---|
BasicEventList |
getEventList() |
Priority |
getPriority()
If two events occur at the same time with the same event priority,
the one with the highest entity priority will be processed first.
|
int |
getSerial() |
void |
handleSimEvent(SimEvent event)
Typically an Event is handled (as opposed to processed, as in SimEventListener)
by actually executing a method.
|
void |
interrupt(java.lang.String eventName)
Cancels the next event for this entity that matches the event name.
|
void |
interrupt(java.lang.String eventName,
java.lang.Object... parameters)
Interrupt (cancel) the next pending event with name eventName
and interruption parameter array "parameters"
belonging to this object.
|
void |
interruptAll()
Interrupt (cancel) all pending events for this entity.
|
void |
interruptAll(java.lang.String eventName)
Cancels all events for this entity that match the event name.
|
void |
interruptAll(java.lang.String eventName,
java.lang.Object... parameters)
Interrupt (cancel) all pending events with name eventName
and interruption parameter array "parameters"
belonging to this object.
|
void |
interruptAllWithArgs(java.lang.Object parameter)
Interrupt (cancel) all events scheduled by this component having
the given eventName and an argument matching the parameter.
|
void |
interruptAllWithArgs(java.lang.String eventName,
java.lang.Object parameter)
Interrupt (cancel) all events scheduled by this component having
the given eventName and an argument matching the parameter.
|
void |
setPriority(Priority priority)
If two events occur at the same time with the same event priority,
the one with the highest entity priority will be processed first.
|
SimEvent |
waitDelay(java.lang.String eventName,
double delay,
java.lang.Object... parameters)
Schedule an event with (optional) given parameters and a default priority after a delay from
the current simulation time.
|
SimEvent |
waitDelay(java.lang.String eventName,
double delay,
Priority priority,
java.lang.Object... parameters)
Schedule an event after a delay from the current
simulation time.
|
static final java.lang.String DEFAULT_ENTITY_NAME
static final java.lang.String DEFAULT_EVENT_NAME
static final Priority DEFAULT_PRIORITY
static final java.lang.String EVENT_METHOD_PREFIX
static final java.lang.String NL
Priority getPriority()
int getSerial()
void handleSimEvent(SimEvent event)
event
- The SimEvent to be handled.void interrupt(java.lang.String eventName, java.lang.Object... parameters)
eventName
- Name of event to cancelparameters
- Parameters of the event to cancel (must be matched)void interrupt(java.lang.String eventName)
eventName
- Given event namevoid interruptAll()
void interruptAll(java.lang.String eventName)
eventName
- Given event namevoid interruptAll(java.lang.String eventName, java.lang.Object... parameters)
eventName
- Given event nameparameters
- Given parameters to be matchedvoid interruptAllWithArgs(java.lang.String eventName, java.lang.Object parameter)
eventName
- name of eventparameter
- parameter to matchvoid interruptAllWithArgs(java.lang.Object parameter)
parameter
- parameter to matchvoid setPriority(Priority priority)
priority
- Priority of this objectSimEvent waitDelay(java.lang.String eventName, double delay, java.lang.Object... parameters)
eventName
- The name of the scheduled event (prefixed by "do" for method name).delay
- The amount of time before the event is scheduledparameters
- parameters, possibly emptySimEvent waitDelay(java.lang.String eventName, double delay, Priority priority, java.lang.Object... parameters)
eventName
- The name of the scheduled event (prefixed by "do" for method name).delay
- The amount of time before the event is scheduledpriority
- The priority of this event (higher is better).parameters
- The parameters passed to the scheduled event.SimEvent
BasicEventList getEventList()
EventList
on which this scheduler will
schedule its events (and receive handleSimEvent()
calls from).