org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue 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 Environmental Impact Value'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue#getImpactType Impact Type}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue#getCategory Category}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue#getUserDefinedCategory User Defined Category}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcEnvironmentalImpactValue()
 * @model
 * @generated
 */
public interface IfcEnvironmentalImpactValue extends IfcAppliedValue {
	/**
	 * Returns the value of the 'Impact Type' attribute.
	 * 
	 * 
	 * If the meaning of the 'Impact Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Impact Type' attribute.
	 * @see #setImpactType(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcEnvironmentalImpactValue_ImpactType()
	 * @model
	 * @generated
	 */
	String getImpactType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue#getImpactType Impact Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Impact Type' attribute.
	 * @see #getImpactType()
	 * @generated
	 */
	void setImpactType(String value);

	/**
	 * Returns the value of the 'Category' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactCategoryEnum}.
	 * 
	 * 
	 * If the meaning of the 'Category' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Category' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactCategoryEnum
	 * @see #setCategory(IfcEnvironmentalImpactCategoryEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcEnvironmentalImpactValue_Category()
	 * @model
	 * @generated
	 */
	IfcEnvironmentalImpactCategoryEnum getCategory();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue#getCategory Category}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Category' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactCategoryEnum
	 * @see #getCategory()
	 * @generated
	 */
	void setCategory(IfcEnvironmentalImpactCategoryEnum value);

	/**
	 * Returns the value of the 'User Defined Category' attribute.
	 * 
	 * 
	 * If the meaning of the 'User Defined Category' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User Defined Category' attribute.
	 * @see #isSetUserDefinedCategory()
	 * @see #unsetUserDefinedCategory()
	 * @see #setUserDefinedCategory(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcEnvironmentalImpactValue_UserDefinedCategory()
	 * @model unsettable="true"
	 * @generated
	 */
	String getUserDefinedCategory();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue#getUserDefinedCategory User Defined Category}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'User Defined Category' attribute.
	 * @see #isSetUserDefinedCategory()
	 * @see #unsetUserDefinedCategory()
	 * @see #getUserDefinedCategory()
	 * @generated
	 */
	void setUserDefinedCategory(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue#getUserDefinedCategory User Defined Category}' attribute.
	 * 
	 * 
	 * @see #isSetUserDefinedCategory()
	 * @see #getUserDefinedCategory()
	 * @see #setUserDefinedCategory(String)
	 * @generated
	 */
	void unsetUserDefinedCategory();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnvironmentalImpactValue#getUserDefinedCategory User Defined Category}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'User Defined Category' attribute is set.
	 * @see #unsetUserDefinedCategory()
	 * @see #getUserDefinedCategory()
	 * @see #setUserDefinedCategory(String)
	 * @generated
	 */
	boolean isSetUserDefinedCategory();

} // IfcEnvironmentalImpactValue