| org.cougaar.planning.ldm.ClusterServesPlugin
| ClusterServesPlugin | | public interface ClusterServesPlugin (Code) | | ClusterServesPlugin is the API which plugins may use to access
agent-level services.
|
| Method Summary | |
| void | addAlarm(Alarm alarm)
Called by a plugin to schedule an Alarm to ring
at some future Scenario time. | | void | addRealTimeAlarm(Alarm alarm)
Called by a plugin to schedule an Alarm to ring
at some future Real (wallclock) time. | | void | advanceTime(long timePeriod)
This method advances the COUGAAR scenario time a period of time
in the future, leaving the clock stopped. | | void | advanceTime(long timePeriod, boolean leaveRunning)
General form of advanceTime, allowing the clock to be left running. | | void | advanceTime(long timePeriod, double newRate)
General form of advanceTime, allowing the clock to be left running at a new rate. | | void | advanceTime(ExecutionTimer.Change[] changes)
Set a series of time parameter changes. | | long | currentTimeMillis()
This method gets the current COUGAAR scenario time. | | ConfigFinder | getConfigFinder()
| | double | getExecutionRate()
Get the current execution time rate. | | LDMServesPlugin | getLDM()
return our LDM instance. | | MessageAddress | getMessageAddress()
| | UIDServer | getUIDServer()
| | void | setTime(long time)
This method sets the COUGAAR scenario time to a specific time
in the future, leaving the clock stopped. | | void | setTime(long time, boolean leaveRunning)
General form of setTime, allowing the clock to be left running. | | void | setTimeRate(double newRate)
Changes the rate at which execution time advances. |
| addAlarm | | void addAlarm(Alarm alarm)(Code) | | Called by a plugin to schedule an Alarm to ring
at some future Scenario time.
This alarm functions over Scenario time which may be discontinuous
and/or offset from realtime.
If you want real (wallclock time, use addRealTimeAlarm instead).
Most plugins will want to just use the wake() functionality,
which is implemented in terms of addAlarm().
|
| addRealTimeAlarm | | void addRealTimeAlarm(Alarm alarm)(Code) | | Called by a plugin to schedule an Alarm to ring
at some future Real (wallclock) time.
|
| advanceTime | | void advanceTime(long timePeriod)(Code) | | This method advances the COUGAAR scenario time a period of time
in the future, leaving the clock stopped.
Time is in milliseconds.
Equivalent to advanceTime(timePeriod, false);
Only UI Plugins controlling the demonstration should use
this method.
|
| advanceTime | | void advanceTime(long timePeriod, boolean leaveRunning)(Code) | | General form of advanceTime, allowing the clock to be left running.
Only UI Plugins controlling the demonstration should use
this method.
|
| advanceTime | | void advanceTime(long timePeriod, double newRate)(Code) | | General form of advanceTime, allowing the clock to be left running at a new rate.
Only UI Plugins controlling the demonstration should use
this method.
|
| advanceTime | | void advanceTime(ExecutionTimer.Change[] changes)(Code) | | Set a series of time parameter changes. The number of such
changes is limited. See ExecutionTimer.create() for details.
|
| currentTimeMillis | | long currentTimeMillis()(Code) | | This method gets the current COUGAAR scenario time.
The returned time is in milliseconds.
|
| getExecutionRate | | double getExecutionRate()(Code) | | Get the current execution time rate.
|
| getLDM | | LDMServesPlugin getLDM()(Code) | | return our LDM instance. You can get the factory(ies) from
the LDM instance.
|
| getMessageAddress | | MessageAddress getMessageAddress()(Code) | | MessageAddress the MessageAddress associated with the Agent where the Plugin is plugged in. |
| setTime | | void setTime(long time)(Code) | | This method sets the COUGAAR scenario time to a specific time
in the future, leaving the clock stopped.
Time is in milliseconds.
Equivalent to setTime(time, false);
Only UI Plugins controlling the demonstration should use
this method.
|
| setTime | | void setTime(long time, boolean leaveRunning)(Code) | | General form of setTime, allowing the clock to be left running.
Only UI Plugins controlling the demonstration should use
this method.
|
| setTimeRate | | void setTimeRate(double newRate)(Code) | | Changes the rate at which execution time advances. There is no
discontinuity in the value of execution time; it flows smoothly
from the current rate to the new rate.
|
|
|