/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCOBJECTDEFINITION_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCOBJECTDEFINITION_AUTO_IMPL_H

#include "IfcRootAutoImpl.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
  An IfcObjectDefinition is the generalization of any semantically treated thing or process, either being a type or an occurrences. 
  Object definitions can be named, using the inherited Name attribute, which should be a user recognizable label for the object occurrence. 
  Further explanations to the object can be given using the inherited Description attribute. 
  A context is a specific kind of object definition as it provides the project or library context in which object types and object occurrences are defined.
  
  Objects are independent pieces of information that might contain or reference other pieces of information. 
  There are four essential kinds of relationships in which object definitions (by their instantiable subtypes) can be involved:

  * Assignment of other objects - an assignment relationship (IfcRelAssigns) that refers to other types of objects and creates a bi-directional association. 
    The semantic of the assignment is established at the level of the subtypes of the general IfcRelAssigns relationship. 
    There is no dependency implied a priori by the assignment.
  * Association to external resources - an association relationship (IfcRelAssociates) that refers to external sources of information 
    (most notably a classification or document) and creates a uni-directional association. There is no dependency implied by the association.
  * Aggregation of other objects - an aggregation relationship (IfcRelAggregates) that establishes an unordered, 
    spatial whole/part relation and creates a bi-directional relation. There is an implied dependency established.
  * Nesting of other objects - a nesting relationship (IfcRelNests) that establishes an ordered, 
    non-spatial whole/part relation and creates a bi-directional relation. There is an implied dependency established.
  * Declaration within a context - a relationship (IfcRelDeclares) of the uppermost object definition 
    within the object definition tree (e.g. the summary object within an object nesting tree) to the context (a project or project library). 
    It applies the units, representation context and other context information to this object definition and all dependent ones.

  \changes
  
  * IFC4 changes: 
    * The new subtype IfcContext and the relationship to context HasContext has been added. 
    * The decomposition relationship is split into ordered nesting (Nests, IsNestedBy) and un-ordered aggregating (Decomposes, IsDecomposedBy).
    * Name of the inverse attribute Decomposes changed to IsNestedBy.
    * Type of the inverse attribute Decomposes changed from "SET OF [0:1] IfcRelDecomposes FOR RelatedObjects" to "SET OF [0:?] IfcRelNests FOR RelatingObject".
    * Name of the inverse attribute IsDecomposedBy changed to Nests.
    * Type of the inverse attribute IsDecomposedBy changed from "SET OF [0:?] IfcRelDecomposes FOR RelatingObject" to "SET OF [0:1] IfcRelNests FOR RelatedObjects".
*/
class IFC4X3_EXPORT IfcObjectDefinition : public IfcRoot
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x3_add2::IfcObjectDefinition);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of HasAssignments attribute. 
  This attribute represents reference to the relationship objects, that assign (by an association relationship) 
  other subtypes of IfcObject to this object instance. Examples are the association to products, processes, controls, resources or groups.
  \param HasAssignments [out] Receives the value of HasAssignments attribute.
  */
  void getInvHasAssignments(OdDAIObjectIds& HasAssignments) const;

  /** \details
  Returns the value of Nests attribute. 
  This attribute represents references to the decomposition relationship being a nesting. 
  It determines that this object definition is a part within an ordered whole/part decomposition relationship. 
  An object occurrence or type can only be part of a single decomposition (to allow hierarchical structures only).
  \param Nests [out] Receives the value of Nests attribute.
  \remarks
  IFC4 CHANGE: The inverse attribute datatype has been added and separated from Decomposes defined at IfcObjectDefinition.
  */
  void getInvNests(OdDAIObjectIds& Nests) const;

  /** \details
  Returns the value of IsNestedBy attribute. 
  This attribute represents references to the decomposition relationship being a nesting. 
  It determines that this object definition is the whole within an ordered whole/part decomposition relationship. 
  An object or object type can be nested by several other objects (occurrences or types).
  \param IsNestedBy [out] Receives the value of IsNestedBy attribute.
  \remarks
  IFC4 CHANGE: The inverse attribute data type has been added and separated from Decomposes defined at IfcObjectDefinition.
  */
  void getInvIsNestedBy(OdDAIObjectIds& IsNestedBy) const;

  /** \details
  Returns the value of HasContext attribute. 
  This attribute represents references to the context providing context information such as project unit or representation context. 
  It should only be asserted for the uppermost non-spatial object.
  \param HasContext [out] Receives the value of HasContext attribute.
  \remarks
  IFC4 CHANGE: The inverse attribute data type has been added.
  */
  void getInvHasContext(OdDAIObjectIds& HasContext) const;

  /** \details
  Returns the value of IsDecomposedBy attribute. 
  This attribute represents references to the decomposition relationship being an aggregation. 
  It determines that this object definition is whole within an unordered whole/part decomposition relationship. 
  An object definitions can be aggregated by several other objects (occurrences or parts).
  \param IsDecomposedBy [out] Receives the value of IsDecomposedBy attribute.
  \remarks
  IFC4 CHANGE: The inverse attribute data type has been changed from the supertype IfcRelDecomposes to subtype IfcRelAggregates.
  */
  void getInvIsDecomposedBy(OdDAIObjectIds& IsDecomposedBy) const;

  /** \details
  Returns the value of Decomposes attribute. 
  This attribute represents references to the decomposition relationship being an aggregation. 
  It determines that this object definition is a part within an unordered whole/part decomposition relationship. 
  An object definitions can only be part of a single decomposition (to allow hierarchical structures only).
  \param Decomposes [out] Receives the value of Decomposes attribute.
  \remarks
  IFC4 CHANGE: The inverse attribute data type has been changed from the supertype IfcRelDecomposes to subtype IfcRelAggregates.
  */
  void getInvDecomposes(OdDAIObjectIds& Decomposes) const;

  /** \details
  Returns the value of HasAssociations attribute. 
  This attribute represents reference to the relationship objects, that associates external references or other resource definitions to the object. 
  Examples are the association to library, documentation or classification.
  \param HasAssociations [out] Receives the value of HasAssociations attribute.
  */
  void getInvHasAssociations(OdDAIObjectIds& HasAssociations) 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 IfcRoot::getAttr;
  using IfcRoot::putAttr;


protected:

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRelAssigns;
  friend class IfcRelNests;
  friend class IfcRelNests;
  friend class IfcRelDeclares;
  friend class IfcRelAggregates;
  friend class IfcRelAggregates;
  friend class IfcRelAssociates;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCOBJECTDEFINITION_AUTO_IMPL_H