/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCRELUSESRESOURCE_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCRELUSESRESOURCE_AUTO_IMPL_H

#include "IfcRelAssignsToResourceAutoImpl.h"
#include "IfcMeasureWithUnitAutoImpl.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
  The IfcRelUsesResource represents the use of a construction resource in a process. 
  It specifies the duration, the costs, the quantity, and the waste factor of the resource used in the process. 
  It also specifies a value of the process productivity conversion rate to calculate the resource use costs.
*/
class IFC2X_FINAL_EXPORT IfcRelUsesResource : public IfcRelAssignsToResource
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcRelUsesResource);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Duration attribute. 
  This attribute represents the time duration of the resource that is used by the process.
  \returns
  Returns the value of Duration attribute.
  */
  double getDuration() const;

  /** \details
  Sets the value of Duration attribute. 
  This attribute represents the time duration of the resource that is used by the process.
  \param Duration [in] Duration attribute to set.
  */
  void setDuration(double Duration);

  /** \details
  Returns the value of Quantity attribute. 
  This attribute represents the total quantity of resource used by the process.
  \returns
  Returns the value of Quantity attribute.
  */
  const OdDAIObjectId& getQuantity() const;

  /** \details
  Sets the value of Quantity attribute. 
  This attribute represents the total quantity of resource used by the process.
  \param Quantity [in] Quantity attribute to set.
  */
  void setQuantity(const OdDAIObjectId& Quantity);

  /** \details
  Returns the value of ProductivityConversionRate attribute. 
  This attribute represents the productivity conversion rate.
  \returns
  Returns the value of ProductivityConversionRate attribute.
  */
  const OdDAIObjectId& getProductivityConversionRate() const;

  /** \details
  Sets the value of ProductivityConversionRate attribute. 
  This attribute represents the productivity conversion rate.
  \param ProductivityConversionRate [in] ProductivityConversionRate attribute to set.
  */
  void setProductivityConversionRate(const OdDAIObjectId& ProductivityConversionRate);

  /** \details
  Returns the value of ConverterMultiplierOrDivider attribute. 
  This attribute indicates whether the productivity conversion rate serves as multiplier or divider.
  \returns
  Returns the value of ConverterMultiplierOrDivider attribute.
  */
  IfcMultiplierOrDivider getConverterMultiplierOrDivider() const;

  /** \details
  Sets the value of ConverterMultiplierOrDivider attribute. 
  This attribute indicates whether the productivity conversion rate serves as multiplier or divider.
  \param ConverterMultiplierOrDivider [in] ConverterMultiplierOrDivider attribute to set.
  */
  void setConverterMultiplierOrDivider(IfcMultiplierOrDivider ConverterMultiplierOrDivider);

  /** \details
  Gets the value of ResourceUseCosts attribute. 
  This attribute represents the costs of the use of the resource in a process.
  \param ResourceUseCosts [out] Receives the ResourceUseCosts attribute.
  */
  void getResourceUseCosts(OdDAIObjectIds& ResourceUseCosts) const;

  /** \details
  Returns the value of ResourceUseCosts attribute. 
  This attribute represents the costs of the use of the resource in a process.
  \returns
  Returns the value of ResourceUseCosts attribute.
  */
  OdDAI::SetOfOdDAIObjectId& resourceUseCosts();

  /** \details
  Returns the value of WasteFactor attribute. 
  This attribute represents the waste factor in percentage of the resource when used in the process.
  \returns
  Returns the value of WasteFactor attribute.
  */
  double getWasteFactor() const;

  /** \details
  Sets the value of WasteFactor attribute. 
  This attribute represents the waste factor in percentage of the resource when used in the process.
  \param WasteFactor [in] WasteFactor attribute to set.
  */
  void setWasteFactor(double WasteFactor);


public:

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

  /** \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: 
  double m_Duration;   // IfcTimeMeasure  [optional]
  OdDAIObjectId m_Quantity;   // IfcMeasureWithUnit  [optional]
  OdDAIObjectId m_ProductivityConversionRate;   // IfcMeasureWithUnit  [optional]
  OdDAI::Enum m_ConverterMultiplierOrDivider;   // IfcMultiplierOrDivider  [optional]
  OdDAI::SetOfOdDAIObjectId m_ResourceUseCosts; // SET [1:?] of IfcCostValue [optional]

  double m_WasteFactor;   // REAL  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCRELUSESRESOURCE_AUTO_IMPL_H