blob: 9cd9a18b078b0ce99d31f3ac134a9a3e6e8877d8 (
plain) (
tree)
|
|
/**
*/
package org.eclipse.etrice.core.room;
import org.eclipse.emf.common.util.EList;
import org.eclipse.etrice.core.common.base.AnnotationType;
import org.eclipse.etrice.core.common.base.Documentation;
import org.eclipse.etrice.core.common.base.Import;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Model</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* <br>The root object for the ROOM model. It gives access to {@link Import imports} and
* the {@link SubSystemClass sub system},
* {@link ActorClass actor}, {@link ProtocolClass protocol} and
* {@link DataClass data} classes defined.
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getName <em>Name</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getDocu <em>Docu</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getImports <em>Imports</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getPrimitiveTypes <em>Primitive Types</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getEnumerationTypes <em>Enumeration Types</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getExternalTypes <em>External Types</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getDataClasses <em>Data Classes</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getProtocolClasses <em>Protocol Classes</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getActorClasses <em>Actor Classes</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getSubSystemClasses <em>Sub System Classes</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getSystems <em>Systems</em>}</li>
* <li>{@link org.eclipse.etrice.core.room.RoomModel#getAnnotationTypes <em>Annotation Types</em>}</li>
* </ul>
*
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel()
* @model
* @generated
*/
public interface RoomModel extends RoomElement
{
/**
* Returns the value of the '<em><b>Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>The model name is a dot separated fully qualified name and is
* used to provide a name space. The generators may use that also
* to place the generated code into separate directories.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Name</em>' attribute.
* @see #setName(String)
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_Name()
* @model
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.RoomModel#getName <em>Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Name</em>' attribute.
* @see #getName()
* @generated
*/
void setName(String value);
/**
* Returns the value of the '<em><b>Docu</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is an optional documentation.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Docu</em>' containment reference.
* @see #setDocu(Documentation)
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_Docu()
* @model containment="true"
* @generated
*/
Documentation getDocu();
/**
* Sets the value of the '{@link org.eclipse.etrice.core.room.RoomModel#getDocu <em>Docu</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Docu</em>' containment reference.
* @see #getDocu()
* @generated
*/
void setDocu(Documentation value);
/**
* Returns the value of the '<em><b>Imports</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.common.base.Import}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of all imported models.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Imports</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_Imports()
* @model containment="true"
* @generated
*/
EList<Import> getImports();
/**
* Returns the value of the '<em><b>Primitive Types</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.PrimitiveType}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of all primitive types defined by this model.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Primitive Types</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_PrimitiveTypes()
* @model containment="true"
* @generated
*/
EList<PrimitiveType> getPrimitiveTypes();
/**
* Returns the value of the '<em><b>Enumeration Types</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.EnumerationType}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Enumeration Types</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>Enumeration Types</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_EnumerationTypes()
* @model containment="true"
* @generated
*/
EList<EnumerationType> getEnumerationTypes();
/**
* Returns the value of the '<em><b>External Types</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.ExternalType}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of all external types defined by this model.
*
* <!-- end-model-doc -->
* @return the value of the '<em>External Types</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_ExternalTypes()
* @model containment="true"
* @generated
*/
EList<ExternalType> getExternalTypes();
/**
* Returns the value of the '<em><b>Data Classes</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.DataClass}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of all data classes defined by this model.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Data Classes</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_DataClasses()
* @model containment="true"
* @generated
*/
EList<DataClass> getDataClasses();
/**
* Returns the value of the '<em><b>Protocol Classes</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.GeneralProtocolClass}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of all protocol classes defined by this model.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Protocol Classes</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_ProtocolClasses()
* @model containment="true"
* @generated
*/
EList<GeneralProtocolClass> getProtocolClasses();
/**
* Returns the value of the '<em><b>Actor Classes</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.ActorClass}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of all actor classes defined by this model.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Actor Classes</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_ActorClasses()
* @model containment="true"
* @generated
*/
EList<ActorClass> getActorClasses();
/**
* Returns the value of the '<em><b>Sub System Classes</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.SubSystemClass}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of all sub system classes defined by this model.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Sub System Classes</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_SubSystemClasses()
* @model containment="true"
* @generated
*/
EList<SubSystemClass> getSubSystemClasses();
/**
* Returns the value of the '<em><b>Systems</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.room.LogicalSystem}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* <br>This is a list of all logical systems defined by this model.
*
* <!-- end-model-doc -->
* @return the value of the '<em>Systems</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_Systems()
* @model containment="true"
* @generated
*/
EList<LogicalSystem> getSystems();
/**
* Returns the value of the '<em><b>Annotation Types</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.etrice.core.common.base.AnnotationType}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Annotation Types</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>Annotation Types</em>' containment reference list.
* @see org.eclipse.etrice.core.room.RoomPackage#getRoomModel_AnnotationTypes()
* @model containment="true"
* @generated
*/
EList<AnnotationType> getAnnotationTypes();
} // RoomModel
|
