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

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.bimserver.emf.IdEObject;
import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Ifc Grid Axis'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcGridAxis#getAxisTag Axis Tag}
 *   {@link org.bimserver.models.ifc4.IfcGridAxis#getAxisCurve Axis Curve}
 *   {@link org.bimserver.models.ifc4.IfcGridAxis#getSameSense Same Sense}
 *   {@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfW Part Of W}
 *   {@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfV Part Of V}
 *   {@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfU Part Of U}
 *   {@link org.bimserver.models.ifc4.IfcGridAxis#getHasIntersections Has Intersections}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGridAxis()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface IfcGridAxis extends IdEObject {
	/**
	 * Returns the value of the 'Axis Tag' attribute.
	 * 
	 * 
	 * If the meaning of the 'Axis Tag' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Axis Tag' attribute.
	 * @see #isSetAxisTag()
	 * @see #unsetAxisTag()
	 * @see #setAxisTag(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGridAxis_AxisTag()
	 * @model unsettable="true"
	 * @generated
	 */
	String getAxisTag();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getAxisTag Axis Tag}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Axis Tag' attribute.
	 * @see #isSetAxisTag()
	 * @see #unsetAxisTag()
	 * @see #getAxisTag()
	 * @generated
	 */
	void setAxisTag(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getAxisTag Axis Tag}' attribute.
	 * 
	 * 
	 * @see #isSetAxisTag()
	 * @see #getAxisTag()
	 * @see #setAxisTag(String)
	 * @generated
	 */
	void unsetAxisTag();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getAxisTag Axis Tag}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Axis Tag' attribute is set.
	 * @see #unsetAxisTag()
	 * @see #getAxisTag()
	 * @see #setAxisTag(String)
	 * @generated
	 */
	boolean isSetAxisTag();

	/**
	 * Returns the value of the 'Axis Curve' reference.
	 * 
	 * 
	 * If the meaning of the 'Axis Curve' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Axis Curve' reference.
	 * @see #setAxisCurve(IfcCurve)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGridAxis_AxisCurve()
	 * @model
	 * @generated
	 */
	IfcCurve getAxisCurve();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getAxisCurve Axis Curve}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Axis Curve' reference.
	 * @see #getAxisCurve()
	 * @generated
	 */
	void setAxisCurve(IfcCurve value);

	/**
	 * Returns the value of the 'Same Sense' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.Tristate}.
	 * 
	 * 
	 * If the meaning of the 'Same Sense' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Same Sense' attribute.
	 * @see org.bimserver.models.ifc4.Tristate
	 * @see #setSameSense(Tristate)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGridAxis_SameSense()
	 * @model
	 * @generated
	 */
	Tristate getSameSense();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getSameSense Same Sense}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Same Sense' attribute.
	 * @see org.bimserver.models.ifc4.Tristate
	 * @see #getSameSense()
	 * @generated
	 */
	void setSameSense(Tristate value);

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

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfW Part Of W}' reference list.
	 * 
	 * 
	 * @see #isSetPartOfW()
	 * @see #getPartOfW()
	 * @generated
	 */
	void unsetPartOfW();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfW Part Of W}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Part Of W' reference list is set.
	 * @see #unsetPartOfW()
	 * @see #getPartOfW()
	 * @generated
	 */
	boolean isSetPartOfW();

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

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfV Part Of V}' reference list.
	 * 
	 * 
	 * @see #isSetPartOfV()
	 * @see #getPartOfV()
	 * @generated
	 */
	void unsetPartOfV();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfV Part Of V}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Part Of V' reference list is set.
	 * @see #unsetPartOfV()
	 * @see #getPartOfV()
	 * @generated
	 */
	boolean isSetPartOfV();

	/**
	 * Returns the value of the 'Part Of U' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcGrid}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcGrid#getUAxes UAxes}'.
	 * 
	 * 
	 * If the meaning of the 'Part Of U' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Part Of U' reference list.
	 * @see #isSetPartOfU()
	 * @see #unsetPartOfU()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGridAxis_PartOfU()
	 * @see org.bimserver.models.ifc4.IfcGrid#getUAxes
	 * @model opposite="UAxes" unsettable="true" upper="2"
	 * @generated
	 */
	EList getPartOfU();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfU Part Of U}' reference list.
	 * 
	 * 
	 * @see #isSetPartOfU()
	 * @see #getPartOfU()
	 * @generated
	 */
	void unsetPartOfU();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getPartOfU Part Of U}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Part Of U' reference list is set.
	 * @see #unsetPartOfU()
	 * @see #getPartOfU()
	 * @generated
	 */
	boolean isSetPartOfU();

	/**
	 * Returns the value of the 'Has Intersections' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcVirtualGridIntersection}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcVirtualGridIntersection#getIntersectingAxes Intersecting Axes}'.
	 * 
	 * 
	 * If the meaning of the 'Has Intersections' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Intersections' reference list.
	 * @see #isSetHasIntersections()
	 * @see #unsetHasIntersections()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcGridAxis_HasIntersections()
	 * @see org.bimserver.models.ifc4.IfcVirtualGridIntersection#getIntersectingAxes
	 * @model opposite="IntersectingAxes" unsettable="true"
	 * @generated
	 */
	EList getHasIntersections();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getHasIntersections Has Intersections}' reference list.
	 * 
	 * 
	 * @see #isSetHasIntersections()
	 * @see #getHasIntersections()
	 * @generated
	 */
	void unsetHasIntersections();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcGridAxis#getHasIntersections Has Intersections}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Intersections' reference list is set.
	 * @see #unsetHasIntersections()
	 * @see #getHasIntersections()
	 * @generated
	 */
	boolean isSetHasIntersections();

} // IfcGridAxis