org.bimserver.models.ifc4.IfcDistributionPort 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 Distribution Port'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcDistributionPort#getFlowDirection Flow Direction}
 *   {@link org.bimserver.models.ifc4.IfcDistributionPort#getPredefinedType Predefined Type}
 *   {@link org.bimserver.models.ifc4.IfcDistributionPort#getSystemType System Type}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDistributionPort()
 * @model
 * @generated
 */
public interface IfcDistributionPort extends IfcPort {
	/**
	 * Returns the value of the 'Flow Direction' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcFlowDirectionEnum}.
	 * 
	 * 
	 * If the meaning of the 'Flow Direction' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Flow Direction' attribute.
	 * @see org.bimserver.models.ifc4.IfcFlowDirectionEnum
	 * @see #isSetFlowDirection()
	 * @see #unsetFlowDirection()
	 * @see #setFlowDirection(IfcFlowDirectionEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDistributionPort_FlowDirection()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcFlowDirectionEnum getFlowDirection();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDistributionPort#getFlowDirection Flow Direction}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Flow Direction' attribute.
	 * @see org.bimserver.models.ifc4.IfcFlowDirectionEnum
	 * @see #isSetFlowDirection()
	 * @see #unsetFlowDirection()
	 * @see #getFlowDirection()
	 * @generated
	 */
	void setFlowDirection(IfcFlowDirectionEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDistributionPort#getFlowDirection Flow Direction}' attribute.
	 * 
	 * 
	 * @see #isSetFlowDirection()
	 * @see #getFlowDirection()
	 * @see #setFlowDirection(IfcFlowDirectionEnum)
	 * @generated
	 */
	void unsetFlowDirection();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDistributionPort#getFlowDirection Flow Direction}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Flow Direction' attribute is set.
	 * @see #unsetFlowDirection()
	 * @see #getFlowDirection()
	 * @see #setFlowDirection(IfcFlowDirectionEnum)
	 * @generated
	 */
	boolean isSetFlowDirection();

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

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

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

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

	/**
	 * Returns the value of the 'System Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcDistributionSystemEnum}.
	 * 
	 * 
	 * If the meaning of the 'System Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'System Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcDistributionSystemEnum
	 * @see #isSetSystemType()
	 * @see #unsetSystemType()
	 * @see #setSystemType(IfcDistributionSystemEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDistributionPort_SystemType()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcDistributionSystemEnum getSystemType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDistributionPort#getSystemType System Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'System Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcDistributionSystemEnum
	 * @see #isSetSystemType()
	 * @see #unsetSystemType()
	 * @see #getSystemType()
	 * @generated
	 */
	void setSystemType(IfcDistributionSystemEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDistributionPort#getSystemType System Type}' attribute.
	 * 
	 * 
	 * @see #isSetSystemType()
	 * @see #getSystemType()
	 * @see #setSystemType(IfcDistributionSystemEnum)
	 * @generated
	 */
	void unsetSystemType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDistributionPort#getSystemType System Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'System Type' attribute is set.
	 * @see #unsetSystemType()
	 * @see #getSystemType()
	 * @see #setSystemType(IfcDistributionSystemEnum)
	 * @generated
	 */
	boolean isSetSystemType();

} // IfcDistributionPort