ca.uqac.lif.ecp.statechart

Class IncrementVariableBy<T extends Event>

java.lang.Object

ca.uqac.lif.ecp.statechart.Action<T>

ca.uqac.lif.ecp.statechart.VariableAssignment<T,java.lang.Integer>

ca.uqac.lif.ecp.statechart.IncrementVariableBy<T>

Type Parameters:

T - The type of events in the statechart

public class IncrementVariableBy<T extends Event>
extends VariableAssignment<T,java.lang.Integer>

Action that increments a state variable by a fixed value. The corresponding state variable in the statechart must be of integer type.

Author:

Sylvain Hallé

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_increment The value to give to the variable
protected int	m_maxValue The maximum value the variable is allowed to take.

Fields inherited from class ca.uqac.lif.ecp.statechart.VariableAssignment

m_variableName

Constructor Summary

Constructors

Constructor and Description
IncrementVariableBy(java.lang.String var_name, int increment)
IncrementVariableBy(java.lang.String var_name, int increment, int max_value)

Method Summary

Modifier and Type	Method and Description
void	execute(T event, Transition<T> transition, Statechart<T> statechart) Executes the action
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_increment

protected final int m_increment

The value to give to the variable

m_maxValue

protected final int m_maxValue

The maximum value the variable is allowed to take. Attempting to increment the variable past this value will cause the action to fail, sending the statechart into the trash state.

Constructor Detail

IncrementVariableBy

public IncrementVariableBy(java.lang.String var_name,
                           int increment)

IncrementVariableBy

public IncrementVariableBy(java.lang.String var_name,
                           int increment,
                           int max_value)

Method Detail

execute

public void execute(T event,
                    Transition<T> transition,
                    Statechart<T> statechart)
             throws ActionException

Description copied from class: Action

Executes the action

Specified by:

execute in class Action<T extends Event>

Parameters:

event - The event that fires the transition to which this action is associated

transition - The transition to which this action is associated

statechart - The statechart this transition belongs to

Throws:

ActionException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object