CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcRelVoidsElement Class Reference

#include <IfcRelVoidsElementAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcRelVoidsElement:
OdIfc4x4::IfcRelDecomposes OdIfc4x4::IfcRelationship OdIfc4x4::IfcRoot OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdDAIObjectId & getRelatingBuildingElement () const
 
void setRelatingBuildingElement (const OdDAIObjectId &RelatingBuildingElement)
 
const OdDAIObjectId & getRelatedOpeningElement () const
 
void setRelatedOpeningElement (const OdDAIObjectId &RelatedOpeningElement)
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void setInverseCounterParts () 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 OdIfc4x4::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 OdIfc4x4::OdIFC4X4Instance
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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAIObjectId m_RelatingBuildingElement
 
OdDAIObjectId m_RelatedOpeningElement
 
- Protected Attributes inherited from OdIfc4x4::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
 

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

IfcRelVoidsElement is an objectified relationship between a building element and one opening element that creates a void in the element. It is a one-to-one relationship. This relationship implies a Boolean operation of subtraction between the geometric bodies of the element and the opening.

<IMAGE ifcrelvoidselements-fig1>

\changes

IFC4 changes: Supertype changed from IfcRelConnects to IfcRelDecomposes.

Definition at line 54 of file IFC4X4/IfcRelVoidsElementAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRelDecomposes.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRelDecomposes.

◆ getRelatedOpeningElement()

const OdDAIObjectId & OdIfc4x4::IfcRelVoidsElement::getRelatedOpeningElement ( ) const

Returns the value of RelatedOpeningElement attribute. This attribute represents reference to the feature subtraction element which defines a void in the associated element.

Returns
Returns the value of RelatedOpeningElement attribute.
Remarks
IFC2x CHANGE: The data type has been changed from IfcOpeningElement to IfcFeatureElementSubtraction with upward compatibility for file-based exchange.

◆ getRelatingBuildingElement()

const OdDAIObjectId & OdIfc4x4::IfcRelVoidsElement::getRelatingBuildingElement ( ) const

Returns the value of RelatingBuildingElement attribute. This attribute represents reference to element in which a void is created by associated feature subtraction element.

Returns
Returns the value of RelatingBuildingElement attribute.
Remarks
IFC2x CHANGE: The data type has been changed from IfcBuildingElement to IfcElement with upward compatibility for file-based exchange.

◆ inFields()

virtual OdResult OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

◆ isKindOf()

virtual bool OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRelDecomposes.

◆ outFields()

virtual OdResult OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

◆ setInverseCounterParts()

virtual void OdIfc4x4::IfcRelVoidsElement::setInverseCounterParts ( )
overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ setRelatedOpeningElement()

void OdIfc4x4::IfcRelVoidsElement::setRelatedOpeningElement ( const OdDAIObjectId & RelatedOpeningElement)

Sets the value of RelatedOpeningElement attribute. This attribute represents reference to the feature subtraction element which defines a void in the associated element.

Parameters
RelatedOpeningElement[in] RelatedOpeningElement to set.
Remarks
IFC2x CHANGE: The data type has been changed from IfcOpeningElement to IfcFeatureElementSubtraction with upward compatibility for file-based exchange.

◆ setRelatingBuildingElement()

void OdIfc4x4::IfcRelVoidsElement::setRelatingBuildingElement ( const OdDAIObjectId & RelatingBuildingElement)

Sets the value of RelatingBuildingElement attribute. This attribute represents reference to element in which a void is created by associated feature subtraction element.

Parameters
RelatingBuildingElement[in] Relating building element to set.
Remarks
IFC2x CHANGE: The data type has been changed from IfcBuildingElement to IfcElement with upward compatibility for file-based exchange.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRelDecomposes.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcRelVoidsElement::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x4::IfcRoot.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcRelVoidsElement::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 OdIfc4x4::IfcRoot.

Member Data Documentation

◆ m_RelatedOpeningElement

OdDAIObjectId OdIfc4x4::IfcRelVoidsElement::m_RelatedOpeningElement
protected

Definition at line 236 of file IFC4X4/IfcRelVoidsElementAutoImpl.h.

◆ m_RelatingBuildingElement

OdDAIObjectId OdIfc4x4::IfcRelVoidsElement::m_RelatingBuildingElement
protected

Definition at line 235 of file IFC4X4/IfcRelVoidsElementAutoImpl.h.


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