CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x2::IfcRelAggregates Class Reference

#include <IfcRelAggregatesAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcRelAggregates:
OdIfc4x2::IfcRelDecomposes OdIfc4x2::IfcRelationship OdIfc4x2::IfcRoot OdIfc4x2::OdIfc4x2Instance OdIfc::OdIfcInstance

Public Member Functions

const OdDAIObjectId & getRelatingObject () const
 
void setRelatingObject (const OdDAIObjectId &RelatingObject)
 
void getRelatedObjects (OdDAIObjectIds &RelatedObjects) const
 
OdDAI::SetOfOdDAIObjectId & relatedObjects ()
 
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 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 OdIfc4x2::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 OdIfc4x2::OdIfc4x2Instance
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_RelatingObject
 
OdDAI::SetOfOdDAIObjectId m_RelatedObjects
 
- Protected Attributes inherited from OdIfc4x2::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 aggregation relationship IfcRelAggregates is a special type of the general composition/decomposition (or whole/part) relationship IfcRelDecomposes. The aggregation relationship can be applied to all subtypes of IfcObjectDefinition. Decompositions imply a dependency, implying that the whole depends on the definition of the parts and the parts depend on the existence of the whole. The behavior that is implied from the dependency relationship has to be established inside the applications.

\changes

IFC4 changes: The attributes RelatingObject and RelatedObjects are demoted from the supertype IfcRelDecomposes.

Definition at line 49 of file Ifc4x2/IfcRelAggregatesAutoImpl.h.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRelDecomposes.

◆ getRelatedObjects()

void OdIfc4x2::IfcRelAggregates::getRelatedObjects ( OdDAIObjectIds & RelatedObjects) const

Returns the value of RelatedObjects attribute. This attribute represents the object definitions, either object occurrences or object types, that are being aggregated. They are defined as the parts in the whole/part relationship. No order is implied between the parts.

Parameters
RelatingObject[out] Receives the related objects.
Remarks
IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the non-ordered set of parts within the aggregation.

◆ getRelatingObject()

const OdDAIObjectId & OdIfc4x2::IfcRelAggregates::getRelatingObject ( ) const

Returns the value of RelatingObject attribute. This attribute represents the object definition, either an object type or an object occurrence, that represents the aggregation. It is the whole within the whole/part relationship.

Returns
Returns the value of RelatingObject attribute.
Remarks
IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the non-ordered aggregation relationship.

◆ inFields()

virtual OdResult OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

◆ isKindOf()

virtual bool OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRelDecomposes.

◆ outFields()

virtual OdResult OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

◆ relatedObjects()

OdDAI::SetOfOdDAIObjectId & OdIfc4x2::IfcRelAggregates::relatedObjects ( )

Returns the value of RelatedObjects attribute. This attribute represents the object definitions, either object occurrences or object types, that are being aggregated. They are defined as the parts in the whole/part relationship. No order is implied between the parts.

Returns
Returns the value of RelatedObjects attribute.
Remarks
IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the non-ordered set of parts within the aggregation.

◆ setInverseCounterParts()

virtual void OdIfc4x2::IfcRelAggregates::setInverseCounterParts ( )
overridevirtual

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

◆ setRelatingObject()

void OdIfc4x2::IfcRelAggregates::setRelatingObject ( const OdDAIObjectId & RelatingObject)

Sets the value of RelatingObject attribute. This attribute represents the object definition, either an object type or an object occurrence, that represents the aggregation. It is the whole within the whole/part relationship.

Parameters
RelatingObject[in] Relating object to set.
Remarks
IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the non-ordered aggregation relationship.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRelDecomposes.

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::IfcRelAggregates::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x2::IfcRoot.

◆ unsetAttr() [2/2]

virtual void OdIfc4x2::IfcRelAggregates::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 OdIfc4x2::IfcRoot.

Member Data Documentation

◆ m_RelatedObjects

OdDAI::SetOfOdDAIObjectId OdIfc4x2::IfcRelAggregates::m_RelatedObjects
protected

Definition at line 216 of file Ifc4x2/IfcRelAggregatesAutoImpl.h.

◆ m_RelatingObject

OdDAIObjectId OdIfc4x2::IfcRelAggregates::m_RelatingObject
protected

Definition at line 215 of file Ifc4x2/IfcRelAggregatesAutoImpl.h.


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