/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCAIRTERMINAL_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCAIRTERMINAL_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 air terminal is a terminating or origination point for the transfer of air between distribution system(s) and one or more spaces. 
  It can also be used for the transfer of air between adjacent spaces.
*/
class IFC2X_FINAL_EXPORT IfcAirTerminal : public IfcFlowTerminal
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcAirTerminal);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of AirFlowType attribute. 
  This attribute represents possible AirTerminal types (e.g., Supply, Return, Exhaust, etc.).
  \returns
  Returns the value of AirFlowType attribute.
  */
  IfcAirFlowTypeEnum getAirFlowType() const;

  /** \details
  Sets the value of AirFlowType attribute. 
  This attribute represents possible AirTerminal types (e.g., Supply, Return, Exhaust, etc.).
  \param AirFlowType [in] AirFlowType attribute to set.
  */
  void setAirFlowType(IfcAirFlowTypeEnum AirFlowType);

  /** \details
  Returns the value of Throw attribute. 
  This attribute represents horizontal or vertical axial distance an air stream travels 
  after leaving an AirTerminal before the maximum stream velocity is reduced to a specified terminal velocity.
  \returns
  Returns the value of Throw attribute.
  */
  double getThrow() const;

  /** \details
  Sets the value of Throw attribute. 
  This attribute represents horizontal or vertical axial distance an air stream travels 
  after leaving an AirTerminal before the maximum stream velocity is reduced to a specified terminal velocity.
  \param Throw [in] Throw attribute to set.
  */
  void setThrow(double Throw);

  /** \details
  Returns the value of AirDiffusionPerformanceIndex attribute. 
  This attribute represents the Air Diffusion Performance Index (ADPI) that is used for cooling mode conditions. 
  If several measurements of air velocity and air temperature are made throughout the occupied zone of a space, 
  the ADPI is the percentage of locations where measurements were taken that meet the specifications for effective draft temperature and air velocity.
  \returns
  Returns the value of AirDiffusionPerformanceIndex attribute.
  */
  double getAirDiffusionPerformanceIndex() const;

  /** \details
  Sets the value of AirDiffusionPerformanceIndex attribute. 
  This attribute represents the Air Diffusion Performance Index (ADPI) that is used for cooling mode conditions. 
  If several measurements of air velocity and air temperature are made throughout the occupied zone of a space, 
  the ADPI is the percentage of locations where measurements were taken that meet the specifications for effective draft temperature and air velocity.
  \param AirDiffusionPerformanceIndex [in] AirDiffusionPerformanceIndex attribute to set.
  */
  void setAirDiffusionPerformanceIndex(double AirDiffusionPerformanceIndex);

  /** \details
  Returns the value of FinishType attribute. 
  This attribute represents the type of finish for the AirTerminal.
  \returns
  Returns the value of FinishType attribute.
  */
  IfcAirTerminalFinishTypeEnum getFinishType() const;

  /** \details
  Sets the value of FinishType attribute. 
  This attribute represents the type of finish for the AirTerminal.
  \param FinishType [in] FinishType attribute to set.
  */
  void setFinishType(IfcAirTerminalFinishTypeEnum FinishType);

  /** \details
  Returns the value of FinishColor attribute. 
  This attribute represents the finish color for the air terminal.
  \returns
  Returns the value of FinishColor attribute.
  */
  const OdAnsiString& getFinishColor() const;

  /** \details
  Sets the value of FinishColor attribute. 
  This attribute represents the finish color for the air terminal.
  \param FinishColor [in] FinishColor attribute to set.
  */
  void setFinishColor(const OdAnsiString& FinishColor);

  /** \details
  Returns the value of MountingType attribute. 
  This attribute represents the way the AirTerminal is mounted to the ceiling, wall, etc.
  \returns
  Returns the value of MountingType attribute.
  */
  IfcAirTerminalMountingTypeEnum getMountingType() const;

  /** \details
  Sets the value of MountingType attribute. 
  This attribute represents the way the AirTerminal is mounted to the ceiling, wall, etc.
  \param MountingType [in] MountingType attribute to set.
  */
  void setMountingType(IfcAirTerminalMountingTypeEnum MountingType);

  /** \details
  Returns the value of FaceType attribute. 
  This attribute identifies how the terminal face of an AirTerminal is constructed.
  \returns
  Returns the value of FaceType attribute.
  */
  IfcAirTerminalFaceTypeEnum getFaceType() const;

  /** \details
  Sets the value of FaceType attribute. 
  This attribute identifies how the terminal face of an AirTerminal is constructed.
  \param FaceType [in] FaceType attribute to set.
  */
  void setFaceType(IfcAirTerminalFaceTypeEnum FaceType);

  /** \details
  Returns the value of CoreType attribute. 
  This attribute identifies the way the core of the AirTerminal is constructed.
  \returns
  Returns the value of CoreType attribute.
  */
  IfcAirTerminalCoreTypeEnum getCoreType() const;

  /** \details
  Sets the value of CoreType attribute. 
  This attribute identifies the way the core of the AirTerminal is constructed.
  \param CoreType [in] CoreType attribute to set.
  */
  void setCoreType(IfcAirTerminalCoreTypeEnum CoreType);

  /** \details
  Returns the value of CoreSetVertical attribute. 
  This attribute represents degree of blade set from the center line.
  \returns
  Returns the value of CoreSetVertical attribute.
  */
  double getCoreSetVertical() const;

  /** \details
  Sets the value of CoreSetVertical attribute. 
  This attribute represents degree of blade set from the center line.
  \param CoreSetVertical [in] CoreSetVertical attribute to set.
  */
  void setCoreSetVertical(double CoreSetVertical);

  /** \details
  Returns the value of CoreSetHorizontal attribute. 
  This attribute represents degree of blade set from the centerline.
  \returns
  Returns the value of CoreSetHorizontal attribute.
  */
  double getCoreSetHorizontal() const;

  /** \details
  Sets the value of CoreSetHorizontal attribute. 
  This attribute represents degree of blade set from the centerline.
  \param CoreSetHorizontal [in] CoreSetHorizontal attribute to set.
  */
  void setCoreSetHorizontal(double CoreSetHorizontal);

  /** \details
  Returns the value of IntegralControl attribute. 
  This attribute indicates whether a self-powered temperature control is included in the AirTerminal.
  \returns
  Returns the value of IntegralControl attribute.
  */
  OdDAI::Boolean getIntegralControl() const;

  /** \details
  Sets the value of IntegralControl attribute. 
  This attribute indicates whether a self-powered temperature control is included in the AirTerminal.
  \param IntegralControl [in] IntegralControl attribute to set.
  */
  void setIntegralControl(OdDAI::Boolean IntegralControl);


public:

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

  /** \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_AirFlowType;   // IfcAirFlowTypeEnum
  double m_Throw;   // IfcLengthMeasure  [optional]
  double m_AirDiffusionPerformanceIndex;   // IfcReal  [optional]
  OdDAI::Enum m_FinishType;   // IfcAirTerminalFinishTypeEnum  [optional]
  OdAnsiString m_FinishColor;   // IfcLabel  [optional]
  OdDAI::Enum m_MountingType;   // IfcAirTerminalMountingTypeEnum  [optional]
  OdDAI::Enum m_FaceType;   // IfcAirTerminalFaceTypeEnum  [optional]
  OdDAI::Enum m_CoreType;   // IfcAirTerminalCoreTypeEnum  [optional]
  double m_CoreSetVertical;   // IfcPlaneAngleMeasure  [optional]
  double m_CoreSetHorizontal;   // IfcPlaneAngleMeasure  [optional]
  OdDAI::Boolean m_IntegralControl;   // IfcBoolean  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCAIRTERMINAL_AUTO_IMPL_H