org.bimserver.models.ifc4.IfcStairFlight Maven / Gradle / Ivy
/**
* 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;
/**
*
* A representation of the model object 'Ifc Stair Flight'.
*
*
*
* The following features are supported:
*
*
* - {@link org.bimserver.models.ifc4.IfcStairFlight#getNumberOfRiser Number Of Riser}
* - {@link org.bimserver.models.ifc4.IfcStairFlight#getNumberOfTreads Number Of Treads}
* - {@link org.bimserver.models.ifc4.IfcStairFlight#getRiserHeight Riser Height}
* - {@link org.bimserver.models.ifc4.IfcStairFlight#getRiserHeightAsString Riser Height As String}
* - {@link org.bimserver.models.ifc4.IfcStairFlight#getTreadLength Tread Length}
* - {@link org.bimserver.models.ifc4.IfcStairFlight#getTreadLengthAsString Tread Length As String}
* - {@link org.bimserver.models.ifc4.IfcStairFlight#getPredefinedType Predefined Type}
*
*
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcStairFlight()
* @model
* @generated
*/
public interface IfcStairFlight extends IfcBuildingElement {
/**
* Returns the value of the 'Number Of Riser' attribute.
*
*
* If the meaning of the 'Number Of Riser' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Number Of Riser' attribute.
* @see #isSetNumberOfRiser()
* @see #unsetNumberOfRiser()
* @see #setNumberOfRiser(long)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcStairFlight_NumberOfRiser()
* @model unsettable="true"
* @generated
*/
long getNumberOfRiser();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getNumberOfRiser Number Of Riser}' attribute.
*
*
* @param value the new value of the 'Number Of Riser' attribute.
* @see #isSetNumberOfRiser()
* @see #unsetNumberOfRiser()
* @see #getNumberOfRiser()
* @generated
*/
void setNumberOfRiser(long value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getNumberOfRiser Number Of Riser}' attribute.
*
*
* @see #isSetNumberOfRiser()
* @see #getNumberOfRiser()
* @see #setNumberOfRiser(long)
* @generated
*/
void unsetNumberOfRiser();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getNumberOfRiser Number Of Riser}' attribute is set.
*
*
* @return whether the value of the 'Number Of Riser' attribute is set.
* @see #unsetNumberOfRiser()
* @see #getNumberOfRiser()
* @see #setNumberOfRiser(long)
* @generated
*/
boolean isSetNumberOfRiser();
/**
* Returns the value of the 'Number Of Treads' attribute.
*
*
* If the meaning of the 'Number Of Treads' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Number Of Treads' attribute.
* @see #isSetNumberOfTreads()
* @see #unsetNumberOfTreads()
* @see #setNumberOfTreads(long)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcStairFlight_NumberOfTreads()
* @model unsettable="true"
* @generated
*/
long getNumberOfTreads();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getNumberOfTreads Number Of Treads}' attribute.
*
*
* @param value the new value of the 'Number Of Treads' attribute.
* @see #isSetNumberOfTreads()
* @see #unsetNumberOfTreads()
* @see #getNumberOfTreads()
* @generated
*/
void setNumberOfTreads(long value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getNumberOfTreads Number Of Treads}' attribute.
*
*
* @see #isSetNumberOfTreads()
* @see #getNumberOfTreads()
* @see #setNumberOfTreads(long)
* @generated
*/
void unsetNumberOfTreads();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getNumberOfTreads Number Of Treads}' attribute is set.
*
*
* @return whether the value of the 'Number Of Treads' attribute is set.
* @see #unsetNumberOfTreads()
* @see #getNumberOfTreads()
* @see #setNumberOfTreads(long)
* @generated
*/
boolean isSetNumberOfTreads();
/**
* Returns the value of the 'Riser Height' attribute.
*
*
* If the meaning of the 'Riser Height' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Riser Height' attribute.
* @see #isSetRiserHeight()
* @see #unsetRiserHeight()
* @see #setRiserHeight(double)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcStairFlight_RiserHeight()
* @model unsettable="true"
* @generated
*/
double getRiserHeight();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getRiserHeight Riser Height}' attribute.
*
*
* @param value the new value of the 'Riser Height' attribute.
* @see #isSetRiserHeight()
* @see #unsetRiserHeight()
* @see #getRiserHeight()
* @generated
*/
void setRiserHeight(double value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getRiserHeight Riser Height}' attribute.
*
*
* @see #isSetRiserHeight()
* @see #getRiserHeight()
* @see #setRiserHeight(double)
* @generated
*/
void unsetRiserHeight();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getRiserHeight Riser Height}' attribute is set.
*
*
* @return whether the value of the 'Riser Height' attribute is set.
* @see #unsetRiserHeight()
* @see #getRiserHeight()
* @see #setRiserHeight(double)
* @generated
*/
boolean isSetRiserHeight();
/**
* Returns the value of the 'Riser Height As String' attribute.
*
*
* If the meaning of the 'Riser Height As String' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Riser Height As String' attribute.
* @see #isSetRiserHeightAsString()
* @see #unsetRiserHeightAsString()
* @see #setRiserHeightAsString(String)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcStairFlight_RiserHeightAsString()
* @model unsettable="true"
* @generated
*/
String getRiserHeightAsString();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getRiserHeightAsString Riser Height As String}' attribute.
*
*
* @param value the new value of the 'Riser Height As String' attribute.
* @see #isSetRiserHeightAsString()
* @see #unsetRiserHeightAsString()
* @see #getRiserHeightAsString()
* @generated
*/
void setRiserHeightAsString(String value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getRiserHeightAsString Riser Height As String}' attribute.
*
*
* @see #isSetRiserHeightAsString()
* @see #getRiserHeightAsString()
* @see #setRiserHeightAsString(String)
* @generated
*/
void unsetRiserHeightAsString();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getRiserHeightAsString Riser Height As String}' attribute is set.
*
*
* @return whether the value of the 'Riser Height As String' attribute is set.
* @see #unsetRiserHeightAsString()
* @see #getRiserHeightAsString()
* @see #setRiserHeightAsString(String)
* @generated
*/
boolean isSetRiserHeightAsString();
/**
* Returns the value of the 'Tread Length' attribute.
*
*
* If the meaning of the 'Tread Length' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Tread Length' attribute.
* @see #isSetTreadLength()
* @see #unsetTreadLength()
* @see #setTreadLength(double)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcStairFlight_TreadLength()
* @model unsettable="true"
* @generated
*/
double getTreadLength();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getTreadLength Tread Length}' attribute.
*
*
* @param value the new value of the 'Tread Length' attribute.
* @see #isSetTreadLength()
* @see #unsetTreadLength()
* @see #getTreadLength()
* @generated
*/
void setTreadLength(double value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getTreadLength Tread Length}' attribute.
*
*
* @see #isSetTreadLength()
* @see #getTreadLength()
* @see #setTreadLength(double)
* @generated
*/
void unsetTreadLength();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getTreadLength Tread Length}' attribute is set.
*
*
* @return whether the value of the 'Tread Length' attribute is set.
* @see #unsetTreadLength()
* @see #getTreadLength()
* @see #setTreadLength(double)
* @generated
*/
boolean isSetTreadLength();
/**
* Returns the value of the 'Tread Length As String' attribute.
*
*
* If the meaning of the 'Tread Length As String' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Tread Length As String' attribute.
* @see #isSetTreadLengthAsString()
* @see #unsetTreadLengthAsString()
* @see #setTreadLengthAsString(String)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcStairFlight_TreadLengthAsString()
* @model unsettable="true"
* @generated
*/
String getTreadLengthAsString();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getTreadLengthAsString Tread Length As String}' attribute.
*
*
* @param value the new value of the 'Tread Length As String' attribute.
* @see #isSetTreadLengthAsString()
* @see #unsetTreadLengthAsString()
* @see #getTreadLengthAsString()
* @generated
*/
void setTreadLengthAsString(String value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getTreadLengthAsString Tread Length As String}' attribute.
*
*
* @see #isSetTreadLengthAsString()
* @see #getTreadLengthAsString()
* @see #setTreadLengthAsString(String)
* @generated
*/
void unsetTreadLengthAsString();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getTreadLengthAsString Tread Length As String}' attribute is set.
*
*
* @return whether the value of the 'Tread Length As String' attribute is set.
* @see #unsetTreadLengthAsString()
* @see #getTreadLengthAsString()
* @see #setTreadLengthAsString(String)
* @generated
*/
boolean isSetTreadLengthAsString();
/**
* Returns the value of the 'Predefined Type' attribute.
* The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcStairFlightTypeEnum}.
*
*
* 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.IfcStairFlightTypeEnum
* @see #isSetPredefinedType()
* @see #unsetPredefinedType()
* @see #setPredefinedType(IfcStairFlightTypeEnum)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcStairFlight_PredefinedType()
* @model unsettable="true"
* @generated
*/
IfcStairFlightTypeEnum getPredefinedType();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getPredefinedType Predefined Type}' attribute.
*
*
* @param value the new value of the 'Predefined Type' attribute.
* @see org.bimserver.models.ifc4.IfcStairFlightTypeEnum
* @see #isSetPredefinedType()
* @see #unsetPredefinedType()
* @see #getPredefinedType()
* @generated
*/
void setPredefinedType(IfcStairFlightTypeEnum value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getPredefinedType Predefined Type}' attribute.
*
*
* @see #isSetPredefinedType()
* @see #getPredefinedType()
* @see #setPredefinedType(IfcStairFlightTypeEnum)
* @generated
*/
void unsetPredefinedType();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcStairFlight#getPredefinedType Predefined Type}' attribute is set.
*
*
* @return whether the value of the 'Predefined Type' attribute is set.
* @see #unsetPredefinedType()
* @see #getPredefinedType()
* @see #setPredefinedType(IfcStairFlightTypeEnum)
* @generated
*/
boolean isSetPredefinedType();
} // IfcStairFlight