javax.realtime

Interface ActiveEvent

public interface ActiveEvent

This is the interface for defining the active event system. Classes implementing ActiveEvent are used to connect events that take place outside the Java runtime to RTSJ activities.

An active event is known by an ID and by a name. Only the name is provided by the application. The system provides the ID. Both must be unique.

When an event takes place outside the Java runtime, some event-specific code in the Java runtime executes. That code notifies the ActiveEvent infrastructure of this event by calling a trigger method in the event.

Method Summary

Modifier and Type	Method and Description
boolean	isActive() Determine the activation state of this event, i.e., it has been started but not yet stopped again.
boolean	isRunning() Determine the running state of this event, i.e., it is both active and enabled.
void	start() Start this active event.
void	start(boolean disabled) Start this active event.
boolean	stop() Stop this active event.

Method Detail

isActive

boolean isActive()

Determine the activation state of this event, i.e., it has been started but not yet stopped again.

Returns:

true when active, false otherwise.

isRunning

boolean isRunning()

Determine the running state of this event, i.e., it is both active and enabled.

Returns:

true when active and enabled, false otherwise.

start

void start()
    throws java.lang.IllegalStateException

Start this active event.

Throws:

java.lang.IllegalStateException - when this event has already been started.

start

void start(boolean disabled)
    throws java.lang.IllegalStateException

Start this active event.

Parameters:

disabled - true for starting in a disabled state.

Throws:

java.lang.IllegalStateException - when this event has already been started.

stop

boolean stop()
      throws java.lang.IllegalStateException

Stop this active event.

Returns:

the previous enabled state.

Throws:

java.lang.IllegalStateException - when this event is not running.