swarm.activity
Interface Schedule

All Known Implementing Classes:
ScheduleImpl

public abstract interface Schedule
extends CompoundActionS, CompoundAction, ActionCreatingS, ActionCreating, RelativeTimeS, RelativeTime, RepeatIntervalS, RepeatInterval, ConcurrentGroupTypeS, ConcurrentGroupType, SingletonGroupsS, SingletonGroups

A collection of actions ordered by time values.. A schedule is compound action whose basic representation is a sorted Map of actions that have been created within it. The key value associated with each of these actions is an unsigned integer value for which the typedef timeval_t is supplied. A schedule inherits its underlying representation from the Map type of the collections library. All the members of the ordered set must consist only of actions that are created by one of the createAction messages defined on Schedule itself. Once the actions are created, they may be accessed or traversed using standard messages of the Map type. The key values of this collection, however, must be cast to and from the id type defined for key values by the Map type. The messages to create actions within a schedule are essentially the same as those for ActionGroup, except for the presence of an initial at: argument indicating the time at which an action is to be performed. Except for the time associated with each action, meaning of the createAction messages is the same as for ActionGroup. When multiple actions are all scheduled at the same time, they are all inserted into a concurrent action group created for that time value. The ConcurrentGroupType option may be used to override the default action group for these concurrent actions by a custom user-defined subclass. (.. Details of doing this are not yet documented, but there are examples.)


Method Summary
 Object at$createAction(long tVal, Object anActionType)
           
 Object at$createActionForEach$message(long tVal, Object target, Selector aSel)
           
 Object at$createActionForEach$message(long tVal, Object target, Selector aSel, Object arg1)
           
 Object at$createActionForEach$message(long tVal, Object target, Selector aSel, Object arg1, Object arg2)
           
 Object at$createActionForEach$message(long tVal, Object target, Selector aSel, Object arg1, Object arg2, Object arg3)
           
 Object at$createActionTo$message(long tVal, Object target, Selector aSel)
           
 Object at$createActionTo$message(long tVal, Object target, Selector aSel, Object arg1)
           
 Object at$createActionTo$message(long tVal, Object target, Selector aSel, Object arg1, Object arg2)
           
 Object at$createActionTo$message(long tVal, Object target, Selector aSel, Object arg1, Object arg2, Object arg3)
           
 Object insertGroup(Object aKey)
           
 Object remove(Object anAction)
          Remove action from either schedule or concurrent group.
 Object setKeepEmptyFlag(boolean keepEmptyFlag)
          Indicate whether an empty schedule should be dropped and ignored or or kept and attended to (default is YES).
 
Methods inherited from interface swarm.activity.ActionCreating
createAction
 
Methods inherited from interface swarm.activity.RelativeTimeS
setRelativeTime
 
Methods inherited from interface swarm.activity.RelativeTime
getRelativeTime
 
Methods inherited from interface swarm.activity.RepeatIntervalS
setRepeatInterval
 
Methods inherited from interface swarm.activity.RepeatInterval
getRepeatInterval
 
Methods inherited from interface swarm.activity.ConcurrentGroupTypeS
setConcurrentGroupType
 
Methods inherited from interface swarm.activity.ConcurrentGroupType
getConcurrentGroupType
 
Methods inherited from interface swarm.activity.SingletonGroupsS
setSingletonGroups
 
Methods inherited from interface swarm.activity.SingletonGroups
getSingletonGroups
 
Methods inherited from interface swarm.activity.ActionType
activateIn
 
Methods inherited from interface swarm.collections.Collection
allSameClass, begin, beginPermuted, contains, copy, deleteAll, getCount, getReplaceOnly, removeAll
 
Methods inherited from interface swarm.activity.AutoDrop
getAutoDrop
 
Methods inherited from interface swarm.activity.DefaultOrder
getDefaultOrder
 
Methods inherited from interface swarm.defobj.Drop
drop
 
Methods inherited from interface swarm.collections.Offsets
atOffset, atOffset$put, getFirst, getLast
 
Methods inherited from interface swarm.collections.ForEach
describeForEach, describeForEachID, forEach, forEach, forEach, forEach
 
Methods inherited from interface swarm.defobj.DefinedObject
compare, describe, describeID, getDisplayName, getTypeName, getZone, perform, perform$with, perform$with$with, perform$with$with$with, respondsTo, setDisplayName, xfprint, xfprintid, xprint, xprintid
 
Methods inherited from interface swarm.activity.ActionCreatingTo
createActionTo$message, createActionTo$message, createActionTo$message, createActionTo$message
 
Methods inherited from interface swarm.activity.ActionCreatingForEach
createActionForEach$message, createActionForEach$message, createActionForEach$message, createActionForEach$message
 

Method Detail

at$createAction

public Object at$createAction(long tVal,
                              Object anActionType)

at$createActionTo$message

public Object at$createActionTo$message(long tVal,
                                        Object target,
                                        Selector aSel)

at$createActionTo$message

public Object at$createActionTo$message(long tVal,
                                        Object target,
                                        Selector aSel,
                                        Object arg1)

at$createActionTo$message

public Object at$createActionTo$message(long tVal,
                                        Object target,
                                        Selector aSel,
                                        Object arg1,
                                        Object arg2)

at$createActionTo$message

public Object at$createActionTo$message(long tVal,
                                        Object target,
                                        Selector aSel,
                                        Object arg1,
                                        Object arg2,
                                        Object arg3)

at$createActionForEach$message

public Object at$createActionForEach$message(long tVal,
                                             Object target,
                                             Selector aSel)

at$createActionForEach$message

public Object at$createActionForEach$message(long tVal,
                                             Object target,
                                             Selector aSel,
                                             Object arg1)

at$createActionForEach$message

public Object at$createActionForEach$message(long tVal,
                                             Object target,
                                             Selector aSel,
                                             Object arg1,
                                             Object arg2)

at$createActionForEach$message

public Object at$createActionForEach$message(long tVal,
                                             Object target,
                                             Selector aSel,
                                             Object arg1,
                                             Object arg2,
                                             Object arg3)

remove

public Object remove(Object anAction)
Remove action from either schedule or concurrent group.

insertGroup

public Object insertGroup(Object aKey)

setKeepEmptyFlag

public Object setKeepEmptyFlag(boolean keepEmptyFlag)
Indicate whether an empty schedule should be dropped and ignored or or kept and attended to (default is YES).