org.bimserver.models.ifc4.IfcMaterialRelationship 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;

import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Ifc Material Relationship'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcMaterialRelationship#getRelatingMaterial Relating Material}
 *   {@link org.bimserver.models.ifc4.IfcMaterialRelationship#getRelatedMaterials Related Materials}
 *   {@link org.bimserver.models.ifc4.IfcMaterialRelationship#getExpression Expression}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialRelationship()
 * @model
 * @generated
 */
public interface IfcMaterialRelationship extends IfcResourceLevelRelationship {
	/**
	 * Returns the value of the 'Relating Material' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcMaterial#getRelatesTo Relates To}'.
	 * 
	 * 
	 * If the meaning of the 'Relating Material' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Relating Material' reference.
	 * @see #setRelatingMaterial(IfcMaterial)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialRelationship_RelatingMaterial()
	 * @see org.bimserver.models.ifc4.IfcMaterial#getRelatesTo
	 * @model opposite="RelatesTo"
	 * @generated
	 */
	IfcMaterial getRelatingMaterial();

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

	/**
	 * Returns the value of the 'Related Materials' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcMaterial}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcMaterial#getIsRelatedWith Is Related With}'.
	 * 
	 * 
	 * If the meaning of the 'Related Materials' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Related Materials' reference list.
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialRelationship_RelatedMaterials()
	 * @see org.bimserver.models.ifc4.IfcMaterial#getIsRelatedWith
	 * @model opposite="IsRelatedWith"
	 * @generated
	 */
	EList getRelatedMaterials();

	/**
	 * Returns the value of the 'Expression' attribute.
	 * 
	 * 
	 * If the meaning of the 'Expression' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Expression' attribute.
	 * @see #isSetExpression()
	 * @see #unsetExpression()
	 * @see #setExpression(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialRelationship_Expression()
	 * @model unsettable="true"
	 * @generated
	 */
	String getExpression();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialRelationship#getExpression Expression}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Expression' attribute.
	 * @see #isSetExpression()
	 * @see #unsetExpression()
	 * @see #getExpression()
	 * @generated
	 */
	void setExpression(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialRelationship#getExpression Expression}' attribute.
	 * 
	 * 
	 * @see #isSetExpression()
	 * @see #getExpression()
	 * @see #setExpression(String)
	 * @generated
	 */
	void unsetExpression();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialRelationship#getExpression Expression}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Expression' attribute is set.
	 * @see #unsetExpression()
	 * @see #getExpression()
	 * @see #setExpression(String)
	 * @generated
	 */
	boolean isSetExpression();

} // IfcMaterialRelationship