blob: bfd835d840da09a3904bc37326ff6f6934c52542 [file] [log] [blame]
package ca.gc.asc_csa.apogy.addons;
/*
* Copyright (c) 2016 Canadian Space Agency (CSA) / Agence spatiale canadienne (ASC).
* 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
*
* Contributors:
* Pierre Allard (Pierre.Allard@canada.ca),
* Regent L'Archeveque (Regent.Larcheveque@canada.ca),
* Sebastien Gemme (Sebastien.Gemme@canada.ca),
* Canadian Space Agency (CSA) - Initial API and implementation
*/
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Simple Tool</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link ca.gc.asc_csa.apogy.addons.SimpleTool#getToolList <em>Tool List</em>}</li>
* <li>{@link ca.gc.asc_csa.apogy.addons.SimpleTool#isActive <em>Active</em>}</li>
* <li>{@link ca.gc.asc_csa.apogy.addons.SimpleTool#isDisposed <em>Disposed</em>}</li>
* <li>{@link ca.gc.asc_csa.apogy.addons.SimpleTool#isInitialized <em>Initialized</em>}</li>
* </ul>
*
* @see ca.gc.asc_csa.apogy.addons.ApogyAddonsPackage#getSimpleTool()
* @model abstract="true"
* @generated
*/
public interface SimpleTool extends AbstractTool {
/**
* Returns the value of the '<em><b>Tool List</b></em>' container reference.
* It is bidirectional and its opposite is '{@link ca.gc.asc_csa.apogy.addons.SimpleToolList#getSimpleTools <em>Simple Tools</em>}'.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Tool List</em>' container reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* *
* The SimpleToolList containing the tool.
* <!-- end-model-doc -->
* @return the value of the '<em>Tool List</em>' container reference.
* @see #setToolList(SimpleToolList)
* @see ca.gc.asc_csa.apogy.addons.ApogyAddonsPackage#getSimpleTool_ToolList()
* @see ca.gc.asc_csa.apogy.addons.SimpleToolList#getSimpleTools
* @model opposite="simpleTools" transient="false"
* annotation="http://www.eclipse.org/emf/2002/GenModel notify='false' children='false' property='None'"
* @generated
*/
SimpleToolList getToolList();
/**
* Sets the value of the '{@link ca.gc.asc_csa.apogy.addons.SimpleTool#getToolList <em>Tool List</em>}' container reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Tool List</em>' container reference.
* @see #getToolList()
* @generated
*/
void setToolList(SimpleToolList value);
/**
* Returns the value of the '<em><b>Active</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Active</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* *
* Whether or not the tool is active.
* <!-- end-model-doc -->
* @return the value of the '<em>Active</em>' attribute.
* @see #setActive(boolean)
* @see ca.gc.asc_csa.apogy.addons.ApogyAddonsPackage#getSimpleTool_Active()
* @model default="false" unique="false" transient="true"
* @generated
*/
boolean isActive();
/**
* Sets the value of the '{@link ca.gc.asc_csa.apogy.addons.SimpleTool#isActive <em>Active</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Active</em>' attribute.
* @see #isActive()
* @generated
*/
void setActive(boolean value);
/**
* Returns the value of the '<em><b>Disposed</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Disposed</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* *
* Whether or not the tool is disposed.
* <!-- end-model-doc -->
* @return the value of the '<em>Disposed</em>' attribute.
* @see #setDisposed(boolean)
* @see ca.gc.asc_csa.apogy.addons.ApogyAddonsPackage#getSimpleTool_Disposed()
* @model default="false" unique="false" transient="true"
* annotation="http://www.eclipse.org/emf/2002/GenModel property='Readonly'"
* @generated
*/
boolean isDisposed();
/**
* Sets the value of the '{@link ca.gc.asc_csa.apogy.addons.SimpleTool#isDisposed <em>Disposed</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Disposed</em>' attribute.
* @see #isDisposed()
* @generated
*/
void setDisposed(boolean value);
/**
* Returns the value of the '<em><b>Initialized</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* *
* Whether or not the tool is initialized.
* <!-- end-model-doc -->
* @return the value of the '<em>Initialized</em>' attribute.
* @see #setInitialized(boolean)
* @see ca.gc.asc_csa.apogy.addons.ApogyAddonsPackage#getSimpleTool_Initialized()
* @model default="false" unique="false" transient="true"
* annotation="http://www.eclipse.org/emf/2002/GenModel property='None'"
* @generated
*/
boolean isInitialized();
/**
* Sets the value of the '{@link ca.gc.asc_csa.apogy.addons.SimpleTool#isInitialized <em>Initialized</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Initialized</em>' attribute.
* @see #isInitialized()
* @generated
*/
void setInitialized(boolean value);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* *
* Method called when the tool is added to its toolList.
* <!-- end-model-doc -->
* @model
* @generated
*/
void initialise();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* *
* Method called when the tool is remove from its toolList.
* <!-- end-model-doc -->
* @model
* @generated
*/
void dispose();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* *
* Method called when the Variables are instantiated.
* <!-- end-model-doc -->
* @model
* @generated
*/
void variablesInstantiated();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* *
* Method called when the Variables are cleared.
* <!-- end-model-doc -->
* @model
* @generated
*/
void variablesCleared();
} // SimpleTool