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

#include "IfcSimplePropertyAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The property with a single value IfcPropertySingleValue defines a property object 
  which has a single (numeric or descriptive) value assigned. 
  It defines a property - single value combination for which the property Name, 
  an optional Description, and an optional NominalValue with measure type is provided. 
  In addition, the default unit as specified within the project unit context 
  can be overridden by assigning an Unit.
  
    * If the Unit attribute is not specified, than the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. 
      The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext).
    * If the Unit attribute is specified, the unit assigned by the Unit attribute overrides the globally assigned unit.

  \changes
  
  * IFC2X_FINAL changes: 
    Entity has been renamed from IfcSimpleProperty.
  * IFC2X3 changes: 
    Attribute NominalValue has been made OPTIONAL with upward compatibility for file based exchange.
*/
class IFC2X3_EXPORT IfcPropertySingleValue : public IfcSimpleProperty
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcPropertySingleValue);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of NominalValue attribute. NominalValue is value and measure type of this property.
  \returns
  Returns the value of NominalValue attribute.
  \remarks
  By virtue of the defined data type that is selected from the SELECT IfcValue, 
  the appropriate unit can be found within the IfcUnitAssignment, 
  defined for the project if no value for the unit attribute is given.
  */
  IfcValue nominalValue();

  /** \details
  Returns the value of Unit attribute that represents the unit for the nominal value. If not specified, 
  the default value for the measure type is used as defined by the global unit assignment at IfcProject.
  \returns
  Returns the value of Unit attribute.
  */
  IfcUnit unit();


public:

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

  /** \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: 
  OdDAI::Select m_NominalValue;   // IfcValue  [optional]
  OdDAI::Select m_Unit;   // IfcUnit  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCPROPERTYSINGLEVALUE_AUTO_IMPL_H