/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCPUMP_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCPUMP_AUTO_IMPL_H

#include "IfcFluidMovingDeviceAutoImpl.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 pump is a device which imparts mechanical work on fluids or slurries to move them through a channel or pipeline. 
  A typical use of a pump is to circulate chilled water or heating hot water in a building services distribution system.
  
  - Material Set -
  This concept can be applied to the following resources:
  * Casing - Material from which the casing is constructed.
  * Impeller - Material from which the impeller of the pump is constructed. In the case of a positive displacement pump, the piston acts as the impeller.
  * Seal - Material from which the impeller shaft seal of the pump is constructed.
  
  - Object Typing -
  This concept can be applied to the following resources:
  * IfcPumpType
  
  - Port Nesting -
  This concept can be applied with the following combinations:
  <table>
  <b>PortName</b>          <b>Flow</b>        <b>PredefinedType</b>
  Power                    SINK               ELECTRICAL
  Inlet                    SINK               NOTDEFINED
  Outlet                   SOURCE             NOTDEFINED
  </table>
  
  - Property Sets for Objects -
  This concept can be applied to the following resources:
  * Pset_PumpOccurrence
  * Pset_PumpTypeCommon
  
  - Property Sets for Performance -
  This concept can be applied to the following resources:
  * Pset_PumpPHistory
  
  - Quantity Sets -
  This concept can be applied to the following resources:
  * Qto_PumpBaseQuantities
*/
class IFC2X_FINAL_EXPORT IfcPump : public IfcFluidMovingDevice
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcPump);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PumpType attribute. 
  This attribute represents the type of centrifugal pump typically used in building services.
  \returns
  Returns the value of PumpType attribute.
  */
  IfcPumpTypeEnum getPumpType() const;

  /** \details
  Sets the value of PumpType attribute. 
  This attribute represents the type of centrifugal pump typically used in building services.
  \param PumpType [in] Pump type to set.
  */
  void setPumpType(IfcPumpTypeEnum PumpType);

  /** \details
  Returns the value of NetPositiveSuctionHead attribute. 
  This attribute represents minimum liquid pressure at pump inlet to prevent cavitation.
  \returns
  Returns the value of NetPositiveSuctionHead attribute.
  */
  double getNetPositiveSuctionHead() const;

  /** \details
  Sets the value of NetPositiveSuctionHead attribute. 
  This attribute represents minimum liquid pressure at pump inlet to prevent cavitation.
  \param NetPositiveSuctionHead [in] NetPositiveSuctionHead attribute to set.
  */
  void setNetPositiveSuctionHead(double NetPositiveSuctionHead);

  /** \details
  Returns the value of ImpellerSealMaterial attribute. 
  This attribute represents the material used for the impeller shaft seals.
  \returns
  Returns the value of ImpellerSealMaterial attribute.
  */
  IfcMaterialSelect impellerSealMaterial();

  /** \details
  Returns the value of PumpBaseType attribute. 
  This attribute represents the type of base used for centrifugal pumps.
  \returns
  Returns the value of PumpBaseType attribute.
  */
  IfcPumpBaseTypeEnum getPumpBaseType() const;

  /** \details
  Sets the value of PumpBaseType attribute. 
  This attribute represents the type of base used for centrifugal pumps.
  \param PumpBaseType [in] PumpBaseType attribute to set.
  */
  void setPumpBaseType(IfcPumpBaseTypeEnum PumpBaseType);

  /** \details
  Returns the value of MotorDriveType attribute. 
  This attribute represents the type of connection between the motor and the pump impeller.
  \returns
  Returns the value of MotorDriveType attribute.
  */
  IfcMoterConnectionTypeEnum getMotorDriveType() const;

  /** \details
  Sets the value of MotorDriveType attribute. 
  This attribute represents the type of connection between the motor and the pump impeller.
  \param MotorDriveType [in] Motor drive type to set.
  */
  void setMotorDriveType(IfcMoterConnectionTypeEnum MotorDriveType);


public:

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

  /** \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_PumpType;   // IfcPumpTypeEnum
  double m_NetPositiveSuctionHead;   // IfcPressureMeasure  [optional]
  OdDAI::Select m_ImpellerSealMaterial;   // IfcMaterialSelect  [optional]
  OdDAI::Enum m_PumpBaseType;   // IfcPumpBaseTypeEnum  [optional]
  OdDAI::Enum m_MotorDriveType;   // IfcMoterConnectionTypeEnum  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCPUMP_AUTO_IMPL_H