samer@0: /*
samer@0:  *	Copyright (c) 2001, Samer Abdallah, King's College London.
samer@0:  *	All rights reserved.
samer@0:  *
samer@0:  *	This software is provided AS iS and WITHOUT ANY WARRANTY; 
samer@0:  *	without even the implied warranty of MERCHANTABILITY or 
samer@0:  *	FITNESS FOR A PARTICULAR PURPOSE.
samer@0:  */
samer@0: 
samer@0: package samer.tools;
samer@0: 
samer@0: /**
samer@0:   *		This is a task that runs a single child task
samer@0:   *		every N iterations, that is, at some integer
samer@0:   *      sub-multiple of the main loop rate
samer@0:   */
samer@0: 
samer@0: public class SubrateTask implements Task, java.io.Serializable
samer@0: {
samer@0: 	private Task	task;
samer@0: 	private int		factor;	// subrate factor
samer@0: 	private int		count;
samer@0: 
samer@0: 	protected SubrateTask() {}
samer@0: 	public SubrateTask(int f) { factor=f; }
samer@0: 	public SubrateTask(int f, Task t) { factor=f; task=t; count=factor; }
samer@0: 
samer@0: 	public int  getFactor() { return factor; }
samer@0: 	public void setFactor(int f) {
samer@0: 		factor=(f==0? 1 : f);	// at least 1
samer@0: 		if (count>factor) count=factor; // cut short current batch
samer@0: 	}
samer@0: 
samer@0: 	public void setTask(Task t) { task=t; }
samer@0: 	public Task getTask() { return task; }
samer@0: 
samer@0: 	public final void starting() { task.starting(); count=factor; }
samer@0: 	public final void stopping() { task.stopping(); }
samer@0: 	public final void run() throws Exception {
samer@0: 		if ((--count)<=0) { task.run(); count=factor; }
samer@0: 	}
samer@0: 
samer@0: 	public void dispose() { task.dispose(); }
samer@0: 	public String toString() { return "Subrate("+factor+"):"+task; }
samer@0: }