org.bimserver.models.ifc2x3tc1.IfcSoundValue 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.ifc2x3tc1;

/**
 * 
 * A representation of the model object 'Ifc Sound Value'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getSoundLevelTimeSeries Sound Level Time Series}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getFrequency Frequency}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getFrequencyAsString Frequency As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getSoundLevelSingleValue Sound Level Single Value}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundValue()
 * @model
 * @generated
 */
public interface IfcSoundValue extends IfcPropertySetDefinition {
	/**
	 * Returns the value of the 'Sound Level Time Series' reference.
	 * 
	 * 
	 * If the meaning of the 'Sound Level Time Series' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Sound Level Time Series' reference.
	 * @see #isSetSoundLevelTimeSeries()
	 * @see #unsetSoundLevelTimeSeries()
	 * @see #setSoundLevelTimeSeries(IfcTimeSeries)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundValue_SoundLevelTimeSeries()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcTimeSeries getSoundLevelTimeSeries();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getSoundLevelTimeSeries Sound Level Time Series}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Sound Level Time Series' reference.
	 * @see #isSetSoundLevelTimeSeries()
	 * @see #unsetSoundLevelTimeSeries()
	 * @see #getSoundLevelTimeSeries()
	 * @generated
	 */
	void setSoundLevelTimeSeries(IfcTimeSeries value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getSoundLevelTimeSeries Sound Level Time Series}' reference.
	 * 
	 * 
	 * @see #isSetSoundLevelTimeSeries()
	 * @see #getSoundLevelTimeSeries()
	 * @see #setSoundLevelTimeSeries(IfcTimeSeries)
	 * @generated
	 */
	void unsetSoundLevelTimeSeries();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getSoundLevelTimeSeries Sound Level Time Series}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Sound Level Time Series' reference is set.
	 * @see #unsetSoundLevelTimeSeries()
	 * @see #getSoundLevelTimeSeries()
	 * @see #setSoundLevelTimeSeries(IfcTimeSeries)
	 * @generated
	 */
	boolean isSetSoundLevelTimeSeries();

	/**
	 * Returns the value of the 'Frequency' attribute.
	 * 
	 * 
	 * If the meaning of the 'Frequency' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Frequency' attribute.
	 * @see #setFrequency(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundValue_Frequency()
	 * @model
	 * @generated
	 */
	double getFrequency();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getFrequency Frequency}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Frequency' attribute.
	 * @see #getFrequency()
	 * @generated
	 */
	void setFrequency(double value);

	/**
	 * Returns the value of the 'Frequency As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Frequency As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Frequency As String' attribute.
	 * @see #setFrequencyAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundValue_FrequencyAsString()
	 * @model
	 * @generated
	 */
	String getFrequencyAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getFrequencyAsString Frequency As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Frequency As String' attribute.
	 * @see #getFrequencyAsString()
	 * @generated
	 */
	void setFrequencyAsString(String value);

	/**
	 * Returns the value of the 'Sound Level Single Value' reference.
	 * 
	 * 
	 * If the meaning of the 'Sound Level Single Value' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Sound Level Single Value' reference.
	 * @see #isSetSoundLevelSingleValue()
	 * @see #unsetSoundLevelSingleValue()
	 * @see #setSoundLevelSingleValue(IfcDerivedMeasureValue)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundValue_SoundLevelSingleValue()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcDerivedMeasureValue getSoundLevelSingleValue();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getSoundLevelSingleValue Sound Level Single Value}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Sound Level Single Value' reference.
	 * @see #isSetSoundLevelSingleValue()
	 * @see #unsetSoundLevelSingleValue()
	 * @see #getSoundLevelSingleValue()
	 * @generated
	 */
	void setSoundLevelSingleValue(IfcDerivedMeasureValue value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getSoundLevelSingleValue Sound Level Single Value}' reference.
	 * 
	 * 
	 * @see #isSetSoundLevelSingleValue()
	 * @see #getSoundLevelSingleValue()
	 * @see #setSoundLevelSingleValue(IfcDerivedMeasureValue)
	 * @generated
	 */
	void unsetSoundLevelSingleValue();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundValue#getSoundLevelSingleValue Sound Level Single Value}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Sound Level Single Value' reference is set.
	 * @see #unsetSoundLevelSingleValue()
	 * @see #getSoundLevelSingleValue()
	 * @see #setSoundLevelSingleValue(IfcDerivedMeasureValue)
	 * @generated
	 */
	boolean isSetSoundLevelSingleValue();

} // IfcSoundValue