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

/**
 * 
 * A representation of the model object 'Ifc Light Source'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getName Name}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getLightColour Light Colour}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getAmbientIntensity Ambient Intensity}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getAmbientIntensityAsString Ambient Intensity As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getIntensity Intensity}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getIntensityAsString Intensity As String}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcLightSource()
 * @model
 * @generated
 */
public interface IfcLightSource extends IfcGeometricRepresentationItem {
	/**
	 * 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 #isSetName()
	 * @see #unsetName()
	 * @see #setName(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcLightSource_Name()
	 * @model unsettable="true"
	 * @generated
	 */
	String getName();

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

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getName Name}' attribute.
	 * 
	 * 
	 * @see #isSetName()
	 * @see #getName()
	 * @see #setName(String)
	 * @generated
	 */
	void unsetName();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getName Name}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Name' attribute is set.
	 * @see #unsetName()
	 * @see #getName()
	 * @see #setName(String)
	 * @generated
	 */
	boolean isSetName();

	/**
	 * Returns the value of the 'Light Colour' reference.
	 * 
	 * 
	 * If the meaning of the 'Light Colour' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Light Colour' reference.
	 * @see #setLightColour(IfcColourRgb)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcLightSource_LightColour()
	 * @model
	 * @generated
	 */
	IfcColourRgb getLightColour();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getLightColour Light Colour}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Light Colour' reference.
	 * @see #getLightColour()
	 * @generated
	 */
	void setLightColour(IfcColourRgb value);

	/**
	 * Returns the value of the 'Ambient Intensity' attribute.
	 * 
	 * 
	 * If the meaning of the 'Ambient Intensity' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Ambient Intensity' attribute.
	 * @see #isSetAmbientIntensity()
	 * @see #unsetAmbientIntensity()
	 * @see #setAmbientIntensity(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcLightSource_AmbientIntensity()
	 * @model unsettable="true"
	 * @generated
	 */
	double getAmbientIntensity();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getAmbientIntensity Ambient Intensity}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Ambient Intensity' attribute.
	 * @see #isSetAmbientIntensity()
	 * @see #unsetAmbientIntensity()
	 * @see #getAmbientIntensity()
	 * @generated
	 */
	void setAmbientIntensity(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getAmbientIntensity Ambient Intensity}' attribute.
	 * 
	 * 
	 * @see #isSetAmbientIntensity()
	 * @see #getAmbientIntensity()
	 * @see #setAmbientIntensity(double)
	 * @generated
	 */
	void unsetAmbientIntensity();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getAmbientIntensity Ambient Intensity}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Ambient Intensity' attribute is set.
	 * @see #unsetAmbientIntensity()
	 * @see #getAmbientIntensity()
	 * @see #setAmbientIntensity(double)
	 * @generated
	 */
	boolean isSetAmbientIntensity();

	/**
	 * Returns the value of the 'Ambient Intensity As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Ambient Intensity As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Ambient Intensity As String' attribute.
	 * @see #isSetAmbientIntensityAsString()
	 * @see #unsetAmbientIntensityAsString()
	 * @see #setAmbientIntensityAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcLightSource_AmbientIntensityAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getAmbientIntensityAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getAmbientIntensityAsString Ambient Intensity As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Ambient Intensity As String' attribute.
	 * @see #isSetAmbientIntensityAsString()
	 * @see #unsetAmbientIntensityAsString()
	 * @see #getAmbientIntensityAsString()
	 * @generated
	 */
	void setAmbientIntensityAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getAmbientIntensityAsString Ambient Intensity As String}' attribute.
	 * 
	 * 
	 * @see #isSetAmbientIntensityAsString()
	 * @see #getAmbientIntensityAsString()
	 * @see #setAmbientIntensityAsString(String)
	 * @generated
	 */
	void unsetAmbientIntensityAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getAmbientIntensityAsString Ambient Intensity As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Ambient Intensity As String' attribute is set.
	 * @see #unsetAmbientIntensityAsString()
	 * @see #getAmbientIntensityAsString()
	 * @see #setAmbientIntensityAsString(String)
	 * @generated
	 */
	boolean isSetAmbientIntensityAsString();

	/**
	 * Returns the value of the 'Intensity' attribute.
	 * 
	 * 
	 * If the meaning of the 'Intensity' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Intensity' attribute.
	 * @see #isSetIntensity()
	 * @see #unsetIntensity()
	 * @see #setIntensity(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcLightSource_Intensity()
	 * @model unsettable="true"
	 * @generated
	 */
	double getIntensity();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getIntensity Intensity}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Intensity' attribute.
	 * @see #isSetIntensity()
	 * @see #unsetIntensity()
	 * @see #getIntensity()
	 * @generated
	 */
	void setIntensity(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getIntensity Intensity}' attribute.
	 * 
	 * 
	 * @see #isSetIntensity()
	 * @see #getIntensity()
	 * @see #setIntensity(double)
	 * @generated
	 */
	void unsetIntensity();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getIntensity Intensity}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Intensity' attribute is set.
	 * @see #unsetIntensity()
	 * @see #getIntensity()
	 * @see #setIntensity(double)
	 * @generated
	 */
	boolean isSetIntensity();

	/**
	 * Returns the value of the 'Intensity As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Intensity As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Intensity As String' attribute.
	 * @see #isSetIntensityAsString()
	 * @see #unsetIntensityAsString()
	 * @see #setIntensityAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcLightSource_IntensityAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getIntensityAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getIntensityAsString Intensity As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Intensity As String' attribute.
	 * @see #isSetIntensityAsString()
	 * @see #unsetIntensityAsString()
	 * @see #getIntensityAsString()
	 * @generated
	 */
	void setIntensityAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getIntensityAsString Intensity As String}' attribute.
	 * 
	 * 
	 * @see #isSetIntensityAsString()
	 * @see #getIntensityAsString()
	 * @see #setIntensityAsString(String)
	 * @generated
	 */
	void unsetIntensityAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcLightSource#getIntensityAsString Intensity As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Intensity As String' attribute is set.
	 * @see #unsetIntensityAsString()
	 * @see #getIntensityAsString()
	 * @see #setIntensityAsString(String)
	 * @generated
	 */
	boolean isSetIntensityAsString();

} // IfcLightSource