CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdIfc2x3::IfcRelationship Class Reference

#include <IfcRelationshipAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcRelationship:
OdIfc2x3::IfcRoot OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance OdIfc2x3::IfcRelAssigns OdIfc2x3::IfcRelAssociates OdIfc2x3::IfcRelConnects OdIfc2x3::IfcRelDecomposes OdIfc2x3::IfcRelDefines OdIfc2x3::IfcRelAssignsToActor OdIfc2x3::IfcRelAssignsToControl OdIfc2x3::IfcRelAssignsToGroup OdIfc2x3::IfcRelAssignsToProcess OdIfc2x3::IfcRelAssignsToProduct OdIfc2x3::IfcRelAssignsToResource OdIfc2x3::IfcRelAssociatesAppliedValue OdIfc2x3::IfcRelAssociatesApproval OdIfc2x3::IfcRelAssociatesClassification OdIfc2x3::IfcRelAssociatesConstraint OdIfc2x3::IfcRelAssociatesDocument OdIfc2x3::IfcRelAssociatesLibrary OdIfc2x3::IfcRelAssociatesMaterial OdIfc2x3::IfcRelAssociatesProfileProperties OdIfc2x3::IfcRelConnectsElements OdIfc2x3::IfcRelConnectsPortToElement OdIfc2x3::IfcRelConnectsPorts OdIfc2x3::IfcRelConnectsStructuralActivity OdIfc2x3::IfcRelConnectsStructuralElement OdIfc2x3::IfcRelConnectsStructuralMember OdIfc2x3::IfcRelContainedInSpatialStructure OdIfc2x3::IfcRelCoversBldgElements OdIfc2x3::IfcRelCoversSpaces OdIfc2x3::IfcRelFillsElement OdIfc2x3::IfcRelFlowControlElements OdIfc2x3::IfcRelInteractionRequirements OdIfc2x3::IfcRelProjectsElement OdIfc2x3::IfcRelReferencedInSpatialStructure OdIfc2x3::IfcRelSequence OdIfc2x3::IfcRelServicesBuildings OdIfc2x3::IfcRelSpaceBoundary OdIfc2x3::IfcRelVoidsElement OdIfc2x3::IfcRelAggregates OdIfc2x3::IfcRelNests OdIfc2x3::IfcRelDefinesByProperties OdIfc2x3::IfcRelDefinesByType

Public Member Functions

virtual OdDAI::Entity * getInstanceType () const override
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () const override
 
- Public Member Functions inherited from OdIfc2x3::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 ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) 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 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 OdIfc2x3::OdIfc2x3Instance
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
 

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)
 
- Protected Attributes inherited from OdIfc2x3::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
 

Detailed Description

IfcRelationship is the abstract generalization of all objectified relationships in IFC. Objectified relationships are the preferred way to handle relationships among objects. This allows to keep relationship specific properties directly at the relationship and opens the possibility to later handle relationship specific behavior.

There are two different types of relationships, 1-to-1 relationships and 1-to-many relationship. used within the subtypes of IfcRelationship. The following convention applies to all subtypes: The two sides of the objectified relationship are named Relating+<name of relating object> and Related+<name of related object> In case of the 1-to-many relationship, the related side of the relationship shall be an aggregate being a set 1:N

Remarks
This definition may not be instantiated.

Definition at line 51 of file Ifc2x3/IfcRelationshipAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcRelationship::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 OdIfc2x3::IfcRoot.

Reimplemented in OdIfc2x3::IfcRelAggregates, OdIfc2x3::IfcRelAssigns, OdIfc2x3::IfcRelAssignsTasks, OdIfc2x3::IfcRelAssignsToActor, OdIfc2x3::IfcRelAssignsToControl, OdIfc2x3::IfcRelAssignsToGroup, OdIfc2x3::IfcRelAssignsToProcess, OdIfc2x3::IfcRelAssignsToProduct, OdIfc2x3::IfcRelAssignsToProjectOrder, OdIfc2x3::IfcRelAssignsToResource, OdIfc2x3::IfcRelAssociates, OdIfc2x3::IfcRelAssociatesAppliedValue, OdIfc2x3::IfcRelAssociatesApproval, OdIfc2x3::IfcRelAssociatesClassification, OdIfc2x3::IfcRelAssociatesConstraint, OdIfc2x3::IfcRelAssociatesDocument, OdIfc2x3::IfcRelAssociatesLibrary, OdIfc2x3::IfcRelAssociatesMaterial, OdIfc2x3::IfcRelAssociatesProfileProperties, OdIfc2x3::IfcRelConnects, OdIfc2x3::IfcRelConnectsElements, OdIfc2x3::IfcRelConnectsPathElements, OdIfc2x3::IfcRelConnectsPorts, OdIfc2x3::IfcRelConnectsPortToElement, OdIfc2x3::IfcRelConnectsStructuralActivity, OdIfc2x3::IfcRelConnectsStructuralElement, OdIfc2x3::IfcRelConnectsStructuralMember, OdIfc2x3::IfcRelConnectsWithEccentricity, OdIfc2x3::IfcRelConnectsWithRealizingElements, OdIfc2x3::IfcRelContainedInSpatialStructure, OdIfc2x3::IfcRelCoversBldgElements, OdIfc2x3::IfcRelCoversSpaces, OdIfc2x3::IfcRelDecomposes, OdIfc2x3::IfcRelDefines, OdIfc2x3::IfcRelDefinesByProperties, OdIfc2x3::IfcRelDefinesByType, OdIfc2x3::IfcRelFillsElement, OdIfc2x3::IfcRelFlowControlElements, OdIfc2x3::IfcRelInteractionRequirements, OdIfc2x3::IfcRelNests, OdIfc2x3::IfcRelOccupiesSpaces, OdIfc2x3::IfcRelOverridesProperties, OdIfc2x3::IfcRelProjectsElement, OdIfc2x3::IfcRelReferencedInSpatialStructure, OdIfc2x3::IfcRelSchedulesCostItems, OdIfc2x3::IfcRelSequence, OdIfc2x3::IfcRelServicesBuildings, OdIfc2x3::IfcRelSpaceBoundary, and OdIfc2x3::IfcRelVoidsElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcRelationship::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 OdIfc2x3::IfcRoot.

Reimplemented in OdIfc2x3::IfcRelAggregates, OdIfc2x3::IfcRelAssigns, OdIfc2x3::IfcRelAssignsTasks, OdIfc2x3::IfcRelAssignsToActor, OdIfc2x3::IfcRelAssignsToControl, OdIfc2x3::IfcRelAssignsToGroup, OdIfc2x3::IfcRelAssignsToProcess, OdIfc2x3::IfcRelAssignsToProduct, OdIfc2x3::IfcRelAssignsToProjectOrder, OdIfc2x3::IfcRelAssignsToResource, OdIfc2x3::IfcRelAssociates, OdIfc2x3::IfcRelAssociatesAppliedValue, OdIfc2x3::IfcRelAssociatesApproval, OdIfc2x3::IfcRelAssociatesClassification, OdIfc2x3::IfcRelAssociatesConstraint, OdIfc2x3::IfcRelAssociatesDocument, OdIfc2x3::IfcRelAssociatesLibrary, OdIfc2x3::IfcRelAssociatesMaterial, OdIfc2x3::IfcRelAssociatesProfileProperties, OdIfc2x3::IfcRelConnects, OdIfc2x3::IfcRelConnectsElements, OdIfc2x3::IfcRelConnectsPathElements, OdIfc2x3::IfcRelConnectsPorts, OdIfc2x3::IfcRelConnectsPortToElement, OdIfc2x3::IfcRelConnectsStructuralActivity, OdIfc2x3::IfcRelConnectsStructuralElement, OdIfc2x3::IfcRelConnectsStructuralMember, OdIfc2x3::IfcRelConnectsWithEccentricity, OdIfc2x3::IfcRelConnectsWithRealizingElements, OdIfc2x3::IfcRelContainedInSpatialStructure, OdIfc2x3::IfcRelCoversBldgElements, OdIfc2x3::IfcRelCoversSpaces, OdIfc2x3::IfcRelDecomposes, OdIfc2x3::IfcRelDefines, OdIfc2x3::IfcRelDefinesByProperties, OdIfc2x3::IfcRelDefinesByType, OdIfc2x3::IfcRelFillsElement, OdIfc2x3::IfcRelFlowControlElements, OdIfc2x3::IfcRelInteractionRequirements, OdIfc2x3::IfcRelNests, OdIfc2x3::IfcRelOccupiesSpaces, OdIfc2x3::IfcRelOverridesProperties, OdIfc2x3::IfcRelProjectsElement, OdIfc2x3::IfcRelReferencedInSpatialStructure, OdIfc2x3::IfcRelSchedulesCostItems, OdIfc2x3::IfcRelSequence, OdIfc2x3::IfcRelServicesBuildings, OdIfc2x3::IfcRelSpaceBoundary, and OdIfc2x3::IfcRelVoidsElement.

◆ isKindOf()

virtual bool OdIfc2x3::IfcRelationship::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 OdIfc2x3::IfcRoot.

Reimplemented in OdIfc2x3::IfcRelAggregates, OdIfc2x3::IfcRelAssigns, OdIfc2x3::IfcRelAssignsTasks, OdIfc2x3::IfcRelAssignsToActor, OdIfc2x3::IfcRelAssignsToControl, OdIfc2x3::IfcRelAssignsToGroup, OdIfc2x3::IfcRelAssignsToProcess, OdIfc2x3::IfcRelAssignsToProduct, OdIfc2x3::IfcRelAssignsToProjectOrder, OdIfc2x3::IfcRelAssignsToResource, OdIfc2x3::IfcRelAssociates, OdIfc2x3::IfcRelAssociatesAppliedValue, OdIfc2x3::IfcRelAssociatesApproval, OdIfc2x3::IfcRelAssociatesClassification, OdIfc2x3::IfcRelAssociatesConstraint, OdIfc2x3::IfcRelAssociatesDocument, OdIfc2x3::IfcRelAssociatesLibrary, OdIfc2x3::IfcRelAssociatesMaterial, OdIfc2x3::IfcRelAssociatesProfileProperties, OdIfc2x3::IfcRelConnects, OdIfc2x3::IfcRelConnectsElements, OdIfc2x3::IfcRelConnectsPathElements, OdIfc2x3::IfcRelConnectsPorts, OdIfc2x3::IfcRelConnectsPortToElement, OdIfc2x3::IfcRelConnectsStructuralActivity, OdIfc2x3::IfcRelConnectsStructuralElement, OdIfc2x3::IfcRelConnectsStructuralMember, OdIfc2x3::IfcRelConnectsWithEccentricity, OdIfc2x3::IfcRelConnectsWithRealizingElements, OdIfc2x3::IfcRelContainedInSpatialStructure, OdIfc2x3::IfcRelCoversBldgElements, OdIfc2x3::IfcRelCoversSpaces, OdIfc2x3::IfcRelDecomposes, OdIfc2x3::IfcRelDefines, OdIfc2x3::IfcRelDefinesByProperties, OdIfc2x3::IfcRelDefinesByType, OdIfc2x3::IfcRelFillsElement, OdIfc2x3::IfcRelFlowControlElements, OdIfc2x3::IfcRelInteractionRequirements, OdIfc2x3::IfcRelNests, OdIfc2x3::IfcRelOccupiesSpaces, OdIfc2x3::IfcRelOverridesProperties, OdIfc2x3::IfcRelProjectsElement, OdIfc2x3::IfcRelReferencedInSpatialStructure, OdIfc2x3::IfcRelSchedulesCostItems, OdIfc2x3::IfcRelSequence, OdIfc2x3::IfcRelServicesBuildings, OdIfc2x3::IfcRelSpaceBoundary, and OdIfc2x3::IfcRelVoidsElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcRelationship::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 OdIfc2x3::IfcRoot.

Reimplemented in OdIfc2x3::IfcRelAggregates, OdIfc2x3::IfcRelAssigns, OdIfc2x3::IfcRelAssignsTasks, OdIfc2x3::IfcRelAssignsToActor, OdIfc2x3::IfcRelAssignsToControl, OdIfc2x3::IfcRelAssignsToGroup, OdIfc2x3::IfcRelAssignsToProcess, OdIfc2x3::IfcRelAssignsToProduct, OdIfc2x3::IfcRelAssignsToProjectOrder, OdIfc2x3::IfcRelAssignsToResource, OdIfc2x3::IfcRelAssociates, OdIfc2x3::IfcRelAssociatesAppliedValue, OdIfc2x3::IfcRelAssociatesApproval, OdIfc2x3::IfcRelAssociatesClassification, OdIfc2x3::IfcRelAssociatesConstraint, OdIfc2x3::IfcRelAssociatesDocument, OdIfc2x3::IfcRelAssociatesLibrary, OdIfc2x3::IfcRelAssociatesMaterial, OdIfc2x3::IfcRelAssociatesProfileProperties, OdIfc2x3::IfcRelConnects, OdIfc2x3::IfcRelConnectsElements, OdIfc2x3::IfcRelConnectsPathElements, OdIfc2x3::IfcRelConnectsPorts, OdIfc2x3::IfcRelConnectsPortToElement, OdIfc2x3::IfcRelConnectsStructuralActivity, OdIfc2x3::IfcRelConnectsStructuralElement, OdIfc2x3::IfcRelConnectsStructuralMember, OdIfc2x3::IfcRelConnectsWithEccentricity, OdIfc2x3::IfcRelConnectsWithRealizingElements, OdIfc2x3::IfcRelContainedInSpatialStructure, OdIfc2x3::IfcRelCoversBldgElements, OdIfc2x3::IfcRelCoversSpaces, OdIfc2x3::IfcRelDecomposes, OdIfc2x3::IfcRelDefines, OdIfc2x3::IfcRelDefinesByProperties, OdIfc2x3::IfcRelDefinesByType, OdIfc2x3::IfcRelFillsElement, OdIfc2x3::IfcRelFlowControlElements, OdIfc2x3::IfcRelInteractionRequirements, OdIfc2x3::IfcRelNests, OdIfc2x3::IfcRelOccupiesSpaces, OdIfc2x3::IfcRelOverridesProperties, OdIfc2x3::IfcRelProjectsElement, OdIfc2x3::IfcRelReferencedInSpatialStructure, OdIfc2x3::IfcRelSchedulesCostItems, OdIfc2x3::IfcRelSequence, OdIfc2x3::IfcRelServicesBuildings, OdIfc2x3::IfcRelSpaceBoundary, and OdIfc2x3::IfcRelVoidsElement.

The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:32:55