/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCDAMPER_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCDAMPER_AUTO_IMPL_H

#include "IfcFlowControllerAutoImpl.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 damper typically participates in an HVAC duct distribution system and is used to control or modulate the flow of air.
  - Material Set -
  This concept can be applied to the following resources:
  * Blade - The material from which the damper blades are constructed.
  * Frame - The material from which the damper frame is constructed.
  * Seal - The material from which the damper seals are constructed.
  
  - Object Typing -
  This concept can be applied to the following resources:
  * IfcDamperType
  
  - Port Nesting -
  This concept can be applied with the following combinations:
  
  <table>
  <b>PortName</b>          <b>Flow</b>        <b>PredefinedType</b>
  AirIn                    SINK               AIRCONDITIONING
  AirOut                   SOURCE             AIRCONDITIONING
  </table>
*/
class IFC2X_FINAL_EXPORT IfcDamper : public IfcFlowController
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcDamper);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents types to further identify the object. 
  Some property sets can be specifically applicable to one of these types.
  \returns
  Returns the value of PredefinedType attribute.
  */
  IfcDamperTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents types to further identify the object. 
  Some property sets can be specifically applicable to one of these types.
  \param PredefinedType [in] PredefinedType to set.
  */
  void setPredefinedType(IfcDamperTypeEnum PredefinedType);

  /** \details
  Returns the value of FrameDepth attribute. 
  This attribute represents the length (or depth) of the damper frame.
  \returns
  Returns the value of FrameDepth attribute.
  */
  double getFrameDepth() const;

  /** \details
  Sets the value of FrameDepth attribute. 
  This attribute represents the length (or depth) of the damper frame.
  \param FrameDepth [in] Frame depth to set.
  */
  void setFrameDepth(double FrameDepth);

  /** \details
  Returns the value of SizingMethod attribute. 
  This attribute indicates whether the damper is sized nominally or with exact measurements.
  \returns
  Returns the value of SizingMethod attribute.
  */
  IfcDamperSizingMethodEnum getSizingMethod() const;

  /** \details
  Sets the value of SizingMethod attribute. 
  This attribute indicates whether the damper is sized nominally or with exact measurements.
  \param SizingMethod [in] Sizing method to set.
  */
  void setSizingMethod(IfcDamperSizingMethodEnum SizingMethod);

  /** \details
  Returns the value of CloseOffRating attribute. 
  This attribute represents the maximum pressure drop 
  that a valve can withstand without leakage while in the fully closed position.
  \returns
  Returns the value of CloseOffRating attribute.
  */
  double getCloseOffRating() const;

  /** \details
  Sets the value of CloseOffRating attribute. 
  This attribute represents the maximum pressure drop 
  that a valve can withstand without leakage while in the fully closed position.
  \param CloseOffRating [in] CloseOffRating attribute to set.
  */
  void setCloseOffRating(double CloseOffRating);

  /** \details
  Returns the value of LeakageAirFlowRate attribute. 
  This attribute represents the volume of air that still passes through a fully closed damper.
  \returns
  Returns the value of LeakageAirFlowRate attribute.
  */
  double getLeakageAirFlowRate() const;

  /** \details
  Sets the value of LeakageAirFlowRate attribute. 
  This attribute represents the volume of air that still passes through a fully closed damper.
  \param LeakageAirFlowRate [in] LeakageAirFlowRate attribute to set.
  */
  void setLeakageAirFlowRate(double LeakageAirFlowRate);

  /** \details
  Returns the value of PercentOpen attribute. 
  This attribute represents the percentage open position for the damper blades. 
  This value varies for dampers under automatic control, but typically remain fixed for dampers used for balancing purposes.
  \returns
  Returns the value of PercentOpen attribute.
  */
  double getPercentOpen() const;

  /** \details
  Sets the value of PercentOpen attribute. 
  This attribute represents the percentage open position for the damper blades. 
  This value varies for dampers under automatic control, but typically remain fixed for dampers used for balancing purposes.
  \param PercentOpen [in] PercentOpen attribute to set.
  */
  void setPercentOpen(double PercentOpen);


public:

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

  /** \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_PredefinedType;   // IfcDamperTypeEnum
  double m_FrameDepth;   // IfcLengthMeasure  [optional]
  OdDAI::Enum m_SizingMethod;   // IfcDamperSizingMethodEnum  [optional]
  double m_CloseOffRating;   // IfcPressureMeasure  [optional]
  double m_LeakageAirFlowRate;   // IfcVolumetricFlowRateMeasure  [optional]
  IfcPositiveRatioMeasure m_PercentOpen;   // IfcPositiveRatioMeasure  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCDAMPER_AUTO_IMPL_H