org.bimserver.models.ifc4.IfcRelContainedInSpatialStructure 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;

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

/**
 * 
 * A representation of the model object 'Ifc Rel Contained In Spatial Structure'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcRelContainedInSpatialStructure#getRelatedElements Related Elements}
 *   {@link org.bimserver.models.ifc4.IfcRelContainedInSpatialStructure#getRelatingStructure Relating Structure}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelContainedInSpatialStructure()
 * @model
 * @generated
 */
public interface IfcRelContainedInSpatialStructure extends IfcRelConnects {
	/**
	 * Returns the value of the 'Related Elements' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcProduct}.
	 * 
	 * 
	 * If the meaning of the 'Related Elements' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Related Elements' reference list.
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelContainedInSpatialStructure_RelatedElements()
	 * @model
	 * @generated
	 */
	EList getRelatedElements();

	/**
	 * Returns the value of the 'Relating Structure' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcSpatialElement#getContainsElements Contains Elements}'.
	 * 
	 * 
	 * If the meaning of the 'Relating Structure' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Relating Structure' reference.
	 * @see #setRelatingStructure(IfcSpatialElement)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRelContainedInSpatialStructure_RelatingStructure()
	 * @see org.bimserver.models.ifc4.IfcSpatialElement#getContainsElements
	 * @model opposite="ContainsElements"
	 * @generated
	 */
	IfcSpatialElement getRelatingStructure();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRelContainedInSpatialStructure#getRelatingStructure Relating Structure}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Relating Structure' reference.
	 * @see #getRelatingStructure()
	 * @generated
	 */
	void setRelatingStructure(IfcSpatialElement value);

} // IfcRelContainedInSpatialStructure