bundles/core/engines/org.eclipse.papyrus.moka.fuml.statemachines/src/org/eclipse/papyrus/moka/fuml/statemachines/Semantics/StateMachines/CompletionEventOccurrence.java

/*****************************************************************************
 * Copyright (c) 2015 CEA LIST and others.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *   Jeremie Tatibouet (CEA LIST)
 *   
 *****************************************************************************/

package org.eclipse.papyrus.moka.fuml.statemachines.Semantics.StateMachines;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.papyrus.moka.fuml.Semantics.Classes.Kernel.IReference;
import org.eclipse.papyrus.moka.fuml.Semantics.CommonBehaviors.BasicBehaviors.IParameterValue;
import org.eclipse.papyrus.moka.fuml.Semantics.impl.CommonBehaviors.Communications.EventOccurrence;
import org.eclipse.papyrus.moka.fuml.statemachines.interfaces.Semantics.CommonBehavior.ISM_ObjectActivation;
import org.eclipse.papyrus.moka.fuml.statemachines.interfaces.Semantics.StateMachines.ICompletionEventOccurrence;
import org.eclipse.papyrus.moka.fuml.statemachines.interfaces.Semantics.StateMachines.IStateActivation;
import org.eclipse.uml2.uml.Trigger;

public class CompletionEventOccurrence extends EventOccurrence implements ICompletionEventOccurrence {

	/*
	 * A completion event is a specific kind of event occurrence.
	 * 
	 * It is placed in the event pool of an active object under the following
	 * circumstances:
	 * 
	 * 1 - The state is simple. As soon as its entry behavior as well as its
	 * doActivity behavior finished a completion event is generated.
	 * 
	 * 2 - The state is composite. All internal activities (e.g., entry and
	 * doActivity Behaviors) have completed execution, and all its orthogonal
	 * Regions have reached a FinalState
	 * 
	 */

	// A reference to the state from which the completion event was generated
	public IStateActivation stateActivation;

	@Override
	public boolean matchAny(List<Trigger> triggers) {
		// A completion event can only trigger transition with no
		// trigger. Hence if the list of trigger that is passed is
		// empty then the completion event occurrence matches. It does match
		// otherwise.
		boolean match = false;
		if (triggers.size() == 0) {
			match = true;
		}
		return match;
	}

	@Override
	public boolean match(Trigger trigger) {
		// A completion event can only trigger transition with no
		// trigger. Hence it cannot match a trigger so false is returned
		// regardless the trigger provided as parameter.
		return false;
	}

	@Override
	public List<IParameterValue> getParameterValues() {
		// A completion will never have associated values. Hence a
		// empty list is returned.
		return new ArrayList<IParameterValue>();
	}

	@Override
	public void sendTo(IReference target) {
		// Do nothing - the completion event is not sent to a target.
		// It is registered during the RTC step of the active object that
		// entered the state from which it was generated.
	}

	@Override
	public void doSend() {
		// Do nothing - the completion event is not sent to a target.
		// It is registered during the RTC step of the active object that
		// entered the state from which it was generated.
	}

	public void register(IStateActivation stateActivation) {
		// Register this completion event occurrence in the event
		// pool of the context object.
		this.stateActivation = stateActivation;
		ISM_ObjectActivation objectActivation = (ISM_ObjectActivation) stateActivation
				.getExecutionContext().getObjectActivation();
		objectActivation.register(this);
	}

	@Override
	public IStateActivation getScope() {
		return this.stateActivation;
	}

	@Override
	public void setScope(IStateActivation stateActivation) {
		this.stateActivation = stateActivation;
	}

}