package affectors;

import main.Node;

/** This affector returns a constant value. Use it when you want a constant input
	to a Node.
	
<p> <b>Formula</b>
<br>dNODEX/dt = Constant

<p> <b>Parameters</b>
<table width="500" border="1">
<tr><td width="150">Input rate [in_nodex]</td><td> The amount of this Node being produced (or degraded) per timestep.</td></tr>
</table>

<p><b>Usage</b>
<code><font size = "3"><br>&nodex
<blockquote>	&ConstantInputAff	in_nodex
</blockquote>
&endnodex</code></font>
*/
public class ConstantInputAff extends Affector	{	
	/** The value returned by this affector. */
	int		inParam;
	
	static final String		desc = "Constant rate of production";
	static final String	[]	paramDescriptions = {"Input rate"};
	
	public ConstantInputAff()	{}

	protected void setLabelsAndTypes()	{
		setDescriptions(this.desc, null, paramDescriptions);

		this.Type[GUI_CAPABLE] = 1;
		this.Type[CERTIFICATION] = Affector.RETURNS_DERIV;
		this.Type[MATHTYPE] = Affector.CC;
		this.Type[TERMTYPE] = Affector.PRODUCTION;
	}
	
	
	public void setParameterNumbers(int [] param_nums)
	{
		inParam = param_nums[0];
	}
		
	public float getValue(Node which_node)	{
		return params[inParam];
	}
}