org.bimserver.models.ifc4.IfcDoor 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
There is a newer version: 2.0.0
/**
 * 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 Door'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcDoor#getOverallHeight Overall Height}
 *   {@link org.bimserver.models.ifc4.IfcDoor#getOverallHeightAsString Overall Height As String}
 *   {@link org.bimserver.models.ifc4.IfcDoor#getOverallWidth Overall Width}
 *   {@link org.bimserver.models.ifc4.IfcDoor#getOverallWidthAsString Overall Width As String}
 *   {@link org.bimserver.models.ifc4.IfcDoor#getPredefinedType Predefined Type}
 *   {@link org.bimserver.models.ifc4.IfcDoor#getOperationType Operation Type}
 *   {@link org.bimserver.models.ifc4.IfcDoor#getUserDefinedOperationType User Defined Operation Type}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDoor()
 * @model
 * @generated
 */
public interface IfcDoor extends IfcBuildingElement {
	/**
	 * Returns the value of the 'Overall Height' attribute.
	 * 
	 * 
	 * If the meaning of the 'Overall Height' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Overall Height' attribute.
	 * @see #isSetOverallHeight()
	 * @see #unsetOverallHeight()
	 * @see #setOverallHeight(double)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDoor_OverallHeight()
	 * @model unsettable="true"
	 * @generated
	 */
	double getOverallHeight();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallHeight Overall Height}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Overall Height' attribute.
	 * @see #isSetOverallHeight()
	 * @see #unsetOverallHeight()
	 * @see #getOverallHeight()
	 * @generated
	 */
	void setOverallHeight(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallHeight Overall Height}' attribute.
	 * 
	 * 
	 * @see #isSetOverallHeight()
	 * @see #getOverallHeight()
	 * @see #setOverallHeight(double)
	 * @generated
	 */
	void unsetOverallHeight();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallHeight Overall Height}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Overall Height' attribute is set.
	 * @see #unsetOverallHeight()
	 * @see #getOverallHeight()
	 * @see #setOverallHeight(double)
	 * @generated
	 */
	boolean isSetOverallHeight();

	/**
	 * Returns the value of the 'Overall Height As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Overall Height As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Overall Height As String' attribute.
	 * @see #isSetOverallHeightAsString()
	 * @see #unsetOverallHeightAsString()
	 * @see #setOverallHeightAsString(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDoor_OverallHeightAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getOverallHeightAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallHeightAsString Overall Height As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Overall Height As String' attribute.
	 * @see #isSetOverallHeightAsString()
	 * @see #unsetOverallHeightAsString()
	 * @see #getOverallHeightAsString()
	 * @generated
	 */
	void setOverallHeightAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallHeightAsString Overall Height As String}' attribute.
	 * 
	 * 
	 * @see #isSetOverallHeightAsString()
	 * @see #getOverallHeightAsString()
	 * @see #setOverallHeightAsString(String)
	 * @generated
	 */
	void unsetOverallHeightAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallHeightAsString Overall Height As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Overall Height As String' attribute is set.
	 * @see #unsetOverallHeightAsString()
	 * @see #getOverallHeightAsString()
	 * @see #setOverallHeightAsString(String)
	 * @generated
	 */
	boolean isSetOverallHeightAsString();

	/**
	 * Returns the value of the 'Overall Width' attribute.
	 * 
	 * 
	 * If the meaning of the 'Overall Width' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Overall Width' attribute.
	 * @see #isSetOverallWidth()
	 * @see #unsetOverallWidth()
	 * @see #setOverallWidth(double)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDoor_OverallWidth()
	 * @model unsettable="true"
	 * @generated
	 */
	double getOverallWidth();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallWidth Overall Width}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Overall Width' attribute.
	 * @see #isSetOverallWidth()
	 * @see #unsetOverallWidth()
	 * @see #getOverallWidth()
	 * @generated
	 */
	void setOverallWidth(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallWidth Overall Width}' attribute.
	 * 
	 * 
	 * @see #isSetOverallWidth()
	 * @see #getOverallWidth()
	 * @see #setOverallWidth(double)
	 * @generated
	 */
	void unsetOverallWidth();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallWidth Overall Width}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Overall Width' attribute is set.
	 * @see #unsetOverallWidth()
	 * @see #getOverallWidth()
	 * @see #setOverallWidth(double)
	 * @generated
	 */
	boolean isSetOverallWidth();

	/**
	 * Returns the value of the 'Overall Width As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Overall Width As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Overall Width As String' attribute.
	 * @see #isSetOverallWidthAsString()
	 * @see #unsetOverallWidthAsString()
	 * @see #setOverallWidthAsString(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDoor_OverallWidthAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getOverallWidthAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallWidthAsString Overall Width As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Overall Width As String' attribute.
	 * @see #isSetOverallWidthAsString()
	 * @see #unsetOverallWidthAsString()
	 * @see #getOverallWidthAsString()
	 * @generated
	 */
	void setOverallWidthAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallWidthAsString Overall Width As String}' attribute.
	 * 
	 * 
	 * @see #isSetOverallWidthAsString()
	 * @see #getOverallWidthAsString()
	 * @see #setOverallWidthAsString(String)
	 * @generated
	 */
	void unsetOverallWidthAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOverallWidthAsString Overall Width As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Overall Width As String' attribute is set.
	 * @see #unsetOverallWidthAsString()
	 * @see #getOverallWidthAsString()
	 * @see #setOverallWidthAsString(String)
	 * @generated
	 */
	boolean isSetOverallWidthAsString();

	/**
	 * Returns the value of the 'Predefined Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcDoorTypeEnum}.
	 * 
	 * 
	 * 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.IfcDoorTypeEnum
	 * @see #isSetPredefinedType()
	 * @see #unsetPredefinedType()
	 * @see #setPredefinedType(IfcDoorTypeEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDoor_PredefinedType()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcDoorTypeEnum getPredefinedType();

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

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

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

	/**
	 * Returns the value of the 'Operation Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcDoorTypeOperationEnum}.
	 * 
	 * 
	 * If the meaning of the 'Operation Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Operation Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcDoorTypeOperationEnum
	 * @see #isSetOperationType()
	 * @see #unsetOperationType()
	 * @see #setOperationType(IfcDoorTypeOperationEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDoor_OperationType()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcDoorTypeOperationEnum getOperationType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOperationType Operation Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Operation Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcDoorTypeOperationEnum
	 * @see #isSetOperationType()
	 * @see #unsetOperationType()
	 * @see #getOperationType()
	 * @generated
	 */
	void setOperationType(IfcDoorTypeOperationEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOperationType Operation Type}' attribute.
	 * 
	 * 
	 * @see #isSetOperationType()
	 * @see #getOperationType()
	 * @see #setOperationType(IfcDoorTypeOperationEnum)
	 * @generated
	 */
	void unsetOperationType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getOperationType Operation Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Operation Type' attribute is set.
	 * @see #unsetOperationType()
	 * @see #getOperationType()
	 * @see #setOperationType(IfcDoorTypeOperationEnum)
	 * @generated
	 */
	boolean isSetOperationType();

	/**
	 * Returns the value of the 'User Defined Operation Type' attribute.
	 * 
	 * 
	 * If the meaning of the 'User Defined Operation Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User Defined Operation Type' attribute.
	 * @see #isSetUserDefinedOperationType()
	 * @see #unsetUserDefinedOperationType()
	 * @see #setUserDefinedOperationType(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDoor_UserDefinedOperationType()
	 * @model unsettable="true"
	 * @generated
	 */
	String getUserDefinedOperationType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getUserDefinedOperationType User Defined Operation Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'User Defined Operation Type' attribute.
	 * @see #isSetUserDefinedOperationType()
	 * @see #unsetUserDefinedOperationType()
	 * @see #getUserDefinedOperationType()
	 * @generated
	 */
	void setUserDefinedOperationType(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getUserDefinedOperationType User Defined Operation Type}' attribute.
	 * 
	 * 
	 * @see #isSetUserDefinedOperationType()
	 * @see #getUserDefinedOperationType()
	 * @see #setUserDefinedOperationType(String)
	 * @generated
	 */
	void unsetUserDefinedOperationType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDoor#getUserDefinedOperationType User Defined Operation Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'User Defined Operation Type' attribute is set.
	 * @see #unsetUserDefinedOperationType()
	 * @see #getUserDefinedOperationType()
	 * @see #setUserDefinedOperationType(String)
	 * @generated
	 */
	boolean isSetUserDefinedOperationType();

} // IfcDoor