org.bimserver.models.ifc4.IfcGrid 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.ifc4;

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

/**
 * 
 * A representation of the model object 'Ifc Grid'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcGrid#getUAxes UAxes}
 *   {@link org.bimserver.models.ifc4.IfcGrid#getVAxes VAxes}
 *   {@link org.bimserver.models.ifc4.IfcGrid#getWAxes WAxes}
 *   {@link org.bimserver.models.ifc4.IfcGrid#getPredefinedType Predefined Type}
 *   {@link org.bimserver.models.ifc4.IfcGrid#getContainedInStructure Contained In Structure}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGrid()
 * @model
 * @generated
 */
public interface IfcGrid extends IfcProduct {
	/**
	 * Returns the value of the 'UAxes' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcGridAxis}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfU Part Of U}'.
	 * 
	 * 
	 * If the meaning of the 'UAxes' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'UAxes' reference list.
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGrid_UAxes()
	 * @see org.bimserver.models.ifc4.IfcGridAxis#getPartOfU
	 * @model opposite="PartOfU"
	 * @generated
	 */
	EList getUAxes();

	/**
	 * Returns the value of the 'VAxes' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcGridAxis}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfV Part Of V}'.
	 * 
	 * 
	 * If the meaning of the 'VAxes' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'VAxes' reference list.
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGrid_VAxes()
	 * @see org.bimserver.models.ifc4.IfcGridAxis#getPartOfV
	 * @model opposite="PartOfV"
	 * @generated
	 */
	EList getVAxes();

	/**
	 * Returns the value of the 'WAxes' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcGridAxis}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfW Part Of W}'.
	 * 
	 * 
	 * If the meaning of the 'WAxes' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'WAxes' reference list.
	 * @see #isSetWAxes()
	 * @see #unsetWAxes()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGrid_WAxes()
	 * @see org.bimserver.models.ifc4.IfcGridAxis#getPartOfW
	 * @model opposite="PartOfW" unsettable="true"
	 * @generated
	 */
	EList getWAxes();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcGrid#getWAxes WAxes}' reference list.
	 * 
	 * 
	 * @see #isSetWAxes()
	 * @see #getWAxes()
	 * @generated
	 */
	void unsetWAxes();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcGrid#getWAxes WAxes}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'WAxes' reference list is set.
	 * @see #unsetWAxes()
	 * @see #getWAxes()
	 * @generated
	 */
	boolean isSetWAxes();

	/**
	 * Returns the value of the 'Predefined Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcGridTypeEnum}.
	 * 
	 * 
	 * If the meaning of the 'Predefined Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Predefined Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcGridTypeEnum
	 * @see #isSetPredefinedType()
	 * @see #unsetPredefinedType()
	 * @see #setPredefinedType(IfcGridTypeEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGrid_PredefinedType()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcGridTypeEnum getPredefinedType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcGrid#getPredefinedType Predefined Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Predefined Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcGridTypeEnum
	 * @see #isSetPredefinedType()
	 * @see #unsetPredefinedType()
	 * @see #getPredefinedType()
	 * @generated
	 */
	void setPredefinedType(IfcGridTypeEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcGrid#getPredefinedType Predefined Type}' attribute.
	 * 
	 * 
	 * @see #isSetPredefinedType()
	 * @see #getPredefinedType()
	 * @see #setPredefinedType(IfcGridTypeEnum)
	 * @generated
	 */
	void unsetPredefinedType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcGrid#getPredefinedType Predefined Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Predefined Type' attribute is set.
	 * @see #unsetPredefinedType()
	 * @see #getPredefinedType()
	 * @see #setPredefinedType(IfcGridTypeEnum)
	 * @generated
	 */
	boolean isSetPredefinedType();

	/**
	 * Returns the value of the 'Contained In Structure' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelContainedInSpatialStructure}.
	 * 
	 * 
	 * If the meaning of the 'Contained In Structure' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Contained In Structure' reference list.
	 * @see #isSetContainedInStructure()
	 * @see #unsetContainedInStructure()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGrid_ContainedInStructure()
	 * @model unsettable="true" upper="2"
	 * @generated
	 */
	EList getContainedInStructure();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcGrid#getContainedInStructure Contained In Structure}' reference list.
	 * 
	 * 
	 * @see #isSetContainedInStructure()
	 * @see #getContainedInStructure()
	 * @generated
	 */
	void unsetContainedInStructure();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcGrid#getContainedInStructure Contained In Structure}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Contained In Structure' reference list is set.
	 * @see #unsetContainedInStructure()
	 * @see #getContainedInStructure()
	 * @generated
	 */
	boolean isSetContainedInStructure();

} // IfcGrid