org.eclipse.osbp.xtext.statemachine/emf-gen/org/eclipse/osbp/xtext/statemachine/Statemachine.java

/**
 * Copyright (c) 2011, 2017 - Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 *  All rights reserved. This program and the accompanying materials 
 *  are made available under the terms of the Eclipse Public License v1.0 
 *  which accompanies this distribution, and is available at 
 *  http://www.eclipse.org/legal/epl-v10.html 
 * 
 *  Based on ideas from Xtext, Xtend, Xcore
 *   
 *  Contributors:  
 *  		Christophe Loetz (Loetz GmbH&Co.KG) - Initial implementation 
 *  
 */
package org.eclipse.osbp.xtext.statemachine;

import org.eclipse.emf.common.util.EList;

import org.eclipse.osbp.xtext.functionlibrarydsl.FunctionLibraryStatemachineGroup;

/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Statemachine</b></em>'.
 * <!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link org.eclipse.osbp.xtext.statemachine.Statemachine#isDescription <em>Description</em>}</li>
 *   <li>{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getDescriptionValue <em>Description Value</em>}</li>
 *   <li>{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getFunctionGroup <em>Function Group</em>}</li>
 *   <li>{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getInitialEvent <em>Initial Event</em>}</li>
 *   <li>{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getInitialState <em>Initial State</em>}</li>
 *   <li>{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getEvents <em>Events</em>}</li>
 *   <li>{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getControls <em>Controls</em>}</li>
 *   <li>{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getStates <em>States</em>}</li>
 * </ul>
 * </p>
 *
 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine()
 * @model
 * @generated
 */
public interface Statemachine extends StatemachineBase {
	/**
	 * Returns the value of the '<em><b>Description</b></em>' attribute.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Description</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Description</em>' attribute.
	 * @see #setDescription(boolean)
	 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine_Description()
	 * @model unique="false"
	 * @generated
	 */
	boolean isDescription();

	/**
	 * Sets the value of the '{@link org.eclipse.osbp.xtext.statemachine.Statemachine#isDescription <em>Description</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Description</em>' attribute.
	 * @see #isDescription()
	 * @generated
	 */
	void setDescription(boolean value);

	/**
	 * Returns the value of the '<em><b>Description Value</b></em>' attribute.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Description Value</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Description Value</em>' attribute.
	 * @see #setDescriptionValue(String)
	 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine_DescriptionValue()
	 * @model unique="false"
	 * @generated
	 */
	String getDescriptionValue();

	/**
	 * Sets the value of the '{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getDescriptionValue <em>Description Value</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Description Value</em>' attribute.
	 * @see #getDescriptionValue()
	 * @generated
	 */
	void setDescriptionValue(String value);

	/**
	 * Returns the value of the '<em><b>Function Group</b></em>' reference.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Function Group</em>' reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Function Group</em>' reference.
	 * @see #setFunctionGroup(FunctionLibraryStatemachineGroup)
	 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine_FunctionGroup()
	 * @model
	 * @generated
	 */
	FunctionLibraryStatemachineGroup getFunctionGroup();

	/**
	 * Sets the value of the '{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getFunctionGroup <em>Function Group</em>}' reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Function Group</em>' reference.
	 * @see #getFunctionGroup()
	 * @generated
	 */
	void setFunctionGroup(FunctionLibraryStatemachineGroup value);

	/**
	 * Returns the value of the '<em><b>Initial Event</b></em>' reference.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Initial Event</em>' reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Initial Event</em>' reference.
	 * @see #setInitialEvent(StatemachineEvent)
	 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine_InitialEvent()
	 * @model
	 * @generated
	 */
	StatemachineEvent getInitialEvent();

	/**
	 * Sets the value of the '{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getInitialEvent <em>Initial Event</em>}' reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Initial Event</em>' reference.
	 * @see #getInitialEvent()
	 * @generated
	 */
	void setInitialEvent(StatemachineEvent value);

	/**
	 * Returns the value of the '<em><b>Initial State</b></em>' reference.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Initial State</em>' reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Initial State</em>' reference.
	 * @see #setInitialState(StatemachineState)
	 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine_InitialState()
	 * @model
	 * @generated
	 */
	StatemachineState getInitialState();

	/**
	 * Sets the value of the '{@link org.eclipse.osbp.xtext.statemachine.Statemachine#getInitialState <em>Initial State</em>}' reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Initial State</em>' reference.
	 * @see #getInitialState()
	 * @generated
	 */
	void setInitialState(StatemachineState value);

	/**
	 * Returns the value of the '<em><b>Events</b></em>' containment reference list.
	 * The list contents are of type {@link org.eclipse.osbp.xtext.statemachine.StatemachineEvent}.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Events</em>' containment reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Events</em>' containment reference list.
	 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine_Events()
	 * @model containment="true"
	 * @generated
	 */
	EList<StatemachineEvent> getEvents();

	/**
	 * Returns the value of the '<em><b>Controls</b></em>' containment reference list.
	 * The list contents are of type {@link org.eclipse.osbp.xtext.statemachine.StatemachineControl}.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Controls</em>' containment reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Controls</em>' containment reference list.
	 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine_Controls()
	 * @model containment="true"
	 * @generated
	 */
	EList<StatemachineControl> getControls();

	/**
	 * Returns the value of the '<em><b>States</b></em>' containment reference list.
	 * The list contents are of type {@link org.eclipse.osbp.xtext.statemachine.StatemachineState}.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>States</em>' containment reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>States</em>' containment reference list.
	 * @see org.eclipse.osbp.xtext.statemachine.StatemachineDSLPackage#getStatemachine_States()
	 * @model containment="true"
	 * @generated
	 */
	EList<StatemachineState> getStates();

} // Statemachine