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

#include "IfcPropertySetDefinitionAutoImpl.h"
#include "IfcTimeSeriesAutoImpl.h"
#include "IfcMaterialAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  Common definition to capture the basic flow properties of a fluid typically used within a flow distribution system.
  IfcFluidFlowProperties is a statically defined property set and should be attached to the instance(s) 
  of the IfcDistributionPort through the IfcRelDefinesByProperties relationship. 
  Instances of the IfcFluidFlowProperties can be shared when two ports are joined together via the IfcRelConnectsPorts relationship.
*/
class IFC2X2_FINAL_EXPORT IfcFluidFlowProperties : public IfcPropertySetDefinition
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcFluidFlowProperties);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PropertySource attribute. 
  This attribute represents the source of the fluid flow properties (e.g., are these design values, measured values, etc.).
  \returns
  Returns the value of PropertySource attribute.
  */
  IfcPropertySourceEnum getPropertySource() const;

  /** \details
  Sets the value of PropertySource attribute. 
  This attribute represents the source of the fluid flow properties (e.g., are these design values, measured values, etc.).
  \param PropertySource [in] PropertySource attribute to set.
  */
  void setPropertySource(IfcPropertySourceEnum PropertySource);

  /** \details
  Returns the value of FlowConditionTimeSeries attribute. 
  This attribute represents time series that define the flow condition as a percentage of the cross-sectional area.
  \returns
  Returns the value of FlowConditionTimeSeries attribute.
  */
  const OdDAIObjectId& getFlowConditionTimeSeries() const;

  /** \details
  Sets the value of FlowConditionTimeSeries attribute. 
  This attribute represents time series that define the flow condition as a percentage of the cross-sectional area.
  \param FlowConditionTimeSeries [in] FlowConditionTimeSeries attribute to set.
  */
  void setFlowConditionTimeSeries(const OdDAIObjectId& FlowConditionTimeSeries);

  /** \details
  Returns the value of VelocityTimeSeries attribute. 
  This attribute represents time series of velocity values of the fluid.
  \returns
  Returns the value of VelocityTimeSeries attribute.
  */
  const OdDAIObjectId& getVelocityTimeSeries() const;

  /** \details
  Sets the value of VelocityTimeSeries attribute. 
  This attribute represents time series of velocity values of the fluid.
  \param VelocityTimeSeries [in] VelocityTimeSeries attribute to set.
  */
  void setVelocityTimeSeries(const OdDAIObjectId& VelocityTimeSeries);

  /** \details
  Returns the value of FlowrateTimeSeries attribute. 
  This attribute represents time series of flow rate values. 
  Note that either volumetric or mass flow rate values should be specified.
  \returns
  Returns the value of FlowrateTimeSeries attribute.
  */
  const OdDAIObjectId& getFlowrateTimeSeries() const;

  /** \details
  Sets the value of FlowrateTimeSeries attribute. 
  This attribute represents time series of flow rate values. 
  Note that either volumetric or mass flow rate values should be specified.
  \param FlowrateTimeSeries [in] FlowrateTimeSeries attribute to set.
  */
  void setFlowrateTimeSeries(const OdDAIObjectId& FlowrateTimeSeries);
  const OdDAIObjectId& getFluid() const;
  void setFluid(const OdDAIObjectId& Fluid);

  /** \details
  Returns the value of PressureTimeSeries attribute. 
  This attribute represents the time series of pressure values of the fluid.
  \returns
  Returns the value of PressureTimeSeries attribute.
  */
  const OdDAIObjectId& getPressureTimeSeries() const;

  /** \details
  Sets the value of PressureTimeSeries attribute. 
  This attribute represents the time series of pressure values of the fluid.
  \param PressureTimeSeries [in] PressureTimeSeries attribute to set.
  */
  void setPressureTimeSeries(const OdDAIObjectId& PressureTimeSeries);

  /** \details
  Returns the value of UserDefinedPropertySource attribute. 
  This attribute is required if the PropertySource is USERDEFINED.
  \returns
  Returns the value of UserDefinedPropertySource attribute.
  */
  const OdAnsiString& getUserDefinedPropertySource() const;

  /** \details
  Sets the value of UserDefinedPropertySource attribute. 
  This attribute is required if the PropertySource is USERDEFINED.
  \param UserDefinedPropertySource [in] UserDefinedPropertySource attribute to set.
  */
  void setUserDefinedPropertySource(const OdAnsiString& UserDefinedPropertySource);

  /** \details
  Returns the value of TemperatureSingleValue attribute. 
  This attribute represents the temperature of the fluid. 
  For air this value represents the dry bulb temperature.
  \returns
  Returns the value of TemperatureSingleValue attribute.
  */
  double getTemperatureSingleValue() const;

  /** \details
  Sets the value of TemperatureSingleValue attribute. 
  This attribute represents the temperature of the fluid. 
  For air this value represents the dry bulb temperature.
  \param TemperatureSingleValue [in] TemperatureSingleValue attribute to set.
  */
  void setTemperatureSingleValue(double TemperatureSingleValue);

  /** \details
  Returns the value of WetBulbTemperatureSingleValue attribute. 
  This attribute represents the wet bulb temperature of the fluid; only applicable if the fluid is air.
  \returns
  Returns the value of WetBulbTemperatureSingleValue attribute.
  */
  double getWetBulbTemperatureSingleValue() const;

  /** \details
  Sets the value of WetBulbTemperatureSingleValue attribute. 
  This attribute represents the wet bulb temperature of the fluid; only applicable if the fluid is air.
  \param WetBulbTemperatureSingleValue [in] WetBulbTemperatureSingleValue attribute to set.
  */
  void setWetBulbTemperatureSingleValue(double WetBulbTemperatureSingleValue);

  /** \details
  Returns the value of WetBulbTemperatureTimeSeries attribute. 
  This attribute represents time series of fluid wet bulb temperature values. 
  These values are only applicable if the fluid is air.
  \returns
  Returns the value of WetBulbTemperatureTimeSeries attribute.
  */
  const OdDAIObjectId& getWetBulbTemperatureTimeSeries() const;

  /** \details
  Sets the value of WetBulbTemperatureTimeSeries attribute. 
  This attribute represents time series of fluid wet bulb temperature values. 
  These values are only applicable if the fluid is air.
  \param WetBulbTemperatureTimeSeries [in] WetBulbTemperatureTimeSeries attribute to set.
  */
  void setWetBulbTemperatureTimeSeries(const OdDAIObjectId& WetBulbTemperatureTimeSeries);

  /** \details
  Returns the value of TemperatureTimeSeries attribute. 
  This attribute represents the time series of fluid temperature values. 
  For air, these values represent the dry bulb temperature.
  \returns
  Returns the value of TemperatureTimeSeries attribute.
  */
  const OdDAIObjectId& getTemperatureTimeSeries() const;

  /** \details
  Sets the value of TemperatureTimeSeries attribute. 
  This attribute represents the time series of fluid temperature values. 
  For air, these values represent the dry bulb temperature.
  \param TemperatureTimeSeries [in] TemperatureTimeSeries attribute to set.
  */
  void setTemperatureTimeSeries(const OdDAIObjectId& TemperatureTimeSeries);

  /** \details
  Returns the value of FlowrateSingleValue attribute. 
  This attribute represents the flow rate of the fluid. Either a mass or volumetric flow rate is defined.
  \returns
  Returns the value of FlowrateSingleValue attribute.
  */
  IfcDerivedMeasureValue flowrateSingleValue();

  /** \details
  Returns the value of FlowConditionSingleValue attribute. 
  This attribute represents the flow condition as a percentage of the cross-sectional area.
  \returns
  Returns the value of FlowConditionSingleValue attribute.
  */
  double getFlowConditionSingleValue() const;

  /** \details
  Sets the value of FlowConditionSingleValue attribute. 
  This attribute represents the flow condition as a percentage of the cross-sectional area.
  \param FlowConditionSingleValue [in] FlowConditionSingleValue attribute to set.
  */
  void setFlowConditionSingleValue(double FlowConditionSingleValue);

  /** \details
  Returns the value of VelocitySingleValue attribute. 
  This attribute represents the velocity of the fluid.
  \returns
  Returns the value of VelocitySingleValue attribute.
  */
  double getVelocitySingleValue() const;

  /** \details
  Sets the value of VelocitySingleValue attribute. 
  This attribute represents the velocity of the fluid.
  \param VelocitySingleValue [in] VelocitySingleValue attribute to set.
  */
  void setVelocitySingleValue(double VelocitySingleValue);

  /** \details
  Returns the value of PressureSingleValue attribute. 
  This attribute represents the pressure of the fluid.
  \returns
  Returns the value of PressureSingleValue attribute.
  */
  double getPressureSingleValue() const;

  /** \details
  Sets the value of PressureSingleValue attribute. 
  This attribute represents the pressure of the fluid.
  \param PressureSingleValue [in] PressureSingleValue attribute to set.
  */
  void setPressureSingleValue(double PressureSingleValue);


public:

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

  /** \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: 
  OdDAI::Enum m_PropertySource;   // IfcPropertySourceEnum
  OdDAIObjectId m_FlowConditionTimeSeries;   // IfcTimeSeries  [optional]
  OdDAIObjectId m_VelocityTimeSeries;   // IfcTimeSeries  [optional]
  OdDAIObjectId m_FlowrateTimeSeries;   // IfcTimeSeries  [optional]
  OdDAIObjectId m_Fluid;   // IfcMaterial
  OdDAIObjectId m_PressureTimeSeries;   // IfcTimeSeries  [optional]
  OdAnsiString m_UserDefinedPropertySource;   // IfcLabel  [optional]
  double m_TemperatureSingleValue;   // IfcThermodynamicTemperatureMeasure  [optional]
  double m_WetBulbTemperatureSingleValue;   // IfcThermodynamicTemperatureMeasure  [optional]
  OdDAIObjectId m_WetBulbTemperatureTimeSeries;   // IfcTimeSeries  [optional]
  OdDAIObjectId m_TemperatureTimeSeries;   // IfcTimeSeries  [optional]
  OdDAI::Select m_FlowrateSingleValue;   // IfcDerivedMeasureValue  [optional]
  IfcPositiveRatioMeasure m_FlowConditionSingleValue;   // IfcPositiveRatioMeasure  [optional]
  double m_VelocitySingleValue;   // IfcLinearVelocityMeasure  [optional]
  double m_PressureSingleValue;   // IfcPressureMeasure  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X2_FINAL_IFCFLUIDFLOWPROPERTIES_AUTO_IMPL_H