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

#include "IfcProductAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  A port provides the means for an element to connect to other elements.
  
  An IfcPort is associated with an IfcElement, it belongs to through the objectified relationship IfcRelNests if such port is fixed, or IfcRelConnectsPortToElement if such port is dynamically attached. 
  Exactly two ports, belonging to two different elements, are connected with each other through the objectified relationship IfcRelConnectsPorts.
  
  An instance of IfcElement can have one or more points at which it connects to other instances of IfcElement. 
  An instance of IfcPort is located at a point where a connection can occur. 
  The location of the port is determined in the context of the local coordinate system of the element to which it belongs.
  
  The local placement for IfcPort is defined in its supertype IfcProduct. 
  It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. 
  The PlacementRelTo relationship of IfcLocalPlacement points to the local placement of the master IfcElement or IfcElementType (relevant subtypes), 
  which is related to the IfcPort by the relationship object IfcRelNests for fixed ports, or IfcRelConnectsPortToElement for dynamic ports.

  \changes
  
  * IFC4 changes: 
    Type of the inverse attribute ContainedIn changed from "IfcRelConnectsPortToElement FOR RelatingPort" to "SET OF [0:1] IfcRelConnectsPortToElement FOR RelatingPort".
*/
class IFC4X3_EXPORT IfcPort : public IfcProduct
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x3_add2::IfcPort);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ContainedIn attribute. 
  This attribute represents reference to the element to port connection relationship. 
  The relationship then refers to the element in which this port is contained.
  \param ContainedIn [out] Receives the value of ContainedIn attribute.
  \remarks
  * IFC4 CHANGE: The cardinality has been changed from 1:1 to 0:1. 
  * IFC4 DEPRECATION: The inverse relationship is deprecated for fixed ports due to deprecation of IfcRelConnectsPortToElement for this usage. Use inverse relationship Nests instead.
  */
  void getInvContainedIn(OdDAIObjectIds& ContainedIn) const;

  /** \details
  Returns the value of ConnectedFrom attribute. 
  This attribute represents reference to a port that is connected by the objectified relationship.
  \param ConnectedFrom [out] Receives the value of ConnectedFrom attribute.
  */
  void getInvConnectedFrom(OdDAIObjectIds& ConnectedFrom) const;

  /** \details
  Returns the value of ConnectedTo attribute. 
  This attribute represents reference to the port connection relationship. 
  The relationship then refers to the other port to which this port is connected.
  \param ConnectedTo [out] Receives the value of ConnectedTo attribute.
  */
  void getInvConnectedTo(OdDAIObjectIds& ConnectedTo) const;


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
  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
  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
  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:
  using IfcProduct::getAttr;
  using IfcProduct::putAttr;


protected:

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRelConnectsPortToElement;
  friend class IfcRelConnectsPorts;
  friend class IfcRelConnectsPorts;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCPORT_AUTO_IMPL_H