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

#include "IfcNamedUnitAutoImpl.h"
#include "IfcMeasureWithUnitAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  An IfcConversionBasedUnit is used to define a unit that has a conversion rate to a base unit. 
  To identify some commonly used conversion based units, the standard designations 
  (case insensitive) for the Name attribute are indicated in the table below.
  <table>
  <b>Name</b>                   <b>Description</b>
  inch                          Indicates project directives issued by the actor.
  foot                          Indicates groups for which the actor is responsible.
  US survey foot                Indicates products for which the actor is responsible.
  yard                          Indicates processes for which the actor is responsible.
  mile                          Indicates resources for which the actor is responsible.
  square inch                   Area measure equal to 0.0006452 square meters
  square foot                   Area measure equal to 0.09290 square meters
  square yard                   Area measure equal to 0.83612736 square meters
  acre                          Area measure equal to 4046.86 square meters
  square mile                   Area measure equal to 2 588 881 square meters
  cubic inch                    Volume measure equal to 0.00001639 cubic meters
  cubic foot                    Volume measure equal to 0.02832 cubic meters
  cubic yard                    Volume measure equal to 0.7636 cubic meters
  litre                         Volume measure equal to 0.001 cubic meters
  fluid ounce UK                Volume measure equal to 0.0000284130625 cubic meters
  fluid ounce US                Volume measure equal to 0.00002957353 cubic meters
  pint UK                       Volume measure equal to 0.000568 cubic meters
  pint US                       Volume measure equal to 0.000473 cubic meters
  gallon UK                     Volume measure equal to 0.004546 cubic meters
  gallon US                     Volume measure equal to 0.003785 cubic meters
  degree                        Angle measure equal to π/180 rad
  ounce                         Mass measure equal to 28.35 g
  pound                         Mass measure equal to 0.454 kg
  ton UK                        Mass measure equal to 1016.0469088 kg, also known as long ton, gross ton, shipper's ton
  ton US                        Mass measure equal to 907.18474 kg, also known as short ton, net ton
  lbf                           Force measure equal to 4.4482216153 N, pound-force
  kip                           Force measure equal to 4448.2216153 N, kilopound-force
  psi                           Pressure measure equal to 6894.7572932 Pa, pound-force per square inch
  ksi                           Pressure measure equal to 6894757.2932 Pa, kilopound-force per square inch
  minute                        Time measure equal to 60 s
  hour                          Time measure equal to 3600 s
  day                           Time measure equal to 86400 s
  btu                           Energy measure equal to 1055.056 J, British Thermal Unit
  </table>
*/
class IFC4X3_RC1_EXPORT IfcConversionBasedUnit : public IfcNamedUnit
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcConversionBasedUnit);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Name attribute. 
  This attribute represents the word, or group of words, by which the conversion based unit is referred to.
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute. 
  This attribute represents the word, or group of words, by which the conversion based unit is referred to.
  \param Name [in] Name to set.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the value of ConversionFactor attribute. 
  This attribute represents the physical quantity from which the converted unit is derived.
  \returns
  Returns the value of ConversionFactor attribute.
  */
  const OdDAIObjectId& getConversionFactor() const;

  /** \details
  Sets the value of ConversionFactor attribute. 
  This attribute represents the physical quantity from which the converted unit is derived.
  \param ConversionFactor [in] Conversion factor to set.
  */
  void setConversionFactor(const OdDAIObjectId& ConversionFactor);

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


public:

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

  /** \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
  OdDAIObjectId m_ConversionFactor;   // IfcMeasureWithUnit

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCCONVERSIONBASEDUNIT_AUTO_IMPL_H