RapidAgentOfInterest Class Reference

The RAPID Agent of Interest is the primary Agent that the UI is interested in at any given time. More...

Collaboration diagram for RapidAgentOfInterest:

List of all members.

Static Public Member Functions
static Agent	getAgentOfInterest ()
static void	setAgentOfInterest (Agent agent)
	Set the Agent of interest for the UI and notify all listeners Will only notify listeners if the agent has changed (i.e.
static boolean	addListener (IAgentOfInterestListener listener)
	add a new IRapidAgentOfInterestListener.
static boolean	removeListener (IAgentOfInterestListener listener)
	Remove a IRapidAgentOfInterestListener from the listener list.

---

Detailed Description

Although many agents may be monitored by the components of the UI, detail views should dynamically track the most interesting agent. In the case of multiple views, each displaying the state of a different Agent, those views should implement "pin" functionality so they can either track the Agent of Interest, or be set explicitly by the user.

Author:

mallan

---

Member Function Documentation

static boolean addListener

(

IAgentOfInterestListener

listener

)

[static]

If the listener is already in the list, it will not be added a second time.

Exceptions:

IllegalArgumentException

if listener is null

static Agent getAgentOfInterest

(

)

[static]

Returns:

the RAPID Agent that the UI is currently focused on. This should never return null.

static boolean removeListener

(

IAgentOfInterestListener

listener

)

[static]

Also, clear out any weak listener references that are no longer valid. Calling with listener==null will clear any invalid weak references.

static void setAgentOfInterest

(

Agent

agent

)

[static]

setting the same Agent multiple times is a no-op)

Exceptions:

IllegalArgumentException

if agent is null

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• RapidAgentOfInterest.java