package affectors;

import main.Globals;
import main.Node;

/**This is the other half of a membrane-bound dimerization reaction where one single Node resides
in one cell and the other single Node resides in a neighboring cell. All Nodes, including
the dimer, must be membrane-bound. Use this affector in the dimer Node. Use the A version
in each of the undimerized nodes.  
The node_scale (max) for each of the singleton proteins is the scaling
factor for the >other< singleton.

<p> <b>Formula</b>
<br>dDIMER/dt = r * max * SINGLE_NODE1 * SINGLE_NODE2

<p> <b>Parameters</b>
<table width="500" border="1">
<tr><td width="150">Membrane Node [SINGLE_NODE1]</td><td> The undimerized Node that is in the same membrane as the dimer </td></tr>
<tr><td width="150">Cytoplasmic Node [SINGLE_NODE2]</td><td> The undimerized Node that is in the opposite membrane from the dimer</td></tr>
<tr><td>Dimerization rate [r_DIMER]</td><td> The rate of the dimerization reaction.</td></tr>
<tr><td>Maximum Cyto [max]</td><td> The maximum relative concentration of the >other< undimerized Node.</td></tr>
</table>

<p> <b>Usage</b>
<code><font size = "3"><br>&DIMER
<blockquote>    &DimerizeCrossMembrane_BAff  SINGLE_NODE1  SINGLE_NODE2	r_DIMER	max
</blockquote>
&endDIMER</code></font>
*/

public class DimerizeCrossMembrane_BAff extends Affector {
	/** The rate of the dimerization reaction. */
	int			kParam;
	/** The scaling factor of the other undimerized node in this reaction (i.e. max for second input node). */
	int			nodeScaleParam;

	static final String		desc = "Dimerize membrane-bound nodes; version B for dimer";
	static final String	[]	nodeDescriptions = {"Most-similar node", "Other node"};
	static final String	[]	paramDescriptions = {"Second-order reaction rate constant",
										"Scale factor (max value) for other node"};
	static final int	[]	whichSides = {-1, 1};
	
	public DimerizeCrossMembrane_BAff()	{}
	
	protected void setLabelsAndTypes()	{
		setDescriptions(this.desc, nodeDescriptions, paramDescriptions);
		setSided(true, whichSides);

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