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

#include <IfcCoveringAutoImpl.h>

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

Public Member Functions

IfcCoveringTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcCoveringTypeEnum PredefinedType)
 
void getInvCovers (OdDAIObjectIds &Covers) const
 
 IfcCovering ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () 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::IfcBuildingElement
void getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const
 
void getInvHasOpenings (OdDAIObjectIds &HasOpenings) const
 
void getInvFillsVoids (OdDAIObjectIds &FillsVoids) const
 
- 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
 

Protected Attributes

OdDAI::Enum m_PredefinedType
 
- 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
 

Friends

class IfcRelCoversBldgElements
 

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)
 

Detailed Description

A covering is an element which covers some part of another element and is fully dependent on that other element. The IfcCovering defines the occurrence of a covering type, that (if specified) is expressed by the IfcCoveringType.

  • Details - Coverings can be assigned to: a space represented by IfcSpace using the inverse relationship CoversSpaces pointing to IfcRelCoversSpaces. The space is then accessible via IfcRelCoversSpaces.RelatedSpace. It defines to which space a covering is facing towards. a space boundary represented by IfcRelSpaceBoundary using the inverse relationship ProvidesBoundaries pointing to IfcRelSpaceBoundary. The space is then accessible via IfcRelSpaceBoundary.RelatingSpace. a building element represented by IfcBuildingElement using the inverse relationship Covers pointing to IfcRelCoversBldgElements. The building element is then accessible via IfcRelCoversBldgElements.RelatingBuildingElement.

The following guideline applies: (default) if the space has coverings that may not have their own shape representation and no defined relationships to the building elements they cover, then the IfcCovering is assigned to IfcSpace using the IfcRelCoversSpaces relationship. if the space has coverings that have an own shape representation and the space has defined space boundaries, then the covering, which relates to that space, is contained in the space using IfcRelContainedInSpatialStructure. It can be assigned to the space boundaries using the IfcRelSpaceBoundary. if the covering does not relate to a space, then the covering should be assigned to the building element or a distribution element using the IfcRelCoversBldgElements relationship.

  • Body SweptSolid Geometry - The following additional constraints apply to the 'SweptSolid' representation of IfcCovering: for planar base surfaces - swept area representation for cylindrical base surfaces - swept area representation

The image below illustrates a body representation where the volume of IfcCovering is specified by an IfcExtrudedAreaSolid for planar base surfaces (here specified by the IfcRelSpaceBoundary). The extruded area (IfcArbitraryClosedProfileDef) is coplanar to the surface defined by the IfcRelSpaceBoundary.

<IMAGE ifccovering_advanced-1-layout1>

The image below illustrates a body representation where the volume of the IfcCovering is specified by an IfcExtrudedAreaSolid for cylindrical base surfaces.

<IMAGE ifccovering_advanced-2-layout1>

  • Material Set - Coverings for surfaces (CEILING, FLOORING, CLADDING, CEILING, ROOFING) can have materials defined according to layers. Coverings for edges (MOLDING, SKIRTINGBOARD) can have materials defined according to profiles. This concept can be applied to the following resources: Front - Optional front-facing material of layer-based coverings such as drywall paper. Fill - The solid material of layer-based coverings such as drywall gypsum. Back - Optional back-facing material of layer-based coverings such as drywall paper. Trim - Profile of trim such as crown molding or base molding. Lining Finish
  • Object Typing - This concept can be applied to the following resources: IfcCoveringType
  • Property Sets for Objects - This concept can be applied to the following resources: Pset_CoveringCommon Pset_CoveringFlooring (only applies to FLOORING) Pset_CoveringTypeMembrane (only applies to MEMBRANE) Pset_Tiling
  • Quantity Sets - This concept can be applied to the following resources: Qto_CoveringBaseQuantities
  • Spatial Containment - The following additional constraints apply to the 'GeometricSet' representation of IfcCovering: for planar base surfaces - bounded surface representation for cylindrical base surfaces - swept surface representation

The image below illustrates a planar surface representation where the area of IfcCovering is specified by an IfcPolyLoop for planar base surfaces (here provided by the IfcRelSpaceBoundary). The implicit planar surface of the IfcPolyLoop is identical with the planar surface defined by the IfcRelSpaceBoundary.

<IMAGE ifccovering_standard-1-layout1>

The image below illustrates a cylindrical surface representation where the area of the IfcCovering is specified by an IfcSurfaceOfLinearExtrusion for cylindrical base surfaces (here specified by the IfcRelSpaceBoundary, such as caused by a round wall).

<IMAGE ifccovering_standard-2-layout1>

\changes

IFC2X_FINAL changes: The attribute PredefinedType is now optional and should only be inserted when no type information, specified by IfcCoveringType, is assigned to the IfcCovering occurrence by IfcRelDefinesByType

Definition at line 124 of file Ifc2x_Final/IfcCoveringAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCovering()

OdIfc2x_final::IfcCovering::IfcCovering ( )

Default constructor for the IfcCovering class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcCovering::getAttr ( const char * attrName) const
overridevirtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcCovering::getAttr ( const OdIfc::OdIfcAttribute attrDef) const
overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcCovering::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.

◆ getInvCovers()

void OdIfc2x_final::IfcCovering::getInvCovers ( OdDAIObjectIds & Covers) const

Returns the value of Covers attribute. This attribute represents reference to the objectified relationship that handles the relationship of the covering to the covered element.

Parameters
Covers[out] Receives the value of Covers attribute.
Remarks
IFC4 CHANGE: The attribute Covers is renamed to CoversElements.

◆ getPredefinedType()

IfcCoveringTypeEnum OdIfc2x_final::IfcCovering::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined types to define the particular type of the covering. There can be property set definitions available for each predefined type.

Returns
Returns the value of PredefinedType attribute.
Remarks
The PredefinedType is only used if no IfcCoveringType is assigned, providing its own IfcCoveringType.PredefinedType.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcCovering::inFields ( OdDAI::OdSpfFilerBase * rdFiler)
overridevirtual

Reads object's data from the specified filer.

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

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcCovering::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.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcCovering::outFields ( OdDAI::OdSpfFilerBase * wrFiler)
overridevirtual

Writes object's data the the specified filer.

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

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcCovering::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcCovering::putAttr ( const OdIfc::OdIfcAttribute explicitAttrDef,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ setPredefinedType()

void OdIfc2x_final::IfcCovering::setPredefinedType ( IfcCoveringTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents predefined types to define the particular type of the covering. There can be property set definitions available for each predefined type.

Parameters
PredefinedType[in] Predefined type to set.
Remarks
The PredefinedType is only used if no IfcCoveringType is assigned, providing its own IfcCoveringType.PredefinedType.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcCovering::testAttr ( const char * explicitAttrName) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcCovering::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcCovering::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.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcCovering::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcCovering::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc2x_final::IfcBuildingElement.

Friends And Related Symbol Documentation

◆ IfcRelCoversBldgElements

friend class IfcRelCoversBldgElements
friend

Definition at line 281 of file Ifc2x_Final/IfcCoveringAutoImpl.h.

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc2x_final::IfcCovering::m_PredefinedType
protected

Definition at line 278 of file Ifc2x_Final/IfcCoveringAutoImpl.h.


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