/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCRELINTERACTIONREQUIREMENTS_AUTO_IMPL_H
#define _IFC2X3_IFCRELINTERACTIONREQUIREMENTS_AUTO_IMPL_H

#include "IfcRelConnectsAutoImpl.h"
#include "IfcSpatialStructureElementAutoImpl.h"
#include "IfcSpaceProgramAutoImpl.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 interaction requirement (IfcRelInteractionRequirements) is provided as a relationship 
  that defines the requirements for the interaction (adjacency) of two spaces in the architectural program.
  Also, this relationship can define the interaction between two parties, such as persons, departments, 
  organizations, that are associated to the space programs (interaction relations between workstations, 
  workstation groups, floor blocks, or spaces, are defined through their associated space programs). 
  
  The interaction requirement is encoded as an normalized ratio measure between 0 and 1.
*/
class IFC2X3_EXPORT IfcRelInteractionRequirements : public IfcRelConnects
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcRelInteractionRequirements);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of DailyInteraction attribute. 
  This attribute represents the number of interactions occurring on a daily basis.
  \returns
  Returns the value of DailyInteraction attribute.
  */
  OdDAI::Number getDailyInteraction() const;

  /** \details
  Sets the value of DailyInteraction attribute. 
  This attribute represents the number of interactions occurring on a daily basis.
  \param DailyInteraction [in] DailyInteraction attribute to set.
  */
  void setDailyInteraction(OdDAI::Number DailyInteraction);

  /** \details
  Returns the value of ImportanceRating attribute. 
  This attribute represents the level of importance of interaction. 
  0 represents the lowest importance, 1 represents the highest importance.
  \returns
  Returns the value of ImportanceRating attribute.
  */
  double getImportanceRating() const;

  /** \details
  Sets the value of ImportanceRating attribute. 
  This attribute represents the level of importance of interaction. 
  0 represents the lowest importance, 1 represents the highest importance.
  \param ImportanceRating [in] ImportanceRating attribute to set.
  */
  void setImportanceRating(double ImportanceRating);

  /** \details
  Returns the value of LocationOfInteraction attribute. 
  This attribute represents the location where this interaction happens.
  \returns
  Returns the value of LocationOfInteraction attribute.
  */
  const OdDAIObjectId& getLocationOfInteraction() const;

  /** \details
  Sets the value of LocationOfInteraction attribute. 
  This attribute represents the location where this interaction happens.
  \param LocationOfInteraction [in] LocationOfInteraction attribute to set.
  */
  void setLocationOfInteraction(const OdDAIObjectId& LocationOfInteraction);

  /** \details
  Returns the value of RelatedSpaceProgram attribute. 
  This attribute represents the related space program for the interaction requirement.
  \returns
  Returns the value of RelatedSpaceProgram attribute.
  */
  const OdDAIObjectId& getRelatedSpaceProgram() const;

  /** \details
  Sets the value of RelatedSpaceProgram attribute. 
  This attribute represents the related space program for the interaction requirement.
  \param RelatedSpaceProgram [in] RelatedSpaceProgram attribute to set.
  */
  void setRelatedSpaceProgram(const OdDAIObjectId& RelatedSpaceProgram);

  /** \details
  Returns the value of RelatingSpaceProgram attribute. 
  This attribute represents the relating space program for the interaction requirement.
  \returns
  Returns the value of RelatingSpaceProgram attribute.
  */
  const OdDAIObjectId& getRelatingSpaceProgram() const;

  /** \details
  Sets the value of RelatingSpaceProgram attribute. 
  This attribute represents the relating space program for the interaction requirement.
  \param RelatingSpaceProgram [in] RelatingSpaceProgram attribute to set.
  */
  void setRelatingSpaceProgram(const OdDAIObjectId& RelatingSpaceProgram);


public:

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

  /** \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
  Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.
  */
  virtual void setInverseCounterParts() 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::Number m_DailyInteraction;   // IfcCountMeasure  [optional]
  IfcNormalisedRatioMeasure m_ImportanceRating;   // IfcNormalisedRatioMeasure  [optional]
  OdDAIObjectId m_LocationOfInteraction;   // IfcSpatialStructureElement  [optional]
  OdDAIObjectId m_RelatedSpaceProgram;   // IfcSpaceProgram
  OdDAIObjectId m_RelatingSpaceProgram;   // IfcSpaceProgram
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCRELINTERACTIONREQUIREMENTS_AUTO_IMPL_H