CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x_final::IfcBeam Class Reference

#include <IfcBeamAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcBeam:
OdIfc2x_final::IfcBuildingElement OdIfc2x_final::IfcElement OdIfc2x_final::IfcProduct OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

virtual OdDAI::Entity * getInstanceType () const override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () const override
 
- Public Member Functions inherited from OdIfc2x_final::IfcBuildingElement
void getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const
 
void getInvHasOpenings (OdDAIObjectIds &HasOpenings) const
 
void getInvFillsVoids (OdDAIObjectIds &FillsVoids) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const override
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const override
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override
 
- Public Member Functions inherited from OdIfc2x_final::IfcElement
const OdAnsiString & getTag () const
 
void setTag (const OdAnsiString &Tag)
 
void getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const
 
void getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
 IfcElement ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
- Public Member Functions inherited from OdIfc2x_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcRoot
OdDAI::CompressedGUID getGlobalId () const
 
void setGlobalId (OdDAI::CompressedGUID GlobalId)
 
const OdDAIObjectId & getOwnerHistory () const
 
void setOwnerHistory (const OdDAIObjectId &OwnerHistory)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
 IfcRoot ()
 
- Public Member Functions inherited from OdIfc::OdIfcInstance
 ODRX_DECLARE_MEMBERS (OdIfcInstance)
 
 OdIfcInstance ()
 
 ~OdIfcInstance ()
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 
- Protected Member Functions inherited from OdIfc2x_final::IfcBuildingElement
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 
- Protected Attributes inherited from OdIfc2x_final::IfcElement
OdAnsiString m_Tag
 
- Protected Attributes inherited from OdIfc2x_final::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x_final::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Detailed Description

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.

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).

<IMAGE ifcbeam_standard-layout1>

The image below illustrates the use of non-perpendicular extrusion to create the IfcExtrudedAreaSolid.

<IMAGE ifcbeam_advanced-1-layout1>

  • 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.

<IMAGE ifcbeam_advanced-2-layout1>

Remarks
The entity IfcBeamStandardCase has been deleted in newer releases, IfcBeam with IfcMaterialProfileSetUsage is used instead.

Definition at line 119 of file Ifc2x_Final/IfcBeamAutoImpl.h.

Member Function Documentation

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcBeam::getInstanceType ( ) const
overridevirtual

Returns a type of a class instance.

Returns
Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcBeam::isKindOf ( OdIfc::OdIfcEntityType entityType) const
overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcBeam::type ( ) const
overridevirtual

Returns the type of this entity.

Returns
A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc2x_final::IfcBuildingElement.


The documentation for this class was generated from the following file: