/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCCOSTVALUE_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCCOSTVALUE_AUTO_IMPL_H

#include "Ifc2x_FinalBaseClass.h"

#include "Ifc2x_FinalEnum.h"
#include "Ifc2x_FinalSelectTypes.h"
#include "Ifc2x_FinalCollectionTypes.h"
#include "IfcMeasureWithUnitAutoImpl.h"
#include "IfcCalendarDateAutoImpl.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
  IfcCostValue represents an amount of money or a value.
  Each instance of IfcCostValue can have a category. 
  There are many possible types of cost value that can be identified. 
  While there is a broad understanding of the meaning of names that can be assigned to different types of costs, 
  there is no general standard for naming cost types nor are there any broadly defined classifications.
*/
class IFC2X_FINAL_EXPORT IfcCostValue : public OdIfc2x_FinalInstance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcCostValue);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of BaseCostValue attribute. 
  This attribute represents the amount of this cost before applying cost modifiers.
  \returns
  Returns the value of BaseCostValue attribute.
  */
  double getBaseCostValue() const;

  /** \details
  Sets the value of BaseCostValue attribute. 
  This attribute represents the amount of this cost before applying cost modifiers.
  \param BaseCostValue [in] Base cost value to set.
  */
  void setBaseCostValue(double BaseCostValue);

  /** \details
  Returns the value of FinalCostValue attribute. 
  This attribute represents the amount of this cost after applying cost modifiers.
  \returns
  Returns the value of FinalCostValue attribute.
  */
  double getFinalCostValue() const;

  /** \details
  Sets the value of FinalCostValue attribute. 
  This attribute represents the amount of this cost after applying cost modifiers.
  \param FinalCostValue [in] Final cost value to set.
  */
  void setFinalCostValue(double FinalCostValue);

  /** \details
  Returns the value of Currency attribute. 
  This attribute represents currency for this cost that can override the global currency setting for the project.
  \returns
  Returns the value of Currency attribute.
  */
  IfcCurrencyEnum getCurrency() const;

  /** \details
  Sets the value of Currency attribute. 
  This attribute represents currency for this cost that can override the global currency setting for the project.
  \param Currency [in] Currency to set.
  */
  void setCurrency(IfcCurrencyEnum Currency);

  /** \details
  Returns the value of UnitCostBasis attribute. 
  This attribute represents the number and unit of measure on which the unit cost is based.
  \returns
  Returns the value of UnitCostBasis attribute.
  */
  const OdDAIObjectId& getUnitCostBasis() const;

  /** \details
  Sets the value of UnitCostBasis attribute. 
  This attribute represents the number and unit of measure on which the unit cost is based.
  \param UnitCostBasis [in] Unit cost basis to set.
  */
  void setUnitCostBasis(const OdDAIObjectId& UnitCostBasis);

  /** \details
  Returns the value of CostType attribute. 
  This attribute represents specification of the cost type that is used.
  \returns
  Returns the value of CostType attribute.
  */
  const OdAnsiString& getCostType() const;

  /** \details
  Sets the value of CostType attribute. 
  This attribute represents specification of the cost type that is used.
  \param CostType [in] Cost type to set.
  */
  void setCostType(const OdAnsiString& CostType);

  /** \details
  Returns the value of CostDate attribute. 
  This attribute represents the date at which the cost is assessed. 
  For example, in an estimate it is the date at which the estimated cost value was made, 
  while for a report of actual costs, it is the cost that the actual costs are recorded.
  \returns
  Returns the value of CostDate attribute.
  */
  const OdDAIObjectId& getCostDate() const;

  /** \details
  Sets the value of CostDate attribute. 
  This attribute represents the date at which the cost is assessed. 
  For example, in an estimate it is the date at which the estimated cost value was made, 
  while for a report of actual costs, it is the cost that the actual costs are recorded.
  \param CostDate [in] Cost date to set.
  */
  void setCostDate(const OdDAIObjectId& CostDate);

  /** \details
  Sets the value of CostModifiers attribute. 
  This attribute represents the modifiers that can be applied to a cost to change its value.
  \param CostModifiers [out] Cost modifiers to get.
  */
  void getCostModifiers(OdDAIObjectIds& CostModifiers) const;

  /** \details
  Returns the value of CostModifiers attribute. 
  This attribute represents the modifiers that can be applied to a cost to change its value.
  \returns
  Returns the value of CostModifiers attribute.
  */
  OdDAI::ListOfOdDAIObjectId& costModifiers();

  /** \details
  Gets the value of ValueOfComponents attribute. 
  This attribute represents the aggregated value of the components within the cost value relationship expressed as a single cost value.
  \param ValueOfComponents [out] Receives the ValueOfComponents attribute.
  */
  void getInvValueOfComponents(OdDAIObjectIds& ValueOfComponents) const;

  /** \details
  Gets the value of IsComponentIn attribute. 
  This attribute represents the value of the single cost value 
  that is used by the cost value relationship to express a complex cost.
  \param IsComponentIn [out] Receives the IsComponentIn attribute.
  */
  void getInvIsComponentIn(OdDAIObjectIds& IsComponentIn) const;

  /** \details
  Gets the value of CostsReferenced attribute. 
  This attribute represents the IfcReferencesCostDocument relationship 
  that refers to a document from which the cost value is referenced.
  \param CostsReferenced [out] Receives the CostsReferenced attribute.
  */
  void getInvCostsReferenced(OdDAIObjectIds& CostsReferenced) const;


public:

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

  /** \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_BaseCostValue;   // IfcMonetaryMeasure  [optional]
  double m_FinalCostValue;   // IfcMonetaryMeasure  [optional]
  OdDAI::Enum m_Currency;   // IfcCurrencyEnum  [optional]
  OdDAIObjectId m_UnitCostBasis;   // IfcMeasureWithUnit  [optional]
  OdAnsiString m_CostType;   // IfcLabel  [optional]
  OdDAIObjectId m_CostDate;   // IfcCalendarDate  [optional]
  OdDAI::ListOfOdDAIObjectId m_CostModifiers; // LIST [1:?] of IfcCostModifier [optional]


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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCCOSTVALUE_AUTO_IMPL_H