/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCVIRTUALELEMENT_AUTO_IMPL_H
#define _IFC2X2_FINAL_IFCVIRTUALELEMENT_AUTO_IMPL_H

#include "IfcElementAutoImpl.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
  A virtual element is a special element used to provide imaginary boundaries, 
  such as between two adjacent, but not separated, spaces. 
  
  - Details -
  Virtual elements are usually not displayed and does not have quantities and other measures. 
  Therefore IfcVirtualElement does not have material information and quantities attached.
  
  Uses of IfcVirtualElement include:
  * An imaginary boundary such as between two adjacent, but not separated, spaces. 
    The IfcVirtualElement can provide the 2D curve or 3D surface representation of the virtual space connection 
    and is referenced by two instances of IfcRelSpaceBoundary, each pointing to one of the two adjacent IfcSpaces. 
    The boundary is exchanged using PredefinedType = BOUNDARY.
  * A provision for voids. Such as where a particular volume of space is requested by an engineering function that might later be accepted or rejected. 
    If accepted it is transformed into a void within a building element, like a wall opening, or a slab opening. 
    The provision for voids is exchanged using the PredefinedType = PROVISIONFORVOID. 
    Typically, it uses a swept solid geometry, where the profile of the swept solid lies on/near the surface of the referred building element 
    and the extrusion depths is equal to or bigger than (in case of round or otherwise irregular element shape) the thickness of the building element. 
    The appropriate Pset_ProvisionForVoid property set should be attached.
  * A clearance space. Typically, a placeholder for the necessary space allocation for future designed elements, 
    such as mechanical equipment that will be determined in a later design phase. 
    The clearance is exchanged using the PredefinedType = CLEARANCE.
  
  The image below describes how to use IfcRelSpaceBoundary in conjunction with IfcVirtualElement to define space boundaries.
  
  <IMAGE ifcvirtualelement_spaceboundaries>
*/
class IFC2X2_FINAL_EXPORT IfcVirtualElement : public IfcElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcVirtualElement);
  //DOM-IGNORE-END


public:

  /** \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
  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
  A data type that represents a smart pointer to a <exref target="OdIfc2x2_final__IfcVirtualElement.html">IfcVirtualElement</exref> object.
*/
typedef OdSmartPtr<IfcVirtualElement> IfcVirtualElementPtr;

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X2_FINAL_IFCVIRTUALELEMENT_AUTO_IMPL_H