/* An SDF test actor.
Copyright (c) 1998-2006 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.sdf.kernel.test;
import ptolemy.actor.lib.Transformer;
import ptolemy.data.IntToken;
import ptolemy.data.expr.Parameter;
import ptolemy.domains.sdf.kernel.SDFDirector;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.kernel.util.Workspace;
//////////////////////////////////////////////////////////////////////////
//// SDFTestZeroRate1
/**
A test actor for HDF/SDF. This actor contains parameters that make it
easy to set the rates of the input and output ports. This actor
simply discards whatever it reads in and outputs the contents of
the <i>value</i> parameter.
@author Brian K. Vogel
@version $Id: SDFTestZeroRate1.java,v 1.31 2006/02/07 00:46:22 cxh Exp $
@since Ptolemy II 2.0
@Pt.ProposedRating Red (vogel)
@Pt.AcceptedRating Red (vogel)
*/
public class SDFTestZeroRate1 extends Transformer {
/** Construct an actor with the given container and name.
* @param container The container.
* @param name The name of this actor.
* @exception IllegalActionException If the actor cannot be contained
* by the proposed container.
* @exception NameDuplicationException If the container already has an
* actor with this name.
*/
public SDFTestZeroRate1(CompositeEntity container, String name)
throws NameDuplicationException, IllegalActionException {
super(container, name);
value = new Parameter(this, "value", new IntToken(1));
input_rate1 = new Parameter(this, "input_rate1", new IntToken(1));
input_tokenConsumptionRate = new Parameter(input,
"tokenConsumptionRate");
input_tokenConsumptionRate.setExpression("input_rate1");
output_rate1 = new Parameter(this, "output_rate1", new IntToken(1));
output_tokenProductionRate = new Parameter(output,
"tokenProductionRate");
output_tokenProductionRate.setExpression("output_rate1");
// Set the type constraint.
output.setTypeAtLeast(value);
}
///////////////////////////////////////////////////////////////////
//// ports and parameters ////
/** The value produced by this constant source.
* By default, it contains an IntToken with value 1. If the
* type of this token is changed during the execution of a model,
* then the director will be asked to redo type resolution.
*/
public Parameter value;
public Parameter input_rate1;
public Parameter output_rate1;
public Parameter input_tokenConsumptionRate;
public Parameter output_tokenProductionRate;
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Clone the actor into the specified workspace. This calls the
* base class and then sets the type constraints.
* @param workspace The workspace for the new object.
* @return A new actor.
* @exception CloneNotSupportedException If a derived class has
* an attribute that cannot be cloned.
*/
public Object clone(Workspace workspace) throws CloneNotSupportedException {
SDFTestZeroRate1 newObject = (SDFTestZeroRate1) super.clone(workspace);
// Set the type constraint.
newObject.output.setTypeAtLeast(newObject.value);
return newObject;
}
/** Discard tokens received. Send the token in the value parameter.
* @exception IllegalActionException If there is no director.
*/
public void fire() throws IllegalActionException {
for (int i = 0; i < ((IntToken) input_rate1.getToken()).intValue(); i++) {
input.get(0);
}
for (int i = 0; i < ((IntToken) output_rate1.getToken()).intValue(); i++) {
output.send(0, value.getToken());
}
}
/**
* for debugging only...
*
* @exception IllegalActionException If a derived class throws it.
*/
public void initialize() throws IllegalActionException {
super.initialize();
// debug sdf schedules:
SDFDirector dir = (SDFDirector) getDirector();
/*SDFScheduler scheduler = (SDFScheduler)*/dir.getScheduler();
// For debugging the SDF scheduler...
//StreamListener sa = new StreamListener();
//scheduler.addDebugListener(sa);
//
// Get the SDF Director's scheduler.
// Scheduler s = dir.getScheduler();
//Iterator allActors = s.getSchedule().actorIterator();
//while (allActors.hasNext()) {
// Actor actor = (Actor)allActors.next();
// String schedActName = ((Nameable)actor).getName();
// System.out.println("Actor in scheduler: " + schedActName);
//}
}
///////////////////////////////////////////////////////////////////
//// private variables ////
}