#include <IfcOpeningElementAutoImpl.h>

Inheritance diagram for OdIfc4::IfcOpeningElement:

Public Member Functions
IfcOpeningElementTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcOpeningElementTypeEnum PredefinedType)

void	getInvHasFillings (OdDAIObjectIds &HasFillings) const

	IfcOpeningElement ()

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 bool	comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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 OdIfc4::IfcFeatureElementSubtraction
OdDAIObjectId	getInvVoidsElements () const

Public Member Functions inherited from OdIfc4::IfcElement
const OdAnsiString &	getTag () const

void	setTag (const OdAnsiString &Tag)

void	getInvFillsVoids (OdDAIObjectIds &FillsVoids) const

void	getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const

void	getInvIsInterferedByElements (OdDAIObjectIds &IsInterferedByElements) const

void	getInvInterferesElements (OdDAIObjectIds &InterferesElements) const

void	getInvHasProjections (OdDAIObjectIds &HasProjections) const

void	getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const

void	getInvHasOpenings (OdDAIObjectIds &HasOpenings) const

void	getInvIsConnectionRealization (OdDAIObjectIds &IsConnectionRealization) const

void	getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const

void	getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const

void	getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const

void	getInvHasCoverings (OdDAIObjectIds &HasCoverings) const

	IfcElement ()

Public Member Functions inherited from OdIfc4::IfcProduct
const OdDAIObjectId &	getObjectPlacement () const

void	setObjectPlacement (const OdDAIObjectId &ObjectPlacement)

const OdDAIObjectId &	getRepresentation () const

void	setRepresentation (const OdDAIObjectId &Representation)

void	getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const

virtual void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc4::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const

void	getInvDeclares (OdDAIObjectIds &Declares) const

void	getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc4::IfcObjectDefinition
void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvNests (OdDAIObjectIds &Nests) const

void	getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const

void	getInvHasContext (OdDAIObjectIds &HasContext) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc4::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 OdIfc4::OdIfc4Instance
void	setInverseCounterParts () override

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 OdGsCache *	gsNode () 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 OdIfc4::IfcElement
OdAnsiString	m_Tag

Protected Attributes inherited from OdIfc4::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc4::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

OdAnsiString	m_Description

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcRelFillsElement

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

The opening element stands for opening, recess or chase, all reflecting voids. It represents a void within any element that has physical manifestation. Openings can be inserted into walls, slabs, beams, columns, or other elements. There are two different types of opening elements. The attribute PredefinedType should be used to capture the differences: an opening, where the thickness of the opening is greater or equal to the thickness of the element — the attribute PredefinedType is set to OPENING a recess or niche, where the thickness of the recess is smaller than the thickness of the element — the attribute PredefinedType is set to RECESS for a recess or niche.

If the value for PredefinedType is omitted, or the value is set to NOTDEFINED, no specific information of whether it is an opening or recess shall be assumed.

An IfcOpeningElement has to be inserted into an IfcElement by using the IfcRelVoidsElement relationship. It can be filled by an IfcDoor, IfcWindow, or another filling element by using the relationship IfcRelFillsElements. Depending on the type of the IfcShapeRepresentation of the IfcOpeningElement the voiding relationship implies: if the IfcShapeRepresentation.RepresentationIdentifier = 'Body', then the Body shape representation of the opening has to be subtracted from the body shape representation of the voided element - implicit Boolean difference operation. if the IfcShapeRepresentation.RepresentationIdentifier = 'Reference', then the Reference shape representation of the opening is not subtracted, it is provided in addition to the hole in the Body shape representation of the voided element.

The IfcOpeningElement does not participate in the containment relationship, i.e. it is not linked directly to the spatial structure of the project. It has a mandatory VoidsElements inverse relationship pointing to the IfcElement that is contained in the spatial structure. The inverse relationship ContainedInStructure should be NIL.

Body SweptSolid Geometry - The 'Body' representation of IfcOpeningElement can be represented using the representation types 'SweptSolid'. The following attribute values for the IfcShapeRepresentation holding this geometric representation are used: IfcShapeRepresentation.RepresentationIdentifier: 'Body' IfcShapeRepresentation.RepresentationType: 'SweptSolid'

The following constraints are recommended: IfcShapeRepresentation.Items can include a single, or multiple, instances of IfcExtrudedAreaSolid. IfcExtrudedAreaSolid.SweptArea supports IfcRectangleProfileDef, IfcCircleProfileDef and IfcArbitraryClosedProfileDef. If multiple instances of IfcExtrudedAreaSolid are used, the extrusion direction of each extrusion should be equal.

If parametric profiles are used, the parameters can be interpreted to be the dimensions of the beam: IfcRectangleProfileDef.YDim interpreted as beam height IfcRectangleProfileDef.XDim interpreted as beam width There are two main extrusion directions: perpendicular and parallel.

For a perpendicular swept solid, IfcExtrudedAreaSolid.ExtrudedDirection extrudes the profile perpendicular to the element it is voiding. This can be horizontal for wall openings, or vertical for floor openings. The next image shows an opening with full extrusion:

The next image shows an opening with recess extrusion:

For a parallel swept solid,IfcExtrudedAreaSolid.ExtrudedDirection extrudes the profile parallel to the element it is voiding. This can be vertical in the case of walls. The image below shows a vertical extrusion with multiple extrusion bodies for the opening. Each extrusion body has a different extrusion length.

Product Local Placement - The local placement for IfcOpeningElement is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. The PlacementRelTo relationship of IfcLocalPlacement should point to the local placement of the element which is voided by the opening, i.e. referred to by VoidsElement.RelatingBuildingElement.
Property Sets for Objects - This concept can be applied to the following resources: Pset_OpeningElementCommon
Quantity Sets - This concept can be applied to the following resources: Qto_OpeningElementBaseQuantities
Reference Geometry - Since there are no Boolean operations, either as IfcBooleanResult or implicitly by IfcRelVoidsElement the geometry of the IfcOpeningElement is not be used to subtract the opening from the 'Body' shape representation of the voided element.
Reference SweptSolid PolyCurve Geometry - Since there are no Boolean operations, either as IfcBooleanResult or implicitly by IfcRelVoidsElement the geometry of the IfcOpeningElement is not be used to subtract the opening from the 'Body' shape representation of the voided element.
Reference Tessellation Geometry - Since there are no Boolean operations, either as IfcBooleanResult or implicitly by IfcRelVoidsElement the geometry of the IfcOpeningElement is not be used to subtract the opening from the 'Body' shape representation of the voided element.

Remarks: The entity IfcOpeningStandardCase has been deleted. Use an IfcOpeningElement with a single extrusion body perpendicular to the wall or slab instead.

Definition at line 123 of file Ifc4/IfcOpeningElementAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcOpeningElement()

OdIfc4::IfcOpeningElement::IfcOpeningElement ( )

Default constructor for the IfcOpeningElement class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcOpeningElement::comparedToEarlyImpl	(	const OdDAI::ApplicationInstance *	pOther,
		OdRx::Ordering &	ordering ) const

overridevirtual

Early-bound version of instances comparison.

Parameters

pOther	[in] Other application instance.
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:

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.

Reimplemented from OdIfc4::IfcFeatureElementSubtraction.

Reimplemented in OdIfc4::IfcOpeningStandardCase.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

Reimplemented in OdIfc4::IfcOpeningStandardCase.

◆ getInvHasFillings()

void OdIfc4::IfcOpeningElement::getInvHasFillings ( OdDAIObjectIds & HasFillings ) const

Returns the value of HasFillings attribute. This attribute represents reference to the Filling Relationship that is used to assign Elements as Fillings for this Opening Element. The Opening Element can be filled with zero-to-many Elements.

Parameters

HasFillings [out] Receives the value of HasFillings attribute.

◆ getPredefinedType()

IfcOpeningElementTypeEnum OdIfc4::IfcOpeningElement::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined generic type for an opening that is specified in an enumeration. There can be a property set specified specifically for the predefined types.

Returns: Returns the value of PredefinedType attribute.

Remarks: IFC4 CHANGE: The attribute has been added at the end of the entity definition.

◆ inFields()

virtual OdResult OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

◆ isKindOf()

virtual bool OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

Reimplemented in OdIfc4::IfcOpeningStandardCase.

◆ outFields()

virtual OdResult OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

◆ setPredefinedType()

void OdIfc4::IfcOpeningElement::setPredefinedType ( IfcOpeningElementTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents predefined generic type for an opening that is specified in an enumeration. There can be a property set specified specifically for the predefined types.

Parameters

PredefinedType [in] Predefined type to set.

Remarks: IFC4 CHANGE: The attribute has been added at the end of the entity definition.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

Reimplemented in OdIfc4::IfcOpeningStandardCase.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcOpeningElement::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4::IfcFeatureElementSubtraction.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcOpeningElement::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 OdIfc4::IfcFeatureElementSubtraction.

Friends And Related Symbol Documentation

◆ IfcRelFillsElement

friend class IfcRelFillsElement

friend

Definition at line 298 of file Ifc4/IfcOpeningElementAutoImpl.h.

Member Data Documentation

◆ m_PredefinedType

OdDAI::Enum OdIfc4::IfcOpeningElement::m_PredefinedType

protected

Definition at line 295 of file Ifc4/IfcOpeningElementAutoImpl.h.

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

Ifc4/IfcOpeningElementAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcOpeningElement()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getInvHasFillings()

◆ getPredefinedType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setPredefinedType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcRelFillsElement

Member Data Documentation

◆ m_PredefinedType