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

#include "IfcPropertySetDefinitionAutoImpl.h"
#include "IfcMeasureWithUnitAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The space thermal load (IfcSpaceThermalLoad) 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 source attribute defines the source of loss or gain, and the maximum value 
  and applicable value ratio are interpreted according to the source (see definition of IfcUseCaseSourceEnum).
*/
class IFC2X_FINAL_EXPORT IfcSpaceThermalLoad : public IfcPropertySetDefinition
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcSpaceThermalLoad);
  //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, interpretation depends on the source type.
  \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, interpretation depends on the source type.
  \param ApplicableValueRatio [in] ApplicableValueRatio attribute to set.
  */
  void setApplicableValueRatio(double ApplicableValueRatio);

  /** \details
  Returns the value of ThermalLoadSource attribute. 
  This attribute represents the source or type of the use or load characteristic.
  Depending on the source, the maximum value has to be interpreted.
  \returns
  Returns the value of ThermalLoadSource attribute.
  */
  IfcThermalLoadTypeEnum getThermalLoadSource() const;

  /** \details
  Sets the value of ThermalLoadSource attribute. 
  This attribute represents the source or type of the use or load characteristic.
  Depending on the source, the maximum value has to be interpreted.
  \param ThermalLoadSource [in] ThermalLoadSource attribute to set.
  */
  void setThermalLoadSource(IfcThermalLoadTypeEnum ThermalLoadSource);

  /** \details
  Returns the value of RequirementOrCriteria attribute. 
  This attribute indicates whether the source values describe a desired value as requirement (REQUIREMENT) 
  or an actual value as criteria (CRITERIA) for the space.
  \returns
  Returns the value of RequirementOrCriteria attribute.
  */
  IfcRequirementOrCriteriaEnum getRequirementOrCriteria() const;

  /** \details
  Sets the value of RequirementOrCriteria attribute. 
  This attribute indicates whether the source values describe a desired value as requirement (REQUIREMENT) 
  or an actual value as criteria (CRITERIA) for the space.
  \param RequirementOrCriteria [in] RequirementOrCriteria attribute to set.
  */
  void setRequirementOrCriteria(IfcRequirementOrCriteriaEnum RequirementOrCriteria);

  /** \details
  Returns the value of ConstantLoad attribute. 
  This attribute indicates whether the use requirement or load is constant during the hours of a day (TRUE) or not (FALSE).
  \returns
  Returns the value of ConstantLoad attribute.
  */
  OdDAI::Boolean getConstantLoad() const;

  /** \details
  Sets the value of ConstantLoad attribute. 
  This attribute indicates whether the use requirement or load is constant during the hours of a day (TRUE) or not (FALSE).
  \param ConstantLoad [in] ConstantLoad attribute to set.
  */
  void setConstantLoad(OdDAI::Boolean ConstantLoad);

  /** \details
  Returns the value of LossOrGain attribute. 
  This attribute indicates whether the source causes a loss (LOSS) or gain (GAIN) for the space.
  \returns
  Returns the value of LossOrGain attribute.
  */
  IfcLossOrGainEnum getLossOrGain() const;

  /** \details
  Sets the value of LossOrGain attribute. 
  This attribute indicates whether the source causes a loss (LOSS) or gain (GAIN) for the space.
  \param LossOrGain [in] LossOrGain attribute to set.
  */
  void setLossOrGain(IfcLossOrGainEnum LossOrGain);

  /** \details
  Returns the value of SourceDescription attribute. 
  This attribute represents the further specification for the source, which might 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 might 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 value of the Gain or Loss for the use requirement or criteria, 
  interpretation depends on the source type.
  \returns
  Returns the value of MaximumValue attribute.
  */
  const OdDAIObjectId& getMaximumValue() const;

  /** \details
  Sets the value of MaximumValue attribute. 
  This attribute represents the maximum value of the Gain or Loss for the use requirement or criteria, 
  interpretation depends on the source type.
  \param MaximumValue [in] MaximumValue attribute to set.
  */
  void setMaximumValue(const OdDAIObjectId& MaximumValue);

  /** \details
  Returns the value of MinimumValue attribute. 
  This attribute represents the minimum value of the Gain or Loss for the use requirement or criteria, interpretation and unit depends on the source type. 
  If given, a upper/lower bound is given (by MaximumValue, MinimumValue). If omitted, the MaximumValue defines the exact requirement of criteria.
  \returns
  Returns the value of MinimumValue attribute.
  */
  const OdDAIObjectId& getMinimumValue() const;

  /** \details
  Sets the value of MinimumValue attribute. 
  This attribute represents the minimum value of the Gain or Loss for the use requirement or criteria, interpretation and unit depends on the source type. 
  If given, a upper/lower bound is given (by MaximumValue, MinimumValue). If omitted, the MaximumValue defines the exact requirement of criteria.
  \param MinimumValue [in] MinimumValue attribute to set.
  */
  void setMinimumValue(const OdDAIObjectId& MinimumValue);


public:

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

  /** \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: 
  IfcPositiveRatioMeasure m_ApplicableValueRatio;   // IfcPositiveRatioMeasure  [optional]
  OdDAI::Enum m_ThermalLoadSource;   // IfcThermalLoadTypeEnum
  OdDAI::Enum m_RequirementOrCriteria;   // IfcRequirementOrCriteriaEnum
  OdDAI::Boolean m_ConstantLoad;   // BOOLEAN
  OdDAI::Enum m_LossOrGain;   // IfcLossOrGainEnum
  OdAnsiString m_SourceDescription;   // IfcText  [optional]
  OdDAIObjectId m_MaximumValue;   // IfcMeasureWithUnit
  OdDAIObjectId m_MinimumValue;   // IfcMeasureWithUnit  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCSPACETHERMALLOAD_AUTO_IMPL_H