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

/**
 * 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;

/**
 * 
 * A representation of the model object 'Ifc Rel Connects Ports'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRelatingPort Relating Port}
 *   {@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRelatedPort Related Port}
 *   {@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRealizingElement Realizing Element}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelConnectsPorts()
 * @model
 * @generated
 */
public interface IfcRelConnectsPorts extends IfcRelConnects {
	/**
	 * Returns the value of the 'Relating Port' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcPort#getConnectedTo Connected To}'.
	 * 
	 * 
	 * If the meaning of the 'Relating Port' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Relating Port' reference.
	 * @see #setRelatingPort(IfcPort)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelConnectsPorts_RelatingPort()
	 * @see org.bimserver.models.ifc4.IfcPort#getConnectedTo
	 * @model opposite="ConnectedTo"
	 * @generated
	 */
	IfcPort getRelatingPort();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRelatingPort Relating Port}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Relating Port' reference.
	 * @see #getRelatingPort()
	 * @generated
	 */
	void setRelatingPort(IfcPort value);

	/**
	 * Returns the value of the 'Related Port' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcPort#getConnectedFrom Connected From}'.
	 * 
	 * 
	 * If the meaning of the 'Related Port' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Related Port' reference.
	 * @see #setRelatedPort(IfcPort)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelConnectsPorts_RelatedPort()
	 * @see org.bimserver.models.ifc4.IfcPort#getConnectedFrom
	 * @model opposite="ConnectedFrom"
	 * @generated
	 */
	IfcPort getRelatedPort();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRelatedPort Related Port}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Related Port' reference.
	 * @see #getRelatedPort()
	 * @generated
	 */
	void setRelatedPort(IfcPort value);

	/**
	 * Returns the value of the 'Realizing Element' reference.
	 * 
	 * 
	 * If the meaning of the 'Realizing Element' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Realizing Element' reference.
	 * @see #isSetRealizingElement()
	 * @see #unsetRealizingElement()
	 * @see #setRealizingElement(IfcElement)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelConnectsPorts_RealizingElement()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcElement getRealizingElement();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRealizingElement Realizing Element}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Realizing Element' reference.
	 * @see #isSetRealizingElement()
	 * @see #unsetRealizingElement()
	 * @see #getRealizingElement()
	 * @generated
	 */
	void setRealizingElement(IfcElement value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRealizingElement Realizing Element}' reference.
	 * 
	 * 
	 * @see #isSetRealizingElement()
	 * @see #getRealizingElement()
	 * @see #setRealizingElement(IfcElement)
	 * @generated
	 */
	void unsetRealizingElement();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRelConnectsPorts#getRealizingElement Realizing Element}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Realizing Element' reference is set.
	 * @see #unsetRealizingElement()
	 * @see #getRealizingElement()
	 * @see #setRealizingElement(IfcElement)
	 * @generated
	 */
	boolean isSetRealizingElement();

} // IfcRelConnectsPorts