/* Static schedule for CT domain.
Copyright (c) 1998-2008 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.domains.ct.kernel;
import java.util.Iterator;
import ptolemy.actor.sched.Schedule;
import ptolemy.kernel.util.NamedObj;
//////////////////////////////////////////////////////////////////////////
//// CTSchedule
/**
A static schedule for CT models. This class overrides the base class and
uses an ArrayList implementation for the first level of the schedule, so
that accessing subschedules takes constant time. A CT schedule is an
array of schedules. The array always has length X, consisting of the
following entries in that order (in a type-safe enumeration),
<pre>
CONTINUOUS_ACTORS
DISCRETE_ACTORS
DYNAMIC_ACTORS
EVENT_GENERATORS
OUTPUT_ACTORS
OUTPUT_STEP_SIZE_CONTROL_ACTORS
STATE_TRANSITION_ACTORS
STATEFUL_ACTORS
STATE_STEP_SIZE_CONTROL_ACTORS
WAVEFORM_GENERATORS
</pre>
Each entry is a schedule. Actors in the schedule are ordered according
to the order they should be executed.
<P>
A typical use of this schedule is to get one of the above schedules.
For example, to schedule an execution of dynamic actor schedule,
(assume we have a CTScheduler called scheduler) do:
<pre>
CTSchedule schedule = scheduler.getSchedule();
Iterator dynamicActorIterator =
schedule.get(CTSchedule.DYNAMIC_ACTOR_SCHEDULE).actorIterator();
</pre>
@author Jie Liu, Haiyang Zheng
@version $Id$
@since Ptolemy II 2.0
@Pt.ProposedRating Yellow (hyzheng)
@Pt.AcceptedRating Red (hyzheng)
*/
public class CTSchedule extends Schedule {
/** Construct a CTSchedule.
*/
public CTSchedule() {
super();
}
///////////////////////////////////////////////////////////////////
//// public variables ////
/** Index for actors in the continuous part of the system, not sorted.
*/
public final static int CONTINUOUS_ACTORS = 0;
/** Index for actors in the discrete part of the system,
* topologically ordered.
*/
public final static int DISCRETE_ACTORS = 1;
/** Index for dynamic actor schedule, in a topologically reverse order.
*/
public final static int DYNAMIC_ACTORS = 2;
/** Index for the schedule of actors that implement
* the CTEventGenerator interface, topologically ordered.
*/
public final static int EVENT_GENERATORS = 3;
/** Index for output schedule, topologically ordered.
*/
public final static int OUTPUT_ACTORS = 4;
/** Index for the schedule of actors that are in the output map and
* implement the CTStepSizeControlActor, not ordered.
*/
public final static int OUTPUT_STEP_SIZE_CONTROL_ACTORS = 5;
/** Index for state transition schedule, topologically sorted.
*/
public final static int STATE_TRANSITION_ACTORS = 6;
/** Index for the schedule of actors that implement the
* CTStatefulActor interface, not ordered.
*/
public final static int STATEFUL_ACTORS = 7;
/** Index for the schedule of actors that are in the state transition map
* and implement the CTStepSizeControlActor interface, not ordered.
*/
public final static int STATE_STEP_SIZE_CONTROL_ACTORS = 8;
/** Index for the schedule of actors that implement
* the CTWaveformGenerator interface, not ordered.
*/
public final static int WAVEFORM_GENERATORS = 9;
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Return all the scheduling information in a Sting.
* @return All the schedules.
*/
public String toString() {
//_schedule.ensureCapacitance();
StringBuffer result = new StringBuffer();
Iterator iterator;
result.append("CTSchedule {\n" + " continuousActors {\n");
Schedule continuous = (Schedule) get(CONTINUOUS_ACTORS);
iterator = continuous.actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " discreteActors {\n");
Schedule discrete = (Schedule) get(DISCRETE_ACTORS);
iterator = discrete.actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " dynamicActors {\n");
iterator = get(DYNAMIC_ACTORS).actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " stateStepSizeControlActors {\n");
iterator = get(STATE_STEP_SIZE_CONTROL_ACTORS).actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " outputStepSizeControlActors {\n");
iterator = get(OUTPUT_STEP_SIZE_CONTROL_ACTORS).actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " eventGenerators {\n");
iterator = get(EVENT_GENERATORS).actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " waveformGenerators {\n");
iterator = get(WAVEFORM_GENERATORS).actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " statefulActors {\n");
iterator = get(STATEFUL_ACTORS).actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " stateTransitionActors {\n");
iterator = get(STATE_TRANSITION_ACTORS).actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + " outputActors {\n");
iterator = get(OUTPUT_ACTORS).actorIterator();
while (iterator.hasNext()) {
result.append("\t" + ((NamedObj) iterator.next()).getFullName()
+ "\n");
}
result.append(" }\n" + "}\n");
return result.toString();
}
}