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

/**
 * 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 Light Source Goniometric'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getPosition Position}
 *   {@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getColourAppearance Colour Appearance}
 *   {@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getColourTemperature Colour Temperature}
 *   {@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getColourTemperatureAsString Colour Temperature As String}
 *   {@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getLuminousFlux Luminous Flux}
 *   {@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getLuminousFluxAsString Luminous Flux As String}
 *   {@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getLightEmissionSource Light Emission Source}
 *   {@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getLightDistributionDataSource Light Distribution Data Source}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric()
 * @model
 * @generated
 */
public interface IfcLightSourceGoniometric extends IfcLightSource {
	/**
	 * Returns the value of the 'Position' reference.
	 * 
	 * 
	 * If the meaning of the 'Position' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Position' reference.
	 * @see #setPosition(IfcAxis2Placement3D)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric_Position()
	 * @model
	 * @generated
	 */
	IfcAxis2Placement3D getPosition();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getPosition Position}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Position' reference.
	 * @see #getPosition()
	 * @generated
	 */
	void setPosition(IfcAxis2Placement3D value);

	/**
	 * Returns the value of the 'Colour Appearance' reference.
	 * 
	 * 
	 * If the meaning of the 'Colour Appearance' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Colour Appearance' reference.
	 * @see #isSetColourAppearance()
	 * @see #unsetColourAppearance()
	 * @see #setColourAppearance(IfcColourRgb)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric_ColourAppearance()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcColourRgb getColourAppearance();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getColourAppearance Colour Appearance}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Colour Appearance' reference.
	 * @see #isSetColourAppearance()
	 * @see #unsetColourAppearance()
	 * @see #getColourAppearance()
	 * @generated
	 */
	void setColourAppearance(IfcColourRgb value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getColourAppearance Colour Appearance}' reference.
	 * 
	 * 
	 * @see #isSetColourAppearance()
	 * @see #getColourAppearance()
	 * @see #setColourAppearance(IfcColourRgb)
	 * @generated
	 */
	void unsetColourAppearance();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getColourAppearance Colour Appearance}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Colour Appearance' reference is set.
	 * @see #unsetColourAppearance()
	 * @see #getColourAppearance()
	 * @see #setColourAppearance(IfcColourRgb)
	 * @generated
	 */
	boolean isSetColourAppearance();

	/**
	 * Returns the value of the 'Colour Temperature' attribute.
	 * 
	 * 
	 * If the meaning of the 'Colour Temperature' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Colour Temperature' attribute.
	 * @see #setColourTemperature(double)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric_ColourTemperature()
	 * @model
	 * @generated
	 */
	double getColourTemperature();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getColourTemperature Colour Temperature}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Colour Temperature' attribute.
	 * @see #getColourTemperature()
	 * @generated
	 */
	void setColourTemperature(double value);

	/**
	 * Returns the value of the 'Colour Temperature As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Colour Temperature As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Colour Temperature As String' attribute.
	 * @see #setColourTemperatureAsString(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric_ColourTemperatureAsString()
	 * @model
	 * @generated
	 */
	String getColourTemperatureAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getColourTemperatureAsString Colour Temperature As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Colour Temperature As String' attribute.
	 * @see #getColourTemperatureAsString()
	 * @generated
	 */
	void setColourTemperatureAsString(String value);

	/**
	 * Returns the value of the 'Luminous Flux' attribute.
	 * 
	 * 
	 * If the meaning of the 'Luminous Flux' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Luminous Flux' attribute.
	 * @see #setLuminousFlux(double)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric_LuminousFlux()
	 * @model
	 * @generated
	 */
	double getLuminousFlux();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getLuminousFlux Luminous Flux}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Luminous Flux' attribute.
	 * @see #getLuminousFlux()
	 * @generated
	 */
	void setLuminousFlux(double value);

	/**
	 * Returns the value of the 'Luminous Flux As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Luminous Flux As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Luminous Flux As String' attribute.
	 * @see #setLuminousFluxAsString(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric_LuminousFluxAsString()
	 * @model
	 * @generated
	 */
	String getLuminousFluxAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getLuminousFluxAsString Luminous Flux As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Luminous Flux As String' attribute.
	 * @see #getLuminousFluxAsString()
	 * @generated
	 */
	void setLuminousFluxAsString(String value);

	/**
	 * Returns the value of the 'Light Emission Source' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcLightEmissionSourceEnum}.
	 * 
	 * 
	 * If the meaning of the 'Light Emission Source' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Light Emission Source' attribute.
	 * @see org.bimserver.models.ifc4.IfcLightEmissionSourceEnum
	 * @see #setLightEmissionSource(IfcLightEmissionSourceEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric_LightEmissionSource()
	 * @model
	 * @generated
	 */
	IfcLightEmissionSourceEnum getLightEmissionSource();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getLightEmissionSource Light Emission Source}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Light Emission Source' attribute.
	 * @see org.bimserver.models.ifc4.IfcLightEmissionSourceEnum
	 * @see #getLightEmissionSource()
	 * @generated
	 */
	void setLightEmissionSource(IfcLightEmissionSourceEnum value);

	/**
	 * Returns the value of the 'Light Distribution Data Source' reference.
	 * 
	 * 
	 * If the meaning of the 'Light Distribution Data Source' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Light Distribution Data Source' reference.
	 * @see #setLightDistributionDataSource(IfcLightDistributionDataSourceSelect)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLightSourceGoniometric_LightDistributionDataSource()
	 * @model
	 * @generated
	 */
	IfcLightDistributionDataSourceSelect getLightDistributionDataSource();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLightSourceGoniometric#getLightDistributionDataSource Light Distribution Data Source}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Light Distribution Data Source' reference.
	 * @see #getLightDistributionDataSource()
	 * @generated
	 */
	void setLightDistributionDataSource(IfcLightDistributionDataSourceSelect value);

} // IfcLightSourceGoniometric