/////////////////////////////////////////////////////////////////////////////// 
// 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 _IFC2X2_FINAL_IFCELECTRICALBASEPROPERTIES_AUTO_IMPL_H
#define _IFC2X2_FINAL_IFCELECTRICALBASEPROPERTIES_AUTO_IMPL_H

#include "IfcEnergyPropertiesAutoImpl.h"

#include "TD_PackPush.h"

/** \details
  The namespace contains schema-dependent classes, definitions and sub routines
  for work with IFC2X2_FINAL express schema definitions.
*/
namespace OdIfc2x2_final {

/** \details
  Common definition to capture basic electrical characteristics for use in building services and facilities management.
*/
class IFC2X2_FINAL_EXPORT IfcElectricalBaseProperties : public IfcEnergyProperties
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcElectricalBaseProperties);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ElectricCurrentType attribute. 
  This attribute represents the type of electrical current applied.
  \returns
  Returns the value of ElectricCurrentType attribute.
  */
  IfcElectricCurrentEnum getElectricCurrentType() const;

  /** \details
  Sets the value of ElectricCurrentType attribute. 
  This attribute represents the type of electrical current applied.
  \param ElectricCurrentType [in] ElectricCurrentType attribute to set.
  */
  void setElectricCurrentType(IfcElectricCurrentEnum ElectricCurrentType);

  /** \details
  Returns the value of InputVoltage attribute. 
  This attribute represents the input electrical potential.
  \returns
  Returns the value of InputVoltage attribute.
  */
  double getInputVoltage() const;

  /** \details
  Sets the value of InputVoltage attribute. 
  This attribute represents the input electrical potential.
  \param InputVoltage [in] InputVoltage attribute to set.
  */
  void setInputVoltage(double InputVoltage);

  /** \details
  Returns the value of InputFrequency attribute. 
  This attribute represents the nominal frequency of input voltage wave form.
  \returns
  Returns the value of InputFrequency attribute.
  */
  double getInputFrequency() const;

  /** \details
  Sets the value of InputFrequency attribute. 
  This attribute represents the nominal frequency of input voltage wave form.
  \param InputFrequency [in] InputFrequency attribute to set.
  */
  void setInputFrequency(double InputFrequency);

  /** \details
  Returns the value of FullLoadCurrent attribute. 
  This attribute represents the full load electrical current requirements.
  \returns
  Returns the value of FullLoadCurrent attribute.
  */
  double getFullLoadCurrent() const;

  /** \details
  Sets the value of FullLoadCurrent attribute. 
  This attribute represents the full load electrical current requirements.
  \param FullLoadCurrent [in] FullLoadCurrent attribute to set.
  */
  void setFullLoadCurrent(double FullLoadCurrent);

  /** \details
  Returns the value of MinimumCircuitCurrent attribute. 
  This attribute represents the minimum current carrying capacity of the electrical circuit.
  \returns
  Returns the value of MinimumCircuitCurrent attribute.
  */
  double getMinimumCircuitCurrent() const;

  /** \details
  Sets the value of MinimumCircuitCurrent attribute. 
  This attribute represents the minimum current carrying capacity of the electrical circuit.
  \param MinimumCircuitCurrent [in] MinimumCircuitCurrent attribute to set.
  */
  void setMinimumCircuitCurrent(double MinimumCircuitCurrent);

  /** \details
  Returns the value of MaximumPowerInput attribute. 
  This attribute represents the maximum power input of the electrical device.
  \returns
  Returns the value of MaximumPowerInput attribute.
  */
  double getMaximumPowerInput() const;

  /** \details
  Sets the value of MaximumPowerInput attribute. 
  This attribute represents the maximum power input of the electrical device.
  \param MaximumPowerInput [in] MaximumPowerInput attribute to set.
  */
  void setMaximumPowerInput(double MaximumPowerInput);

  /** \details
  Returns the value of RatedPowerInput attribute. 
  This attribute represents the actual electrical input power of the electrical device at its rated capacity.
  \returns
  Returns the value of RatedPowerInput attribute.
  */
  double getRatedPowerInput() const;

  /** \details
  Sets the value of RatedPowerInput attribute. 
  This attribute represents the actual electrical input power of the electrical device at its rated capacity.
  \param RatedPowerInput [in] RatedPowerInput attribute to set.
  */
  void setRatedPowerInput(double RatedPowerInput);

  /** \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);


public:

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

  /** \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_ElectricCurrentType;   // IfcElectricCurrentEnum  [optional]
  double m_InputVoltage;   // IfcElectricVoltageMeasure
  double m_InputFrequency;   // IfcFrequencyMeasure
  double m_FullLoadCurrent;   // IfcElectricCurrentMeasure  [optional]
  double m_MinimumCircuitCurrent;   // IfcElectricCurrentMeasure  [optional]
  double m_MaximumPowerInput;   // IfcPowerMeasure  [optional]
  double m_RatedPowerInput;   // IfcPowerMeasure  [optional]
  int m_InputPhase;   // INTEGER
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X2_FINAL_IFCELECTRICALBASEPROPERTIES_AUTO_IMPL_H