org.javades.jqueues.r5.entity

Class SimEntityEvent

java.lang.Object

org.javades.jsimulation.r5.DefaultSimEvent

org.javades.jqueues.r5.entity.SimEntityEvent

All Implemented Interfaces:

org.javades.jsimulation.r5.SimEvent

Direct Known Subclasses:

SimEntityEvent.Reset, SimEntityEvent.Update, SimJQEvent

public abstract class SimEntityEvent
extends org.javades.jsimulation.r5.DefaultSimEvent

A SimEvent for a SimEntity (queue, job, or other) operation.

This class only administers the key parameters for the event; it does not actually schedule it.

Author:

Jan de Jongh, TNO

Copyright (C) 2005-2017 Jan de Jongh, TNO

This file is covered by the LICENSE file in the root of this project.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimEntityEvent.Reset The (default) SimEvent for resetting a SimEntity.
static class	SimEntityEvent.Update The (default) SimEvent for updating a SimEntity.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimEntityEvent(String name, double time, SimEntity entity, org.javades.jsimulation.r5.SimEventAction<? extends SimEntity> action) Creates a new event for an entity.

Method Summary

Modifier and Type	Method and Description
SimEntity	getEntity() Gets the entity at which the event occurs.

Methods inherited from class org.javades.jsimulation.r5.DefaultSimEvent

getEventAction, getName, getObject, getSimEventListDeconflictValue, getTime, setEventAction, setName, setObject, setSimEventListDeconflictValue, setTime, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimEntityEvent

protected SimEntityEvent(String name,
                         double time,
                         SimEntity entity,
                         org.javades.jsimulation.r5.SimEventAction<? extends SimEntity> action)

Creates a new event for an entity.

Parameters:

name - The (optional) name of the event, may be null.

time - The time at which the event occurs.

entity - The entity related to the event, non-null.

action - The SimEventAction to take; may be null.

Throws:

IllegalArgumentException - If entity == null.

Method Detail

getEntity

public final SimEntity getEntity()

Gets the entity at which the event occurs.

Returns:

The entity to which the event applies, may be null.