org.bimserver.models.ifc4.IfcMaterialConstituent 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 Material Constituent'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcMaterialConstituent#getName Name}
 *   {@link org.bimserver.models.ifc4.IfcMaterialConstituent#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcMaterialConstituent#getMaterial Material}
 *   {@link org.bimserver.models.ifc4.IfcMaterialConstituent#getFraction Fraction}
 *   {@link org.bimserver.models.ifc4.IfcMaterialConstituent#getFractionAsString Fraction As String}
 *   {@link org.bimserver.models.ifc4.IfcMaterialConstituent#getCategory Category}
 *   {@link org.bimserver.models.ifc4.IfcMaterialConstituent#getToMaterialConstituentSet To Material Constituent Set}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialConstituent()
 * @model
 * @generated
 */
public interface IfcMaterialConstituent extends IfcMaterialDefinition {
	/**
	 * Returns the value of the 'Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Name' attribute.
	 * @see #isSetName()
	 * @see #unsetName()
	 * @see #setName(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialConstituent_Name()
	 * @model unsettable="true"
	 * @generated
	 */
	String getName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getName Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Name' attribute.
	 * @see #isSetName()
	 * @see #unsetName()
	 * @see #getName()
	 * @generated
	 */
	void setName(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getName Name}' attribute.
	 * 
	 * 
	 * @see #isSetName()
	 * @see #getName()
	 * @see #setName(String)
	 * @generated
	 */
	void unsetName();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getName Name}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Name' attribute is set.
	 * @see #unsetName()
	 * @see #getName()
	 * @see #setName(String)
	 * @generated
	 */
	boolean isSetName();

	/**
	 * Returns the value of the 'Description' attribute.
	 * 
	 * 
	 * If the meaning of the 'Description' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Description' attribute.
	 * @see #isSetDescription()
	 * @see #unsetDescription()
	 * @see #setDescription(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialConstituent_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getDescription Description}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Description' attribute.
	 * @see #isSetDescription()
	 * @see #unsetDescription()
	 * @see #getDescription()
	 * @generated
	 */
	void setDescription(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getDescription Description}' attribute.
	 * 
	 * 
	 * @see #isSetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	void unsetDescription();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getDescription Description}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Description' attribute is set.
	 * @see #unsetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	boolean isSetDescription();

	/**
	 * Returns the value of the 'Material' reference.
	 * 
	 * 
	 * If the meaning of the 'Material' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Material' reference.
	 * @see #setMaterial(IfcMaterial)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialConstituent_Material()
	 * @model
	 * @generated
	 */
	IfcMaterial getMaterial();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getMaterial Material}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Material' reference.
	 * @see #getMaterial()
	 * @generated
	 */
	void setMaterial(IfcMaterial value);

	/**
	 * Returns the value of the 'Fraction' attribute.
	 * 
	 * 
	 * If the meaning of the 'Fraction' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Fraction' attribute.
	 * @see #isSetFraction()
	 * @see #unsetFraction()
	 * @see #setFraction(double)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialConstituent_Fraction()
	 * @model unsettable="true"
	 * @generated
	 */
	double getFraction();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getFraction Fraction}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Fraction' attribute.
	 * @see #isSetFraction()
	 * @see #unsetFraction()
	 * @see #getFraction()
	 * @generated
	 */
	void setFraction(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getFraction Fraction}' attribute.
	 * 
	 * 
	 * @see #isSetFraction()
	 * @see #getFraction()
	 * @see #setFraction(double)
	 * @generated
	 */
	void unsetFraction();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getFraction Fraction}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Fraction' attribute is set.
	 * @see #unsetFraction()
	 * @see #getFraction()
	 * @see #setFraction(double)
	 * @generated
	 */
	boolean isSetFraction();

	/**
	 * Returns the value of the 'Fraction As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Fraction As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Fraction As String' attribute.
	 * @see #isSetFractionAsString()
	 * @see #unsetFractionAsString()
	 * @see #setFractionAsString(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialConstituent_FractionAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getFractionAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getFractionAsString Fraction As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Fraction As String' attribute.
	 * @see #isSetFractionAsString()
	 * @see #unsetFractionAsString()
	 * @see #getFractionAsString()
	 * @generated
	 */
	void setFractionAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getFractionAsString Fraction As String}' attribute.
	 * 
	 * 
	 * @see #isSetFractionAsString()
	 * @see #getFractionAsString()
	 * @see #setFractionAsString(String)
	 * @generated
	 */
	void unsetFractionAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getFractionAsString Fraction As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Fraction As String' attribute is set.
	 * @see #unsetFractionAsString()
	 * @see #getFractionAsString()
	 * @see #setFractionAsString(String)
	 * @generated
	 */
	boolean isSetFractionAsString();

	/**
	 * Returns the value of the 'Category' attribute.
	 * 
	 * 
	 * 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 #isSetCategory()
	 * @see #unsetCategory()
	 * @see #setCategory(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialConstituent_Category()
	 * @model unsettable="true"
	 * @generated
	 */
	String getCategory();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getCategory Category}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Category' attribute.
	 * @see #isSetCategory()
	 * @see #unsetCategory()
	 * @see #getCategory()
	 * @generated
	 */
	void setCategory(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getCategory Category}' attribute.
	 * 
	 * 
	 * @see #isSetCategory()
	 * @see #getCategory()
	 * @see #setCategory(String)
	 * @generated
	 */
	void unsetCategory();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getCategory Category}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Category' attribute is set.
	 * @see #unsetCategory()
	 * @see #getCategory()
	 * @see #setCategory(String)
	 * @generated
	 */
	boolean isSetCategory();

	/**
	 * Returns the value of the 'To Material Constituent Set' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcMaterialConstituentSet#getMaterialConstituents Material Constituents}'.
	 * 
	 * 
	 * If the meaning of the 'To Material Constituent Set' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'To Material Constituent Set' reference.
	 * @see #isSetToMaterialConstituentSet()
	 * @see #unsetToMaterialConstituentSet()
	 * @see #setToMaterialConstituentSet(IfcMaterialConstituentSet)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialConstituent_ToMaterialConstituentSet()
	 * @see org.bimserver.models.ifc4.IfcMaterialConstituentSet#getMaterialConstituents
	 * @model opposite="MaterialConstituents" unsettable="true"
	 * @generated
	 */
	IfcMaterialConstituentSet getToMaterialConstituentSet();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getToMaterialConstituentSet To Material Constituent Set}' reference.
	 * 
	 * 
	 * @param value the new value of the 'To Material Constituent Set' reference.
	 * @see #isSetToMaterialConstituentSet()
	 * @see #unsetToMaterialConstituentSet()
	 * @see #getToMaterialConstituentSet()
	 * @generated
	 */
	void setToMaterialConstituentSet(IfcMaterialConstituentSet value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getToMaterialConstituentSet To Material Constituent Set}' reference.
	 * 
	 * 
	 * @see #isSetToMaterialConstituentSet()
	 * @see #getToMaterialConstituentSet()
	 * @see #setToMaterialConstituentSet(IfcMaterialConstituentSet)
	 * @generated
	 */
	void unsetToMaterialConstituentSet();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialConstituent#getToMaterialConstituentSet To Material Constituent Set}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'To Material Constituent Set' reference is set.
	 * @see #unsetToMaterialConstituentSet()
	 * @see #getToMaterialConstituentSet()
	 * @see #setToMaterialConstituentSet(IfcMaterialConstituentSet)
	 * @generated
	 */
	boolean isSetToMaterialConstituentSet();

} // IfcMaterialConstituent