path: root/examples/org.eclipse.etrice.examples.dynamicactors1/src-gen/org/eclipse/etrice/examples/dynamicactors1/AC1.java

package org.eclipse.etrice.examples.dynamicactors1;

import org.eclipse.etrice.runtime.java.messaging.Address;
import org.eclipse.etrice.runtime.java.messaging.IRTObject;
import org.eclipse.etrice.runtime.java.messaging.IMessageReceiver;
import org.eclipse.etrice.runtime.java.modelbase.ActorClassBase;
import org.eclipse.etrice.runtime.java.modelbase.SubSystemClassBase;
import org.eclipse.etrice.runtime.java.modelbase.DataPortBase;
import org.eclipse.etrice.runtime.java.modelbase.InterfaceItemBase;
import org.eclipse.etrice.runtime.java.debugging.DebuggingService;
import static org.eclipse.etrice.runtime.java.etunit.EtUnit.*;


import org.eclipse.etrice.examples.dynamicactors1.PC.*;




public class AC1 extends ActorClassBase {

	
	//--------------------- ports
	protected PCPort p0 = null;
	protected PCConjPort hlp = null;
	
	//--------------------- saps
	
	//--------------------- services
	
	//--------------------- optional actors
	
	//--------------------- interface item IDs
	public static final int IFITEM_p0 = 1;
	public static final int IFITEM_hlp = 2;
	
	/*--------------------- attributes ---------------------*/
	/*--------------------- operations ---------------------*/

	//--------------------- construction
	public AC1(IRTObject parent, String name) {
		super(parent, name);
		setClassName("AC1");
		
		// initialize attributes

		// own ports
		p0 = new PCPort(this, "p0", IFITEM_p0);
		hlp = new PCConjPort(this, "hlp", IFITEM_hlp);
		
		// own saps
		
		// own service implementations
		
		// sub actors
		DebuggingService.getInstance().addMessageActorCreate(this, "helper");
		new AC3(this, "helper");
		
		// wiring
		InterfaceItemBase.connect(this, "helper/p0", "hlp");
		

	}
	
	/* --------------------- attribute setters and getters */
	
	
	//--------------------- port getters
	public PCPort getP0 (){
		return this.p0;
	}
	public PCConjPort getHlp (){
		return this.hlp;
	}

	//--------------------- lifecycle functions
	public void stop(){
		stopUser();
		super.stop();
	}
	
	public void destroy() {
		DebuggingService.getInstance().addMessageActorDestroy(this);
		super.destroy();
	}

	/* state IDs */
	public static final int STATE_Ready = 2;
	public static final int STATE_AskHelper = 3;
	public static final int STATE_MAX = 4;
	
	/* transition chains */
	public static final int CHAIN_TRANS_INITIAL_TO__Ready = 1;
	public static final int CHAIN_TRANS_tr0_FROM_Ready_TO_AskHelper_BY_sayHellop0 = 2;
	public static final int CHAIN_TRANS_tr1_FROM_AskHelper_TO_Ready_BY_hellohlp = 3;
	
	/* triggers */
	public static final int POLLING = 0;
	public static final int TRIG_hlp__hello = IFITEM_hlp + EVT_SHIFT*PC.OUT_hello;
	public static final int TRIG_p0__sayHello = IFITEM_p0 + EVT_SHIFT*PC.IN_sayHello;
	
	// state names
	protected static final String stateStrings[] = {
		"<no state>",
		"<top>",
		"Ready",
		"AskHelper"
	};
		
	// history
	protected int history[] = {NO_STATE, NO_STATE, NO_STATE, NO_STATE};
	
	private void setState(int new_state) {
		DebuggingService.getInstance().addActorState(this,stateStrings[new_state]);
		this.state = new_state;
	}
	
	/* Entry and Exit Codes */
	protected void entry_AskHelper() {
		hlp.sayHello();
	}
	
	/* Action Codes */
	protected void action_TRANS_tr1_FROM_AskHelper_TO_Ready_BY_hellohlp(InterfaceItemBase ifitem, String txt) {
		System.out.println("helper said "+txt);
		p0.hello("this is AC1, instance "+getInstancePath());
	}
	
	/**
	 * calls exit codes while exiting from the current state to one of its
	 * parent states while remembering the history
	 * @param current - the current state
	 * @param to - the final parent state
	 */
	private void exitTo(int current, int to) {
		while (current!=to) {
			switch (current) {
				case STATE_Ready:
					this.history[STATE_TOP] = STATE_Ready;
					current = STATE_TOP;
					break;
				case STATE_AskHelper:
					this.history[STATE_TOP] = STATE_AskHelper;
					current = STATE_TOP;
					break;
				default:
					/* should not occur */
					break;
			}
		}
	}
	
	/**
	 * calls action, entry and exit codes along a transition chain. The generic data are cast to typed data
	 * matching the trigger of this chain. The ID of the final state is returned
	 * @param chain - the chain ID
	 * @param generic_data - the generic data pointer
	 * @return the +/- ID of the final state either with a positive sign, that indicates to execute the state's entry code, or a negative sign vice versa
	 */
	private int executeTransitionChain(int chain, InterfaceItemBase ifitem, Object generic_data) {
		switch (chain) {
			case CHAIN_TRANS_INITIAL_TO__Ready:
			{
				return STATE_Ready;
			}
			case CHAIN_TRANS_tr0_FROM_Ready_TO_AskHelper_BY_sayHellop0:
			{
				return STATE_AskHelper;
			}
			case CHAIN_TRANS_tr1_FROM_AskHelper_TO_Ready_BY_hellohlp:
			{
				String txt = (String) generic_data;
				action_TRANS_tr1_FROM_AskHelper_TO_Ready_BY_hellohlp(ifitem, txt);
				return STATE_Ready;
			}
				default:
					/* should not occur */
					break;
		}
		return NO_STATE;
	}
	
	/**
	 * calls entry codes while entering a state's history. The ID of the final leaf state is returned
	 * @param state - the state which is entered
	 * @return - the ID of the final leaf state
	 */
	private int enterHistory(int state) {
		boolean skip_entry = false;
		if (state >= STATE_MAX) {
			state =  (state - STATE_MAX);
			skip_entry = true;
		}
		while (true) {
			switch (state) {
				case STATE_Ready:
					/* in leaf state: return state id */
					return STATE_Ready;
				case STATE_AskHelper:
					if (!(skip_entry)) entry_AskHelper();
					/* in leaf state: return state id */
					return STATE_AskHelper;
				case STATE_TOP:
					state = this.history[STATE_TOP];
					break;
				default:
					/* should not occur */
					break;
			}
			skip_entry = false;
		}
		/* return NO_STATE; // required by CDT but detected as unreachable by JDT because of while (true) */
	}
	
	public void executeInitTransition() {
		int chain = CHAIN_TRANS_INITIAL_TO__Ready;
		int next = executeTransitionChain(chain, null, null);
		next = enterHistory(next);
		setState(next);
	}
	
	/* receiveEvent contains the main implementation of the FSM */
	public void receiveEvent(InterfaceItemBase ifitem, int evt, Object generic_data) {
		int trigger = ifitem.getLocalId() + EVT_SHIFT*evt;
		int chain = NOT_CAUGHT;
		int catching_state = NO_STATE;
		
		if (!handleSystemEvent(ifitem, evt, generic_data)) {
			switch (getState()) {
				case STATE_Ready:
					switch(trigger) {
							case TRIG_p0__sayHello:
								{
									chain = CHAIN_TRANS_tr0_FROM_Ready_TO_AskHelper_BY_sayHellop0;
									catching_state = STATE_TOP;
								}
							break;
							default:
								/* should not occur */
								break;
					}
					break;
				case STATE_AskHelper:
					switch(trigger) {
							case TRIG_hlp__hello:
								{
									chain = CHAIN_TRANS_tr1_FROM_AskHelper_TO_Ready_BY_hellohlp;
									catching_state = STATE_TOP;
								}
							break;
							default:
								/* should not occur */
								break;
					}
					break;
				default:
					/* should not occur */
					break;
			}
		}
		if (chain != NOT_CAUGHT) {
			exitTo(getState(), catching_state);
			{
				int next = executeTransitionChain(chain, ifitem, generic_data);
				next = enterHistory(next);
				setState(next);
			}
		}
	}
};