org.bimserver.models.ifc4.IfcSpatialElement 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 Spatial Element'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcSpatialElement#getLongName Long Name}
 *   {@link org.bimserver.models.ifc4.IfcSpatialElement#getContainsElements Contains Elements}
 *   {@link org.bimserver.models.ifc4.IfcSpatialElement#getServicedBySystems Serviced By Systems}
 *   {@link org.bimserver.models.ifc4.IfcSpatialElement#getReferencesElements References Elements}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpatialElement()
 * @model
 * @generated
 */
public interface IfcSpatialElement extends IfcProduct {
	/**
	 * Returns the value of the 'Long Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Long Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Long Name' attribute.
	 * @see #isSetLongName()
	 * @see #unsetLongName()
	 * @see #setLongName(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpatialElement_LongName()
	 * @model unsettable="true"
	 * @generated
	 */
	String getLongName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getLongName Long Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Long Name' attribute.
	 * @see #isSetLongName()
	 * @see #unsetLongName()
	 * @see #getLongName()
	 * @generated
	 */
	void setLongName(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getLongName Long Name}' attribute.
	 * 
	 * 
	 * @see #isSetLongName()
	 * @see #getLongName()
	 * @see #setLongName(String)
	 * @generated
	 */
	void unsetLongName();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getLongName Long Name}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Long Name' attribute is set.
	 * @see #unsetLongName()
	 * @see #getLongName()
	 * @see #setLongName(String)
	 * @generated
	 */
	boolean isSetLongName();

	/**
	 * Returns the value of the 'Contains Elements' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelContainedInSpatialStructure}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelContainedInSpatialStructure#getRelatingStructure Relating Structure}'.
	 * 
	 * 
	 * If the meaning of the 'Contains Elements' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Contains Elements' reference list.
	 * @see #isSetContainsElements()
	 * @see #unsetContainsElements()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpatialElement_ContainsElements()
	 * @see org.bimserver.models.ifc4.IfcRelContainedInSpatialStructure#getRelatingStructure
	 * @model opposite="RelatingStructure" unsettable="true"
	 * @generated
	 */
	EList getContainsElements();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getContainsElements Contains Elements}' reference list.
	 * 
	 * 
	 * @see #isSetContainsElements()
	 * @see #getContainsElements()
	 * @generated
	 */
	void unsetContainsElements();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getContainsElements Contains Elements}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Contains Elements' reference list is set.
	 * @see #unsetContainsElements()
	 * @see #getContainsElements()
	 * @generated
	 */
	boolean isSetContainsElements();

	/**
	 * Returns the value of the 'Serviced By Systems' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelServicesBuildings}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelServicesBuildings#getRelatedBuildings Related Buildings}'.
	 * 
	 * 
	 * If the meaning of the 'Serviced By Systems' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Serviced By Systems' reference list.
	 * @see #isSetServicedBySystems()
	 * @see #unsetServicedBySystems()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpatialElement_ServicedBySystems()
	 * @see org.bimserver.models.ifc4.IfcRelServicesBuildings#getRelatedBuildings
	 * @model opposite="RelatedBuildings" unsettable="true"
	 * @generated
	 */
	EList getServicedBySystems();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getServicedBySystems Serviced By Systems}' reference list.
	 * 
	 * 
	 * @see #isSetServicedBySystems()
	 * @see #getServicedBySystems()
	 * @generated
	 */
	void unsetServicedBySystems();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getServicedBySystems Serviced By Systems}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Serviced By Systems' reference list is set.
	 * @see #unsetServicedBySystems()
	 * @see #getServicedBySystems()
	 * @generated
	 */
	boolean isSetServicedBySystems();

	/**
	 * Returns the value of the 'References Elements' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelReferencedInSpatialStructure}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelReferencedInSpatialStructure#getRelatingStructure Relating Structure}'.
	 * 
	 * 
	 * If the meaning of the 'References Elements' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'References Elements' reference list.
	 * @see #isSetReferencesElements()
	 * @see #unsetReferencesElements()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpatialElement_ReferencesElements()
	 * @see org.bimserver.models.ifc4.IfcRelReferencedInSpatialStructure#getRelatingStructure
	 * @model opposite="RelatingStructure" unsettable="true"
	 * @generated
	 */
	EList getReferencesElements();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getReferencesElements References Elements}' reference list.
	 * 
	 * 
	 * @see #isSetReferencesElements()
	 * @see #getReferencesElements()
	 * @generated
	 */
	void unsetReferencesElements();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpatialElement#getReferencesElements References Elements}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'References Elements' reference list is set.
	 * @see #unsetReferencesElements()
	 * @see #getReferencesElements()
	 * @generated
	 */
	boolean isSetReferencesElements();

} // IfcSpatialElement