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

#include "IfcHeatTransferDeviceAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  A heat exchanger is a device that provides heat transfer between non-mixing media such as plate and shell, and tube heat exchangers.
  IfcHeatExchanger is commonly used on water-side distribution systems to recover energy from a liquid to another liquid (typically water-based), 
  whereas IfcAirToAirHeatRecovery is commonly used on air-side distribution systems to recover energy from a gas to a gas (usually air).
  
  - Material Set -
  This concept can be applied to the following resources:
  * Casing - Material from which the casing is constructed.
  
  - Object Typing -
  This concept can be applied to the following resources:
  * IfcHeatExchangerType
  
  - Port Nesting -
  This concept can be applied with the following combinations:
  <table>
  <b>PortName</b>           <b>Flow</b>         <b>PredefinedType</b>
  HeatingInlet              SINK                NOTDEFINED
  HeatingOutlet             SOURCE              NOTDEFINED
  CoolingInlet              SINK                NOTDEFINED
  CoolingOutlet             SOURCE              NOTDEFINED
  </table>
  
  - Property Sets for Objects -
  This concept can be applied to the following resources:
  * Pset_HeatExchangerTypeCommon
  * Pset_HeatExchangerTypePlate (only applies to PLATE)
  
  - Quantity Sets -
  This concept can be applied to the following resources:
  * Qto_HeatExchangerBaseQuantities
*/
class IFC2X_FINAL_EXPORT IfcHeatExchanger : public IfcHeatTransferDevice
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcHeatExchanger);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of HeatExchangerType attribute. 
  This attribute represents the basic types of heat exchanger (e.g., plate, shell and tube, etc.).
  \returns
  Returns the value of HeatExchangerType attribute.
  */
  IfcHeatExchangerTypeEnum getHeatExchangerType() const;

  /** \details
  Sets the value of HeatExchangerType attribute. 
  This attribute represents the basic types of heat exchanger (e.g., plate, shell and tube, etc.).
  \param HeatExchangerType [in] Heat exchanger type to set.
  */
  void setHeatExchangerType(IfcHeatExchangerTypeEnum HeatExchangerType);

  /** \details
  Returns the value of HeatExchangerArrangement attribute. 
  This attribute represents the basic flow arrangements for the heat exchanger (e.g., Counterflow, Crossflow, etc.).
  \returns
  Returns the value of HeatExchangerArrangement attribute.
  */
  IfcHeatExchangerArrangementEnum getHeatExchangerArrangement() const;

  /** \details
  Sets the value of HeatExchangerArrangement attribute. 
  This attribute represents the basic flow arrangements for the heat exchanger (e.g., Counterflow, Crossflow, etc.).
  \param HeatExchangerArrangement [in] Heat exchanger arrangement to set.
  */
  void setHeatExchangerArrangement(IfcHeatExchangerArrangementEnum HeatExchangerArrangement);

  /** \details
  Returns the value of NumberOfPlates attribute. 
  This attribute represents the number of plates used for the plate and frame heat exchanger.
  \returns
  Returns the value of NumberOfPlates attribute.
  */
  int getNumberOfPlates() const;

  /** \details
  Sets the value of NumberOfPlates attribute. 
  This attribute represents the number of plates used for the plate and frame heat exchanger.
  \param NumberOfPlates [in] Number of plates to set.
  */
  void setNumberOfPlates(int NumberOfPlates);


public:

  /** \details
  Default constructor for the IfcHeatExchanger class.
  */
  IfcHeatExchanger();

  /** \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
  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: 
  OdDAI::Enum m_HeatExchangerType;   // IfcHeatExchangerTypeEnum
  OdDAI::Enum m_HeatExchangerArrangement;   // IfcHeatExchangerArrangementEnum  [optional]
  int m_NumberOfPlates;   // IfcInteger  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCHEATEXCHANGER_AUTO_IMPL_H