/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCHYDRONICHEATER_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCHYDRONICHEATER_AUTO_IMPL_H

#include "IfcFlowTerminalAutoImpl.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
  An IfcHydronicHeater is a device which adds heat to a space utilizing a combination of radiation and natural convection. 
  The heat source is typically steam or hot water. Examples of HydronicHeaters include radiators, convectors, baseboard and finned-tube heaters, etc. 
  The physical dimensions and properties of the heating element can be defined by an aggregated coil element (IfcCoil).
  
  - Local Placement -
  The use of local placement is defined at the supertype IfcDistributionFlowElement.
  
  - Standard Geometric Representation -
  The use of Standard Geometric Representations is defined at the supertype IfcDistributionFlowElement.
*/
class IFC2X_FINAL_EXPORT IfcHydronicHeater : public IfcFlowTerminal
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcHydronicHeater);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of HydronicHeaterType attribute. 
  This attribute represents possible hydronic heater types (e.g., baseboard heater, convector, radiator, etc.).
  \returns
  Returns the value of HydronicHeaterType attribute.
  */
  IfcHydronicHeaterTypeEnum getHydronicHeaterType() const;

  /** \details
  Sets the value of HydronicHeaterType attribute. 
  This attribute represents possible hydronic heater types (e.g., baseboard heater, convector, radiator, etc.).
  \param HydronicHeaterType [in] HydronicHeaterType attribute to set.
  */
  void setHydronicHeaterType(IfcHydronicHeaterTypeEnum HydronicHeaterType);

  /** \details
  Returns the value of HeatOutput attribute. 
  This attribute represents the total nominal heat output as listed by the manufacturer.
  \returns
  Returns the value of HeatOutput attribute.
  */
  double getHeatOutput() const;

  /** \details
  Sets the value of HeatOutput attribute. 
  This attribute represents the total nominal heat output as listed by the manufacturer.
  \param HeatOutput [in] HeatOutput attribute to set.
  */
  void setHeatOutput(double HeatOutput);

  /** \details
  Returns the value of Enclosure attribute. 
  This attribute represents the description of the the type of enclosure around the HydronicHeater.
  \returns
  Returns the value of Enclosure attribute.
  */
  const OdAnsiString& getEnclosure() const;

  /** \details
  Sets the value of Enclosure attribute. 
  This attribute represents the description of the the type of enclosure around the HydronicHeater.
  \param Enclosure [in] Enclosure attribute to set.
  */
  void setEnclosure(const OdAnsiString& Enclosure);

  /** \details
  Returns the value of BodyMass attribute. 
  This attribute represents the overall body mass of a HydronicHeater.
  \returns
  Returns the value of BodyMass attribute.
  */
  double getBodyMass() const;

  /** \details
  Sets the value of BodyMass attribute. 
  This attribute represents the overall body mass of a HydronicHeater.
  \param BodyMass [in] BodyMass attribute to set.
  */
  void setBodyMass(double BodyMass);

  /** \details
  Returns the value of NumberOfPanels attribute. 
  This attribute represents the number of panels (panel radiators only).
  \returns
  Returns the value of NumberOfPanels attribute.
  */
  int getNumberOfPanels() const;

  /** \details
  Sets the value of NumberOfPanels attribute. 
  This attribute represents the number of panels (panel radiators only).
  \param NumberOfPanels [in] NumberOfPanels attribute to set.
  */
  void setNumberOfPanels(int NumberOfPanels);

  /** \details
  Returns the value of NumberOfSections attribute. 
  This attribute represents the number of vertical sections, measured in the direction of flow.
  \returns
  Returns the value of NumberOfSections attribute.
  */
  int getNumberOfSections() const;

  /** \details
  Sets the value of NumberOfSections attribute. 
  This attribute represents the number of vertical sections, measured in the direction of flow.
  \param NumberOfSections [in] NumberOfSections attribute to set.
  */
  void setNumberOfSections(int NumberOfSections);


public:

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

  /** \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_HydronicHeaterType;   // IfcHydronicHeaterTypeEnum
  double m_HeatOutput;   // IfcPowerMeasure  [optional]
  OdAnsiString m_Enclosure;   // IfcLabel  [optional]
  double m_BodyMass;   // IfcMassMeasure  [optional]
  int m_NumberOfPanels;   // IfcInteger  [optional]
  int m_NumberOfSections;   // IfcInteger  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCHYDRONICHEATER_AUTO_IMPL_H