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

/**
 * 
 * A representation of the model object 'Ifc Energy Properties'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcEnergyProperties#getEnergySequence Energy Sequence}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcEnergyProperties#getUserDefinedEnergySequence User Defined Energy Sequence}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcEnergyProperties()
 * @model
 * @generated
 */
public interface IfcEnergyProperties extends IfcPropertySetDefinition {
	/**
	 * Returns the value of the 'Energy Sequence' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcEnergySequenceEnum}.
	 * 
	 * 
	 * If the meaning of the 'Energy Sequence' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Energy Sequence' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcEnergySequenceEnum
	 * @see #isSetEnergySequence()
	 * @see #unsetEnergySequence()
	 * @see #setEnergySequence(IfcEnergySequenceEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcEnergyProperties_EnergySequence()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcEnergySequenceEnum getEnergySequence();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnergyProperties#getEnergySequence Energy Sequence}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Energy Sequence' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcEnergySequenceEnum
	 * @see #isSetEnergySequence()
	 * @see #unsetEnergySequence()
	 * @see #getEnergySequence()
	 * @generated
	 */
	void setEnergySequence(IfcEnergySequenceEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnergyProperties#getEnergySequence Energy Sequence}' attribute.
	 * 
	 * 
	 * @see #isSetEnergySequence()
	 * @see #getEnergySequence()
	 * @see #setEnergySequence(IfcEnergySequenceEnum)
	 * @generated
	 */
	void unsetEnergySequence();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnergyProperties#getEnergySequence Energy Sequence}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Energy Sequence' attribute is set.
	 * @see #unsetEnergySequence()
	 * @see #getEnergySequence()
	 * @see #setEnergySequence(IfcEnergySequenceEnum)
	 * @generated
	 */
	boolean isSetEnergySequence();

	/**
	 * Returns the value of the 'User Defined Energy Sequence' attribute.
	 * 
	 * 
	 * If the meaning of the 'User Defined Energy Sequence' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User Defined Energy Sequence' attribute.
	 * @see #isSetUserDefinedEnergySequence()
	 * @see #unsetUserDefinedEnergySequence()
	 * @see #setUserDefinedEnergySequence(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcEnergyProperties_UserDefinedEnergySequence()
	 * @model unsettable="true"
	 * @generated
	 */
	String getUserDefinedEnergySequence();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnergyProperties#getUserDefinedEnergySequence User Defined Energy Sequence}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'User Defined Energy Sequence' attribute.
	 * @see #isSetUserDefinedEnergySequence()
	 * @see #unsetUserDefinedEnergySequence()
	 * @see #getUserDefinedEnergySequence()
	 * @generated
	 */
	void setUserDefinedEnergySequence(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnergyProperties#getUserDefinedEnergySequence User Defined Energy Sequence}' attribute.
	 * 
	 * 
	 * @see #isSetUserDefinedEnergySequence()
	 * @see #getUserDefinedEnergySequence()
	 * @see #setUserDefinedEnergySequence(String)
	 * @generated
	 */
	void unsetUserDefinedEnergySequence();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcEnergyProperties#getUserDefinedEnergySequence User Defined Energy Sequence}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'User Defined Energy Sequence' attribute is set.
	 * @see #unsetUserDefinedEnergySequence()
	 * @see #getUserDefinedEnergySequence()
	 * @see #setUserDefinedEnergySequence(String)
	 * @generated
	 */
	boolean isSetUserDefinedEnergySequence();

} // IfcEnergyProperties