/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCBOILER_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCBOILER_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 boiler is a closed, pressure-rated vessel in which water or other fluid is heated using an energy source such as natural gas, heating oil, or electricity. 
  The fluid in the vessel is then circulated out of the boiler for use in various processes or heating applications.
  
  IfcBoiler is a vessel that is used for heating of water or other fluids. 
  Storage vessels, such as for drinking water storage are considered as tanks (IfcTank entity should be used instead).
*/
class IFC2X_FINAL_EXPORT IfcBoiler : public IfcHeatTransferDevice
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcBoiler);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of BoilerType attribute. 
  This attribute represents boiler types by heat transfer medium.
  \returns
  Returns the value of BoilerType attribute.
  */
  IfcBoilerTypeEnum getBoilerType() const;

  /** \details
  Sets the value of BoilerType attribute. 
  This attribute represents boiler types by heat transfer medium.
  \param BoilerType [in] Boiler type to set.
  */
  void setBoilerType(IfcBoilerTypeEnum BoilerType);

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

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

  /** \details
  Returns the value of PressureRating attribute. 
  This attribute represents nominal pressure rating of the boiler as rated by ASME Boiler 
  and Pressure Vessel Code Section IV, Rules for Construction of Heating Boilers, 
  and Section I, Rules for Construction of Power Boilers.
  \returns
  Returns the value of PressureRating attribute.
  */
  double getPressureRating() const;

  /** \details
  Sets the value of PressureRating attribute. 
  This attribute represents nominal pressure rating of the boiler as rated by ASME Boiler 
  and Pressure Vessel Code Section IV, Rules for Construction of Heating Boilers, 
  and Section I, Rules for Construction of Power Boilers.
  \param PressureRating [in] PressureRating attribute to set.
  */
  void setPressureRating(double PressureRating);

  /** \details
  Returns the value of EnergyInputRate attribute. 
  This attribute represents nominal fuel consumption rate required to produce the total boiler heat output.
  \returns
  Returns the value of EnergyInputRate attribute.
  */
  double getEnergyInputRate() const;

  /** \details
  Sets the value of EnergyInputRate attribute. 
  This attribute represents nominal fuel consumption rate required to produce the total boiler heat output.
  \param EnergyInputRate [in] EnergyInputRate attribute to set.
  */
  void setEnergyInputRate(double EnergyInputRate);


public:

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

  /** \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_BoilerType;   // IfcBoilerTypeEnum
  double m_HeatOutput;   // IfcPowerMeasure  [optional]
  double m_PressureRating;   // IfcPressureMeasure  [optional]
  double m_EnergyInputRate;   // IfcVolumetricFlowRateMeasure  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCBOILER_AUTO_IMPL_H