/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCSPACETHERMALLOADPROPERTIES_AUTO_IMPL_H
#define _IFC2X3_IFCSPACETHERMALLOADPROPERTIES_AUTO_IMPL_H

#include "IfcPropertySetDefinitionAutoImpl.h"
#include "IfcTimeSeriesAutoImpl.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 space thermal load IfcSpaceThermalLoadProperties defines all thermal losses and gains occurring within a space or zone. 
  Those losses or gains can either be requirements (desired values) or criteria (actual values). 
  The thermal load source attribute defines an enumeration of possible sources of the thermal load. 
  The maximum, minimum, time series and applicable value ratio values are all interpreted according to the source. 
  The maximum and minimum values should not be used if time series values are provided.
*/
class IFC2X3_EXPORT IfcSpaceThermalLoadProperties : public IfcPropertySetDefinition
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcSpaceThermalLoadProperties);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ApplicableValueRatio attribute. 
  This attribute represents the percentage of use requirement or criteria applicable to the space.
  \returns
  Returns the value of ApplicableValueRatio attribute.
  */
  double getApplicableValueRatio() const;

  /** \details
  Sets the value of ApplicableValueRatio attribute. 
  This attribute represents the percentage of use requirement or criteria applicable to the space.
  \param ApplicableValueRatio [in] ApplicableValueRatio attribute to set.
  */
  void setApplicableValueRatio(double ApplicableValueRatio);

  /** \details
  Returns the value of ThermalLoadSource attribute. 
  This attribute represents the source of the thermal loss or gain.
  \returns
  Returns the value of ThermalLoadSource attribute.
  */
  IfcThermalLoadSourceEnum getThermalLoadSource() const;

  /** \details
  Sets the value of ThermalLoadSource attribute. 
  This attribute represents the source of the thermal loss or gain.
  \param ThermalLoadSource [in] ThermalLoadSource attribute to set.
  */
  void setThermalLoadSource(IfcThermalLoadSourceEnum ThermalLoadSource);

  /** \details
  Returns the value of PropertySource attribute. 
  This attribute represents the source of the space thermal load 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 space thermal load 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 SourceDescription attribute. 
  This attribute represents the further specification for the source, which can be specific for a region or project. 
  E.g. whether the heat gain from Person is caused by specific activities.
  \returns
  Returns the value of SourceDescription attribute.
  */
  const OdAnsiString& getSourceDescription() const;

  /** \details
  Sets the value of SourceDescription attribute. 
  This attribute represents the further specification for the source, which can be specific for a region or project. 
  E.g. whether the heat gain from Person is caused by specific activities.
  \param SourceDescription [in] SourceDescription attribute to set.
  */
  void setSourceDescription(const OdAnsiString& SourceDescription);

  /** \details
  Returns the value of MaximumValue attribute. 
  This attribute represents the maximum thermal load value. If this value is less than zero (negative), then the thermal load is lost from the space. 
  If the value is greater than zero (positive), then the thermal load is a gain to the space. 
  If the minimum value is not specified, then this value is the actual value. 
  At least one of the maximum, minimum, or time series values must be specified.
  \returns
  Returns the value of MaximumValue attribute.
  */
  double getMaximumValue() const;

  /** \details
  Sets the value of MaximumValue attribute. 
  This attribute represents the maximum thermal load value. If this value is less than zero (negative), then the thermal load is lost from the space. 
  If the value is greater than zero (positive), then the thermal load is a gain to the space. 
  If the minimum value is not specified, then this value is the actual value. 
  At least one of the maximum, minimum, or time series values must be specified.
  \param MaximumValue [in] MaximumValue attribute to set.
  */
  void setMaximumValue(double MaximumValue);

  /** \details
  Returns the value of MinimumValue attribute. 
  This attribute represents the minimum thermal load value. If this value is less than zero (negative), then the thermal load is lost from the space. 
  If the value is greater than zero (positive), then the thermal load is a gain to the space. 
  The requirement for the inclusion of this attribute is dependent on the load source. 
  At least one of the maximum, minimum, or time series values must be specified.
  \returns
  Returns the value of MinimumValue attribute.
  */
  double getMinimumValue() const;

  /** \details
  Sets the value of MinimumValue attribute. 
  This attribute represents the minimum thermal load value. If this value is less than zero (negative), then the thermal load is lost from the space. 
  If the value is greater than zero (positive), then the thermal load is a gain to the space. 
  The requirement for the inclusion of this attribute is dependent on the load source. 
  At least one of the maximum, minimum, or time series values must be specified.
  \param MinimumValue [in] MinimumValue attribute to set.
  */
  void setMinimumValue(double MinimumValue);

  /** \details
  Returns the value of ThermalLoadTimeSeriesValues attribute. 
  This attribute represents time series of the thermal load values. 
  If a value is less than zero (negative), then the thermal load is lost from the space. 
  If the value is greater than zero (positive), then the thermal load is a gain to the space. 
  These values are contributed from the specified thermal load source. 
  At least one of the maximum, minimum, or time series values must be specified.
  \returns
  Returns the value of ThermalLoadTimeSeriesValues attribute.
  */
  const OdDAIObjectId& getThermalLoadTimeSeriesValues() const;

  /** \details
  Sets the value of ThermalLoadTimeSeriesValues attribute. 
  This attribute represents time series of the thermal load values. 
  If a value is less than zero (negative), then the thermal load is lost from the space. 
  If the value is greater than zero (positive), then the thermal load is a gain to the space. 
  These values are contributed from the specified thermal load source. 
  At least one of the maximum, minimum, or time series values must be specified.
  \param ThermalLoadTimeSeriesValues [in] ThermalLoadTimeSeriesValues attribute to set.
  */
  void setThermalLoadTimeSeriesValues(const OdDAIObjectId& ThermalLoadTimeSeriesValues);

  /** \details
  Returns the value of UserDefinedThermalLoadSource attribute. 
  This attribute represents a user-defined thermal load source. 
  This attribute must be defined if the ThermalLoadSource is USERDEFINED.
  \returns
  Returns the value of UserDefinedThermalLoadSource attribute.
  */
  const OdAnsiString& getUserDefinedThermalLoadSource() const;

  /** \details
  Sets the value of UserDefinedThermalLoadSource attribute. 
  This attribute represents a user-defined thermal load source. 
  This attribute must be defined if the ThermalLoadSource is USERDEFINED.
  \param UserDefinedThermalLoadSource [in] UserDefinedThermalLoadSource attribute to set.
  */
  void setUserDefinedThermalLoadSource(const OdAnsiString& UserDefinedThermalLoadSource);

  /** \details
  Returns the value of UserDefinedPropertySource attribute. 
  This attribute represents a user-defined property source. 
  This attribute must be defined 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 represents a user-defined property source. 
  This attribute must be defined if the PropertySource is USERDEFINED.
  \param UserDefinedPropertySource [in] UserDefinedPropertySource attribute to set.
  */
  void setUserDefinedPropertySource(const OdAnsiString& UserDefinedPropertySource);

  /** \details
  Returns the value of ThermalLoadType attribute. 
  This attribute represents the type of thermal load (e.g., sensible, latent, radiant, etc.).
  \returns
  Returns the value of ThermalLoadType attribute.
  */
  IfcThermalLoadTypeEnum getThermalLoadType() const;

  /** \details
  Sets the value of ThermalLoadType attribute. 
  This attribute represents the type of thermal load (e.g., sensible, latent, radiant, etc.).
  \param ThermalLoadType [in] ThermalLoadType attribute to set.
  */
  void setThermalLoadType(IfcThermalLoadTypeEnum ThermalLoadType);


public:

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

  /** \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: 
  IfcPositiveRatioMeasure m_ApplicableValueRatio;   // IfcPositiveRatioMeasure  [optional]
  OdDAI::Enum m_ThermalLoadSource;   // IfcThermalLoadSourceEnum
  OdDAI::Enum m_PropertySource;   // IfcPropertySourceEnum
  OdAnsiString m_SourceDescription;   // IfcText  [optional]
  double m_MaximumValue;   // IfcPowerMeasure
  double m_MinimumValue;   // IfcPowerMeasure  [optional]
  OdDAIObjectId m_ThermalLoadTimeSeriesValues;   // IfcTimeSeries  [optional]
  OdAnsiString m_UserDefinedThermalLoadSource;   // IfcLabel  [optional]
  OdAnsiString m_UserDefinedPropertySource;   // IfcLabel  [optional]
  OdDAI::Enum m_ThermalLoadType;   // IfcThermalLoadTypeEnum
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCSPACETHERMALLOADPROPERTIES_AUTO_IMPL_H