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

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

/**
 * 
 * A representation of the model object 'Ifc Space Program'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getSpaceProgramIdentifier Space Program Identifier}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMaxRequiredArea Max Required Area}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMaxRequiredAreaAsString Max Required Area As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMinRequiredArea Min Required Area}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMinRequiredAreaAsString Min Required Area As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getRequestedLocation Requested Location}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getStandardRequiredArea Standard Required Area}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getStandardRequiredAreaAsString Standard Required Area As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getHasInteractionReqsFrom Has Interaction Reqs From}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getHasInteractionReqsTo Has Interaction Reqs To}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram()
 * @model
 * @generated
 */
public interface IfcSpaceProgram extends IfcControl {
	/**
	 * Returns the value of the 'Space Program Identifier' attribute.
	 * 
	 * 
	 * If the meaning of the 'Space Program Identifier' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Space Program Identifier' attribute.
	 * @see #setSpaceProgramIdentifier(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_SpaceProgramIdentifier()
	 * @model
	 * @generated
	 */
	String getSpaceProgramIdentifier();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getSpaceProgramIdentifier Space Program Identifier}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Space Program Identifier' attribute.
	 * @see #getSpaceProgramIdentifier()
	 * @generated
	 */
	void setSpaceProgramIdentifier(String value);

	/**
	 * Returns the value of the 'Max Required Area' attribute.
	 * 
	 * 
	 * If the meaning of the 'Max Required Area' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Max Required Area' attribute.
	 * @see #isSetMaxRequiredArea()
	 * @see #unsetMaxRequiredArea()
	 * @see #setMaxRequiredArea(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_MaxRequiredArea()
	 * @model unsettable="true"
	 * @generated
	 */
	double getMaxRequiredArea();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMaxRequiredArea Max Required Area}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Max Required Area' attribute.
	 * @see #isSetMaxRequiredArea()
	 * @see #unsetMaxRequiredArea()
	 * @see #getMaxRequiredArea()
	 * @generated
	 */
	void setMaxRequiredArea(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMaxRequiredArea Max Required Area}' attribute.
	 * 
	 * 
	 * @see #isSetMaxRequiredArea()
	 * @see #getMaxRequiredArea()
	 * @see #setMaxRequiredArea(double)
	 * @generated
	 */
	void unsetMaxRequiredArea();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMaxRequiredArea Max Required Area}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Max Required Area' attribute is set.
	 * @see #unsetMaxRequiredArea()
	 * @see #getMaxRequiredArea()
	 * @see #setMaxRequiredArea(double)
	 * @generated
	 */
	boolean isSetMaxRequiredArea();

	/**
	 * Returns the value of the 'Max Required Area As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Max Required Area As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Max Required Area As String' attribute.
	 * @see #isSetMaxRequiredAreaAsString()
	 * @see #unsetMaxRequiredAreaAsString()
	 * @see #setMaxRequiredAreaAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_MaxRequiredAreaAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getMaxRequiredAreaAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMaxRequiredAreaAsString Max Required Area As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Max Required Area As String' attribute.
	 * @see #isSetMaxRequiredAreaAsString()
	 * @see #unsetMaxRequiredAreaAsString()
	 * @see #getMaxRequiredAreaAsString()
	 * @generated
	 */
	void setMaxRequiredAreaAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMaxRequiredAreaAsString Max Required Area As String}' attribute.
	 * 
	 * 
	 * @see #isSetMaxRequiredAreaAsString()
	 * @see #getMaxRequiredAreaAsString()
	 * @see #setMaxRequiredAreaAsString(String)
	 * @generated
	 */
	void unsetMaxRequiredAreaAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMaxRequiredAreaAsString Max Required Area As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Max Required Area As String' attribute is set.
	 * @see #unsetMaxRequiredAreaAsString()
	 * @see #getMaxRequiredAreaAsString()
	 * @see #setMaxRequiredAreaAsString(String)
	 * @generated
	 */
	boolean isSetMaxRequiredAreaAsString();

	/**
	 * Returns the value of the 'Min Required Area' attribute.
	 * 
	 * 
	 * If the meaning of the 'Min Required Area' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Min Required Area' attribute.
	 * @see #isSetMinRequiredArea()
	 * @see #unsetMinRequiredArea()
	 * @see #setMinRequiredArea(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_MinRequiredArea()
	 * @model unsettable="true"
	 * @generated
	 */
	double getMinRequiredArea();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMinRequiredArea Min Required Area}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Min Required Area' attribute.
	 * @see #isSetMinRequiredArea()
	 * @see #unsetMinRequiredArea()
	 * @see #getMinRequiredArea()
	 * @generated
	 */
	void setMinRequiredArea(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMinRequiredArea Min Required Area}' attribute.
	 * 
	 * 
	 * @see #isSetMinRequiredArea()
	 * @see #getMinRequiredArea()
	 * @see #setMinRequiredArea(double)
	 * @generated
	 */
	void unsetMinRequiredArea();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMinRequiredArea Min Required Area}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Min Required Area' attribute is set.
	 * @see #unsetMinRequiredArea()
	 * @see #getMinRequiredArea()
	 * @see #setMinRequiredArea(double)
	 * @generated
	 */
	boolean isSetMinRequiredArea();

	/**
	 * Returns the value of the 'Min Required Area As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Min Required Area As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Min Required Area As String' attribute.
	 * @see #isSetMinRequiredAreaAsString()
	 * @see #unsetMinRequiredAreaAsString()
	 * @see #setMinRequiredAreaAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_MinRequiredAreaAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getMinRequiredAreaAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMinRequiredAreaAsString Min Required Area As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Min Required Area As String' attribute.
	 * @see #isSetMinRequiredAreaAsString()
	 * @see #unsetMinRequiredAreaAsString()
	 * @see #getMinRequiredAreaAsString()
	 * @generated
	 */
	void setMinRequiredAreaAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMinRequiredAreaAsString Min Required Area As String}' attribute.
	 * 
	 * 
	 * @see #isSetMinRequiredAreaAsString()
	 * @see #getMinRequiredAreaAsString()
	 * @see #setMinRequiredAreaAsString(String)
	 * @generated
	 */
	void unsetMinRequiredAreaAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getMinRequiredAreaAsString Min Required Area As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Min Required Area As String' attribute is set.
	 * @see #unsetMinRequiredAreaAsString()
	 * @see #getMinRequiredAreaAsString()
	 * @see #setMinRequiredAreaAsString(String)
	 * @generated
	 */
	boolean isSetMinRequiredAreaAsString();

	/**
	 * Returns the value of the 'Requested Location' reference.
	 * 
	 * 
	 * If the meaning of the 'Requested Location' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Requested Location' reference.
	 * @see #isSetRequestedLocation()
	 * @see #unsetRequestedLocation()
	 * @see #setRequestedLocation(IfcSpatialStructureElement)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_RequestedLocation()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcSpatialStructureElement getRequestedLocation();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getRequestedLocation Requested Location}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Requested Location' reference.
	 * @see #isSetRequestedLocation()
	 * @see #unsetRequestedLocation()
	 * @see #getRequestedLocation()
	 * @generated
	 */
	void setRequestedLocation(IfcSpatialStructureElement value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getRequestedLocation Requested Location}' reference.
	 * 
	 * 
	 * @see #isSetRequestedLocation()
	 * @see #getRequestedLocation()
	 * @see #setRequestedLocation(IfcSpatialStructureElement)
	 * @generated
	 */
	void unsetRequestedLocation();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getRequestedLocation Requested Location}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Requested Location' reference is set.
	 * @see #unsetRequestedLocation()
	 * @see #getRequestedLocation()
	 * @see #setRequestedLocation(IfcSpatialStructureElement)
	 * @generated
	 */
	boolean isSetRequestedLocation();

	/**
	 * Returns the value of the 'Standard Required Area' attribute.
	 * 
	 * 
	 * If the meaning of the 'Standard Required Area' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Standard Required Area' attribute.
	 * @see #setStandardRequiredArea(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_StandardRequiredArea()
	 * @model
	 * @generated
	 */
	double getStandardRequiredArea();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getStandardRequiredArea Standard Required Area}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Standard Required Area' attribute.
	 * @see #getStandardRequiredArea()
	 * @generated
	 */
	void setStandardRequiredArea(double value);

	/**
	 * Returns the value of the 'Standard Required Area As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Standard Required Area As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Standard Required Area As String' attribute.
	 * @see #setStandardRequiredAreaAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_StandardRequiredAreaAsString()
	 * @model
	 * @generated
	 */
	String getStandardRequiredAreaAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getStandardRequiredAreaAsString Standard Required Area As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Standard Required Area As String' attribute.
	 * @see #getStandardRequiredAreaAsString()
	 * @generated
	 */
	void setStandardRequiredAreaAsString(String value);

	/**
	 * Returns the value of the 'Has Interaction Reqs From' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc2x3tc1.IfcRelInteractionRequirements}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc2x3tc1.IfcRelInteractionRequirements#getRelatedSpaceProgram Related Space Program}'.
	 * 
	 * 
	 * If the meaning of the 'Has Interaction Reqs From' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Interaction Reqs From' reference list.
	 * @see #isSetHasInteractionReqsFrom()
	 * @see #unsetHasInteractionReqsFrom()
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_HasInteractionReqsFrom()
	 * @see org.bimserver.models.ifc2x3tc1.IfcRelInteractionRequirements#getRelatedSpaceProgram
	 * @model opposite="RelatedSpaceProgram" unsettable="true"
	 * @generated
	 */
	EList getHasInteractionReqsFrom();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getHasInteractionReqsFrom Has Interaction Reqs From}' reference list.
	 * 
	 * 
	 * @see #isSetHasInteractionReqsFrom()
	 * @see #getHasInteractionReqsFrom()
	 * @generated
	 */
	void unsetHasInteractionReqsFrom();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getHasInteractionReqsFrom Has Interaction Reqs From}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Interaction Reqs From' reference list is set.
	 * @see #unsetHasInteractionReqsFrom()
	 * @see #getHasInteractionReqsFrom()
	 * @generated
	 */
	boolean isSetHasInteractionReqsFrom();

	/**
	 * Returns the value of the 'Has Interaction Reqs To' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc2x3tc1.IfcRelInteractionRequirements}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc2x3tc1.IfcRelInteractionRequirements#getRelatingSpaceProgram Relating Space Program}'.
	 * 
	 * 
	 * If the meaning of the 'Has Interaction Reqs To' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Interaction Reqs To' reference list.
	 * @see #isSetHasInteractionReqsTo()
	 * @see #unsetHasInteractionReqsTo()
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcSpaceProgram_HasInteractionReqsTo()
	 * @see org.bimserver.models.ifc2x3tc1.IfcRelInteractionRequirements#getRelatingSpaceProgram
	 * @model opposite="RelatingSpaceProgram" unsettable="true"
	 * @generated
	 */
	EList getHasInteractionReqsTo();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getHasInteractionReqsTo Has Interaction Reqs To}' reference list.
	 * 
	 * 
	 * @see #isSetHasInteractionReqsTo()
	 * @see #getHasInteractionReqsTo()
	 * @generated
	 */
	void unsetHasInteractionReqsTo();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcSpaceProgram#getHasInteractionReqsTo Has Interaction Reqs To}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Interaction Reqs To' reference list is set.
	 * @see #unsetHasInteractionReqsTo()
	 * @see #getHasInteractionReqsTo()
	 * @generated
	 */
	boolean isSetHasInteractionReqsTo();

} // IfcSpaceProgram