package affectors;

import main.Node;
import main.Globals;

/** For exocytosis from an intracellular to a membrane-bound Node. Use this one in the Node
representing the intracellular compartment. Note that a separate Node is used for the
intracellular and the extracellular protein pools, even though the protein 
itself may be identical in both locations.

<p> <b>Formula</b>
<br>dI_NODEX/dt = -exo_NODEX * I_NODEX

<p> <b>Parameters</b>
<table width="500" border="1">
<tr><td width="150">Intracellular Node [I_NODEX]</td><td> The intracellular Node that is being exocytosed</td></tr>
<tr><td width="150">Extracellular Node [E_NODEX]</td><td> The extracellular Node representing the now membrane-bound protein</td></tr>
<tr><td>Exocytosis rate [exo_NODEX]</td><td> The rate at which Node is exocytosed.</td></tr>
</table>

<p> <b>Usage</b>
<code><font size = "3"><br>&I_NODEX
<blockquote>    &ExoIAff  I_NODEX  E_NODEX	exo_NODEX
</blockquote>
&endI_NODEX</code></font>

@see ExoEAff
*/
public class ExoIAff extends Affector	{
	/** Rate of exocytosis. */
	int		exoParam;

	static final String		desc = "Exocytosis; version I for the Node that gets exocytosed";
	static final String	[]	nodeDescriptions = {"Intracellular form", "Extracellular form"};
	static final String	[]	paramDescriptions = {"Rate of exocytosis"};
	
	public ExoIAff()	{}
	
	protected void setLabelsAndTypes()	{
		setDescriptions(this.desc, nodeDescriptions, paramDescriptions);
		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)
	{
		exoParam = param_nums[0];
	}
	
	public float getValue(Node which_node)	{
		return -Globals.characteristicTime * (params[exoParam]*Nodes[0].getIntegrationValue(0));
	}
	
	public float getNCValue(Node which_node)  {
		return -Globals.characteristicTime * (params[exoParam]);
	}	
}