org.bimserver.models.ifc4.IfcMetric Maven / Gradle / Ivy

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;

/**
 * 
 * A representation of the model object 'Ifc Metric'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcMetric#getBenchmark Benchmark}
 *   {@link org.bimserver.models.ifc4.IfcMetric#getValueSource Value Source}
 *   {@link org.bimserver.models.ifc4.IfcMetric#getDataValue Data Value}
 *   {@link org.bimserver.models.ifc4.IfcMetric#getReferencePath Reference Path}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMetric()
 * @model
 * @generated
 */
public interface IfcMetric extends IfcConstraint {
	/**
	 * Returns the value of the 'Benchmark' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcBenchmarkEnum}.
	 * 
	 * 
	 * If the meaning of the 'Benchmark' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Benchmark' attribute.
	 * @see org.bimserver.models.ifc4.IfcBenchmarkEnum
	 * @see #setBenchmark(IfcBenchmarkEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMetric_Benchmark()
	 * @model
	 * @generated
	 */
	IfcBenchmarkEnum getBenchmark();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMetric#getBenchmark Benchmark}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Benchmark' attribute.
	 * @see org.bimserver.models.ifc4.IfcBenchmarkEnum
	 * @see #getBenchmark()
	 * @generated
	 */
	void setBenchmark(IfcBenchmarkEnum value);

	/**
	 * Returns the value of the 'Value Source' attribute.
	 * 
	 * 
	 * If the meaning of the 'Value Source' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Value Source' attribute.
	 * @see #isSetValueSource()
	 * @see #unsetValueSource()
	 * @see #setValueSource(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMetric_ValueSource()
	 * @model unsettable="true"
	 * @generated
	 */
	String getValueSource();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMetric#getValueSource Value Source}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Value Source' attribute.
	 * @see #isSetValueSource()
	 * @see #unsetValueSource()
	 * @see #getValueSource()
	 * @generated
	 */
	void setValueSource(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMetric#getValueSource Value Source}' attribute.
	 * 
	 * 
	 * @see #isSetValueSource()
	 * @see #getValueSource()
	 * @see #setValueSource(String)
	 * @generated
	 */
	void unsetValueSource();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMetric#getValueSource Value Source}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Value Source' attribute is set.
	 * @see #unsetValueSource()
	 * @see #getValueSource()
	 * @see #setValueSource(String)
	 * @generated
	 */
	boolean isSetValueSource();

	/**
	 * Returns the value of the 'Data Value' reference.
	 * 
	 * 
	 * If the meaning of the 'Data Value' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Data Value' reference.
	 * @see #setDataValue(IfcMetricValueSelect)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMetric_DataValue()
	 * @model
	 * @generated
	 */
	IfcMetricValueSelect getDataValue();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMetric#getDataValue Data Value}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Data Value' reference.
	 * @see #getDataValue()
	 * @generated
	 */
	void setDataValue(IfcMetricValueSelect value);

	/**
	 * Returns the value of the 'Reference Path' reference.
	 * 
	 * 
	 * If the meaning of the 'Reference Path' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Reference Path' reference.
	 * @see #isSetReferencePath()
	 * @see #unsetReferencePath()
	 * @see #setReferencePath(IfcReference)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcMetric_ReferencePath()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcReference getReferencePath();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcMetric#getReferencePath Reference Path}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Reference Path' reference.
	 * @see #isSetReferencePath()
	 * @see #unsetReferencePath()
	 * @see #getReferencePath()
	 * @generated
	 */
	void setReferencePath(IfcReference value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMetric#getReferencePath Reference Path}' reference.
	 * 
	 * 
	 * @see #isSetReferencePath()
	 * @see #getReferencePath()
	 * @see #setReferencePath(IfcReference)
	 * @generated
	 */
	void unsetReferencePath();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMetric#getReferencePath Reference Path}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Reference Path' reference is set.
	 * @see #unsetReferencePath()
	 * @see #getReferencePath()
	 * @see #setReferencePath(IfcReference)
	 * @generated
	 */
	boolean isSetReferencePath();

} // IfcMetric