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

/**
 * 
 * A representation of the model object 'Ifc Vector'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcVector#getOrientation Orientation}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcVector#getMagnitude Magnitude}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcVector#getMagnitudeAsString Magnitude As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcVector#getDim Dim}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcVector()
 * @model
 * @generated
 */
public interface IfcVector extends IfcGeometricRepresentationItem, IfcVectorOrDirection {
	/**
	 * Returns the value of the 'Orientation' reference.
	 * 
	 * 
	 * If the meaning of the 'Orientation' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Orientation' reference.
	 * @see #setOrientation(IfcDirection)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcVector_Orientation()
	 * @model
	 * @generated
	 */
	IfcDirection getOrientation();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcVector#getOrientation Orientation}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Orientation' reference.
	 * @see #getOrientation()
	 * @generated
	 */
	void setOrientation(IfcDirection value);

	/**
	 * Returns the value of the 'Magnitude' attribute.
	 * 
	 * 
	 * If the meaning of the 'Magnitude' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Magnitude' attribute.
	 * @see #setMagnitude(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcVector_Magnitude()
	 * @model
	 * @generated
	 */
	double getMagnitude();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcVector#getMagnitude Magnitude}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Magnitude' attribute.
	 * @see #getMagnitude()
	 * @generated
	 */
	void setMagnitude(double value);

	/**
	 * Returns the value of the 'Magnitude As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Magnitude As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Magnitude As String' attribute.
	 * @see #setMagnitudeAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcVector_MagnitudeAsString()
	 * @model
	 * @generated
	 */
	String getMagnitudeAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcVector#getMagnitudeAsString Magnitude As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Magnitude As String' attribute.
	 * @see #getMagnitudeAsString()
	 * @generated
	 */
	void setMagnitudeAsString(String value);

	/**
	 * Returns the value of the 'Dim' attribute.
	 * 
	 * 
	 * If the meaning of the 'Dim' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Dim' attribute.
	 * @see #isSetDim()
	 * @see #unsetDim()
	 * @see #setDim(int)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcVector_Dim()
	 * @model unsettable="true" derived="true"
	 * @generated
	 */
	int getDim();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcVector#getDim Dim}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Dim' attribute.
	 * @see #isSetDim()
	 * @see #unsetDim()
	 * @see #getDim()
	 * @generated
	 */
	void setDim(int value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcVector#getDim Dim}' attribute.
	 * 
	 * 
	 * @see #isSetDim()
	 * @see #getDim()
	 * @see #setDim(int)
	 * @generated
	 */
	void unsetDim();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcVector#getDim Dim}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Dim' attribute is set.
	 * @see #unsetDim()
	 * @see #getDim()
	 * @see #setDim(int)
	 * @generated
	 */
	boolean isSetDim();

} // IfcVector