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

#include "IfcProductAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  An element is a generalization of all components that make up an AEC product.
  Elements are physically existent objects, although they might be void elements, such as holes.  
  Elements can be either assembled on site or pre-manufactured and built in on site.
  * EXAMPLE: Examples of elements in a building construction context are walls, floors, windows and recesses.
  
  The elements can be logically contained by a spatial structure element that constitutes a certain level within a project structure hierarchy (site, building, storey or space). 
  This is done by using the IfcRelContainedInSpatialStructure relationship. An element can have material 
  and quantity information assigned through the IfcRelAssociatesMaterial and IfcRelDefinesByProperties relationship.
  
  In addition an element can be declared to be a specific occurrence of an element type 
  (and thereby be defined by the element type properties) using the IfcRelDefinesByType relationship. 
  An element can also be defined as an element assembly that is a group of semantically and topologically related elements that form a higher level part of the AEC product. 
  Those element assemblies are defined by virtue of the IfcRelAggregates relationship.
  * EXAMPLE: Examples for element assembly are complete Roof Structures, made by several Roof Areas, or a Stair, composed by Flights and Landings.
  
  Elements that performs the same function can be grouped by an "Element Group By Function". 
  It is realized by an instance of IfcGroup with the ObjectType ='ElementGroupByFunction'.

  \changes
  
  * IFC4 changes: 
    * Name of the inverse attribute HasPorts changed to IsInterferedByElements.
  * Type of the inverse attribute HasPorts changed from "SET OF [0:?] IfcRelConnectsPortToElement FOR RelatedElement" to "SET OF [0:?] IfcRelInterferesElements FOR RelatedElement".
*/
class IFC4_EXPORT IfcElement : public IfcProduct
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4::IfcElement);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Tag attribute. 
  This attribute represents the tag (or label) identifier at the particular instance of a product, 
  e.g. the serial number, or the position number. It is the identifier at the occurrence level.
  \returns
  Returns the value of Tag attribute.
  */
  const OdAnsiString& getTag() const;

  /** \details
  Sets the value of Tag attribute. 
  This attribute represents the tag (or label) identifier at the particular instance of a product, 
  e.g. the serial number, or the position number. It is the identifier at the occurrence level.
  \param Tag [in] Tag to set.
  */
  void setTag(const OdAnsiString& Tag);

  /** \details
  Returns the value of FillsVoids attribute. 
  This attribute represents the reference to the IfcRelFillsElement Relationship 
  that puts the element as a filling into the opening created within another element.
  \param FillsVoids [out] Receives the value of FillsVoids attribute.
  */
  void getInvFillsVoids(OdDAIObjectIds& FillsVoids) const;

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

  /** \details
  Returns the value of IsInterferedByElements attribute. 
  This attribute represents the reference to the interference relationship to indicate the element that is interfered. 
  The relationship, if provided, indicates that this element has an interference with one or many other elements.
  \param IsInterferedByElements [out] Receives the value of IsInterferedByElements attribute.
  \remarks
  There is no indication of precedence between IsInterferedByElements and InterferesElements.
  */
  void getInvIsInterferedByElements(OdDAIObjectIds& IsInterferedByElements) const;

  /** \details
  Returns the value of InterferesElements attribute. 
  This attribute represents the reference to the interference relationship to indicate the element that interferes. 
  The relationship, if provided, indicates that this element has an interference with one or many other elements.
  \param InterferesElements [out] Receives the value of InterferesElements attribute.
  \remarks
  There is no indication of precedence between IsInterferedByElements and InterferesElements.
  */
  void getInvInterferesElements(OdDAIObjectIds& InterferesElements) const;

  /** \details
  Returns the value of HasProjections attribute. 
  This attribute represents the projection relationship that adds a feature (using a Boolean union) to the IfcBuildingElement.
  \param HasProjections [out] Receives the value of HasProjections attribute.
  */
  void getInvHasProjections(OdDAIObjectIds& HasProjections) const;

  /** \details
  Returns the value of ReferencedInStructures attribute. 
  This attribute represents the reference relationship to the spatial structure element, to which the element is additionally associated. 
  This relationship may not be hierarchical, an element can be referenced by zero, one or many spatial structure elements.
  \param ReferencedInStructures [out] Receives the value of ReferencedInStructures attribute.
  */
  void getInvReferencedInStructures(OdDAIObjectIds& ReferencedInStructures) const;

  /** \details
  Returns the value of HasOpenings attribute. 
  This attribute represents the reference to the IfcRelVoidsElement relationship that creates an opening in an element. 
  An element can incorporate zero-to-many openings. For each opening, that voids the element, a new relationship IfcRelVoidsElement is generated.
  \param HasOpenings [out] Receives the value of HasOpenings attribute.
  */
  void getInvHasOpenings(OdDAIObjectIds& HasOpenings) const;

  /** \details
  Returns the value of IsConnectionRealization attribute. 
  This attribute represents the reference to the connection relationship with realizing element. 
  The relationship, if provided, assigns this element as the realizing element to the connection, which provides the physical manifestation of the connection relationship.
  \param IsConnectionRealization [out] Receives the value of IsConnectionRealization attribute.
  */
  void getInvIsConnectionRealization(OdDAIObjectIds& IsConnectionRealization) const;

  /** \details
  Returns the value of ProvidesBoundaries attribute. 
  This attribute represents the reference to space boundaries by virtue of the objectified relationship IfcRelSpaceBoundary. 
  It defines the concept of an element bounding spaces.
  \param ProvidesBoundaries [out] Receives the value of ProvidesBoundaries attribute.
  */
  void getInvProvidesBoundaries(OdDAIObjectIds& ProvidesBoundaries) const;

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

  /** \details
  Returns the value of ContainedInStructure attribute. 
  This attribute represents the containment relationship to the spatial structure element, to which the element is primarily associated. 
  This containment relationship has to be hierarchical, i.e. an element can only be assigned directly to zero or one spatial structure.
  \param ContainedInStructure [out] Receives the value of ContainedInStructure attribute.
  */
  void getInvContainedInStructure(OdDAIObjectIds& ContainedInStructure) const;

  /** \details
  Returns the value of HasCoverings attribute. 
  This attribute represents the reference to IfcCovering by virtue of the objectified relationship IfcRelCoversBldgElement. 
  It defines the concept of an element having coverings associated.
  \param HasCoverings [out] Receives the value of HasCoverings attribute.
  */
  void getInvHasCoverings(OdDAIObjectIds& HasCoverings) const;


public:

  /** \details
  Default constructor for the IfcElement class.
  */
  IfcElement();

  /** \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
  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
  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
  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: 
  OdAnsiString m_Tag;   // IfcIdentifier  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRelFillsElement;
  friend class IfcRelConnectsElements;
  friend class IfcRelInterferesElements;
  friend class IfcRelInterferesElements;
  friend class IfcRelProjectsElement;
  friend class IfcRelReferencedInSpatialStructure;
  friend class IfcRelVoidsElement;
  friend class IfcRelConnectsWithRealizingElements;
  friend class IfcRelSpaceBoundary;
  friend class IfcRelConnectsElements;
  friend class IfcRelContainedInSpatialStructure;
  friend class IfcRelCoversBldgElements;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCELEMENT_AUTO_IMPL_H