org.bimserver.models.ifc2x3tc1.IfcTransportElement 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.ifc2x3tc1;

/**
 * 
 * A representation of the model object 'Ifc Transport Element'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getOperationType Operation Type}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByWeight Capacity By Weight}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByWeightAsString Capacity By Weight As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByNumber Capacity By Number}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByNumberAsString Capacity By Number As String}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcTransportElement()
 * @model
 * @generated
 */
public interface IfcTransportElement extends IfcElement {
	/**
	 * Returns the value of the 'Operation Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcTransportElementTypeEnum}.
	 * 
	 * 
	 * 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.ifc2x3tc1.IfcTransportElementTypeEnum
	 * @see #isSetOperationType()
	 * @see #unsetOperationType()
	 * @see #setOperationType(IfcTransportElementTypeEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcTransportElement_OperationType()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcTransportElementTypeEnum getOperationType();

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

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

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

	/**
	 * Returns the value of the 'Capacity By Weight' attribute.
	 * 
	 * 
	 * If the meaning of the 'Capacity By Weight' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Capacity By Weight' attribute.
	 * @see #isSetCapacityByWeight()
	 * @see #unsetCapacityByWeight()
	 * @see #setCapacityByWeight(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcTransportElement_CapacityByWeight()
	 * @model unsettable="true"
	 * @generated
	 */
	double getCapacityByWeight();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByWeight Capacity By Weight}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Capacity By Weight' attribute.
	 * @see #isSetCapacityByWeight()
	 * @see #unsetCapacityByWeight()
	 * @see #getCapacityByWeight()
	 * @generated
	 */
	void setCapacityByWeight(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByWeight Capacity By Weight}' attribute.
	 * 
	 * 
	 * @see #isSetCapacityByWeight()
	 * @see #getCapacityByWeight()
	 * @see #setCapacityByWeight(double)
	 * @generated
	 */
	void unsetCapacityByWeight();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByWeight Capacity By Weight}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Capacity By Weight' attribute is set.
	 * @see #unsetCapacityByWeight()
	 * @see #getCapacityByWeight()
	 * @see #setCapacityByWeight(double)
	 * @generated
	 */
	boolean isSetCapacityByWeight();

	/**
	 * Returns the value of the 'Capacity By Weight As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Capacity By Weight As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Capacity By Weight As String' attribute.
	 * @see #isSetCapacityByWeightAsString()
	 * @see #unsetCapacityByWeightAsString()
	 * @see #setCapacityByWeightAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcTransportElement_CapacityByWeightAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getCapacityByWeightAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByWeightAsString Capacity By Weight As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Capacity By Weight As String' attribute.
	 * @see #isSetCapacityByWeightAsString()
	 * @see #unsetCapacityByWeightAsString()
	 * @see #getCapacityByWeightAsString()
	 * @generated
	 */
	void setCapacityByWeightAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByWeightAsString Capacity By Weight As String}' attribute.
	 * 
	 * 
	 * @see #isSetCapacityByWeightAsString()
	 * @see #getCapacityByWeightAsString()
	 * @see #setCapacityByWeightAsString(String)
	 * @generated
	 */
	void unsetCapacityByWeightAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByWeightAsString Capacity By Weight As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Capacity By Weight As String' attribute is set.
	 * @see #unsetCapacityByWeightAsString()
	 * @see #getCapacityByWeightAsString()
	 * @see #setCapacityByWeightAsString(String)
	 * @generated
	 */
	boolean isSetCapacityByWeightAsString();

	/**
	 * Returns the value of the 'Capacity By Number' attribute.
	 * 
	 * 
	 * If the meaning of the 'Capacity By Number' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Capacity By Number' attribute.
	 * @see #isSetCapacityByNumber()
	 * @see #unsetCapacityByNumber()
	 * @see #setCapacityByNumber(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcTransportElement_CapacityByNumber()
	 * @model unsettable="true"
	 * @generated
	 */
	double getCapacityByNumber();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByNumber Capacity By Number}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Capacity By Number' attribute.
	 * @see #isSetCapacityByNumber()
	 * @see #unsetCapacityByNumber()
	 * @see #getCapacityByNumber()
	 * @generated
	 */
	void setCapacityByNumber(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByNumber Capacity By Number}' attribute.
	 * 
	 * 
	 * @see #isSetCapacityByNumber()
	 * @see #getCapacityByNumber()
	 * @see #setCapacityByNumber(double)
	 * @generated
	 */
	void unsetCapacityByNumber();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByNumber Capacity By Number}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Capacity By Number' attribute is set.
	 * @see #unsetCapacityByNumber()
	 * @see #getCapacityByNumber()
	 * @see #setCapacityByNumber(double)
	 * @generated
	 */
	boolean isSetCapacityByNumber();

	/**
	 * Returns the value of the 'Capacity By Number As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Capacity By Number As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Capacity By Number As String' attribute.
	 * @see #isSetCapacityByNumberAsString()
	 * @see #unsetCapacityByNumberAsString()
	 * @see #setCapacityByNumberAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcTransportElement_CapacityByNumberAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getCapacityByNumberAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByNumberAsString Capacity By Number As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Capacity By Number As String' attribute.
	 * @see #isSetCapacityByNumberAsString()
	 * @see #unsetCapacityByNumberAsString()
	 * @see #getCapacityByNumberAsString()
	 * @generated
	 */
	void setCapacityByNumberAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByNumberAsString Capacity By Number As String}' attribute.
	 * 
	 * 
	 * @see #isSetCapacityByNumberAsString()
	 * @see #getCapacityByNumberAsString()
	 * @see #setCapacityByNumberAsString(String)
	 * @generated
	 */
	void unsetCapacityByNumberAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcTransportElement#getCapacityByNumberAsString Capacity By Number As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Capacity By Number As String' attribute is set.
	 * @see #unsetCapacityByNumberAsString()
	 * @see #getCapacityByNumberAsString()
	 * @see #setCapacityByNumberAsString(String)
	 * @generated
	 */
	boolean isSetCapacityByNumberAsString();

} // IfcTransportElement