blob: 026549dec8526879e8d308eb0bbc1598fc259d33 [file] [log] [blame]
/**
* Copyright (c) 2018 CEA LIST.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* CEA LIST - Initial API and implementation
*/
package org.eclipse.papyrus.moka.ssp.omsimulatorprofile;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.uml2.uml.ConnectorEnd;
import org.eclipse.uml2.uml.Port;
import org.eclipse.uml2.uml.Type;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Bus Connection End</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* BusConnectionEnd is a stereotype that has to be applied on the corresponding connectorEnd of an UML connector, when connected to an OMSimulatorBus port.
* The "referencedSignals" attribute shoud be a subset of the OMSimulatorBus::signals attribute.
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.papyrus.moka.ssp.omsimulatorprofile.BusConnectionEnd#getBase_ConnectorEnd <em>Base Connector End</em>}</li>
* <li>{@link org.eclipse.papyrus.moka.ssp.omsimulatorprofile.BusConnectionEnd#getReferencedSignal <em>Referenced Signal</em>}</li>
* </ul>
*
* @see org.eclipse.papyrus.moka.ssp.omsimulatorprofile.OMSimulatorPackage#getBusConnectionEnd()
* @model
* @generated
*/
public interface BusConnectionEnd extends EObject {
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
String copyright = "Copyright (c) 2018 CEA LIST.\n\n All rights reserved. This program and the accompanying materials\n are made available under the terms of the Eclipse Public License 2.0\n which accompanies this distribution, and is available at\n https://www.eclipse.org/legal/epl-2.0 \r\n\r\nSPDX-License-Identifier: EPL-2.0\n\n Contributors:\n CEA LIST - Initial API and implementation";
/**
* Returns the value of the '<em><b>Base Connector End</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Base Connector End</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Base Connector End</em>' reference.
* @see #setBase_ConnectorEnd(ConnectorEnd)
* @see org.eclipse.papyrus.moka.ssp.omsimulatorprofile.OMSimulatorPackage#getBusConnectionEnd_Base_ConnectorEnd()
* @model required="true" ordered="false"
* @generated
*/
ConnectorEnd getBase_ConnectorEnd();
/**
* Sets the value of the '{@link org.eclipse.papyrus.moka.ssp.omsimulatorprofile.BusConnectionEnd#getBase_ConnectorEnd <em>Base Connector End</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Base Connector End</em>' reference.
* @see #getBase_ConnectorEnd()
* @generated
*/
void setBase_ConnectorEnd(ConnectorEnd value);
/**
* Returns the value of the '<em><b>Referenced Signal</b></em>' reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Port}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Referenced Signal</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Referenced Signal</em>' reference list.
* @see org.eclipse.papyrus.moka.ssp.omsimulatorprofile.OMSimulatorPackage#getBusConnectionEnd_ReferencedSignal()
* @model ordered="false"
* @generated
*/
EList<Port> getReferencedSignal();
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Port} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>' from the '<em><b>Referenced Signal</b></em>' reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or <code>null</code>.
* @param type The '<em><b>Type</b></em>' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.uml.Port} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', or <code>null</code>.
* @see #getReferencedSignal()
* @generated
*/
Port getReferencedSignal(String name, Type type);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Port} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>' from the '<em><b>Referenced Signal</b></em>' reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or <code>null</code>.
* @param type The '<em><b>Type</b></em>' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or <code>null</code>.
* @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
* @return The first {@link org.eclipse.uml2.uml.Port} with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', or <code>null</code>.
* @see #getReferencedSignal()
* @generated
*/
Port getReferencedSignal(String name, Type type, boolean ignoreCase);
} // BusConnectionEnd