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

#include <IfcRelAssociatesAutoImpl.h>

Inheritance diagram for OdIfc4::IfcRelAssociates:
OdIfc4::IfcRelationship OdIfc4::IfcRoot OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance OdIfc4::IfcRelAssociatesApproval OdIfc4::IfcRelAssociatesClassification OdIfc4::IfcRelAssociatesConstraint OdIfc4::IfcRelAssociatesDocument OdIfc4::IfcRelAssociatesLibrary OdIfc4::IfcRelAssociatesMaterial

Public Member Functions

void getRelatedObjects (OdArray< OdDAI::Select > &RelatedObjects) const
 
void getRelatedObjectsWrapperArray (OdArray< IfcDefinitionSelect > &RelatedObjects) const
 
OdDAI::SetOfSelect & relatedObjects ()
 
 IfcRelAssociates ()
 
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

OdDAI::SetOfSelect m_RelatedObjects
 
- 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 association relationship IfcRelAssociates refers to sources of information (most notably a classification, library, document, approval, constraint, or material). The information associated can reside internally or externally of the project data. There is no dependency implied by the association.

EXAMPLE: Further external information can be provided to the tank equipment (as subtype of IfcProduct) in terms of its classification and instruction documents, the source of the additional information is held external to the project data model.

Association relationships can be established to objects (occurrences as subtypes of IfcObject) or to types (as subtypes of IfcTypeObject). Some associations (such as approval, or document) can also be applied to property templates (as subtypes of IfcPropertyDefinition). The association relationship establishes an association between one to many objects or property templates and the associated information. The subtypes of IfcRelAssociates establish the particular semantic meaning of the association relationship.

Remarks
EXAMPLE: The classification information for the storage tank equipment can be associated to the IfcTankType (subtype of IfcTypeObject), defining the specific information for all occurrences of that tank in the project. Therefore the association of the Uniclass notation 'L6814' can be associated by a subtype of IfcRelAssociates to the type information. EXAMPLE: The classification information for a particular space within a building can be associated to the IfcSpace object (subtype of IfcObject), defining a particular occurrence of space. Therefore the association of the DIN notation 'NF 1.5' can be associated by a subtype of IfcRelAssociates to the object.

\changes

IFC4 changes: Entity has been changed into an ABSTRACT supertype. Type of the RelatedObjects attribute changed from "set[1:?] of IfcRoot" to "set[1:?] of IfcDefinitionSelect".

Definition at line 64 of file Ifc4/IfcRelAssociatesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRelAssociates()

OdIfc4::IfcRelAssociates::IfcRelAssociates ( )

Default constructor for the IfcRelAssociates class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcRelAssociates::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::IfcRelationship.

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ getAttr() [1/2]

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ getAttr() [2/2]

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcRelAssociates::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::IfcRelationship.

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ getRelatedObjects()

void OdIfc4::IfcRelAssociates::getRelatedObjects ( OdArray< OdDAI::Select > & RelatedObjects) const

Returns the value of RelatedObjects attribute. This attribute represents a set of object or property definitions to which the external references or information is associated. It includes object and type objects, property set templates, property templates and property sets and contexts.

Parameters
RelatedObjects[out] Receives the related objects.
Remarks
IFC4 CHANGE: The attribute datatype has been changed from IfcRoot to IfcDefinitionSelect.

◆ getRelatedObjectsWrapperArray()

void OdIfc4::IfcRelAssociates::getRelatedObjectsWrapperArray ( OdArray< IfcDefinitionSelect > & RelatedObjects) const

Returns the value of RelatedObjects attribute. This attribute represents a set of object or property definitions to which the external references or information is associated. It includes object and type objects, property set templates, property templates and property sets and contexts.

Parameters
RelatedObjects[out] Receives the related objects.
Remarks
IFC4 CHANGE: The attribute datatype has been changed from IfcRoot to IfcDefinitionSelect.

◆ inFields()

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ isKindOf()

virtual bool OdIfc4::IfcRelAssociates::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::IfcRelationship.

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ outFields()

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ putAttr() [1/2]

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ putAttr() [2/2]

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ relatedObjects()

OdDAI::SetOfSelect & OdIfc4::IfcRelAssociates::relatedObjects ( )

Returns the value of RelatedObjects attribute. This attribute represents a set of object or property definitions to which the external references or information is associated. It includes object and type objects, property set templates, property templates and property sets and contexts.

Returns
Returns the value of RelatedObjects attribute.
Remarks
IFC4 CHANGE: The attribute datatype has been changed from IfcRoot to IfcDefinitionSelect.

◆ setInverseCounterParts()

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

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ testAttr() [1/2]

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcRelAssociates::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::IfcRelationship.

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ unsetAttr() [1/2]

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

◆ unsetAttr() [2/2]

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

Reimplemented in OdIfc4::IfcRelAssociatesApproval, OdIfc4::IfcRelAssociatesClassification, OdIfc4::IfcRelAssociatesConstraint, OdIfc4::IfcRelAssociatesDocument, OdIfc4::IfcRelAssociatesLibrary, and OdIfc4::IfcRelAssociatesMaterial.

Member Data Documentation

◆ m_RelatedObjects

OdDAI::SetOfSelect OdIfc4::IfcRelAssociates::m_RelatedObjects
protected

Definition at line 243 of file Ifc4/IfcRelAssociatesAutoImpl.h.


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