AvailableSubStateAbstract.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 class for substates of composite state 'Available'.
 */
public abstract class AvailableSubStateAbstract implements AcsState 
{
	protected final AlmaSubsystemContext m_superContext;

    // the nested state AvailableState serves as both state class and context class for its substates
    protected AvailableState m_context;

    public AvailableSubStateAbstract(AlmaSubsystemContext superContext, AvailableState context) {
        m_superContext = superContext;
        m_context = context;
    }

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


    public abstract void entry();

    // events to be dealt with by subclasses
    
    public void initPass1() throws AcsJIllegalStateEventEx {
		m_superContext.illegalEvent(stateName(), "initPass1");
    }

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

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

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

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

    
    // events handled by this base class 
    
    public void shutdownPass1() {
    	m_superContext.m_stateShuttingdownPass1.activate("shutdownPass1");
    }

    public void reinit() {		
    	m_superContext.m_stateReinitializing.activate("reinit");
    }

    public void error() {
		m_context.setSubstate(m_superContext.m_stateError, "error");
    }

}