org.bimserver.models.ifc4.IfcSpace 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 Space'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcSpace#getPredefinedType Predefined Type}
 *   {@link org.bimserver.models.ifc4.IfcSpace#getElevationWithFlooring Elevation With Flooring}
 *   {@link org.bimserver.models.ifc4.IfcSpace#getElevationWithFlooringAsString Elevation With Flooring As String}
 *   {@link org.bimserver.models.ifc4.IfcSpace#getHasCoverings Has Coverings}
 *   {@link org.bimserver.models.ifc4.IfcSpace#getBoundedBy Bounded By}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpace()
 * @model
 * @generated
 */
public interface IfcSpace extends IfcSpatialStructureElement, IfcSpaceBoundarySelect {
	/**
	 * Returns the value of the 'Predefined Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcSpaceTypeEnum}.
	 * 
	 * 
	 * If the meaning of the 'Predefined Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Predefined Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcSpaceTypeEnum
	 * @see #isSetPredefinedType()
	 * @see #unsetPredefinedType()
	 * @see #setPredefinedType(IfcSpaceTypeEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpace_PredefinedType()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcSpaceTypeEnum getPredefinedType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getPredefinedType Predefined Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Predefined Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcSpaceTypeEnum
	 * @see #isSetPredefinedType()
	 * @see #unsetPredefinedType()
	 * @see #getPredefinedType()
	 * @generated
	 */
	void setPredefinedType(IfcSpaceTypeEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getPredefinedType Predefined Type}' attribute.
	 * 
	 * 
	 * @see #isSetPredefinedType()
	 * @see #getPredefinedType()
	 * @see #setPredefinedType(IfcSpaceTypeEnum)
	 * @generated
	 */
	void unsetPredefinedType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getPredefinedType Predefined Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Predefined Type' attribute is set.
	 * @see #unsetPredefinedType()
	 * @see #getPredefinedType()
	 * @see #setPredefinedType(IfcSpaceTypeEnum)
	 * @generated
	 */
	boolean isSetPredefinedType();

	/**
	 * Returns the value of the 'Elevation With Flooring' attribute.
	 * 
	 * 
	 * If the meaning of the 'Elevation With Flooring' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Elevation With Flooring' attribute.
	 * @see #isSetElevationWithFlooring()
	 * @see #unsetElevationWithFlooring()
	 * @see #setElevationWithFlooring(double)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpace_ElevationWithFlooring()
	 * @model unsettable="true"
	 * @generated
	 */
	double getElevationWithFlooring();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getElevationWithFlooring Elevation With Flooring}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Elevation With Flooring' attribute.
	 * @see #isSetElevationWithFlooring()
	 * @see #unsetElevationWithFlooring()
	 * @see #getElevationWithFlooring()
	 * @generated
	 */
	void setElevationWithFlooring(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getElevationWithFlooring Elevation With Flooring}' attribute.
	 * 
	 * 
	 * @see #isSetElevationWithFlooring()
	 * @see #getElevationWithFlooring()
	 * @see #setElevationWithFlooring(double)
	 * @generated
	 */
	void unsetElevationWithFlooring();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getElevationWithFlooring Elevation With Flooring}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Elevation With Flooring' attribute is set.
	 * @see #unsetElevationWithFlooring()
	 * @see #getElevationWithFlooring()
	 * @see #setElevationWithFlooring(double)
	 * @generated
	 */
	boolean isSetElevationWithFlooring();

	/**
	 * Returns the value of the 'Elevation With Flooring As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Elevation With Flooring As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Elevation With Flooring As String' attribute.
	 * @see #isSetElevationWithFlooringAsString()
	 * @see #unsetElevationWithFlooringAsString()
	 * @see #setElevationWithFlooringAsString(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpace_ElevationWithFlooringAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getElevationWithFlooringAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getElevationWithFlooringAsString Elevation With Flooring As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Elevation With Flooring As String' attribute.
	 * @see #isSetElevationWithFlooringAsString()
	 * @see #unsetElevationWithFlooringAsString()
	 * @see #getElevationWithFlooringAsString()
	 * @generated
	 */
	void setElevationWithFlooringAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getElevationWithFlooringAsString Elevation With Flooring As String}' attribute.
	 * 
	 * 
	 * @see #isSetElevationWithFlooringAsString()
	 * @see #getElevationWithFlooringAsString()
	 * @see #setElevationWithFlooringAsString(String)
	 * @generated
	 */
	void unsetElevationWithFlooringAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getElevationWithFlooringAsString Elevation With Flooring As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Elevation With Flooring As String' attribute is set.
	 * @see #unsetElevationWithFlooringAsString()
	 * @see #getElevationWithFlooringAsString()
	 * @see #setElevationWithFlooringAsString(String)
	 * @generated
	 */
	boolean isSetElevationWithFlooringAsString();

	/**
	 * Returns the value of the 'Has Coverings' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelCoversSpaces}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelCoversSpaces#getRelatingSpace Relating Space}'.
	 * 
	 * 
	 * If the meaning of the 'Has Coverings' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Coverings' reference list.
	 * @see #isSetHasCoverings()
	 * @see #unsetHasCoverings()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpace_HasCoverings()
	 * @see org.bimserver.models.ifc4.IfcRelCoversSpaces#getRelatingSpace
	 * @model opposite="RelatingSpace" unsettable="true"
	 * @generated
	 */
	EList getHasCoverings();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getHasCoverings Has Coverings}' reference list.
	 * 
	 * 
	 * @see #isSetHasCoverings()
	 * @see #getHasCoverings()
	 * @generated
	 */
	void unsetHasCoverings();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getHasCoverings Has Coverings}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Coverings' reference list is set.
	 * @see #unsetHasCoverings()
	 * @see #getHasCoverings()
	 * @generated
	 */
	boolean isSetHasCoverings();

	/**
	 * Returns the value of the 'Bounded By' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelSpaceBoundary}.
	 * 
	 * 
	 * If the meaning of the 'Bounded By' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Bounded By' reference list.
	 * @see #isSetBoundedBy()
	 * @see #unsetBoundedBy()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSpace_BoundedBy()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getBoundedBy();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getBoundedBy Bounded By}' reference list.
	 * 
	 * 
	 * @see #isSetBoundedBy()
	 * @see #getBoundedBy()
	 * @generated
	 */
	void unsetBoundedBy();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSpace#getBoundedBy Bounded By}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Bounded By' reference list is set.
	 * @see #unsetBoundedBy()
	 * @see #getBoundedBy()
	 * @generated
	 */
	boolean isSetBoundedBy();

} // IfcSpace