/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCRELCONNECTSELEMENTS_AUTO_IMPL_H
#define _IFC2X3_IFCRELCONNECTSELEMENTS_AUTO_IMPL_H

#include "IfcRelConnectsAutoImpl.h"
#include "IfcConnectionGeometryAutoImpl.h"
#include "IfcElementAutoImpl.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 objectified relationship provides the generalization of the connectivity between elements. 
  It is a 1 to 1 relationship. The concept of two elements being physically or logically connected is described independently from the connecting elements. 
  The connectivity can be related to the shape representation of the connected entities by providing a connection geometry.
  * In this case the geometrical constraints of the connection are provided by the optional relationship to the IfcConnectionGeometry. 
    The connection geometry is provided as a point, curve or surface within the local placement coordinate systems of the connecting elements.
  * If the connection geometry is omitted then the connection is provided as a logical connection. Under this circumstance, 
    the connection point, curve or surface has to be recalculated by the receiving application.
*/
class IFC2X3_EXPORT IfcRelConnectsElements : public IfcRelConnects
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcRelConnectsElements);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ConnectionGeometry attribute. 
  This attribute represents the geometric shape representation of the connection geometry that is provided 
  in the object coordinate system of the RelatingElement (mandatory) and in the object coordinate system of the RelatedElement (optionally).
  \returns
  Returns the value of ConnectionGeometry attribute.
  */
  const OdDAIObjectId& getConnectionGeometry() const;

  /** \details
  Sets the value of ConnectionGeometry attribute. 
  This attribute represents the geometric shape representation of the connection geometry that is provided 
  in the object coordinate system of the RelatingElement (mandatory) and in the object coordinate system of the RelatedElement (optionally).
  \param ConnectionGeometry [in] Connection geometry to set.
  */
  void setConnectionGeometry(const OdDAIObjectId& ConnectionGeometry);

  /** \details
  Returns the value of RelatingElement attribute. This attribute represents reference to a subtype of IfcElement 
  that is connected by the connection relationship in the role of RelatingElement.
  \returns
  Returns the value of RelatingElement attribute.
  */
  const OdDAIObjectId& getRelatingElement() const;

  /** \details
  Sets the value of RelatingElement attribute. This attribute represents reference to a subtype of IfcElement 
  that is connected by the connection relationship in the role of RelatingElement.
  \param RelatingElement [in] Relating element to set.
  */
  void setRelatingElement(const OdDAIObjectId& RelatingElement);

  /** \details
  Returns the value of RelatedElement attribute. This attribute represents reference to a subtype of IfcElement 
  that is connected by the connection relationship in the role of RelatedElement.
  \returns
  Returns the value of RelatedElement attribute.
  */
  const OdDAIObjectId& getRelatedElement() const;

  /** \details
  Sets the value of RelatedElement attribute. This attribute represents reference to a subtype of IfcElement 
  that is connected by the connection relationship in the role of RelatedElement.
  \param RelatedElement [in] Related element to set.
  */
  void setRelatedElement(const OdDAIObjectId& RelatedElement);


public:

  /** \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: 
  OdDAIObjectId m_ConnectionGeometry;   // IfcConnectionGeometry  [optional]
  OdDAIObjectId m_RelatingElement;   // IfcElement
  OdDAIObjectId m_RelatedElement;   // IfcElement
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCRELCONNECTSELEMENTS_AUTO_IMPL_H