plugins/org.eclipse.papyrus.moka.pssm/src/org/eclipse/papyrus/moka/pssm/statemachines/DeepHistoryPseudostateActivation.java

/*****************************************************************************
 * Copyright (c) 2016 CEA LIST.
 *
 *
 * 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.pssm.statemachines;


import org.eclipse.papyrus.moka.fuml.commonbehavior.IEventOccurrence;
import org.eclipse.papyrus.moka.pssm.statemachines.IRegionActivation;
import org.eclipse.papyrus.moka.pssm.statemachines.IStateActivation;
import org.eclipse.papyrus.moka.pssm.statemachines.ITransitionActivation;
import org.eclipse.uml2.uml.Vertex;

public class DeepHistoryPseudostateActivation extends HistoryPseudostateActivation {
	
	protected boolean canRestore(IStateActivation stateActivation){
		// A state activation can only be restored if it is directly or indirectly
		// by the region containing the history state.
		boolean canRestore = false;
		if(stateActivation != null){
			RegionActivation historyRegion = (RegionActivation) this.getParent(); 
			if(historyRegion.getVertexActivation((Vertex)stateActivation.getNode()) != null){
				canRestore = true;
			}
		}
		return canRestore;
	}
	
	public void restore(IRegionActivation regionActivation, ITransitionActivation enteringTransition, IEventOccurrence eventOccurrence){
		// Restore the execution of a Region. 
		// If the Region restored is the region which contained
		// the deep history then two executions are possible:
		// 1. If the restored region has already been entered then its last known configuration 
		//    (i.e. active state) is restored.
		// 2. If the restored region has never been entered then if the deep history has an outgoing
		//    transition then this transition is fired to force the entrance of the target state.
		// If the region restored is not the region which contains the deep history then
		// two execution are possible:
		// 1. If the region already has an history then this history is restored
		// 2. If the region has no history then it is entered using the implicit rule.
		regionActivation.setCompleted(false);
		if(regionActivation == this.getParent()){
			if(regionActivation.getHistory() != null){
				this.restore(regionActivation.getHistory(), enteringTransition, eventOccurrence);
			}else{
				if(this.hasDefaultTransition()){
					this.outgoingTransitionActivations.get(0).fire(eventOccurrence);
				}
			}
		}else{
			if(this.canRestore(regionActivation.getHistory())){
				this.restore(regionActivation.getHistory(), enteringTransition, eventOccurrence);
			}else{
				regionActivation.enter(enteringTransition, eventOccurrence);
			}
		}	
	}
}