sub_arctic.input
Class work_agent

java.lang.Object
  |
  +--sub_arctic.input.dispatch_agent
        |
        +--sub_arctic.input.work_agent

public class work_agent

extends dispatch_agent

This is the class that handles dispatching the work_procs on the "synchronized side of the world."

User's should never use this class directly but should use the API in the manager instead.

Field Summary

static int

WORK_EVENT We derive our event code in the same way the animation agent does, and we use the constant +2 instead of +1 like it does...

Method Summary

boolean	dispatch_event(event evt, java.lang.Object user_info, interactor to_obj, int seq_num) Dispatch a work event.
boolean	event_is_useful(event evt) Indicate whether the given event might be dispatchable by this agent.

Methods inherited from class sub_arctic.input.dispatch_agent

after_dispatch_notify, dispatch_unused_event

Methods inherited from class java.lang.Object

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

Field Detail

WORK_EVENT

public static final int WORK_EVENT

We derive our event code in the same way the animation agent does, and we use the constant +2 instead of +1 like it does...

Method Detail

event_is_useful

public boolean event_is_useful(event evt)

Indicate whether the given event might be dispatchable by this agent. Events will not be delivered to the agent unless they pass this test. We only accept the work event.

Parameters:

event - evt the event to be tested for usefulness.

Returns:

boolean true if the event is one this agent is interested in.

Overrides:

event_is_useful in class dispatch_agent

dispatch_event

public boolean dispatch_event(event evt,
                              java.lang.Object user_info,
                              interactor to_obj,
                              int seq_num)

Dispatch a work event.

Parameters:

event - evt the event to dispatch.

Object - user_info policy defined user information

interactor - to_obj the object to (possibly)send the event to

int - seq_num the sequence number of this event

Overrides:

dispatch_event in class dispatch_agent