/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCELECTRICALEXTENDEDPROPERTIES_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCELECTRICALEXTENDEDPROPERTIES_AUTO_IMPL_H

#include "IfcElectricalBasePropertiesAutoImpl.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
  This definition is a common definition to capture extended electrical characteristics for use in building services and facilities management.
*/
class IFC2X_FINAL_EXPORT IfcElectricalExtendedProperties : public IfcElectricalBaseProperties
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcElectricalExtendedProperties);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of InputPhase attribute. 
  This attribute represents the relative phase of input conductors.
  \returns
  Returns the value of InputPhase attribute.
  */
  int getInputPhase() const;

  /** \details
  Sets the value of InputPhase attribute. 
  This attribute represents the relative phase of input conductors.
  \param InputPhase [in] InputPhase attribute to set.
  */
  void setInputPhase(int InputPhase);

  /** \details
  Returns the value of InrushCurrent attribute. 
  This attribute represents the current the electrical device can be subjected to upon initial startup.
  \returns
  Returns the value of InrushCurrent attribute.
  */
  double getInrushCurrent() const;

  /** \details
  Sets the value of InrushCurrent attribute. 
  This attribute represents the current the electrical device can be subjected to upon initial startup.
  \param InrushCurrent [in] InrushCurrent attribute to set.
  */
  void setInrushCurrent(double InrushCurrent);

  /** \details
  Returns the value of LockedRotorCurrent attribute. 
  This attribute represents the input current when a motor armature is energized but not rotating.
  \returns
  Returns the value of LockedRotorCurrent attribute.
  */
  double getLockedRotorCurrent() const;

  /** \details
  Sets the value of LockedRotorCurrent attribute. 
  This attribute represents the input current when a motor armature is energized but not rotating.
  \param LockedRotorCurrent [in] LockedRotorCurrent attribute to set.
  */
  void setLockedRotorCurrent(double LockedRotorCurrent);

  /** \details
  Returns the value of CircuitSizePowerInput attribute. 
  This attribute represents the electrical power input that should be used for circuit sizing.
  \returns
  Returns the value of CircuitSizePowerInput attribute.
  */
  double getCircuitSizePowerInput() const;

  /** \details
  Sets the value of CircuitSizePowerInput attribute. 
  This attribute represents the electrical power input that should be used for circuit sizing.
  \param CircuitSizePowerInput [in] CircuitSizePowerInput attribute to set.
  */
  void setCircuitSizePowerInput(double CircuitSizePowerInput);

  /** \details
  Returns the value of FuseSize attribute. 
  This attribute represents the designation for fuse for this electrical device.
  \returns
  Returns the value of FuseSize attribute.
  */
  double getFuseSize() const;

  /** \details
  Sets the value of FuseSize attribute. 
  This attribute represents the designation for fuse for this electrical device.
  \param FuseSize [in] FuseSize attribute to set.
  */
  void setFuseSize(double FuseSize);

  /** \details
  Returns the value of Grounded attribute. 
  This attribute indicates whether this element requires electrical grounding.
  \returns
  Returns the value of Grounded attribute.
  */
  OdDAI::Boolean getGrounded() const;

  /** \details
  Sets the value of Grounded attribute. 
  This attribute indicates whether this element requires electrical grounding.
  \param Grounded [in] Grounded attribute to set.
  */
  void setGrounded(OdDAI::Boolean Grounded);


public:

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

  /** \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: 
  int m_InputPhase;   // INTEGER  [optional]
  double m_InrushCurrent;   // IfcElectricCurrentMeasure  [optional]
  double m_LockedRotorCurrent;   // IfcElectricCurrentMeasure  [optional]
  double m_CircuitSizePowerInput;   // IfcPowerMeasure  [optional]
  double m_FuseSize;   // IfcElectricCurrentMeasure  [optional]
  OdDAI::Boolean m_Grounded;   // BOOLEAN  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCELECTRICALEXTENDEDPROPERTIES_AUTO_IMPL_H