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

#include "IfcDistributionElementAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The distribution element IfcDistributionControlElement defines occurrence elements 
  of a building automation control system that are used to impart control over elements of a distribution system.
  
  IfcDistributionControlElement defines elements of a building automation control system. 
  They are typically used to control distribution system elements to maintain variables such as temperature, 
  humidity, pressure, flow, power, etc. 
  The three general functional categories of control elements are as follows:
  * Impart control over flow control elements (IfcFlowController) in a distribution system such as dampers, valves, or relays, typically through the use of actuation (IfcActuator).
  * Sensing elements (IfcSensor) that measure changes in the controlled variable such as temperature, humidity, pressure, or flow.
  * Controllers (IfcController) typically classified according to the control action they seek to perform and generally responsible for making decisions about the elements under control.
  
  Since IfcDistributionControlElement and its subtypes typically relate to many different distribution flow elements (IfcDistributionFlowElement), 
  the objectified relationship IfcRelFlowControlElements has been provided to relate control and flow elements as required.
  
  The key distinction between IfcDistributionFlowElement and IfcDistributionControlElement is whether it is internal or external to the flow system, respectively. 
  For example, the distinction between IfcFlowMeter (subtype of IfcDistributionFlowElement measuring a flow quantity) 
  and IfcFlowInstrument (subtype of IfcDistributionControlElement measuring a flow quality), is based on this principal. 
  A physical device that connects within the flow system in which it measures (having inlet/outlet pipes for the measured substance) 
  follows the IfcDistributionFlowElement hierarchy (and therefore IfcFlowMeter which measures the flow internally). 
  Otherwise, if it monitors/controls but does not connect inline within the flow system (it is external or is a component of another device), 
  then it follows the IfcDistributionControlElement hierarchy (and therefore IfcFlowInstrument which can display various attributes through connected sensors).
*/
class IFC2X3_EXPORT IfcDistributionControlElement : public IfcDistributionElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcDistributionControlElement);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ControlElementId attribute. 
  This attribute represents the identification assigned to this control element by the Building Automation System.
  \returns
  Returns the value of ControlElementId attribute.
  */
  const OdAnsiString& getControlElementId() const;

  /** \details
  Sets the value of ControlElementId attribute. 
  This attribute represents the identification assigned to this control element by the Building Automation System.
  \param ControlElementId [in] ControlElementId attribute to set.
  */
  void setControlElementId(const OdAnsiString& ControlElementId);

  /** \details
  Returns the value of AssignedToFlowElement attribute. 
  This attribute represents reference through the relationship object to related distribution flow elements.
  \param AssignedToFlowElement [out] Receives the value of AssignedToFlowElement attribute.
  */
  void getInvAssignedToFlowElement(OdDAIObjectIds& AssignedToFlowElement) const;


public:

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

  /** \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
  Early-bound version of instances comparison.
  \param pOther [in] Other application instance.
  \param ordering [out] Receives the ordering (comparison) status.
  \returns
  true if comparison was performed, false if method has no implementation, so late-bound version could be applied.
  \remarks
  If the method returns true,
  the ordering parameter can receive one of the following statuses:
  <table>
    Name             Value    Description
    _kLessThan_      -1       This object < Other Object.
    _kEqual_          0       This object = Other Object.
    _kGreaterThan_    1       This object > Other Object.
    _kNotOrderable_   2       This class is not orderable.
  </table>
  */
  virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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: 
  OdAnsiString m_ControlElementId;   // IfcIdentifier  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRelFlowControlElements;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCDISTRIBUTIONCONTROLELEMENT_AUTO_IMPL_H