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

#include "IfcProductAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  A spatial element is the generalization of all spatial elements that 
  might be used to define a spatial structure or to define spatial zones.
  
  * A hierarchical spatial structure element as IfcSpatialStructureElement
      * A spatial structure is a hierarchical decomposition of the project. 
        That spatial structure is often used to provide a project structure to organize a building project.
      * A spatial project structure might define as many levels of decomposition as necessary for the building project. 
        Elements within the spatial project structure are site, building, storey, and space or alternatively, site, bridge and bridge part.
  * A spatial zone as IfcSpatialZone
      * A spatial zone is a non-hierarchical and potentially overlapping decomposition of the project under some functional consideration.
      * A spatial zone might be used to represent a thermal zone, a lighting zone, a usable area zone.
      * A spatial zone might be used to represent a horizontal spatial structure as used in civil works.
      * A spatial zone might have its independent placement and shape representation.

  \remarks
  This definition cannot be instantiated.
*/
class IFC4X4_EXPORT IfcSpatialElement : public IfcProduct
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x4::IfcSpatialElement);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of LongName attribute. 
  This attribute represents long name for a spatial structure element, used for informal purposes. 
  It should be used, if available, in conjunction with the inherited Name attribute.
  \returns
  Returns the value of LongName attribute.
  \remarks
  In many scenarios the Name attribute refers to the short name or number of a spacial element, and the LongName refers to the full descriptive name.
  */
  const OdAnsiString& getLongName() const;

  /** \details
  Sets the value of LongName attribute. 
  This attribute represents long name for a spatial structure element, used for informal purposes. 
  It should be used, if available, in conjunction with the inherited Name attribute.
  \param LongName [in] Long name to set.
  \remarks
  In many scenarios the Name attribute refers to the short name or number of a spacial element, and the LongName refers to the full descriptive name.
  */
  void setLongName(const OdAnsiString& LongName);

  /** \details
  Returns the value of ContainsElements attribute. 
  This attribute represents set of spatial containment relationships, that holds those elements, 
  which are contained within this element of the project spatial structure.
  \param ContainsElements [out] Receives the value of ContainsElements attribute.
  \remarks
  The spatial containment relationship, established by IfcRelContainedInSpatialStructure, 
  is required to be an hierarchical relationship, where each element can only be assigned to 0 or 1 spatial structure element.
  */
  void getInvContainsElements(OdDAIObjectIds& ContainsElements) const;

  /** \details
  Returns the value of ServicedBySystems attribute. 
  This attribute represents a set of relationships to systems, that provides a certain service to the spatial element for which it is defined. 
  The relationship is handled by the objectified relationship IfcRelServicesBuildings.
  \param ServicedBySystems [out] Receives the value of ServicedBySystems attribute.
  \remarks
  IFC4 CHANGE: The inverse attribute has been promoted to the new supertype IfcSpatialElement with upward compatibility for file-based exchange.
  */
  void getInvServicedBySystems(OdDAIObjectIds& ServicedBySystems) const;

  /** \details
  Returns the value of ReferencesElements attribute. 
  This attribute represents a set of spatial reference relationships, that holds those elements, 
  which are referenced, but not contained, within this element of the project spatial structure.
  \param ReferencesElements [out] Receives the value of ReferencesElements attribute.
  \remarks
  * The spatial reference relationship, established by IfcRelReferencedInSpatialStructure, is not required to be an hierarchical relationship, 
    i.e. each element can be assigned to 0, 1 or many spatial structure elements.
  * IFC2x3 CHANGE: The inverse attribute has been added with upward compatibility for file-based exchange.
  */
  void getInvReferencesElements(OdDAIObjectIds& ReferencesElements) const;

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

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


public:

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

  /** \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_LongName;   // IfcLabel  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRelContainedInSpatialStructure;
  friend class IfcRelServicesBuildings;
  friend class IfcRelReferencedInSpatialStructure;
  friend class IfcRelInterferesElements;
  friend class IfcRelInterferesElements;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X4_IFCSPATIALELEMENT_AUTO_IMPL_H