CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4::IfcRelInterferesElements Class Reference

#include <IfcRelInterferesElementsAutoImpl.h>

Inheritance diagram for OdIfc4::IfcRelInterferesElements:
OdIfc4::IfcRelConnects OdIfc4::IfcRelationship OdIfc4::IfcRoot OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdDAIObjectId & getRelatingElement () const
 
void setRelatingElement (const OdDAIObjectId &RelatingElement)
 
const OdDAIObjectId & getRelatedElement () const
 
void setRelatedElement (const OdDAIObjectId &RelatedElement)
 
const OdDAIObjectId & getInterferenceGeometry () const
 
void setInterferenceGeometry (const OdDAIObjectId &InterferenceGeometry)
 
const OdAnsiString & getInterferenceType () const
 
void setInterferenceType (const OdAnsiString &InterferenceType)
 
OdDAI::Logical getImpliedOrder () const
 
void setImpliedOrder (OdDAI::Logical ImpliedOrder)
 
 IfcRelInterferesElements ()
 
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 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAIObjectId m_RelatingElement
 
OdDAIObjectId m_RelatedElement
 
OdDAIObjectId m_InterferenceGeometry
 
OdAnsiString m_InterferenceType
 
OdDAI::Logical m_ImpliedOrder
 
- 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
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

The IfcRelInterferesElements objectified relationship indicates that two elements interfere. It is a 1 to 1 relationship, and the concept of two elements interfering physically or logically is described independently of the elements.

The interference can be related to the shape representation of the entities by providing an interference geometry or zone: when the interference is between two physical products, the InterferenceGeometry attribute is used to define the physical interference shape, it can be part of the shape of one of the elements used in the relationship or define the interface between the two shapes using a IfcConnectionGeometry. when the interference is between two spatial objects, the InterferenceSpace attribute is used to define the interference space between the two footprints associated to the spatial objects, expressed by a specific IfcSpatialZone of predefined type IfcSpatialZoneTypeEnum INTERFERENCE.

If the interference geometry and Zone are omitted then the interference is provided as a logical relationship. Under this circumstance, the connection point, curve, surface, or solid has to be recalculated by the receiving application. Both InterferenceGeometry and InterferenceSpace should not be set together.

The RelatingElement and RelatedElement define the two elements in the relationship, that can have different roles. The relation orientation can be required by certain InterferenceType values or InterferenceGeometry calculation, this is done by setting the attribute ImpliedOrder accordingly: ImpliedOrder=TRUE The RelatingElement constitutes the primary element of the interference relationship that is oriented from RelatingElement (source) to RelatedElement (target). If the interference is to be resolved by subtracting the overlapping part, it should be subtracted from the RelatingElement. The net result would be the RelatingElement subtracted by the InterferenceGeometry. This would be the case in interference relationships where the RelatedElement creates a void in the RelatingElement dynamically. ImpliedOrder=FALSE The RelatingElement and RelatedElement have no priority among each other. If the interference is to be resolved then no information about whether the InterferenceGeometry should be subtracted from the RelatingElement or the RelatedElement can be traced. This would be the case for clash detection results. ImpliedOrder=UNKNOWN No information about the priorities is provided.

The InterferenceType property optionally specifies the type of interference between the two elements, two set of default types are provided: Oriented interferences types imply usage of ImpliedOrder set to TRUE and specific choice of RelatingElement and RelatedElement to be meaningful: Crosses: the RelatingElement is crossing the RelatedElement (e.g. Railway crossing a road) PassesThrough: the RelatingElement is passing through the RelatedElement (e.g. a Road passing inside a tunnel) PassesOver: the RelatingElement is passing over the RelatedElement (e.g a bridge passing over a water canal) PassesUnder: the RelatingElement is passing under the RelatedElement (e.g a Tunnel passing under a road) Non oriented interferences types do not imply specific values of ImpliedOrder (but can still be set to detail shape interference calculation) Clash: The RelatingElement and RelatedElement have a spatial or shape-based clash Along: The RelatingElement and RelatedElement have a common frontier/surface

\changes

IFC4 changes: Type of the ImpliedOrder attribute changed from logical to IfcLogical. Type of the RelatedElement attribute changed from IfcElement to IfcInterferenceSelect. Type of the RelatingElement attribute changed from IfcElement to IfcInterferenceSelect.

Definition at line 87 of file Ifc4/IfcRelInterferesElementsAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRelInterferesElements()

OdIfc4::IfcRelInterferesElements::IfcRelInterferesElements ( )

Default constructor for the IfcRelInterferesElements class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcRelInterferesElements::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::IfcRelConnects.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ getImpliedOrder()

OdDAI::Logical OdIfc4::IfcRelInterferesElements::getImpliedOrder ( ) const

Returns the value of ImpliedOrder attribute. This attribute represents logical value indicating if the RelatingElement is considered a source and the RelatedElement a target (giving a formal orientation to the relation). It shall be provided in regards to InterferenceGeometry usage and InterferenceType declaration.

Returns
Returns the value of ImpliedOrder attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcRelInterferesElements::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::IfcRelConnects.

◆ getInterferenceGeometry()

const OdDAIObjectId & OdIfc4::IfcRelInterferesElements::getInterferenceGeometry ( ) const

Returns the value of InterferenceGeometry attribute. This attribute represents the geometric shape representation of the interference geometry that is provided in the object coordinate system of the RelatingElement (mandatory) and in the object coordinate system of the RelatedElement (optionally).

Returns
Returns the value of InterferenceGeometry attribute.

◆ getInterferenceType()

const OdAnsiString & OdIfc4::IfcRelInterferesElements::getInterferenceType ( ) const

Returns the value of InterferenceType attribute. This is optional identifier that describes the nature of the interference.

Returns
Returns the value of InterferenceType attribute.

◆ getRelatedElement()

const OdDAIObjectId & OdIfc4::IfcRelInterferesElements::getRelatedElement ( ) const

Returns the value of RelatedElement attribute. This attribute represents one of two elements in the relationship that can have a certain role. See class description for more information.

Returns
Returns the value of RelatedElement attribute.

◆ getRelatingElement()

const OdDAIObjectId & OdIfc4::IfcRelInterferesElements::getRelatingElement ( ) const

Returns the value of RelatingElement attribute. This attribute represents one of two elements in the relationship that can have a certain role. See class description for more information.

Returns
Returns the value of RelatingElement attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ isKindOf()

virtual bool OdIfc4::IfcRelInterferesElements::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::IfcRelConnects.

◆ outFields()

virtual OdResult OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ setImpliedOrder()

void OdIfc4::IfcRelInterferesElements::setImpliedOrder ( OdDAI::Logical ImpliedOrder)

Sets the value of ImpliedOrder attribute. This attribute represents logical value indicating if the RelatingElement is considered a source and the RelatedElement a target (giving a formal orientation to the relation). It shall be provided in regards to InterferenceGeometry usage and InterferenceType declaration.

Parameters
ImpliedOrder[in] Implied order to set.

◆ setInterferenceGeometry()

void OdIfc4::IfcRelInterferesElements::setInterferenceGeometry ( const OdDAIObjectId & InterferenceGeometry)

Sets the value of InterferenceGeometry attribute. This attribute represents the geometric shape representation of the interference geometry that is provided in the object coordinate system of the RelatingElement (mandatory) and in the object coordinate system of the RelatedElement (optionally).

Parameters
InterferenceGeometry[in] Interference geometry to set.

◆ setInterferenceType()

void OdIfc4::IfcRelInterferesElements::setInterferenceType ( const OdAnsiString & InterferenceType)

Sets the value of InterferenceType attribute. This is optional identifier that describes the nature of the interference.

Parameters
InterferenceType[in] Interference type to set.

◆ setInverseCounterParts()

virtual void OdIfc4::IfcRelInterferesElements::setInverseCounterParts ( )
overridevirtual

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

◆ setRelatedElement()

void OdIfc4::IfcRelInterferesElements::setRelatedElement ( const OdDAIObjectId & RelatedElement)

Sets the value of RelatedElement attribute. This attribute represents one of two elements in the relationship that can have a certain role. See class description for more information.

Parameters
RelatedElement[in] Related element to set.

◆ setRelatingElement()

void OdIfc4::IfcRelInterferesElements::setRelatingElement ( const OdDAIObjectId & RelatingElement)

Sets the value of RelatingElement attribute. This attribute represents one of two elements in the relationship that can have a certain role. See class description for more information.

Parameters
RelatingElement[in] Relating element to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcRelInterferesElements::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::IfcRelConnects.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcRelInterferesElements::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::IfcRoot.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcRelInterferesElements::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::IfcRoot.

Member Data Documentation

◆ m_ImpliedOrder

OdDAI::Logical OdIfc4::IfcRelInterferesElements::m_ImpliedOrder
protected

Definition at line 324 of file Ifc4/IfcRelInterferesElementsAutoImpl.h.

◆ m_InterferenceGeometry

OdDAIObjectId OdIfc4::IfcRelInterferesElements::m_InterferenceGeometry
protected

Definition at line 322 of file Ifc4/IfcRelInterferesElementsAutoImpl.h.

◆ m_InterferenceType

OdAnsiString OdIfc4::IfcRelInterferesElements::m_InterferenceType
protected

Definition at line 323 of file Ifc4/IfcRelInterferesElementsAutoImpl.h.

◆ m_RelatedElement

OdDAIObjectId OdIfc4::IfcRelInterferesElements::m_RelatedElement
protected

Definition at line 321 of file Ifc4/IfcRelInterferesElementsAutoImpl.h.

◆ m_RelatingElement

OdDAIObjectId OdIfc4::IfcRelInterferesElements::m_RelatingElement
protected

Definition at line 320 of file Ifc4/IfcRelInterferesElementsAutoImpl.h.


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