org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary 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 Rel Space Boundary'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getRelatingSpace Relating Space}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getRelatedBuildingElement Related Building Element}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getConnectionGeometry Connection Geometry}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getPhysicalOrVirtualBoundary Physical Or Virtual Boundary}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getInternalOrExternalBoundary Internal Or External Boundary}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcRelSpaceBoundary()
 * @model
 * @generated
 */
public interface IfcRelSpaceBoundary extends IfcRelConnects {
	/**
	 * Returns the value of the 'Relating Space' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc2x3tc1.IfcSpace#getBoundedBy Bounded By}'.
	 * 
	 * 
	 * If the meaning of the 'Relating Space' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Relating Space' reference.
	 * @see #setRelatingSpace(IfcSpace)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcRelSpaceBoundary_RelatingSpace()
	 * @see org.bimserver.models.ifc2x3tc1.IfcSpace#getBoundedBy
	 * @model opposite="BoundedBy"
	 * @generated
	 */
	IfcSpace getRelatingSpace();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getRelatingSpace Relating Space}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Relating Space' reference.
	 * @see #getRelatingSpace()
	 * @generated
	 */
	void setRelatingSpace(IfcSpace value);

	/**
	 * Returns the value of the 'Related Building Element' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc2x3tc1.IfcElement#getProvidesBoundaries Provides Boundaries}'.
	 * 
	 * 
	 * If the meaning of the 'Related Building Element' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Related Building Element' reference.
	 * @see #isSetRelatedBuildingElement()
	 * @see #unsetRelatedBuildingElement()
	 * @see #setRelatedBuildingElement(IfcElement)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcRelSpaceBoundary_RelatedBuildingElement()
	 * @see org.bimserver.models.ifc2x3tc1.IfcElement#getProvidesBoundaries
	 * @model opposite="ProvidesBoundaries" unsettable="true"
	 * @generated
	 */
	IfcElement getRelatedBuildingElement();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getRelatedBuildingElement Related Building Element}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Related Building Element' reference.
	 * @see #isSetRelatedBuildingElement()
	 * @see #unsetRelatedBuildingElement()
	 * @see #getRelatedBuildingElement()
	 * @generated
	 */
	void setRelatedBuildingElement(IfcElement value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getRelatedBuildingElement Related Building Element}' reference.
	 * 
	 * 
	 * @see #isSetRelatedBuildingElement()
	 * @see #getRelatedBuildingElement()
	 * @see #setRelatedBuildingElement(IfcElement)
	 * @generated
	 */
	void unsetRelatedBuildingElement();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getRelatedBuildingElement Related Building Element}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Related Building Element' reference is set.
	 * @see #unsetRelatedBuildingElement()
	 * @see #getRelatedBuildingElement()
	 * @see #setRelatedBuildingElement(IfcElement)
	 * @generated
	 */
	boolean isSetRelatedBuildingElement();

	/**
	 * Returns the value of the 'Connection Geometry' reference.
	 * 
	 * 
	 * If the meaning of the 'Connection Geometry' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Connection Geometry' reference.
	 * @see #isSetConnectionGeometry()
	 * @see #unsetConnectionGeometry()
	 * @see #setConnectionGeometry(IfcConnectionGeometry)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcRelSpaceBoundary_ConnectionGeometry()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcConnectionGeometry getConnectionGeometry();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getConnectionGeometry Connection Geometry}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Connection Geometry' reference.
	 * @see #isSetConnectionGeometry()
	 * @see #unsetConnectionGeometry()
	 * @see #getConnectionGeometry()
	 * @generated
	 */
	void setConnectionGeometry(IfcConnectionGeometry value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getConnectionGeometry Connection Geometry}' reference.
	 * 
	 * 
	 * @see #isSetConnectionGeometry()
	 * @see #getConnectionGeometry()
	 * @see #setConnectionGeometry(IfcConnectionGeometry)
	 * @generated
	 */
	void unsetConnectionGeometry();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getConnectionGeometry Connection Geometry}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Connection Geometry' reference is set.
	 * @see #unsetConnectionGeometry()
	 * @see #getConnectionGeometry()
	 * @see #setConnectionGeometry(IfcConnectionGeometry)
	 * @generated
	 */
	boolean isSetConnectionGeometry();

	/**
	 * Returns the value of the 'Physical Or Virtual Boundary' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcPhysicalOrVirtualEnum}.
	 * 
	 * 
	 * If the meaning of the 'Physical Or Virtual Boundary' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Physical Or Virtual Boundary' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcPhysicalOrVirtualEnum
	 * @see #setPhysicalOrVirtualBoundary(IfcPhysicalOrVirtualEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcRelSpaceBoundary_PhysicalOrVirtualBoundary()
	 * @model
	 * @generated
	 */
	IfcPhysicalOrVirtualEnum getPhysicalOrVirtualBoundary();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getPhysicalOrVirtualBoundary Physical Or Virtual Boundary}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Physical Or Virtual Boundary' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcPhysicalOrVirtualEnum
	 * @see #getPhysicalOrVirtualBoundary()
	 * @generated
	 */
	void setPhysicalOrVirtualBoundary(IfcPhysicalOrVirtualEnum value);

	/**
	 * Returns the value of the 'Internal Or External Boundary' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcInternalOrExternalEnum}.
	 * 
	 * 
	 * If the meaning of the 'Internal Or External Boundary' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Internal Or External Boundary' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcInternalOrExternalEnum
	 * @see #setInternalOrExternalBoundary(IfcInternalOrExternalEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcRelSpaceBoundary_InternalOrExternalBoundary()
	 * @model
	 * @generated
	 */
	IfcInternalOrExternalEnum getInternalOrExternalBoundary();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcRelSpaceBoundary#getInternalOrExternalBoundary Internal Or External Boundary}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Internal Or External Boundary' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcInternalOrExternalEnum
	 * @see #getInternalOrExternalBoundary()
	 * @generated
	 */
	void setInternalOrExternalBoundary(IfcInternalOrExternalEnum value);

} // IfcRelSpaceBoundary