/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCCOSTQUANTITY_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCCOSTQUANTITY_AUTO_IMPL_H

#include "Ifc2x_FinalBaseClass.h"

#include "Ifc2x_FinalEnum.h"
#include "Ifc2x_FinalSelectTypes.h"
#include "Ifc2x_FinalCollectionTypes.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
  An IfcCostQuantity contains quantities that can be applied to a cost.
*/
class IFC2X_FINAL_EXPORT IfcCostQuantity : public OdIfc2x_FinalInstance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcCostQuantity);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of BaseQuantity attribute. 
  This attribute represents the "as measured" quantity resulting from a quantity takeoff or similar operation.
  \returns
  Returns the value of BaseQuantity attribute.
  */
  const OdDAIObjectId& getBaseQuantity() const;

  /** \details
  Sets the value of BaseQuantity attribute. 
  This attribute represents the "as measured" quantity resulting from a quantity takeoff or similar operation.
  \param BaseQuantity [in] BaseQuantity attribute to set.
  */
  void setBaseQuantity(const OdDAIObjectId& BaseQuantity);

  /** \details
  Returns the value of FinalQuantity attribute. 
  This attribute represents a value used for the actual price calculations 
  and the only quantity used if no modifications are used.
  \returns
  Returns the value of FinalQuantity attribute.
  */
  const OdDAIObjectId& getFinalQuantity() const;

  /** \details
  Sets the value of FinalQuantity attribute. 
  This attribute represents a value used for the actual price calculations 
  and the only quantity used if no modifications are used.
  \param FinalQuantity [in] FinalQuantity attribute to set.
  */
  void setFinalQuantity(const OdDAIObjectId& FinalQuantity);

  /** \details
  Returns the value of WasteFactor attribute. 
  This attribute represents a quantity to be added to base quantities to account for wasteage.
  \returns
  Returns the value of WasteFactor attribute.
  */
  double getWasteFactor() const;

  /** \details
  Sets the value of WasteFactor attribute. 
  This attribute represents a quantity to be added to base quantities to account for wasteage.
  \param WasteFactor [in] WasteFactor attribute to set.
  */
  void setWasteFactor(double WasteFactor);

  /** \details
  Returns the value of RoundOffIncrement attribute. 
  This attribute represents a number indicating the size of units that quantities should be rounded off to, 
  particularly in the case of materials that must be ordered in specific size lots.
  \returns
  Returns the value of RoundOffIncrement attribute.
  */
  double getRoundOffIncrement() const;

  /** \details
  Sets the value of RoundOffIncrement attribute. 
  This attribute represents a number indicating the size of units that quantities should be rounded off to, 
  particularly in the case of materials that must be ordered in specific size lots.
  \param RoundOffIncrement [in] RoundOffIncrement attribute to set.
  */
  void setRoundOffIncrement(double RoundOffIncrement);

  /** \details
  Returns the value of RoundOffBasis attribute. 
  This attribute represents the basis on which quantities are 'rounded off' i.e. the nearest unit for quantification purposes that can be used. 
  For instance, a numerical quantity can be determined to be 4.886 but should be rounded up 
  with an increment of 0.1 meters or 1 decimal place. In this case, a value of 4.9 would be applied.
  \returns
  Returns the value of RoundOffBasis attribute.
  */
  IfcQuantityRoundOffBasisEnum getRoundOffBasis() const;

  /** \details
  Sets the value of RoundOffBasis attribute. 
  This attribute represents the basis on which quantities are 'rounded off' i.e. the nearest unit for quantification purposes that can be used. 
  For instance, a numerical quantity can be determined to be 4.886 but should be rounded up 
  with an increment of 0.1 meters or 1 decimal place. In this case, a value of 4.9 would be applied.
  \param RoundOffBasis [in] RoundOffBasis attribute to set.
  */
  void setRoundOffBasis(IfcQuantityRoundOffBasisEnum RoundOffBasis);


public:

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

  /** \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: 
  OdDAIObjectId m_BaseQuantity;   // IfcMeasureWithUnit  [optional]
  OdDAIObjectId m_FinalQuantity;   // IfcMeasureWithUnit  [optional]
  IfcPositiveRatioMeasure m_WasteFactor;   // IfcPositiveRatioMeasure  [optional]
  double m_RoundOffIncrement;   // IfcReal
  OdDAI::Enum m_RoundOffBasis;   // IfcQuantityRoundOffBasisEnum
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCCOSTQUANTITY_AUTO_IMPL_H