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

#include "IfcObjectAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcGroup is an generalization of any arbitrary group. A group is a logical collection of objects. 
  It does not have its own position, nor can it hold its own shape representation. 
  Therefore a group is an aggregation under some non-geometrical / topological grouping aspects.
  
  * EXAMPLE: An example for a group is a system, since it groups elements under the aspect of their role, regardless of their position in a building. 
    One of the most important usage of a group representing a system is the IfcDistributionSystem, 
    that groups distribution components, such as space heaters and valves into a heating system.
  
  A group can hold any collection of objects, the relationship IfcRelAssignsToGroup is used to establish the group collection. 
  Objects within a group are products, processes, controls, resources, actors or other groups, thus groups can be nested. 
  An object can be part of zero, one, or many groups. Grouping relationships are not required to be hierarchical nor do they imply a dependency.
  Groups are assigned to other objects (such as a process or a resource) by the relationship object that refers to the corresponding object:
  * Process: assigned using IfcRelAssignsToProcess
  * Resource: assigned using IfcRelAssignsToResource
  * Controls: affecting the group using IfcRelAssignsToControl
  
  A group can be exchanged without having already objects within the group collection.
  IfcGroup does not define an own object coordinate system, nor does it have an independent shape representation.
*/
class IFC2X2_FINAL_EXPORT IfcGroup : public IfcObject
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcGroup);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of IsGroupedBy attribute. 
  This attribute represents reference to the relationship IfcRelAssignsToGroup that assigns the one to many group members to the IfcGroup object.
  \param IsGroupedBy [out] Receives the value of IsGroupedBy attribute.
  \returns
  Returns the value of IsGroupedBy attribute (relevant for schemas prior to Ifc4x1).
  \remarks
  IFC4 CHANGE: The cardinality has been changed from 1..1 to 0..? in order to allow the exchange of a group concept without having already group members assigned. 
  It now also allows the use of many instances of IfcRelAssignsToGroup to assign the group members. 
  The change has been done with upward compatibility for file based exchange.
  */
  OdDAIObjectId getInvIsGroupedBy() 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
  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 IfcObject::getAttr;
  using IfcObject::putAttr;


protected:

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X2_FINAL_IFCGROUP_AUTO_IMPL_H