AlmaSubsystemStateAbstract.java

/*******************************************************************************
 * ALMA - Atacama Large Millimeter Array
 * Copyright (c) ESO - European Southern Observatory, 2011
 * (in the framework of the ALMA collaboration).
 * All rights reserved.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *******************************************************************************/
package alma.ACS.MasterComponentImpl.statemachine;

import alma.ACSErrTypeCommon.wrappers.AcsJIllegalStateEventEx;
import alma.acs.genfw.runtime.sm.AcsState;

/**
 * Abstract state class. Concrete subclass receives delegation calls from the
 * SM's super context class.
 */
public abstract class AlmaSubsystemStateAbstract implements AcsState 
{
	protected AlmaSubsystemContext m_superContext;

	public AlmaSubsystemStateAbstract(AlmaSubsystemContext superContext) {
		m_superContext = superContext;
	}

	public abstract AcsState[] getStateHierarchy();
	public abstract String stateName();

	// all events that the master component can handle
	// make all events illegal here, and let subclasses allow certain events 

	public void stop() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "stop");
	}

	public void shutdownPass1() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "shutdownPass1");
	}

	public void initPass2() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "initPass2");
	}

	public void start() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "start");
	}

	public void initPass1() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "initPass1");
	}

	public void shutdownPass2() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "shutdownPass2");
	}

	public void reinit() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "reinit");
	}

	public void error() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "error");
	}

	public abstract void entry();

	public void exit() {
	}

}