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

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

/**
 * 
 * A representation of the model object 'Ifc Material'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcMaterial#getName Name}
 *   {@link org.bimserver.models.ifc4.IfcMaterial#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcMaterial#getCategory Category}
 *   {@link org.bimserver.models.ifc4.IfcMaterial#getHasRepresentation Has Representation}
 *   {@link org.bimserver.models.ifc4.IfcMaterial#getIsRelatedWith Is Related With}
 *   {@link org.bimserver.models.ifc4.IfcMaterial#getRelatesTo Relates To}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterial()
 * @model
 * @generated
 */
public interface IfcMaterial 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 #setName(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterial_Name()
	 * @model
	 * @generated
	 */
	String getName();

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

	/**
	 * 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#getIfcMaterial_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#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.IfcMaterial#getDescription Description}' attribute.
	 * 
	 * 
	 * @see #isSetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	void unsetDescription();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#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 '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#getIfcMaterial_Category()
	 * @model unsettable="true"
	 * @generated
	 */
	String getCategory();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#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.IfcMaterial#getCategory Category}' attribute.
	 * 
	 * 
	 * @see #isSetCategory()
	 * @see #getCategory()
	 * @see #setCategory(String)
	 * @generated
	 */
	void unsetCategory();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#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 'Has Representation' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcMaterialDefinitionRepresentation}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcMaterialDefinitionRepresentation#getRepresentedMaterial Represented Material}'.
	 * 
	 * 
	 * If the meaning of the 'Has Representation' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Representation' reference list.
	 * @see #isSetHasRepresentation()
	 * @see #unsetHasRepresentation()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterial_HasRepresentation()
	 * @see org.bimserver.models.ifc4.IfcMaterialDefinitionRepresentation#getRepresentedMaterial
	 * @model opposite="RepresentedMaterial" unsettable="true" upper="2"
	 * @generated
	 */
	EList getHasRepresentation();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#getHasRepresentation Has Representation}' reference list.
	 * 
	 * 
	 * @see #isSetHasRepresentation()
	 * @see #getHasRepresentation()
	 * @generated
	 */
	void unsetHasRepresentation();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#getHasRepresentation Has Representation}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Representation' reference list is set.
	 * @see #unsetHasRepresentation()
	 * @see #getHasRepresentation()
	 * @generated
	 */
	boolean isSetHasRepresentation();

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

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#getIsRelatedWith Is Related With}' reference list.
	 * 
	 * 
	 * @see #isSetIsRelatedWith()
	 * @see #getIsRelatedWith()
	 * @generated
	 */
	void unsetIsRelatedWith();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#getIsRelatedWith Is Related With}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Is Related With' reference list is set.
	 * @see #unsetIsRelatedWith()
	 * @see #getIsRelatedWith()
	 * @generated
	 */
	boolean isSetIsRelatedWith();

	/**
	 * Returns the value of the 'Relates To' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcMaterialRelationship}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcMaterialRelationship#getRelatingMaterial Relating Material}'.
	 * 
	 * 
	 * If the meaning of the 'Relates To' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Relates To' reference list.
	 * @see #isSetRelatesTo()
	 * @see #unsetRelatesTo()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterial_RelatesTo()
	 * @see org.bimserver.models.ifc4.IfcMaterialRelationship#getRelatingMaterial
	 * @model opposite="RelatingMaterial" unsettable="true" upper="2"
	 * @generated
	 */
	EList getRelatesTo();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#getRelatesTo Relates To}' reference list.
	 * 
	 * 
	 * @see #isSetRelatesTo()
	 * @see #getRelatesTo()
	 * @generated
	 */
	void unsetRelatesTo();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterial#getRelatesTo Relates To}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Relates To' reference list is set.
	 * @see #unsetRelatesTo()
	 * @see #getRelatesTo()
	 * @generated
	 */
	boolean isSetRelatesTo();

} // IfcMaterial