PapaBench.java example

Explorer
jop-master
/* $Id$
 * 
 * This file is a part of jPapaBench providing a Java implementation 
 * of PapaBench project.
 * Copyright (C) 2010  Michal Malohlava <michal.malohlava_at_d3s.mff.cuni.cz>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * 
 */
package papabench.core;

import papabench.core.autopilot.modules.AutopilotModule;
import papabench.core.commons.data.FlightPlan;
import papabench.core.commons.modules.Module;
import papabench.core.fbw.modules.FBWModule;

/**
 * Interface of PapaBench benchmark. 
 * 
 * It represents top-level module providing access to autopilot and fly-by-wire subsystems.
 * 
 * It should be also responsible by managing tasks of contained modules.
 * 
 * @author Michal Malohlava
 *
 */
public interface PapaBench extends Module {
	
	/**
	 * Returns autopilot module.
	 * 
	 * @return
	 */
	AutopilotModule getAutopilotModule();
	
	/**
	 * Returns fly-by-wire module.
	 * 
	 * @return
	 */
	FBWModule getFBWModule();
	
	/**
	 * Setup the mission flight-plan.
	 * 
	 * @param flightPlan
	 */
	void setFlightPlan(FlightPlan flightPlan);
	
	/**
	 * Shutdown running instance.
	 */
	void shutdown();
}