/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCRELNESTS_AUTO_IMPL_H
#define _IFC2X3_IFCRELNESTS_AUTO_IMPL_H

#include "IfcRelDecomposesAutoImpl.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 nesting relationship IfcRelNests is a special type of the general composition/decomposition (or whole/part) relationship IfcRelDecomposes. 
  The nesting relationship can be applied to all non physical subtypes of object and object types, namely processes, 
  controls (like cost items), and resources. It can also be applied to physical subtypes of object and object types, namely elements having ports. 
  The nesting implies an order among the nested parts.

  \remarks
  * EXAMPLE: A nesting of costs items in an IfcCostSchedule is the composition of complex cost items from other cost items. 
    The order of the nested cost items underneath the parent cost item is determined by the order of the list of RelatedObjects.
  * EXAMPLE: A nesting of IfcTask's within a work schedule is the composition of a parent work task from more specific sub work tasks. 
    The order of the sub tasks underneath the parent task is determined by the order of the list of RelatedObjects.
  * EXAMPLE: A series of IfcDistributionPort's can be nested within an IfcDistributionElement. 
    They decompose the distribution element and have an implied order.
*/
class IFC2X3_EXPORT IfcRelNests : public IfcRelDecomposes
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcRelNests);
  //DOM-IGNORE-END


public:

  /** \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
  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
  A data type that represents a smart pointer to a <exref target="OdIfc2x3__IfcRelNests.html">IfcRelNests</exref> object.
*/
typedef OdSmartPtr<IfcRelNests> IfcRelNestsPtr;

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCRELNESTS_AUTO_IMPL_H