///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
// This application incorporates Open Design Alliance software pursuant to a license
// agreement with Open Design Alliance.
// Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
// All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
// This file is generated automatically.
#ifndef _IFC4X3_ADD2_IFCMATERIALLAYER_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCMATERIALLAYER_AUTO_IMPL_H
#include "IfcMaterialDefinitionAutoImpl.h"
#include "IfcMaterialAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X3_ADD2 express schema definitions.
*/
namespace OdIfc4x3_add2 {
/** \details
IfcMaterialLayer is a single and identifiable part of an element which is constructed of a number of layers (one or more).
Each IfcMaterialLayer has a constant thickness and is located relative to the referencing IfcMaterialLayerSet along the material layer set base (MlsBase).
Air gaps within a material layer set are represented as an IfcMaterialLayer with the attribute IsVentilated having the value TRUE or UNKNOWN.
Such air gaps is interpreted as voids (not having a material).
The IfcMaterialLayer can have a material layer name which may differ from name of the IfcMaterial that is referenced.
\changes
* IFC4 changes:
Type of the LayerThickness attribute changed from "IfcPositiveLengthMeasure" to "IfcNonNegativeLengthMeasure"
*/
class IFC4X3_EXPORT IfcMaterialLayer : public IfcMaterialDefinition
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcMaterialLayer);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of Material attribute.
This attribute represents optional reference to the material from which the layer is constructed.
If this value is not specified, it does not denote a layer with no material (an air gap),
it only means that the material is not specified at that point.
\returns
Returns the value of Material attribute.
*/
const OdDAIObjectId& getMaterial() const;
/** \details
Sets the value of Material attribute.
This attribute represents optional reference to the material from which the layer is constructed.
If this value is not specified, it does not denote a layer with no material (an air gap),
it only means that the material is not specified at that point.
\param Material [in] Material to set.
*/
void setMaterial(const OdDAIObjectId& Material);
/** \details
Returns the value of LayerThickness attribute.
This attribute represents the thickness of the material layer. The meaning of thickness depends on its usage.
In case of building elements elements utilizing IfcMaterialLayerSetUsage, the dimension is measured along the positive LayerSetDirection as specified in IfcMaterialLayerSetUsage.
\returns
Returns the value of LayerThickness attribute.
*/
double getLayerThickness() const;
/** \details
Sets the value of LayerThickness attribute.
This attribute represents the thickness of the material layer. The meaning of thickness depends on its usage.
In case of building elements elements utilizing IfcMaterialLayerSetUsage, the dimension is measured along the positive LayerSetDirection as specified in IfcMaterialLayerSetUsage.
\param LayerThickness [in] LayerThickness to set.
*/
void setLayerThickness(double LayerThickness);
/** \details
Returns the value of IsVentilated attribute.
This attribute represents indication of whether the material layer represents an air layer (or cavity).
* TRUE if the material layer is an air gap and provides air exchange from the layer to the outside air.
* UNKNOWN if the material layer is an air gap and does not provide air exchange (or when this information about air exchange of the air gap is not available).
* FALSE if the material layer is a solid material layer (the default).
\returns
Returns the value of IsVentilated attribute.
*/
OdDAI::Logical getIsVentilated() const;
/** \details
Sets the value of IsVentilated attribute.
This attribute represents indication of whether the material layer represents an air layer (or cavity).
* TRUE if the material layer is an air gap and provides air exchange from the layer to the outside air.
* UNKNOWN if the material layer is an air gap and does not provide air exchange (or when this information about air exchange of the air gap is not available).
* FALSE if the material layer is a solid material layer (the default).
\param IsVentilated [in] IsVentilated to set.
*/
void setIsVentilated(OdDAI::Logical IsVentilated);
/** \details
Returns the value of Name attribute.
This attribute represents the name by which the material layer is known.
\returns
Returns the value of Name attribute.
*/
const OdAnsiString& getName() const;
/** \details
Sets the value of Name attribute.
This attribute represents the name by which the material layer is known.
\param Name [in] Name to set.
*/
void setName(const OdAnsiString& Name);
/** \details
Returns the value of Description attribute.
This attribute represents definition of the material layer in more descriptive terms than specified by attributes Name or Category.
\returns
Returns the value of Description attribute.
*/
const OdAnsiString& getDescription() const;
/** \details
Sets the value of Description attribute.
This attribute represents definition of the material layer in more descriptive terms than specified by attributes Name or Category.
\param Description [in] Description to set.
*/
void setDescription(const OdAnsiString& Description);
/** \details
Returns the value of Category attribute.
This attribute represents category of the material layer, e.g. the role it has in the layer set it belongs to (such as 'load bearing', 'thermal insulation' etc.).
The list of keywords can be extended by model view definitions, however the following keywords apply in general:
* 'LoadBearing' — for all material layers having a load bearing function.
* 'Insulation' — for all material layers having an insulating function.
* 'Inner finish' — for the material layer being the inner finish.
* 'Outer finish' — for the material layer being the outer finish.
\returns
Returns the value of Category attribute.
*/
const OdAnsiString& getCategory() const;
/** \details
Sets the value of Category attribute.
This attribute represents category of the material layer, e.g. the role it has in the layer set it belongs to (such as 'load bearing', 'thermal insulation' etc.).
The list of keywords can be extended by model view definitions, however the following keywords apply in general:
* 'LoadBearing' — for all material layers having a load bearing function.
* 'Insulation' — for all material layers having an insulating function.
* 'Inner finish' — for the material layer being the inner finish.
* 'Outer finish' — for the material layer being the outer finish.
\param Category [in] Category to set.
*/
void setCategory(const OdAnsiString& Category);
/** \details
Returns the value of Priority attribute.
This attribute represents the relative priority of the layer, expressed as normalized integer range [0..100].
Controls how layers intersect in connections and corners of building elements:
a layer from one element protrudes into (i.e. displaces) a layer from another element in a joint of these elements
if the former element's layer has higher priority than the latter.
The priority value for a material layer in an element has to be set and maintained by software applications
in relation to the material layers in connected elements.
\returns
Returns the value of Priority attribute.
*/
int getPriority() const;
/** \details
Sets the value of Priority attribute.
This attribute represents the relative priority of the layer, expressed as normalized integer range [0..100].
Controls how layers intersect in connections and corners of building elements:
a layer from one element protrudes into (i.e. displaces) a layer from another element in a joint of these elements
if the former element's layer has higher priority than the latter.
The priority value for a material layer in an element has to be set and maintained by software applications
in relation to the material layers in connected elements.
\param Priority [in] Priority to set.
*/
void setPriority(int Priority);
/** \details
Returns the value of ToMaterialLayerSet attribute.
This attribute represents reference to the IfcMaterialLayerSet in which the material layer is included.
\returns
Returns the value of ToMaterialLayerSet attribute.
*/
OdDAIObjectId getInvToMaterialLayerSet() const;
public:
/** \details
Default constructor for the IfcMaterialLayer class.
*/
IfcMaterialLayer();
/** \details
Reads object's data from the specified filer.
\param rdFiler [in] Pointer to a filer from which to read the data.
\returns
A value of OdResult type that contains the result of the method execution.
*/
virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override;
/** \details
Writes object's data the the specified filer.
\param wrFiler [in] Pointer to a filer to which to write the data.
\returns
A value of OdResult type that contains the result of the method execution.
*/
virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override;
/** \details
Returns a type of a class instance.
\returns
Pointer to the OdDAI::Entity type that determines an entity definition within a schema.
*/
virtual OdDAI::Entity* getInstanceType() const override;
/** \details
Returns an attribute value for the specified attribute name.
\param attrName [in] Name of an attribute to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const char * attrName) const override;
/** \details
Early-bound version of instances comparison.
\param pOther [in] Other application instance.
\param ordering [out] Receives the ordering (comparison) status.
\returns
true if comparison was performed, false if method has no implementation, so late-bound version could be applied.
\remarks
If the method returns true,
the ordering parameter can receive one of the following statuses:
Name Value Description
_kLessThan_ -1 This object < Other Object.
_kEqual_ 0 This object = Other Object.
_kGreaterThan_ 1 This object > Other Object.
_kNotOrderable_ 2 This class is not orderable.
*/
virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrName [in] Explicit name of the attribute to reset.
*/
virtual void unsetAttr(const char * explicitAttrName) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrName [in] Explicit name of the attribute to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const char * explicitAttrName) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrName [in] Explicit name of the attribute to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override;
/** \details
Checks whether the specified instance is the object derived from or belongs to this class.
\param entityType [in] Entity to check.
\returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.
*/
virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override;
/** \details
Returns the type of this entity.
\returns
A value of the OdIfc::OdIfcEntityType type that represents type of this entity.
*/
virtual OdIfc::OdIfcEntityType type() const override;
/** \details
Returns an attribute value for the specified attribute definition.
\param attrDef [in] Attribute definition to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrDef [in] Explicit definition that represents an attribute to reset.
*/
virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrDef [in] Attribute definition to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrDef [in] Explicit attribute definition to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override;
protected:
// Fields declaration:
OdDAIObjectId m_Material; // IfcMaterial [optional]
IfcNonNegativeLengthMeasure m_LayerThickness; // IfcNonNegativeLengthMeasure
OdDAI::Logical m_IsVentilated; // IfcLogical [optional]
OdAnsiString m_Name; // IfcLabel [optional]
OdAnsiString m_Description; // IfcText [optional]
OdAnsiString m_Category; // IfcLabel [optional]
int m_Priority; // IfcInteger [optional]
// Declare friend classes for inverse attributes functionality:
friend class IfcMaterialLayerSet;
};
/** \details
A data type that represents a smart pointer to a IfcMaterialLayer object.
*/
typedef OdSmartPtr IfcMaterialLayerPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X3_ADD2_IFCMATERIALLAYER_AUTO_IMPL_H