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

#include "IFC4X4BaseClass.h"

#include "IFC4X4Enum.h"
#include "IFC4X4SelectTypes.h"
#include "IFC4X4CollectionTypes.h"
#include "IfcMeasureWithUnitAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  This entity captures a value driven by a formula, 
  with additional qualifications including unit basis, valid date range, and categorization.
  
  The extent of the IfcAppliedValue is determined by the AppliedValue attribute 
  which can be defined either as an IfcMeasureWithUnit or as an IfcMonetaryMeasure 
  or as an IfcRatioMeasure via the IfcAppliedValueSelect type.
  
  Optionally, an IfcAppliedValue can have an applicable date. 
  This is intended to fix the date on which the value became relevant for use. 
  It can be the date on which the value was set in the model or it can be a prior or future date when the value becomes operable. 
  Similarly, an IfcAppliedValue can have a 'fixed until' date. 
  This is intended to fix the date on which the value ceases to be relevant for use.

  \changes
  
  * IFC4 changes: 
    * Type of the ApplicableDate attribute changed from "IfcDateTimeSelect" to "IfcDate"
    * Type of the FixedUntilDate attribute changed from "IfcDateTimeSelect" to "IfcDate"
    * Inverse attribute ValuesReferenced renamed to HasExternalReference
    * Type of the inverse attribute ValuesReferenced changed from "SET OF [0:?] IfcReferencesValueDocument FOR ReferencingValues" to "SET OF [0:?] IfcExternalReferenceRelationship FOR RelatedResourceObjects"
*/
class IFC4X4_EXPORT IfcAppliedValue : public OdIFC4X4Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcAppliedValue);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Name attribute. 
  This attribute represents a name or additional clarification given to a cost value.
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute. 
  This attribute represents a name or additional clarification given to a cost value.
  \param Name [in] Name to set.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the value of Description attribute. 
  This attribute represents the description that can apply additional information about a cost value.
  \returns
  Returns the value of Description attribute.
  */
  const OdAnsiString& getDescription() const;

  /** \details
  Sets the value of Description attribute. 
  This attribute represents the description that can apply additional information about a cost value.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of AppliedValue attribute. 
  This attribute represents the extent (or quantity, or amount) of an applied value.
  \returns
  Returns the value of AppliedValue attribute.
  */
  IfcAppliedValueSelect appliedValue();

  /** \details
  Returns the value of UnitBasis attribute. 
  This attribute represents the number and unit of measure on which the unit cost is based.
  \returns
  Returns the value of UnitBasis attribute.
  \remarks
  As well as the normally expected units of measure such as length, area, volume etc., 
  costs can be based on units of measure which need to be defined e.g. sack, drum, pallet, item etc. 
  Unit costs can be based on quantities greater (or lesser) than a unitary value of the basis measure.
  */
  const OdDAIObjectId& getUnitBasis() const;

  /** \details
  Sets the value of UnitBasis attribute. 
  This attribute represents the number and unit of measure on which the unit cost is based.
  \param UnitBasis [in] Unit basis to set.
  \remarks
  As well as the normally expected units of measure such as length, area, volume etc., 
  costs can be based on units of measure which need to be defined e.g. sack, drum, pallet, item etc. 
  Unit costs can be based on quantities greater (or lesser) than a unitary value of the basis measure.
  */
  void setUnitBasis(const OdDAIObjectId& UnitBasis);

  /** \details
  Returns the value of ApplicableDate attribute. 
  This attribute represents the date on or from which an applied value is applicable.
  \returns
  Returns the value of ApplicableDate attribute.
  */
  const OdAnsiString& getApplicableDate() const;

  /** \details
  Sets the value of ApplicableDate attribute. 
  This attribute represents the date on or from which an applied value is applicable.
  \param ApplicableDate [in] Applicable date to set.
  */
  void setApplicableDate(const OdAnsiString& ApplicableDate);

  /** \details
  Returns the value of FixedUntilDate attribute. 
  This attribute represents the date until which applied value is applicable.
  \returns
  Returns the value of FixedUntilDate attribute.
  */
  const OdAnsiString& getFixedUntilDate() const;

  /** \details
  Sets the value of FixedUntilDate attribute. 
  This attribute represents the date until which applied value is applicable.
  \param FixedUntilDate [in] Fixed until date to set.
  */
  void setFixedUntilDate(const OdAnsiString& FixedUntilDate);

  /** \details
  Returns the value of Category attribute. 
  This attribute represents specification of the type of cost used.
  \returns
  Returns the value of Category attribute.
  */
  const OdAnsiString& getCategory() const;

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

  /** \details
  Returns the value of Condition attribute. 
  This attribute represents the condition under which a cost value applies.
  For example, within the context of a bid submission, this can refer to an option that may or may not be elected.
  \returns
  Returns the value of Condition attribute.
  */
  const OdAnsiString& getCondition() const;

  /** \details
  Sets the value of Condition attribute. 
  This attribute represents the condition under which a cost value applies.
  For example, within the context of a bid submission, this can refer to an option that may or may not be elected.
  \param Condition [in] Condition to set.
  */
  void setCondition(const OdAnsiString& Condition);

  /** \details
  Returns the value of ArithmeticOperator attribute. 
  This attribute represents the arithmetic operator applied to component values.
  \returns
  Returns the value of ArithmeticOperator attribute.
  */
  IfcArithmeticOperatorEnum getArithmeticOperator() const;

  /** \details
  Sets the value of ArithmeticOperator attribute. 
  This attribute represents the arithmetic operator applied to component values.
  \param ArithmeticOperator [in] Arithmetic operator to set.
  */
  void setArithmeticOperator(IfcArithmeticOperatorEnum ArithmeticOperator);

  /** \details
  Gets the value of Components attribute. 
  This attribute represents optional component values from which AppliedValue is calculated.
  \param Components [out] Receives the components.
  */
  void getComponents(OdDAIObjectIds& Components) const;

  /** \details
  Returns the value of Components attribute. 
  This attribute represents optional component values from which AppliedValue is calculated.
  \returns
  Returns the value of Components attribute.
  */
  OdDAI::ListOfOdDAIObjectId& components();

  /** \details
  Returns the value of HasExternalReference attribute. 
  This attribute represents reference to an external reference, e.g. library, 
  classification, or document information, that is associated to the IfcAppliedValue.
  \param HasExternalReference [out] Receives the value of HasExternalReference attribute.
  */
  void getInvHasExternalReference(OdDAIObjectIds& HasExternalReference) const;


public:

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

  /** \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_Name;   // IfcLabel  [optional]
  OdAnsiString m_Description;   // IfcText  [optional]
  OdDAI::Select m_AppliedValue;   // IfcAppliedValueSelect  [optional]
  OdDAIObjectId m_UnitBasis;   // IfcMeasureWithUnit  [optional]
  OdAnsiString m_ApplicableDate;   // IfcDate  [optional]
  OdAnsiString m_FixedUntilDate;   // IfcDate  [optional]
  OdAnsiString m_Category;   // IfcLabel  [optional]
  OdAnsiString m_Condition;   // IfcLabel  [optional]
  OdDAI::Enum m_ArithmeticOperator;   // IfcArithmeticOperatorEnum  [optional]
  OdDAI::ListOfOdDAIObjectId m_Components; // LIST [1:?] of IfcAppliedValue [optional]


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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X4_IFCAPPLIEDVALUE_AUTO_IMPL_H