Interface of methods that should be implemented for agent classes that are involved in solute reactions. More...

Inheritance diagram for simulator.agent.HasReaction:

Public Member Functions
void	addActiveReaction (Reaction aReaction, boolean useDefaultParam)
	Add a previously declared reaction to the list that this agent is to participate in. More...

void	addReaction (Reaction aReaction, boolean useDefaultParam)
	Add the details of a new reaction that a particular agent is to participate in. More...

void	removeReaction (Reaction aPathway)
	Remove a reaction from those that the agent is involved in. More...

void	switchOffreaction (Reaction aPathway)
	Switches off a particular reaction this agent is involved in but does not delete it from reaction list. More...

void	switchOnReaction (Reaction aPathway)
	Switches on a particular reaction this agent is involved in. Must have been previously declared. More...

Detailed Description

Interface of methods that should be implemented for agent classes that are involved in solute reactions.

Interface of methods that should be implemented for agent classes that are involved in solute reactions

Member Function Documentation

void simulator.agent.HasReaction.addActiveReaction	(	Reaction	aReaction,
		boolean	useDefaultParam
	)

Add a previously declared reaction to the list that this agent is to participate in.

Add a previously declared reaction to the list that this agent is to participate in

Parameters

aReaction	The reaction object that this agent will participate with
useDefaultParam	Whether or not the default reaction parameters should be used in this reaction

void simulator.agent.HasReaction.addReaction	(	Reaction	aReaction,
		boolean	useDefaultParam
	)

Add the details of a new reaction that a particular agent is to participate in.

Add the details of a new reaction that a particular agent is to participate in

Parameters

aReaction	The reaction object that this agent will participate with
useDefaultParam	Whether or not the default reaction parameters should be used in this reaction

void simulator.agent.HasReaction.removeReaction ( Reaction aPathway )

Remove a reaction from those that the agent is involved in.

Remove a reaction from those that the agent is involved in

Parameters

aPathway Reaction that this agent should no longer participate in

void simulator.agent.HasReaction.switchOffreaction ( Reaction aPathway )

Switches off a particular reaction this agent is involved in but does not delete it from reaction list.

Switches off a particular reaction this agent is involved in but does not delete it from reaction list

Parameters

aPathway The reaction object that should be switched off

void simulator.agent.HasReaction.switchOnReaction ( Reaction aPathway )

Switches on a particular reaction this agent is involved in. Must have been previously declared.

Switches on a particular reaction this agent is involved in. Must have been previously declared

Parameters

aPathway The reaction object that should be switched on

The documentation for this interface was generated from the following file: