/////////////////////////////////////////////////////////////////////////////// 
// 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 _IFC2X3_IFCMATERIALLAYER_AUTO_IMPL_H
#define _IFC2X3_IFCMATERIALLAYER_AUTO_IMPL_H

#include "Ifc2x3BaseClass.h"

#include "Ifc2x3Enum.h"
#include "Ifc2x3SelectTypes.h"
#include "Ifc2x3CollectionTypes.h"
#include "IfcMaterialAutoImpl.h"

#include "TD_PackPush.h"

/** \details
  The namespace contains schema-dependent classes, definitions and sub routines
  for work with IFC2X3 express schema definitions.
*/
namespace OdIfc2x3 {

/** \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.
*/
class IFC2X3_EXPORT IfcMaterialLayer : public OdIfc2x3Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::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 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 <exref target="OdDAI__Entity.html">OdDAI::Entity</exref> 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:
  <table>
    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.
  </table>
  */
  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 <exref target="OdIfc__OdIfcEntityType.html">OdIfc::OdIfcEntityType</exref> 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]
  IfcPositiveLengthMeasure m_LayerThickness;   // IfcPositiveLengthMeasure
  OdDAI::Logical m_IsVentilated;   // IfcLogical  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcMaterialLayerSet;
};

/** \details
  A data type that represents a smart pointer to a <exref target="OdIfc2x3__IfcMaterialLayer.html">IfcMaterialLayer</exref> object.
*/
typedef OdSmartPtr<IfcMaterialLayer> IfcMaterialLayerPtr;

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCMATERIALLAYER_AUTO_IMPL_H