org.bimserver.models.ifc4.IfcPhysicalQuantity 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 Physical Quantity'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcPhysicalQuantity#getName Name}
 *   {@link org.bimserver.models.ifc4.IfcPhysicalQuantity#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcPhysicalQuantity#getHasExternalReferences Has External References}
 *   {@link org.bimserver.models.ifc4.IfcPhysicalQuantity#getPartOfComplex Part Of Complex}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPhysicalQuantity()
 * @model
 * @generated
 */
public interface IfcPhysicalQuantity extends IfcResourceObjectSelect {
	/**
	 * 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#getIfcPhysicalQuantity_Name()
	 * @model
	 * @generated
	 */
	String getName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcPhysicalQuantity#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#getIfcPhysicalQuantity_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

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

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPhysicalQuantity#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 'Has External References' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcExternalReferenceRelationship}.
	 * 
	 * 
	 * If the meaning of the 'Has External References' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has External References' reference list.
	 * @see #isSetHasExternalReferences()
	 * @see #unsetHasExternalReferences()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPhysicalQuantity_HasExternalReferences()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getHasExternalReferences();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcPhysicalQuantity#getHasExternalReferences Has External References}' reference list.
	 * 
	 * 
	 * @see #isSetHasExternalReferences()
	 * @see #getHasExternalReferences()
	 * @generated
	 */
	void unsetHasExternalReferences();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPhysicalQuantity#getHasExternalReferences Has External References}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has External References' reference list is set.
	 * @see #unsetHasExternalReferences()
	 * @see #getHasExternalReferences()
	 * @generated
	 */
	boolean isSetHasExternalReferences();

	/**
	 * Returns the value of the 'Part Of Complex' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcPhysicalComplexQuantity}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcPhysicalComplexQuantity#getHasQuantities Has Quantities}'.
	 * 
	 * 
	 * If the meaning of the 'Part Of Complex' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Part Of Complex' reference list.
	 * @see #isSetPartOfComplex()
	 * @see #unsetPartOfComplex()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPhysicalQuantity_PartOfComplex()
	 * @see org.bimserver.models.ifc4.IfcPhysicalComplexQuantity#getHasQuantities
	 * @model opposite="HasQuantities" unsettable="true" upper="2"
	 * @generated
	 */
	EList getPartOfComplex();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcPhysicalQuantity#getPartOfComplex Part Of Complex}' reference list.
	 * 
	 * 
	 * @see #isSetPartOfComplex()
	 * @see #getPartOfComplex()
	 * @generated
	 */
	void unsetPartOfComplex();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPhysicalQuantity#getPartOfComplex Part Of Complex}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Part Of Complex' reference list is set.
	 * @see #unsetPartOfComplex()
	 * @see #getPartOfComplex()
	 * @generated
	 */
	boolean isSetPartOfComplex();

} // IfcPhysicalQuantity