org.bimserver.models.ifc2x3tc1.IfcReinforcingBar 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 Reinforcing Bar'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getNominalDiameter Nominal Diameter}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getNominalDiameterAsString Nominal Diameter As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getCrossSectionArea Cross Section Area}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getCrossSectionAreaAsString Cross Section Area As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarLength Bar Length}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarLengthAsString Bar Length As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarRole Bar Role}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarSurface Bar Surface}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReinforcingBar()
 * @model
 * @generated
 */
public interface IfcReinforcingBar extends IfcReinforcingElement {
	/**
	 * Returns the value of the 'Nominal Diameter' attribute.
	 * 
	 * 
	 * If the meaning of the 'Nominal Diameter' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Nominal Diameter' attribute.
	 * @see #setNominalDiameter(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReinforcingBar_NominalDiameter()
	 * @model
	 * @generated
	 */
	double getNominalDiameter();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getNominalDiameter Nominal Diameter}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Nominal Diameter' attribute.
	 * @see #getNominalDiameter()
	 * @generated
	 */
	void setNominalDiameter(double value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getNominalDiameterAsString Nominal Diameter As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Nominal Diameter As String' attribute.
	 * @see #getNominalDiameterAsString()
	 * @generated
	 */
	void setNominalDiameterAsString(String value);

	/**
	 * Returns the value of the 'Cross Section Area' attribute.
	 * 
	 * 
	 * If the meaning of the 'Cross Section Area' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Cross Section Area' attribute.
	 * @see #setCrossSectionArea(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReinforcingBar_CrossSectionArea()
	 * @model
	 * @generated
	 */
	double getCrossSectionArea();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getCrossSectionArea Cross Section Area}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Cross Section Area' attribute.
	 * @see #getCrossSectionArea()
	 * @generated
	 */
	void setCrossSectionArea(double value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getCrossSectionAreaAsString Cross Section Area As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Cross Section Area As String' attribute.
	 * @see #getCrossSectionAreaAsString()
	 * @generated
	 */
	void setCrossSectionAreaAsString(String value);

	/**
	 * Returns the value of the 'Bar Length' attribute.
	 * 
	 * 
	 * If the meaning of the 'Bar Length' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Bar Length' attribute.
	 * @see #isSetBarLength()
	 * @see #unsetBarLength()
	 * @see #setBarLength(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReinforcingBar_BarLength()
	 * @model unsettable="true"
	 * @generated
	 */
	double getBarLength();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarLength Bar Length}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Bar Length' attribute.
	 * @see #isSetBarLength()
	 * @see #unsetBarLength()
	 * @see #getBarLength()
	 * @generated
	 */
	void setBarLength(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarLength Bar Length}' attribute.
	 * 
	 * 
	 * @see #isSetBarLength()
	 * @see #getBarLength()
	 * @see #setBarLength(double)
	 * @generated
	 */
	void unsetBarLength();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarLength Bar Length}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Bar Length' attribute is set.
	 * @see #unsetBarLength()
	 * @see #getBarLength()
	 * @see #setBarLength(double)
	 * @generated
	 */
	boolean isSetBarLength();

	/**
	 * Returns the value of the 'Bar Length As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Bar Length As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Bar Length As String' attribute.
	 * @see #isSetBarLengthAsString()
	 * @see #unsetBarLengthAsString()
	 * @see #setBarLengthAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReinforcingBar_BarLengthAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getBarLengthAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarLengthAsString Bar Length As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Bar Length As String' attribute.
	 * @see #isSetBarLengthAsString()
	 * @see #unsetBarLengthAsString()
	 * @see #getBarLengthAsString()
	 * @generated
	 */
	void setBarLengthAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarLengthAsString Bar Length As String}' attribute.
	 * 
	 * 
	 * @see #isSetBarLengthAsString()
	 * @see #getBarLengthAsString()
	 * @see #setBarLengthAsString(String)
	 * @generated
	 */
	void unsetBarLengthAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarLengthAsString Bar Length As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Bar Length As String' attribute is set.
	 * @see #unsetBarLengthAsString()
	 * @see #getBarLengthAsString()
	 * @see #setBarLengthAsString(String)
	 * @generated
	 */
	boolean isSetBarLengthAsString();

	/**
	 * Returns the value of the 'Bar Role' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBarRoleEnum}.
	 * 
	 * 
	 * If the meaning of the 'Bar Role' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Bar Role' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcReinforcingBarRoleEnum
	 * @see #setBarRole(IfcReinforcingBarRoleEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReinforcingBar_BarRole()
	 * @model
	 * @generated
	 */
	IfcReinforcingBarRoleEnum getBarRole();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarRole Bar Role}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Bar Role' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcReinforcingBarRoleEnum
	 * @see #getBarRole()
	 * @generated
	 */
	void setBarRole(IfcReinforcingBarRoleEnum value);

	/**
	 * Returns the value of the 'Bar Surface' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBarSurfaceEnum}.
	 * 
	 * 
	 * If the meaning of the 'Bar Surface' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Bar Surface' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcReinforcingBarSurfaceEnum
	 * @see #isSetBarSurface()
	 * @see #unsetBarSurface()
	 * @see #setBarSurface(IfcReinforcingBarSurfaceEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReinforcingBar_BarSurface()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcReinforcingBarSurfaceEnum getBarSurface();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarSurface Bar Surface}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Bar Surface' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcReinforcingBarSurfaceEnum
	 * @see #isSetBarSurface()
	 * @see #unsetBarSurface()
	 * @see #getBarSurface()
	 * @generated
	 */
	void setBarSurface(IfcReinforcingBarSurfaceEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarSurface Bar Surface}' attribute.
	 * 
	 * 
	 * @see #isSetBarSurface()
	 * @see #getBarSurface()
	 * @see #setBarSurface(IfcReinforcingBarSurfaceEnum)
	 * @generated
	 */
	void unsetBarSurface();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReinforcingBar#getBarSurface Bar Surface}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Bar Surface' attribute is set.
	 * @see #unsetBarSurface()
	 * @see #getBarSurface()
	 * @see #setBarSurface(IfcReinforcingBarSurfaceEnum)
	 * @generated
	 */
	boolean isSetBarSurface();

} // IfcReinforcingBar