org.bimserver.models.ifc4.IfcPort Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pluginbase Show documentation
Base project for BIMserver plugin development. Some plugins mights also need the Shared library
The newest version!
/**
 * Copyright (C) 2009-2014 BIMserver.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.bimserver.models.ifc4;

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

/**
 * 
 * A representation of the model object 'Ifc Port'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcPort#getContainedIn Contained In}
 *   {@link org.bimserver.models.ifc4.IfcPort#getConnectedFrom Connected From}
 *   {@link org.bimserver.models.ifc4.IfcPort#getConnectedTo Connected To}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPort()
 * @model
 * @generated
 */
public interface IfcPort extends IfcProduct {
	/**
	 * Returns the value of the 'Contained In' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelConnectsPortToElement}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelConnectsPortToElement#getRelatingPort Relating Port}'.
	 * 
	 * 
	 * If the meaning of the 'Contained In' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Contained In' reference list.
	 * @see #isSetContainedIn()
	 * @see #unsetContainedIn()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPort_ContainedIn()
	 * @see org.bimserver.models.ifc4.IfcRelConnectsPortToElement#getRelatingPort
	 * @model opposite="RelatingPort" unsettable="true" upper="2"
	 * @generated
	 */
	EList getContainedIn();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcPort#getContainedIn Contained In}' reference list.
	 * 
	 * 
	 * @see #isSetContainedIn()
	 * @see #getContainedIn()
	 * @generated
	 */
	void unsetContainedIn();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPort#getContainedIn Contained In}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Contained In' reference list is set.
	 * @see #unsetContainedIn()
	 * @see #getContainedIn()
	 * @generated
	 */
	boolean isSetContainedIn();

	/**
	 * Returns the value of the 'Connected From' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelConnectsPorts}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRelatedPort Related Port}'.
	 * 
	 * 
	 * If the meaning of the 'Connected From' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Connected From' reference list.
	 * @see #isSetConnectedFrom()
	 * @see #unsetConnectedFrom()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPort_ConnectedFrom()
	 * @see org.bimserver.models.ifc4.IfcRelConnectsPorts#getRelatedPort
	 * @model opposite="RelatedPort" unsettable="true" upper="2"
	 * @generated
	 */
	EList getConnectedFrom();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcPort#getConnectedFrom Connected From}' reference list.
	 * 
	 * 
	 * @see #isSetConnectedFrom()
	 * @see #getConnectedFrom()
	 * @generated
	 */
	void unsetConnectedFrom();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPort#getConnectedFrom Connected From}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Connected From' reference list is set.
	 * @see #unsetConnectedFrom()
	 * @see #getConnectedFrom()
	 * @generated
	 */
	boolean isSetConnectedFrom();

	/**
	 * Returns the value of the 'Connected To' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelConnectsPorts}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRelatingPort Relating Port}'.
	 * 
	 * 
	 * If the meaning of the 'Connected To' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Connected To' reference list.
	 * @see #isSetConnectedTo()
	 * @see #unsetConnectedTo()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPort_ConnectedTo()
	 * @see org.bimserver.models.ifc4.IfcRelConnectsPorts#getRelatingPort
	 * @model opposite="RelatingPort" unsettable="true" upper="2"
	 * @generated
	 */
	EList getConnectedTo();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcPort#getConnectedTo Connected To}' reference list.
	 * 
	 * 
	 * @see #isSetConnectedTo()
	 * @see #getConnectedTo()
	 * @generated
	 */
	void unsetConnectedTo();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPort#getConnectedTo Connected To}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Connected To' reference list is set.
	 * @see #unsetConnectedTo()
	 * @see #getConnectedTo()
	 * @generated
	 */
	boolean isSetConnectedTo();

} // IfcPort