public class Schedule extends ScheduleElement
Each element of the schedule is represented by an instance of the ScheduleElement class. Each element may correspond to a number of firings of a single firing element (represented by the Firing class) or an entire sub-schedule (represented by a hierarchically contained instance of this class). This nesting allows this concise representation of looped schedules. The nesting can be arbitrarily deep, but must be a tree where the leaf nodes represent firings. It is up to the scheduler to enforce this requirement.
The add() and remove() methods are used to add or remove schedule elements. Only elements of type ScheduleElement (Schedule or Firing) may be added to the schedule list. The iteration count is set by the setIterationCount() method. If this method is not invoked, a default value of one will be used.
As an example, suppose that we have an SDF graph containing actors A, B, C, and D, with the firing order ABCBCBCDD. This firing order can be represented by a simple looped schedule. The code to create this schedule appears below.
Schedule S = new Schedule();
Firing S1 = new Firing();
Schedule S2 = new Schedule();
Firing S3 = new Firing();
S.add(S1);
S.add(S2);
S.add(S3);
S1.setFiringElement(A);
S2.setIterationCount(3);
Firing S2_1 = new Firing();
Firing S2_2 = new Firing();
S2_1.setFiringElement(B);
S2_2.setFiringElement(C);
S2.add(S2_1);
S2.add(S2_2);
S3.setIterationCount(2);
S3.setFiringElement(D);
Note that this implementation is not synchronized. It is therefore not safe for a thread to make modifications to the schedule structure while multiple threads are concurrently accessing the schedule.
Firing,
Schedule,
ScheduleElement| red (ssb) |
| red (shahrooz) |
| Modifier and Type | Field and Description |
|---|---|
protected java.util.List |
_schedule
The list of schedule elements contained by this schedule.
|
_parent| Constructor and Description |
|---|
Schedule()
Construct a schedule with iteration count of one and an
empty schedule list.
|
Schedule(java.lang.Class firingElementClass)
Construct a schedule with iteration count of one and an
empty schedule list.
|
| Modifier and Type | Method and Description |
|---|---|
void |
add(int index,
ScheduleElement element)
Insert the specified schedule element at the specified position in
the schedule list.
|
void |
add(ScheduleElement element)
Append the specified schedule element to the end of the schedule
list.
|
int |
appearanceCount(java.lang.Object firingElement)
The number of times the given firing element appears in the
schedule.
|
java.util.Iterator |
firingElementIterator()
Return the firing element invocation sequence of the schedule in the
form of a sequence of firing elements.
|
java.util.Iterator |
firingIterator()
Return the Firing invocation sequence of this schedule in the form
of a sequence of firings.
|
java.util.List |
firings(java.lang.Object firingElement)
Get firings for the firing element.
|
ScheduleElement |
get(int index)
Return the element at the specified position in the list.
|
java.util.Iterator |
iterator()
Return an iterator over the schedule elements of this schedule.
|
java.util.List |
lexicalOrder()
Get the lexical order of firing elements.
|
int |
maxAppearanceCount()
Get the maximum appearance counts of all firing elements in
the schedule.
|
ScheduleElement |
remove(int index)
Remove the schedule element at the specified position in the
schedule list.
|
int |
size()
Return the number of elements in this list.
|
java.lang.String |
toParenthesisString(java.util.Map nameMap,
java.lang.String delimiter)
Print the schedule in a nested parenthesis style.
|
java.lang.String |
toString()
Output a string representation of this Schedule.
|
_getVersion, _incrementVersion, firingElementClass, getIterationCount, getParent, setIterationCount, setParent, toParenthesisStringprotected java.util.List _schedule
public Schedule()
public Schedule(java.lang.Class firingElementClass)
ScheduleElements containing firing elements of the given class
would only be accepted as next elements for this schedule.firingElementClass - The given class type.public void add(ScheduleElement element)
element - The schedule element to add.public void add(int index,
ScheduleElement element)
index - The index at which the specified element is to be
inserted.element - The schedule element to add.java.lang.IndexOutOfBoundsException - If the specified index is out of
range (index < 0 || index > size()).public int appearanceCount(java.lang.Object firingElement)
firingElement - The given firing element.public java.util.Iterator firingElementIterator()
A runtime exception is thrown if the underlying schedule structure is modified while the iterator is active.
firingElementIterator in class ScheduleElementjava.util.ConcurrentModificationException - If the
underlying schedule structure is modified while the iterator
is active.public java.util.Iterator firingIterator()
A runtime exception is thrown if the underlying schedule structure is modified while the iterator is active.
Implementation note: This method is optimized to be memory efficient. It walks the schedule tree structure as the iterator methods are invoked.
firingIterator in class ScheduleElementjava.util.ConcurrentModificationException - If the
underlying schedule structure is modified while the iterator
is active.public java.util.List firings(java.lang.Object firingElement)
firingElement - The given firing element.public ScheduleElement get(int index)
index - The index of the element to return.public java.util.Iterator iterator()
A runtime exception is thrown if the underlying schedule structure is modified while the iterator is active.
java.util.ConcurrentModificationException - If the
underlying schedule structure is modified while the iterator
is active.public java.util.List lexicalOrder()
java.lang.IllegalStateException - If this is not a single
appearance schedule.public int maxAppearanceCount()
public ScheduleElement remove(int index)
index - The index of the schedule element to be removed.public int size()
public java.lang.String toParenthesisString(java.util.Map nameMap,
java.lang.String delimiter)
ScheduleElement.toParenthesisString(Map, String).toParenthesisString in class ScheduleElementnameMap - The map from firing elements to their short names.delimiter - The delimiter between iterands.public java.lang.String toString()
toString in class java.lang.Object