///////////////////////////////////////////////////////////////////////////////
// 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 _IFC2X_FINAL_IFCBEAM_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCBEAM_AUTO_IMPL_H
#include "IfcBuildingElementAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC2X_FINAL express schema definitions.
*/
namespace OdIfc2x_final {
/** \details
An IfcBeam is a horizontal, or nearly horizontal, structural member that is capable of withstanding load primarily by resisting bending.
It represents such a member from an architectural point of view. It is not required to be load bearing.
There are two main representations for beam occurrences:
* IfcBeam with IfcMaterialProfileSetUsage is used for all occurrences of beams, that have a profile defined that is swept along a directrix.
The profile might change uniformly by a taper definition along the directrix.
The profile parameter and its cardinal point of insertion can be fully described by the IfcMaterialProfileSetUsage.
These beams are always represented geometrically by an 'Axis' and a 'SweptSolid' or 'AdvancedSweptSolid' shape representation
(or by a 'Clipping' geometry based on the swept solid), if a 3D geometric representation is assigned.
* IfcBeam without IfcMaterialProfileSetUsage is used for all other occurrences of beams,
particularly for beams with non-uniformly changing profile sizes along the sweep,
or beams having only 'AdvancedBrep', 'Brep', or 'SurfaceModel' geometry,
if a more parametric representation is not intended.
For any other longitudinal structural member, not constrained to be predominately horizontal nor vertical,
or where this semantic information is irrelevant, the entity IfcMember should be used.
- Spatial Containment -
The Spatial Containment concept template applies to this entity as shown in table below:
RelatingStructure Description
IfcBuildingStorey A system or zone for which time-based system information is provided, such as overall status parameters of a building control system
IfcBuilding Spatial container for the element if it cannot be assigned to a building storey
IfcSite A process for which time-based information is provided, such as an alarm event being raised and acknowledged, or regular and overtime costs spent on a task
The IfcBeam, as any subtype of IfcBuildingElement, can participate alternatively in one of the two different containment relationships:
* the Spatial Containment (defined here)
* the Element Composition.
- Material Profile Set -
The material of the IfcBeam is usually defined by the IfcMaterialProfileSet
and it is attached either directly or at the IfcBeamType.
* It is illegal to assign an IfcMaterialProfileSetUsage to an IfcBeam. Only the subtype IfcBeamStandardCase supports this concept.
- Axis 3D Geometry -
The Axis 3D Geometry concept template applies to this entity as shown in the table below:
RelatingStructure Type Items Description
IfcBuildingStorey Curve3D IfcBoundedCurve Three-dimensional reference curve for the beam.
The 'Axis' 'Curve 3D' geometry can be used to represent the system axis and length of a beam that can extent the body length.
- Body SweptSolid Geometry -
The following additional constraints apply to the 'SweptSolid' representation type:
* Solid: IfcExtrudedAreaSolid, IfcRevolvedAreaSolid is supported
* Profile: all subtypes of IfcProfileDef (with exception of IfcArbitraryOpenProfileDef)
* Extrusion: All extrusion directions are supported
* Boolean result: The IfcBooleanClippingResult is supported,
allowing for Boolean differences between the swept solid (here IfcExtrudedAreaSolid) and one or several IfcHalfSpaceSolid (or its subtypes).
The image below illustrates the 'SweptSolid' geometric representation.
There are no restrictions or conventions on how to use the local placement (black), solid of extrusion placement (red) and profile placement (green).
The image below illustrates the use of non-perpendicular extrusion to create the IfcExtrudedAreaSolid.
- Body AdvancedSweptSolid Geometry -
The following additional constraints apply to the 'AdvancedSweptSolid' representation type:
* Solid: IfcSurfaceCurveSweptAreaSolid, IfcFixedReferenceSweptAreaSolid, IfcExtrudedAreaSolidTapered, IfcRevolvedAreaSolidTapered is be supported.
* Profile: see 'SweptSolid' geometric representation
* Extrusion: not applicable
- Body Clipping Geometry -
The following additional constraints apply to the 'Clipping' representation type:
* Solid: see 'SweptSolid' geometric representation
* Profile: see 'SweptSolid' geometric representation
* Extrusion: see 'SweptSolid' geometric representation
* Boolean result: The IfcBooleanClippingResult is supported, allowing for Boolean differences between the swept solid
(here IfcExtrudedAreaSolid) and one or several IfcHalfSpaceSolid (or its subtypes).
The image below illustrates use of IfcBooleanClippingResult between an IfcExtrudedAreaSolid and an IfcHalfSpaceSolid to create a clipped body.
\remarks
The entity IfcBeamStandardCase has been deleted in newer releases, IfcBeam with IfcMaterialProfileSetUsage is used instead.
*/
class IFC2X_FINAL_EXPORT IfcBeam : public IfcBuildingElement
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcBeam);
//DOM-IGNORE-END
public:
/** \details
Returns a type of a class instance.
\returns
Pointer to the OdDAI::Entity 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 OdIfc::OdIfcEntityType type that represents type of this entity.
*/
virtual OdIfc::OdIfcEntityType type() const override;
};
/** \details
A data type that represents a smart pointer to a IfcBeam object.
*/
typedef OdSmartPtr IfcBeamPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X_FINAL_IFCBEAM_AUTO_IMPL_H