package affectors;

import main.Node;
import main.Globals;

/** Generalized rate-based conversion of one Node to another.  Use this version in
reactant node, use the "I" version in the product Node.  These Affectors can be used
for either intracellular or membrane-bound nodes as long as both participants reside
in the same cell and compartment. 

<p> <b>Formula</b>
<br>dREACTANT/dt = - REACTANT * r_REACTANT

<p> <b>Parameters</b>
<table width="500" border="1">
<tr><td width="150">Reactant [REACTANT]</td><td> The Node which is being converted to something else. </td></tr>
<tr><td> Product [PRODUCT]</td><td> The product of the conversion.</td></tr>
<tr><td> Conversion rate [H_REACTANT_PRODUCT]</td><td> The proportion of reactant converted to product per timestep</td></tr>
</table>

<p> <b>Usage</b>
<code><font size = "3"><br>&REACTANT
<blockquote>    &ConversionEAff  REACTANT	PRODUCT  r_REACTANT
</blockquote>
&endREACTANT</code></font>

<p>@see ConversionIAff
*/
public class ConversionEAff extends Affector	{	
	/** Rate of conversion, expressed as a first-order rate constant. */
	int		rateParam;
	
	static final String		desc = "Generalized conversion; version E for the Node that gets taken away from";
	static final String	[]	nodeDescriptions = {"Reactant", "Product"};
	static final String	[]	paramDescriptions = {"Rate of conversion"};
	static final int	[]	whichSides = { -1, -1 };
	
	public ConversionEAff()	{}

	protected void setLabelsAndTypes()	{
		setDescriptions(this.desc, nodeDescriptions, paramDescriptions);
		setSided(true, whichSides);
		setContainsTarget(true);

		this.Type[GUI_CAPABLE] = 1;
		this.Type[CERTIFICATION] = Affector.RETURNS_DERIV;
		this.Type[MATHTYPE] = Affector.HH;
		this.Type[TERMTYPE] = Affector.CONVERSION;
	}
	
	
	public void setParameterNumbers(int [] param_nums)
	{
		rateParam = param_nums[0];
	}
	
	public float getValue(Node which_node)	{
		return -Globals.characteristicTime * (params[rateParam]*Nodes[0].getIntegrationValue(side));
	}

	public float getNCValue(Node which_node)  {
		return -Globals.characteristicTime * (params[rateParam]);
	}	
}