
org.bimserver.models.ifc4.IfcMaterialLayer Maven / Gradle / Ivy
Show all versions of PluginBase Show documentation
/**
* 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 Material Layer'.
*
*
*
* The following features are supported:
*
*
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getMaterial Material}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getLayerThickness Layer Thickness}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getLayerThicknessAsString Layer Thickness As String}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getIsVentilated Is Ventilated}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getName Name}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getDescription Description}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getCategory Category}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getPriority Priority}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getPriorityAsString Priority As String}
* - {@link org.bimserver.models.ifc4.IfcMaterialLayer#getToMaterialLayerSet To Material Layer Set}
*
*
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer()
* @model
* @generated
*/
public interface IfcMaterialLayer extends IfcMaterialDefinition {
/**
* Returns the value of the 'Material' reference.
*
*
* If the meaning of the 'Material' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Material' reference.
* @see #isSetMaterial()
* @see #unsetMaterial()
* @see #setMaterial(IfcMaterial)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_Material()
* @model unsettable="true"
* @generated
*/
IfcMaterial getMaterial();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getMaterial Material}' reference.
*
*
* @param value the new value of the 'Material' reference.
* @see #isSetMaterial()
* @see #unsetMaterial()
* @see #getMaterial()
* @generated
*/
void setMaterial(IfcMaterial value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getMaterial Material}' reference.
*
*
* @see #isSetMaterial()
* @see #getMaterial()
* @see #setMaterial(IfcMaterial)
* @generated
*/
void unsetMaterial();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getMaterial Material}' reference is set.
*
*
* @return whether the value of the 'Material' reference is set.
* @see #unsetMaterial()
* @see #getMaterial()
* @see #setMaterial(IfcMaterial)
* @generated
*/
boolean isSetMaterial();
/**
* Returns the value of the 'Layer Thickness' attribute.
*
*
* If the meaning of the 'Layer Thickness' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Layer Thickness' attribute.
* @see #setLayerThickness(double)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_LayerThickness()
* @model
* @generated
*/
double getLayerThickness();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getLayerThickness Layer Thickness}' attribute.
*
*
* @param value the new value of the 'Layer Thickness' attribute.
* @see #getLayerThickness()
* @generated
*/
void setLayerThickness(double value);
/**
* Returns the value of the 'Layer Thickness As String' attribute.
*
*
* If the meaning of the 'Layer Thickness As String' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Layer Thickness As String' attribute.
* @see #setLayerThicknessAsString(String)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_LayerThicknessAsString()
* @model
* @generated
*/
String getLayerThicknessAsString();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getLayerThicknessAsString Layer Thickness As String}' attribute.
*
*
* @param value the new value of the 'Layer Thickness As String' attribute.
* @see #getLayerThicknessAsString()
* @generated
*/
void setLayerThicknessAsString(String value);
/**
* Returns the value of the 'Is Ventilated' attribute.
* The literals are from the enumeration {@link org.bimserver.models.ifc4.Tristate}.
*
*
* If the meaning of the 'Is Ventilated' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Is Ventilated' attribute.
* @see org.bimserver.models.ifc4.Tristate
* @see #isSetIsVentilated()
* @see #unsetIsVentilated()
* @see #setIsVentilated(Tristate)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_IsVentilated()
* @model unsettable="true"
* @generated
*/
Tristate getIsVentilated();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getIsVentilated Is Ventilated}' attribute.
*
*
* @param value the new value of the 'Is Ventilated' attribute.
* @see org.bimserver.models.ifc4.Tristate
* @see #isSetIsVentilated()
* @see #unsetIsVentilated()
* @see #getIsVentilated()
* @generated
*/
void setIsVentilated(Tristate value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getIsVentilated Is Ventilated}' attribute.
*
*
* @see #isSetIsVentilated()
* @see #getIsVentilated()
* @see #setIsVentilated(Tristate)
* @generated
*/
void unsetIsVentilated();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getIsVentilated Is Ventilated}' attribute is set.
*
*
* @return whether the value of the 'Is Ventilated' attribute is set.
* @see #unsetIsVentilated()
* @see #getIsVentilated()
* @see #setIsVentilated(Tristate)
* @generated
*/
boolean isSetIsVentilated();
/**
* Returns the value of the 'Name' attribute.
*
*
* If the meaning of the 'Name' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Name' attribute.
* @see #isSetName()
* @see #unsetName()
* @see #setName(String)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_Name()
* @model unsettable="true"
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getName Name}' attribute.
*
*
* @param value the new value of the 'Name' attribute.
* @see #isSetName()
* @see #unsetName()
* @see #getName()
* @generated
*/
void setName(String value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getName Name}' attribute.
*
*
* @see #isSetName()
* @see #getName()
* @see #setName(String)
* @generated
*/
void unsetName();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getName Name}' attribute is set.
*
*
* @return whether the value of the 'Name' attribute is set.
* @see #unsetName()
* @see #getName()
* @see #setName(String)
* @generated
*/
boolean isSetName();
/**
* Returns the value of the 'Description' attribute.
*
*
* If the meaning of the 'Description' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Description' attribute.
* @see #isSetDescription()
* @see #unsetDescription()
* @see #setDescription(String)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_Description()
* @model unsettable="true"
* @generated
*/
String getDescription();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getDescription Description}' attribute.
*
*
* @param value the new value of the 'Description' attribute.
* @see #isSetDescription()
* @see #unsetDescription()
* @see #getDescription()
* @generated
*/
void setDescription(String value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getDescription Description}' attribute.
*
*
* @see #isSetDescription()
* @see #getDescription()
* @see #setDescription(String)
* @generated
*/
void unsetDescription();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getDescription Description}' attribute is set.
*
*
* @return whether the value of the 'Description' attribute is set.
* @see #unsetDescription()
* @see #getDescription()
* @see #setDescription(String)
* @generated
*/
boolean isSetDescription();
/**
* Returns the value of the 'Category' attribute.
*
*
* If the meaning of the 'Category' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Category' attribute.
* @see #isSetCategory()
* @see #unsetCategory()
* @see #setCategory(String)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_Category()
* @model unsettable="true"
* @generated
*/
String getCategory();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getCategory Category}' attribute.
*
*
* @param value the new value of the 'Category' attribute.
* @see #isSetCategory()
* @see #unsetCategory()
* @see #getCategory()
* @generated
*/
void setCategory(String value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getCategory Category}' attribute.
*
*
* @see #isSetCategory()
* @see #getCategory()
* @see #setCategory(String)
* @generated
*/
void unsetCategory();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getCategory Category}' attribute is set.
*
*
* @return whether the value of the 'Category' attribute is set.
* @see #unsetCategory()
* @see #getCategory()
* @see #setCategory(String)
* @generated
*/
boolean isSetCategory();
/**
* Returns the value of the 'Priority' attribute.
*
*
* If the meaning of the 'Priority' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Priority' attribute.
* @see #isSetPriority()
* @see #unsetPriority()
* @see #setPriority(double)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_Priority()
* @model unsettable="true"
* @generated
*/
double getPriority();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getPriority Priority}' attribute.
*
*
* @param value the new value of the 'Priority' attribute.
* @see #isSetPriority()
* @see #unsetPriority()
* @see #getPriority()
* @generated
*/
void setPriority(double value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getPriority Priority}' attribute.
*
*
* @see #isSetPriority()
* @see #getPriority()
* @see #setPriority(double)
* @generated
*/
void unsetPriority();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getPriority Priority}' attribute is set.
*
*
* @return whether the value of the 'Priority' attribute is set.
* @see #unsetPriority()
* @see #getPriority()
* @see #setPriority(double)
* @generated
*/
boolean isSetPriority();
/**
* Returns the value of the 'Priority As String' attribute.
*
*
* If the meaning of the 'Priority As String' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Priority As String' attribute.
* @see #isSetPriorityAsString()
* @see #unsetPriorityAsString()
* @see #setPriorityAsString(String)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_PriorityAsString()
* @model unsettable="true"
* @generated
*/
String getPriorityAsString();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getPriorityAsString Priority As String}' attribute.
*
*
* @param value the new value of the 'Priority As String' attribute.
* @see #isSetPriorityAsString()
* @see #unsetPriorityAsString()
* @see #getPriorityAsString()
* @generated
*/
void setPriorityAsString(String value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getPriorityAsString Priority As String}' attribute.
*
*
* @see #isSetPriorityAsString()
* @see #getPriorityAsString()
* @see #setPriorityAsString(String)
* @generated
*/
void unsetPriorityAsString();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getPriorityAsString Priority As String}' attribute is set.
*
*
* @return whether the value of the 'Priority As String' attribute is set.
* @see #unsetPriorityAsString()
* @see #getPriorityAsString()
* @see #setPriorityAsString(String)
* @generated
*/
boolean isSetPriorityAsString();
/**
* Returns the value of the 'To Material Layer Set' reference.
* It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcMaterialLayerSet#getMaterialLayers Material Layers}'.
*
*
* If the meaning of the 'To Material Layer Set' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'To Material Layer Set' reference.
* @see #isSetToMaterialLayerSet()
* @see #unsetToMaterialLayerSet()
* @see #setToMaterialLayerSet(IfcMaterialLayerSet)
* @see org.bimserver.models.ifc4.Ifc4Package#getIfcMaterialLayer_ToMaterialLayerSet()
* @see org.bimserver.models.ifc4.IfcMaterialLayerSet#getMaterialLayers
* @model opposite="MaterialLayers" unsettable="true"
* @generated
*/
IfcMaterialLayerSet getToMaterialLayerSet();
/**
* Sets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getToMaterialLayerSet To Material Layer Set}' reference.
*
*
* @param value the new value of the 'To Material Layer Set' reference.
* @see #isSetToMaterialLayerSet()
* @see #unsetToMaterialLayerSet()
* @see #getToMaterialLayerSet()
* @generated
*/
void setToMaterialLayerSet(IfcMaterialLayerSet value);
/**
* Unsets the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getToMaterialLayerSet To Material Layer Set}' reference.
*
*
* @see #isSetToMaterialLayerSet()
* @see #getToMaterialLayerSet()
* @see #setToMaterialLayerSet(IfcMaterialLayerSet)
* @generated
*/
void unsetToMaterialLayerSet();
/**
* Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcMaterialLayer#getToMaterialLayerSet To Material Layer Set}' reference is set.
*
*
* @return whether the value of the 'To Material Layer Set' reference is set.
* @see #unsetToMaterialLayerSet()
* @see #getToMaterialLayerSet()
* @see #setToMaterialLayerSet(IfcMaterialLayerSet)
* @generated
*/
boolean isSetToMaterialLayerSet();
} // IfcMaterialLayer