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

#include "IfcRelDecomposesAutoImpl.h"
#include "IfcObjectDefinitionAutoImpl.h"

#include "TD_PackPush.h"

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

/** \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.

  \changes
  
  * IFC4 changes: 
    The attributes RelatingObject and RelatedObjects are demoted from the supertype IfcRelDecomposes, and RelatedObjects is refined to be a list. 
  The use of IfcRelNests is re-purposed to be a nesting of an ordered collections of parts.
*/
class IFC4X1_EXPORT IfcRelNests : public IfcRelDecomposes
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcRelNests);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of RelatingObject attribute. 
  This attribute represents the object definition, either an non-product object type or a non-product object occurrence, that represents the nest. 
  It is the whole within the whole/part relationship.
  \returns
  Returns the value of RelatingObject attribute.
  \remarks
  IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the ordered nesting relationship.
  */
  const OdDAIObjectId& getRelatingObject() const;

  /** \details
  Sets the value of RelatingObject attribute. 
  This attribute represents the object definition, either an non-product object type or a non-product object occurrence, that represents the nest. 
  It is the whole within the whole/part relationship.
  \param RelatingObject [in] Relating object to set.
  \remarks
  IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the ordered nesting relationship.
  */
  void setRelatingObject(const OdDAIObjectId& RelatingObject);

  /** \details
  Sets the value of RelatedObjects attribute. 
  This attribute represents the object definitions, either non-product object occurrences or non-product object types, that are being nestes. 
  They are defined as the parts in the ordered whole/part relationship -i.e. there is an implied order 
  among the parts expressed by the position within the list of RelatedObjects.
  \param RelatedObjects [out] Receives the related objects.
  \remarks
  IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the ordered set of parts within the nest.
  */
  void getRelatedObjects(OdDAIObjectIds& RelatedObjects) const;

  /** \details
  Returns the value of RelatedObjects attribute. 
  This attribute represents the object definitions, either non-product object occurrences or non-product object types, that are being nestes. 
  They are defined as the parts in the ordered whole/part relationship -i.e. there is an implied order 
  among the parts expressed by the position within the list of RelatedObjects.
  \returns
  Returns the value of RelatingObject attribute.
  \remarks
  IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the ordered set of parts within the nest.
  */
  OdDAI::ListOfOdDAIObjectId& relatedObjects();


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
  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_RelatingObject;   // IfcObjectDefinition
  OdDAI::ListOfOdDAIObjectId m_RelatedObjects; // LIST [1:?] of IfcObjectDefinition
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X1_IFCRELNESTS_AUTO_IMPL_H