package affectors;

import main.Node;
import main.Globals;

/**
 * This is one half of an affector that dephosphorylates a single node assuming a constant
 * background phosphotase activity.  Use {@link DephosphorylateA_Aff} in the phosphorylated species.  Use this
 * version in the dephosphorylated species.  For cytoplasmic proteins.
 * <p>
 * <b>Formula</b>
 * <br>dNODEp/dt = -DMax * NODEp
 * <p>
 * <b>Parameters</b>
 * <table width="500" border="1">
 * <tr><td width="150">NODEp [NODEp]</td><td> The phosphorylated Node</td></tr>
 * <tr><td>Dmax [Dmax]</td><td> Rate of dephosphorylation.</td></tr>
 * </table>
 * <p>
 * <b>Usage</b>
 * <code><font size = "3"><br>&NODEp
 * <blockquote>
 * 		&DephosphorylateB_Aff	NODEp	Dmax
 * </blockquote>
 * &endNODEp</code></font>
 *
 * @author Kerry Kim
 * @see DephosphorylateA_Aff
 */

public class DephosphorylateB_Aff extends Affector {
	/** The rate of dephosphorylation. */
	int		dMax;
		
	static final String		desc = "Dephosphorylation of cytoplasmic protein, use version B for unphosphorylated";
	static final String	[]	nodeDescriptions = {"Phosphorylated protein"};
	static final String	[]	paramDescriptions = {"Rate of dephosphorylataion"};
	static final int	[]	whichSides = {-1};
	
	public DephosphorylateB_Aff()	{}

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

		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)
	{
		dMax = param_nums[0];
	}

	public float getValue(Node which_node)	{
		return Globals.characteristicTime *(Nodes[0].getIntegrationValue() * params[dMax]);
	}
}