blob: 958015712bca4035f33bcafa128c9ae0344e822a [file] [log] [blame]
/**
* Copyright (c) 2016 CEA LIST.
*
* 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:
* CEA LIST - Initial API and implementation
*/
package org.eclipse.papyrus.moka.fmi.modeldescription;
import org.eclipse.emf.ecore.EObject;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Real Type1</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getDisplayUnit <em>Display Unit</em>}</li>
* <li>{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getMax <em>Max</em>}</li>
* <li>{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getMin <em>Min</em>}</li>
* <li>{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getNominal <em>Nominal</em>}</li>
* <li>{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getQuantity <em>Quantity</em>}</li>
* <li>{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#isRelativeQuantity <em>Relative Quantity</em>}</li>
* <li>{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#isUnbounded <em>Unbounded</em>}</li>
* <li>{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getUnit <em>Unit</em>}</li>
* </ul>
*
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1()
* @model extendedMetaData="name='Real_._1_._type' kind='empty'"
* @generated
*/
public interface RealType1 extends EObject {
/**
* Returns the value of the '<em><b>Display Unit</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Default display unit, provided the conversion of values in "unit" to values in "displayUnit" is defined in UnitDefinitions / Unit / DisplayUnit.
* <!-- end-model-doc -->
* @return the value of the '<em>Display Unit</em>' attribute.
* @see #setDisplayUnit(String)
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1_DisplayUnit()
* @model dataType="org.eclipse.emf.ecore.xml.type.NormalizedString"
* extendedMetaData="kind='attribute' name='displayUnit' namespace='##targetNamespace'"
* @generated
*/
String getDisplayUnit();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getDisplayUnit <em>Display Unit</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Display Unit</em>' attribute.
* @see #getDisplayUnit()
* @generated
*/
void setDisplayUnit(String value);
/**
* Returns the value of the '<em><b>Max</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* max >= min required
* <!-- end-model-doc -->
* @return the value of the '<em>Max</em>' attribute.
* @see #isSetMax()
* @see #unsetMax()
* @see #setMax(double)
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1_Max()
* @model unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Double"
* extendedMetaData="kind='attribute' name='max' namespace='##targetNamespace'"
* @generated
*/
double getMax();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getMax <em>Max</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Max</em>' attribute.
* @see #isSetMax()
* @see #unsetMax()
* @see #getMax()
* @generated
*/
void setMax(double value);
/**
* Unsets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getMax <em>Max</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetMax()
* @see #getMax()
* @see #setMax(double)
* @generated
*/
void unsetMax();
/**
* Returns whether the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getMax <em>Max</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Max</em>' attribute is set.
* @see #unsetMax()
* @see #getMax()
* @see #setMax(double)
* @generated
*/
boolean isSetMax();
/**
* Returns the value of the '<em><b>Min</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Min</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Min</em>' attribute.
* @see #isSetMin()
* @see #unsetMin()
* @see #setMin(double)
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1_Min()
* @model unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Double"
* extendedMetaData="kind='attribute' name='min' namespace='##targetNamespace'"
* @generated
*/
double getMin();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getMin <em>Min</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Min</em>' attribute.
* @see #isSetMin()
* @see #unsetMin()
* @see #getMin()
* @generated
*/
void setMin(double value);
/**
* Unsets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getMin <em>Min</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetMin()
* @see #getMin()
* @see #setMin(double)
* @generated
*/
void unsetMin();
/**
* Returns whether the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getMin <em>Min</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Min</em>' attribute is set.
* @see #unsetMin()
* @see #getMin()
* @see #setMin(double)
* @generated
*/
boolean isSetMin();
/**
* Returns the value of the '<em><b>Nominal</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* nominal > 0.0 required
* <!-- end-model-doc -->
* @return the value of the '<em>Nominal</em>' attribute.
* @see #isSetNominal()
* @see #unsetNominal()
* @see #setNominal(double)
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1_Nominal()
* @model unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Double"
* extendedMetaData="kind='attribute' name='nominal' namespace='##targetNamespace'"
* @generated
*/
double getNominal();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getNominal <em>Nominal</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Nominal</em>' attribute.
* @see #isSetNominal()
* @see #unsetNominal()
* @see #getNominal()
* @generated
*/
void setNominal(double value);
/**
* Unsets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getNominal <em>Nominal</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetNominal()
* @see #getNominal()
* @see #setNominal(double)
* @generated
*/
void unsetNominal();
/**
* Returns whether the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getNominal <em>Nominal</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Nominal</em>' attribute is set.
* @see #unsetNominal()
* @see #getNominal()
* @see #setNominal(double)
* @generated
*/
boolean isSetNominal();
/**
* Returns the value of the '<em><b>Quantity</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Quantity</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Quantity</em>' attribute.
* @see #setQuantity(String)
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1_Quantity()
* @model dataType="org.eclipse.emf.ecore.xml.type.NormalizedString"
* extendedMetaData="kind='attribute' name='quantity' namespace='##targetNamespace'"
* @generated
*/
String getQuantity();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getQuantity <em>Quantity</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Quantity</em>' attribute.
* @see #getQuantity()
* @generated
*/
void setQuantity(String value);
/**
* Returns the value of the '<em><b>Relative Quantity</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* If relativeQuantity=true, offset for displayUnit must be ignored.
* <!-- end-model-doc -->
* @return the value of the '<em>Relative Quantity</em>' attribute.
* @see #isSetRelativeQuantity()
* @see #unsetRelativeQuantity()
* @see #setRelativeQuantity(boolean)
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1_RelativeQuantity()
* @model default="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Boolean"
* extendedMetaData="kind='attribute' name='relativeQuantity' namespace='##targetNamespace'"
* @generated
*/
boolean isRelativeQuantity();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#isRelativeQuantity <em>Relative Quantity</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Relative Quantity</em>' attribute.
* @see #isSetRelativeQuantity()
* @see #unsetRelativeQuantity()
* @see #isRelativeQuantity()
* @generated
*/
void setRelativeQuantity(boolean value);
/**
* Unsets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#isRelativeQuantity <em>Relative Quantity</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetRelativeQuantity()
* @see #isRelativeQuantity()
* @see #setRelativeQuantity(boolean)
* @generated
*/
void unsetRelativeQuantity();
/**
* Returns whether the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#isRelativeQuantity <em>Relative Quantity</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Relative Quantity</em>' attribute is set.
* @see #unsetRelativeQuantity()
* @see #isRelativeQuantity()
* @see #setRelativeQuantity(boolean)
* @generated
*/
boolean isSetRelativeQuantity();
/**
* Returns the value of the '<em><b>Unbounded</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Set to true, e.g., for crank angle. If true and variable is a state, relative tolerance should be zero on this variable.
* <!-- end-model-doc -->
* @return the value of the '<em>Unbounded</em>' attribute.
* @see #isSetUnbounded()
* @see #unsetUnbounded()
* @see #setUnbounded(boolean)
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1_Unbounded()
* @model default="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Boolean"
* extendedMetaData="kind='attribute' name='unbounded' namespace='##targetNamespace'"
* @generated
*/
boolean isUnbounded();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#isUnbounded <em>Unbounded</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Unbounded</em>' attribute.
* @see #isSetUnbounded()
* @see #unsetUnbounded()
* @see #isUnbounded()
* @generated
*/
void setUnbounded(boolean value);
/**
* Unsets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#isUnbounded <em>Unbounded</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetUnbounded()
* @see #isUnbounded()
* @see #setUnbounded(boolean)
* @generated
*/
void unsetUnbounded();
/**
* Returns whether the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#isUnbounded <em>Unbounded</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Unbounded</em>' attribute is set.
* @see #unsetUnbounded()
* @see #isUnbounded()
* @see #setUnbounded(boolean)
* @generated
*/
boolean isSetUnbounded();
/**
* Returns the value of the '<em><b>Unit</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Unit</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Unit</em>' attribute.
* @see #setUnit(String)
* @see org.eclipse.papyrus.moka.fmi.modeldescription.FmiPackage#getRealType1_Unit()
* @model dataType="org.eclipse.emf.ecore.xml.type.NormalizedString"
* extendedMetaData="kind='attribute' name='unit' namespace='##targetNamespace'"
* @generated
*/
String getUnit();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.fmi.modeldescription.RealType1#getUnit <em>Unit</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Unit</em>' attribute.
* @see #getUnit()
* @generated
*/
void setUnit(String value);
} // RealType1