package affectors;

import main.Node;
import main.Globals;

/** One half of a pair of affectors which recycles proteins from one state back to another.
Use this one in the pre-recycled state.  Use the B version in the recycled state.  The
recycling occurs at some fixed rate. This can be used for both
cytoplasmic and membrane-bound proteins.  DOES NOT substitute for the Dissociation_Aff pair
unless you don't care about the ligand.

<p> <b>Formula</b>
<br>dNODEX/dt = -NODEX / H_NODEX

<p> <b>Parameters</b>
<table width="500" border="1">
<tr><td width="150"> Recyclee [NODEX]</td><td> The Node that is going to be recycled back to another Node. </td></tr>
<tr><td> Half-life [H_NODEX]</td><td> The time it takes for half of the recyclee node to be recycled. </td></tr>
</table>

<p> <b>Usage</b>
<code><font size = "3"><br>&NODEX
<blockquote>    &RecycleAAff  NODEX  H_NODEX </blockquote>
&endNODEX/code></font>
*/

public class RecycleAAff extends Affector	{
	/** The half-life in minutes for disappearance of the pre-recycled state. */
	int		halfLifeParam;

	static final String		desc = "Recycler; version A for recyclee";
	static final String	[]	nodeDescriptions = {"Recyclee"};
	static final String	[]	paramDescriptions = {"Half-life of recyclee"};
	static final int	[]	whichSides = {-1};
	
	public RecycleAAff()	{}
	
	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)
	{
		halfLifeParam = param_nums[0];
	}

	public float getValue(Node which_node)	{
		return -((Globals.characteristicTime / params[halfLifeParam]) * Nodes[0].getIntegrationValue(side));
	}
	
	public float getNCValue(Node which_node)  {
		return (-Globals.characteristicTime / params[halfLifeParam]);
	}

}