/////////////////////////////////////////////////////////////////////////////// 
// 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_RC1_IFCOPENINGSTANDARDCASE_AUTO_IMPL_H
#define _IFC4X3_RC1_IFCOPENINGSTANDARDCASE_AUTO_IMPL_H

#include "IfcOpeningElementAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The standard opening, IfcOpeningStandardCase, defines an opening with certain constraints for the dimension parameters, 
  position within the voided element, and with certain constraints for the geometric representation. 
  The IfcOpeningStandardCase handles all cases of openings, that:
  
  * are true openings where the opening depth is greater than or equal to the thickness of the element, and the PredefinedType is set correctly to .OPENING.
  * are true recesses where the opening depth is lower than the thickness of the element, and the PredefinedType is set correctly to .RECESS.
  * are extruded perpendicular to the wall plane in case of openings in a wall
  * are extruded perpendicular to the slab plane in case of openings in a slab
  * have a local placement relative to the local placement of the voided element
  * have a 'Body' shape representation with 'SweptSolid' representation type
  * have only a single extrusion body within the 'Body' shape representation
  
  - Placement -
  The following constraint is mandatory for IfcOpeningStandardCase:
  * The PlacementRelTo relationship of IfcLocalPlacement should point to the local placement of the same element, 
    which is voided by the opening, i.e. referred to by VoidsElement.RelatingBuildingElement.
    
  - Body Geometry -
  The geometric representation of IfcOpeningStandardCase is defined using the following multiple shape representations for its definition:
  * Body: A SweptSolid representation defining the 3D subtraction shape of the standard opening
  
  - Body Representation -
  The body representation of IfcOpeningStandardCase is represented using the representation type 'SweptSolid'.
  The standard geometric representation of IfcOpeningStandardCase is defined using the 'SweptSolid' representation. 
  The following attribute values for the IfcShapeRepresentation holding this geometric representation are be used:
  * RepresentationIdentifier : 'Body'
  * RepresentationType : 'SweptSolid'
  
  The following additional constraints apply to the swept solid representation:
  * Solid: a single IfcExtrudedAreaSolid is required
  * Profile: IfcRectangleProfileDef, IfcCircleProfileDef and IfcArbitraryClosedProfileDef are supported.
  * Extrusion: The profile is extruded horizontally (i.e. perpendicular to the extrusion direction of the voided element) 
    for wall openings, or vertically (i.e. in the extrusion direction of the voided element), for slab openings.
  
  As shown on the image below, the orientation of the opening profile that is extruded for the opening body 
  guarantees the following interpretation of dimension parameter for rectangular openings:
  * IfcRectangleProfileDef.YDim interpreted as opening width
  * IfcRectangleProfileDef.XDim interpreted as opening height
  
  <IMAGE ifcopeningstandardcase_wall-layout1>

  \remarks
  Deprecated: this definition may be imported, but is not exported by applications. This definition is removed from Ifc4x3 version.
*/
class IFC4X3_RC1_EXPORT IfcOpeningStandardCase : public IfcOpeningElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcOpeningStandardCase);
  //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
  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
  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="OdIfc4x3_rc1__IfcOpeningStandardCase.html">IfcOpeningStandardCase</exref> object.
*/
typedef OdSmartPtr<IfcOpeningStandardCase> IfcOpeningStandardCasePtr;

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCOPENINGSTANDARDCASE_AUTO_IMPL_H