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

#include "IfcQuantitySetAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  An IfcElementQuantity defines a set of derived measures of an element's physical property. 
  Elements could be spatial structure elements (like buildings, storeys, or spaces) or building elements (like walls, slabs, finishes). 
  The IfcElementQuantity gets assigned to the element by using the IfcRelDefinesByProperties relationship.
  
  The IfcElementQuantity can have the following subtypes of IfcPhysicalQuantity within its SET of Quantities, which count for the basis measure types used:
  * Count measure
  * Weight measure
  * Length measure
  * Area measure
  * Volume measure
  * Time measure
  
  Base quantities are quantity definitions that are independent of a particular method of measurement and therefore internationally applicable. 
  Base quantities are defined as gross and net values and provided by measurement of the correct geometric shape representation of the element. 
  This specification includes a set of base quantity definition. See each subtype of IfcElement for applicable base quantities.

  \changes
  
  * IFC4 changes: 
    Subtyped from new intermediate IfcQuantitySet supertype.
*/
class IFC4_EXPORT IfcElementQuantity : public IfcQuantitySet
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcElementQuantity);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of MethodOfMeasurement attribute. 
  This attribute represents name of the method of measurement used to calculate the element quantity. 
  The method of measurement attribute has to be made recognizable by further agreements.
  \returns
  Returns the value of MethodOfMeasurement attribute.
  \remarks
  IFC2x2 Addendum 1 change: The attribute has been changed to be optional.
  */
  const OdAnsiString& getMethodOfMeasurement() const;

  /** \details
  Sets the value of MethodOfMeasurement attribute. 
  This attribute represents name of the method of measurement used to calculate the element quantity. 
  The method of measurement attribute has to be made recognizable by further agreements.
  \param MethodOfMeasurement [in] Method of measurement to set.
  \remarks
  IFC2x2 Addendum 1 change: The attribute has been changed to be optional.
  */
  void setMethodOfMeasurement(const OdAnsiString& MethodOfMeasurement);

  /** \details
  Returns the value of Quantities attribute. 
  This attribute represents the individual quantities for the element, 
  can be a set of length, area, volume, weight or count based quantities.
  \param Quantities [out] Receives the Quantities attribute.
  */
  void getQuantities(OdDAIObjectIds& Quantities) const;

  /** \details
  Returns the value of Quantities attribute. 
  This attribute represents the individual quantities for the element, 
  can be a set of length, area, volume, weight or count based quantities.
  \returns
  Returns the value of Quantities attribute.
  */
  OdDAI::SetOfOdDAIObjectId& quantities();


public:

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

  /** \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_MethodOfMeasurement;   // IfcLabel  [optional]
  OdDAI::SetOfOdDAIObjectId m_Quantities; // SET [1:?] of IfcPhysicalQuantity
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCELEMENTQUANTITY_AUTO_IMPL_H