/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCWATERPROPERTIES_AUTO_IMPL_H
#define _IFC2X3_IFCWATERPROPERTIES_AUTO_IMPL_H

#include "IfcMaterialPropertiesAutoImpl.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
  This is a common definition that captures properties of water typically used within the context of building services and flow distribution systems.
*/
class IFC2X3_EXPORT IfcWaterProperties : public IfcMaterialProperties
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcWaterProperties);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of IsPotable attribute. 
  This attribute indicates whether the water is considered potable.
  \returns
  Returns the value of IsPotable attribute.
  */
  OdDAI::Boolean getIsPotable() const;

  /** \details
  Sets the value of IsPotable attribute. 
  This attribute indicates whether the water is considered potable.
  \param IsPotable [in] IsPotable attribute to set.
  */
  void setIsPotable(OdDAI::Boolean IsPotable);

  /** \details
  Returns the value of Hardness attribute. 
  This attribute represents the water hardness as positive, multivalent ion concentration 
  in the water (usually concentrations of calcium and magnesium ions in terms of calcium carbonate).
  \returns
  Returns the value of Hardness attribute.
  */
  double getHardness() const;

  /** \details
  Sets the value of Hardness attribute. 
  This attribute represents the water hardness as positive, multivalent ion concentration 
  in the water (usually concentrations of calcium and magnesium ions in terms of calcium carbonate).
  \param Hardness [in] Hardness attribute to set.
  */
  void setHardness(double Hardness);

  /** \details
  Returns the value of AlkalinityConcentration attribute. 
  This attribute represents the maximum alkalinity concentration 
  (maximum sum of concentrations of each of the negative ions substances measured as CaCO3).
  \returns
  Returns the value of AlkalinityConcentration attribute.
  */
  double getAlkalinityConcentration() const;

  /** \details
  Sets the value of AlkalinityConcentration attribute. 
  This attribute represents the maximum alkalinity concentration 
  (maximum sum of concentrations of each of the negative ions substances measured as CaCO3).
  \param AlkalinityConcentration [in] AlkalinityConcentration attribute to set.
  */
  void setAlkalinityConcentration(double AlkalinityConcentration);

  /** \details
  Returns the value of AcidityConcentration attribute. 
  This attribute represents the maximum CaCO3 equivalent that would neutralize the acid.
  \returns
  Returns the value of AcidityConcentration attribute.
  */
  double getAcidityConcentration() const;

  /** \details
  Sets the value of AcidityConcentration attribute. 
  This attribute represents the maximum CaCO3 equivalent that would neutralize the acid.
  \param AcidityConcentration [in] AcidityConcentration attribute to set.
  */
  void setAcidityConcentration(double AcidityConcentration);

  /** \details
  Returns the value of ImpuritiesContent attribute. 
  This attribute represents the fraction of impurities such as dust to the total amount of water. 
  This is measured in weight of impurities per weight of water and is therefore unitless.
  \returns
  Returns the value of ImpuritiesContent attribute.
  */
  double getImpuritiesContent() const;

  /** \details
  Sets the value of ImpuritiesContent attribute. 
  This attribute represents the fraction of impurities such as dust to the total amount of water. 
  This is measured in weight of impurities per weight of water and is therefore unitless.
  \param ImpuritiesContent [in] ImpuritiesContent attribute to set.
  */
  void setImpuritiesContent(double ImpuritiesContent);

  /** \details
  Returns the value of PHLevel attribute. 
  This attribute represents the maximum water PH in a range from 0-14.
  \returns
  Returns the value of PHLevel attribute.
  */
  double getPHLevel() const;

  /** \details
  Sets the value of PHLevel attribute. 
  This attribute represents the maximum water PH in a range from 0-14.
  \param PHLevel [in] PHLevel attribute to set.
  */
  void setPHLevel(double PHLevel);

  /** \details
  Returns the value of DissolvedSolidsContent attribute. 
  This attribute represents the fraction of the dissolved solids to the total amount of water. 
  It is measured in weight of dissolved solids per weight of water and is therefore unitless.
  \returns
  Returns the value of DissolvedSolidsContent attribute.
  */
  double getDissolvedSolidsContent() const;

  /** \details
  Sets the value of DissolvedSolidsContent attribute. 
  This attribute represents the fraction of the dissolved solids to the total amount of water. 
  It is measured in weight of dissolved solids per weight of water and is therefore unitless.
  \param DissolvedSolidsContent [in] DissolvedSolidsContent attribute to set.
  */
  void setDissolvedSolidsContent(double DissolvedSolidsContent);


public:

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

  /** \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::Boolean m_IsPotable;   // BOOLEAN  [optional]
  double m_Hardness;   // IfcIonConcentrationMeasure  [optional]
  double m_AlkalinityConcentration;   // IfcIonConcentrationMeasure  [optional]
  double m_AcidityConcentration;   // IfcIonConcentrationMeasure  [optional]
  IfcNormalisedRatioMeasure m_ImpuritiesContent;   // IfcNormalisedRatioMeasure  [optional]
  double m_PHLevel;   // IfcPHMeasure  [optional]
  IfcNormalisedRatioMeasure m_DissolvedSolidsContent;   // IfcNormalisedRatioMeasure  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCWATERPROPERTIES_AUTO_IMPL_H