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

/**
 * 
 * A representation of the model object 'Ifc Construction Resource'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceIdentifier Resource Identifier}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceGroup Resource Group}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceConsumption Resource Consumption}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getBaseQuantity Base Quantity}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcConstructionResource()
 * @model
 * @generated
 */
public interface IfcConstructionResource extends IfcResource {
	/**
	 * Returns the value of the 'Resource Identifier' attribute.
	 * 
	 * 
	 * If the meaning of the 'Resource Identifier' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Resource Identifier' attribute.
	 * @see #isSetResourceIdentifier()
	 * @see #unsetResourceIdentifier()
	 * @see #setResourceIdentifier(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcConstructionResource_ResourceIdentifier()
	 * @model unsettable="true"
	 * @generated
	 */
	String getResourceIdentifier();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceIdentifier Resource Identifier}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Resource Identifier' attribute.
	 * @see #isSetResourceIdentifier()
	 * @see #unsetResourceIdentifier()
	 * @see #getResourceIdentifier()
	 * @generated
	 */
	void setResourceIdentifier(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceIdentifier Resource Identifier}' attribute.
	 * 
	 * 
	 * @see #isSetResourceIdentifier()
	 * @see #getResourceIdentifier()
	 * @see #setResourceIdentifier(String)
	 * @generated
	 */
	void unsetResourceIdentifier();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceIdentifier Resource Identifier}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Resource Identifier' attribute is set.
	 * @see #unsetResourceIdentifier()
	 * @see #getResourceIdentifier()
	 * @see #setResourceIdentifier(String)
	 * @generated
	 */
	boolean isSetResourceIdentifier();

	/**
	 * Returns the value of the 'Resource Group' attribute.
	 * 
	 * 
	 * If the meaning of the 'Resource Group' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Resource Group' attribute.
	 * @see #isSetResourceGroup()
	 * @see #unsetResourceGroup()
	 * @see #setResourceGroup(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcConstructionResource_ResourceGroup()
	 * @model unsettable="true"
	 * @generated
	 */
	String getResourceGroup();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceGroup Resource Group}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Resource Group' attribute.
	 * @see #isSetResourceGroup()
	 * @see #unsetResourceGroup()
	 * @see #getResourceGroup()
	 * @generated
	 */
	void setResourceGroup(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceGroup Resource Group}' attribute.
	 * 
	 * 
	 * @see #isSetResourceGroup()
	 * @see #getResourceGroup()
	 * @see #setResourceGroup(String)
	 * @generated
	 */
	void unsetResourceGroup();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceGroup Resource Group}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Resource Group' attribute is set.
	 * @see #unsetResourceGroup()
	 * @see #getResourceGroup()
	 * @see #setResourceGroup(String)
	 * @generated
	 */
	boolean isSetResourceGroup();

	/**
	 * Returns the value of the 'Resource Consumption' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcResourceConsumptionEnum}.
	 * 
	 * 
	 * If the meaning of the 'Resource Consumption' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Resource Consumption' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcResourceConsumptionEnum
	 * @see #isSetResourceConsumption()
	 * @see #unsetResourceConsumption()
	 * @see #setResourceConsumption(IfcResourceConsumptionEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcConstructionResource_ResourceConsumption()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcResourceConsumptionEnum getResourceConsumption();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceConsumption Resource Consumption}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Resource Consumption' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcResourceConsumptionEnum
	 * @see #isSetResourceConsumption()
	 * @see #unsetResourceConsumption()
	 * @see #getResourceConsumption()
	 * @generated
	 */
	void setResourceConsumption(IfcResourceConsumptionEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceConsumption Resource Consumption}' attribute.
	 * 
	 * 
	 * @see #isSetResourceConsumption()
	 * @see #getResourceConsumption()
	 * @see #setResourceConsumption(IfcResourceConsumptionEnum)
	 * @generated
	 */
	void unsetResourceConsumption();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getResourceConsumption Resource Consumption}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Resource Consumption' attribute is set.
	 * @see #unsetResourceConsumption()
	 * @see #getResourceConsumption()
	 * @see #setResourceConsumption(IfcResourceConsumptionEnum)
	 * @generated
	 */
	boolean isSetResourceConsumption();

	/**
	 * Returns the value of the 'Base Quantity' reference.
	 * 
	 * 
	 * If the meaning of the 'Base Quantity' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Base Quantity' reference.
	 * @see #isSetBaseQuantity()
	 * @see #unsetBaseQuantity()
	 * @see #setBaseQuantity(IfcMeasureWithUnit)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcConstructionResource_BaseQuantity()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcMeasureWithUnit getBaseQuantity();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getBaseQuantity Base Quantity}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Base Quantity' reference.
	 * @see #isSetBaseQuantity()
	 * @see #unsetBaseQuantity()
	 * @see #getBaseQuantity()
	 * @generated
	 */
	void setBaseQuantity(IfcMeasureWithUnit value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getBaseQuantity Base Quantity}' reference.
	 * 
	 * 
	 * @see #isSetBaseQuantity()
	 * @see #getBaseQuantity()
	 * @see #setBaseQuantity(IfcMeasureWithUnit)
	 * @generated
	 */
	void unsetBaseQuantity();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcConstructionResource#getBaseQuantity Base Quantity}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Base Quantity' reference is set.
	 * @see #unsetBaseQuantity()
	 * @see #getBaseQuantity()
	 * @see #setBaseQuantity(IfcMeasureWithUnit)
	 * @generated
	 */
	boolean isSetBaseQuantity();

} // IfcConstructionResource