org.simulator.sbml

Class SBMLEventInProgress

java.lang.Object

org.simulator.math.odes.EventInProgress

org.simulator.sbml.SBMLEventInProgress

Direct Known Subclasses:

SBMLEventInProgressWithDelay

public class SBMLEventInProgress
extends EventInProgress

This class represents a compilation of all information calculated during simulation concerning events in SBML. It can also contain the math of the trigger, the priority and the delay.

Since:

0.9

Version:

$Rev$

Author:

Alexander Dörr

Constructor Summary

Constructors

Constructor and Description
SBMLEventInProgress(boolean fired) Creates a new EventInProcess with the given boolean value indicating whether or not it can fire at the initial time point.

Method Summary

Modifier and Type	Method and Description
void	addRuleObject(AssignmentRuleValue assignmentRuleObject) Adds the math of an assignment rule as an AssignmentRuleObject.
void	changePriority(double priority) Change the priority.
void	clearRuleObjects() Clears the assignment rule objects.
ASTNodeValue	getDelayObject()
int	getNumEventAssignments()
boolean	getPersistent()
Double	getPriority() Return the priority of the associated event.
ASTNodeValue	getPriorityObject()
List<AssignmentRuleValue>	getRuleObjects()
ASTNodeValue	getTriggerObject()
boolean	getUseValuesFromTriggerTime() Returns true if the values of the assignments are calculated at the trigger time of the event, otherwise false.
void	refresh(boolean fired)
void	setDelayObject(ASTNodeValue delayObject) Sets the math of the delay to a specific ASTNodeObject.
void	setPersistent(boolean persistent) Sets the persistent flag of the event.
void	setPriorityObject(ASTNodeValue priorityObject) Sets the math of the priority to a specific ASTNodeObject.
void	setTriggerObject(ASTNodeValue triggerObject) Sets the math of the trigger to a specific ASTNodeObject.
void	setUseValuesFromTriggerTime(boolean useValuesFromTriggerTime) Sets the useValuesFromTriggerTime value of the event.

Methods inherited from class org.simulator.math.odes.EventInProgress

aborted, addAssignment, addValues, clearAssignments, executed, fired, getAssignments, getFireStatus, getLastTimeExecuted, getLastTimeFired, getTime, getValues, hasExecutionTime, hasMoreAssignments, recovered, refresh

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SBMLEventInProgress

public SBMLEventInProgress(boolean fired)

Creates a new EventInProcess with the given boolean value indicating whether or not it can fire at the initial time point.

Parameters:

fired -

Method Detail

refresh

public void refresh(boolean fired)

Overrides:

refresh in class EventInProgress

changePriority

public void changePriority(double priority)

Change the priority.

Parameters:

priority -

getPriority

public Double getPriority()

Return the priority of the associated event.

Returns:

priority

setTriggerObject

public void setTriggerObject(ASTNodeValue triggerObject)

Sets the math of the trigger to a specific ASTNodeObject.

Parameters:

triggerObject -

getTriggerObject

public ASTNodeValue getTriggerObject()

Returns:

the trigger object of the event as an ASTNodeObject

setPriorityObject

public void setPriorityObject(ASTNodeValue priorityObject)

Sets the math of the priority to a specific ASTNodeObject.

Parameters:

priorityObject -

getPriorityObject

public ASTNodeValue getPriorityObject()

Returns:

priorityObject the priority object of the event as an ASTNodeObject

setDelayObject

public void setDelayObject(ASTNodeValue delayObject)

Sets the math of the delay to a specific ASTNodeObject.

Parameters:

delayObject -

getDelayObject

public ASTNodeValue getDelayObject()

Returns:

delayObject the delay object of the event as an ASTNodeObject (null if there is no delay)

addRuleObject

public void addRuleObject(AssignmentRuleValue assignmentRuleObject)

Adds the math of an assignment rule as an AssignmentRuleObject.

Parameters:

assignmentRuleObject -

getRuleObjects

public List<AssignmentRuleValue> getRuleObjects()

Returns:

ruleObjects the list of the assignment rules as AssignmentRuleObjects

getUseValuesFromTriggerTime

public boolean getUseValuesFromTriggerTime()

Returns true if the values of the assignments are calculated at the trigger time of the event, otherwise false.

Returns:

useValuesFromTriggerTime

setUseValuesFromTriggerTime

public void setUseValuesFromTriggerTime(boolean useValuesFromTriggerTime)

Sets the useValuesFromTriggerTime value of the event.

Parameters:

useValuesFromTriggerTime -

getNumEventAssignments

public int getNumEventAssignments()

Returns:

numAssignments the number of assignments of the event

getPersistent

public boolean getPersistent()

Returns:

persistent? the persistent flag of the event.

setPersistent

public void setPersistent(boolean persistent)

Sets the persistent flag of the event.

Parameters:

persistent -

clearRuleObjects

public void clearRuleObjects()

Clears the assignment rule objects.