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

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

/**
 * 
 * A representation of the model object 'Ifc Sound Properties'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSoundProperties#getIsAttenuating Is Attenuating}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSoundProperties#getSoundScale Sound Scale}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSoundProperties#getSoundValues Sound Values}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundProperties()
 * @model
 * @generated
 */
public interface IfcSoundProperties extends IfcPropertySetDefinition {
	/**
	 * Returns the value of the 'Is Attenuating' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.Tristate}.
	 * 
	 * 
	 * If the meaning of the 'Is Attenuating' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Is Attenuating' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.Tristate
	 * @see #setIsAttenuating(Tristate)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundProperties_IsAttenuating()
	 * @model
	 * @generated
	 */
	Tristate getIsAttenuating();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundProperties#getIsAttenuating Is Attenuating}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Is Attenuating' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.Tristate
	 * @see #getIsAttenuating()
	 * @generated
	 */
	void setIsAttenuating(Tristate value);

	/**
	 * Returns the value of the 'Sound Scale' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcSoundScaleEnum}.
	 * 
	 * 
	 * If the meaning of the 'Sound Scale' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Sound Scale' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcSoundScaleEnum
	 * @see #isSetSoundScale()
	 * @see #unsetSoundScale()
	 * @see #setSoundScale(IfcSoundScaleEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundProperties_SoundScale()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcSoundScaleEnum getSoundScale();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundProperties#getSoundScale Sound Scale}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Sound Scale' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcSoundScaleEnum
	 * @see #isSetSoundScale()
	 * @see #unsetSoundScale()
	 * @see #getSoundScale()
	 * @generated
	 */
	void setSoundScale(IfcSoundScaleEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundProperties#getSoundScale Sound Scale}' attribute.
	 * 
	 * 
	 * @see #isSetSoundScale()
	 * @see #getSoundScale()
	 * @see #setSoundScale(IfcSoundScaleEnum)
	 * @generated
	 */
	void unsetSoundScale();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSoundProperties#getSoundScale Sound Scale}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Sound Scale' attribute is set.
	 * @see #unsetSoundScale()
	 * @see #getSoundScale()
	 * @see #setSoundScale(IfcSoundScaleEnum)
	 * @generated
	 */
	boolean isSetSoundScale();

	/**
	 * Returns the value of the 'Sound Values' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc2x3tc1.IfcSoundValue}.
	 * 
	 * 
	 * If the meaning of the 'Sound Values' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Sound Values' reference list.
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSoundProperties_SoundValues()
	 * @model
	 * @generated
	 */
	EList getSoundValues();

} // IfcSoundProperties