/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCELECTRICMOTOR_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCELECTRICMOTOR_AUTO_IMPL_H

#include "IfcElectricalElementAutoImpl.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 electric motor is an engine that is a machine for converting electrical energy into mechanical energy.
    
  - Material Set -
  This concept can be applied to the following resources:
  * Casing - Material from which the casing is constructed.
  
  - Object Typing -
  This concept can be applied to the following resources:
  * IfcElectricMotorType
  
  - Port Nesting -
  This concept can be applied with the following combinations:
  <table>
  <b>PortName</b>          <b>Flow</b>        <b>PredefinedType</b>
  Line                     SINK               ELECTRICAL
  Drive                    SOURCE             NOTDEFINED
  </table>
  
  - Property Sets for Objects -
  This concept can be applied to the following resources:
  * Pset_ElectricMotorTypeCommon
  
  - Quantity Sets -
  This concept can be applied to the following resources:
  * Qto_ElectricMotorBaseQuantities
*/
class IFC2X_FINAL_EXPORT IfcElectricMotor : public IfcElectricalElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcElectricMotor);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of MotorWindingType attribute. 
  This attribute represents the type of winding used for the motor.
  \returns
  Returns the value of MotorWindingType attribute.
  */
  IfcMotorWindingEnum getMotorWindingType() const;

  /** \details
  Sets the value of MotorWindingType attribute. 
  This attribute represents the type of winding used for the motor.
  \param MotorWindingType [in] MotorWindingType to set.
  */
  void setMotorWindingType(IfcMotorWindingEnum MotorWindingType);

  /** \details
  Returns the value of Efficiency attribute. 
  This attribute represents motor efficiency.
  \returns
  Returns the value of Efficiency attribute.
  */
  double getEfficiency() const;

  /** \details
  Sets the value of Efficiency attribute. 
  This attribute represents motor efficiency.
  \param Efficiency [in] Efficiency value to set.
  */
  void setEfficiency(double Efficiency);

  /** \details
  Returns the value of PowerOutput attribute. 
  This attribute represents nominal electrical power output of the motor per NEMA Standards MG10 and MG11.
  \returns
  Returns the value of PowerOutput attribute.
  */
  double getPowerOutput() const;

  /** \details
  Sets the value of PowerOutput attribute. 
  This attribute represents nominal electrical power output of the motor per NEMA Standards MG10 and MG11.
  \param PowerOutput [in] PowerOutput to set.
  */
  void setPowerOutput(double PowerOutput);

  /** \details
  Returns the value of FrameConfiguration attribute. 
  This attribute represents motor frame designation.
  \returns
  Returns the value of FrameConfiguration attribute.
  */
  const OdAnsiString& getFrameConfiguration() const;

  /** \details
  Sets the value of FrameConfiguration attribute. 
  This attribute represents motor frame designation.
  \param FrameConfiguration [in] Frame configuration to set.
  */
  void setFrameConfiguration(const OdAnsiString& FrameConfiguration);

  /** \details
  Returns the value of InsulationRating attribute. 
  This attribute represents nominal rating of the motor wiring insulation.
  \returns
  Returns the value of InsulationRating attribute.
  */
  const OdAnsiString& getInsulationRating() const;

  /** \details
  Sets the value of InsulationRating attribute. 
  This attribute represents nominal rating of the motor wiring insulation.
  \param InsulationRating [in] InsulationRating attribute to set.
  */
  void setInsulationRating(const OdAnsiString& InsulationRating);

  /** \details
  Returns the value of MotorHousing attribute. 
  This attribute represents the type of motor housing.
  \returns
  Returns the value of MotorHousing attribute.
  */
  IfcMotorHousingEnum getMotorHousing() const;

  /** \details
  Sets the value of MotorHousing attribute. 
  This attribute represents the type of motor housing.
  \param MotorHousing [in] MotorHousing attribute to set.
  */
  void setMotorHousing(IfcMotorHousingEnum MotorHousing);


public:

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

  /** \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_MotorWindingType;   // IfcMotorWindingEnum  [optional]
  IfcPositiveRatioMeasure m_Efficiency;   // IfcPositiveRatioMeasure  [optional]
  double m_PowerOutput;   // IfcPowerMeasure  [optional]
  OdAnsiString m_FrameConfiguration;   // IfcText  [optional]
  OdAnsiString m_InsulationRating;   // IfcText  [optional]
  OdDAI::Enum m_MotorHousing;   // IfcMotorHousingEnum  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCELECTRICMOTOR_AUTO_IMPL_H