CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x2_final::IfcRelDecomposes Class Reference

#include <IfcRelDecomposesAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcRelDecomposes:
OdIfc2x2_final::IfcRelationship OdIfc2x2_final::IfcRoot OdIfc2x2_final::OdIfc2x2_FinalInstance OdIfc::OdIfcInstance OdIfc2x2_final::IfcRelAggregates OdIfc2x2_final::IfcRelNests

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 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 OdIfc2x2_final::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 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 OdIfc2x2_final::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 decomposition relationship, IfcRelDecomposes, defines the general concept of elements being composed or decomposed. The decomposition relationship denotes a whole/part hierarchy with the ability to navigate from the whole (the composition) to the parts and vice versa. Decompositions can be constrained by requiring both, the whole and its parts, to be of the same type - thus establishing a nesting relationship. Or they can require some form of physical containment, thus establishing special types of aggregation relationships.

EXAMPLE: A cost element is a nest of other cost elements. Or a structural frame is an aggregation of beams and columns. Both are applications of decomposition relationship.

Decompositions imply a dependency, i.e. the definition of the whole depends on the definition of the parts and the parts depend on the existence of the whole. The decomposition relationship can be applied in a recursive manner, i.e. a decomposed element can be part in another decomposition. Cyclic references have to be prevented at application level.

Remarks
There are two special names for decomposition, which are linguistically distinguished, nesting and aggregation. The subtypes of IfcRelDecomposes will introduce either the nesting or aggregation convention (see IfcRelNests and IfcRelAggregates).

Definition at line 54 of file Ifc2x2_Final/IfcRelDecomposesAutoImpl.h.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRelationship.

Reimplemented in OdIfc2x2_final::IfcRelAggregates, and OdIfc2x2_final::IfcRelNests.

◆ getRelatedObjects()

void OdIfc2x2_final::IfcRelDecomposes::getRelatedObjects ( OdDAIObjectIds & RelatedObjects) const

Sets the value of RelatedObjects attribute. This attribute represents the part within the whole/part relationship.

Parameters
RelatedObjects[out] Receives the related objects.

◆ getRelatingObject()

const OdDAIObjectId & OdIfc2x2_final::IfcRelDecomposes::getRelatingObject ( ) const

Returns the value of RelatingObject attribute. This attribute represents the whole within the whole/part relationship.

Returns
Returns the value of RelatingObject attribute.

◆ inFields()

virtual OdResult OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRelationship.

Reimplemented in OdIfc2x2_final::IfcRelAggregates, and OdIfc2x2_final::IfcRelNests.

◆ outFields()

virtual OdResult OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

◆ relatedObjects()

OdDAI::SetOfOdDAIObjectId & OdIfc2x2_final::IfcRelDecomposes::relatedObjects ( )

Returns the value of RelatedObjects attribute. This attribute represents the part within the whole/part relationship.

Returns
Returns the value of RelatingObject attribute.

◆ setRelatingObject()

void OdIfc2x2_final::IfcRelDecomposes::setRelatingObject ( const OdDAIObjectId & RelatingObject)

Sets the value of RelatingObject attribute. This attribute represents the whole within the whole/part relationship.

Parameters
RelatingObject[in] Relating object to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

◆ testAttr() [2/2]

virtual bool OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRelationship.

Reimplemented in OdIfc2x2_final::IfcRelAggregates, and OdIfc2x2_final::IfcRelNests.

◆ unsetAttr() [1/2]

virtual void OdIfc2x2_final::IfcRelDecomposes::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x2_final::IfcRoot.

◆ unsetAttr() [2/2]

virtual void OdIfc2x2_final::IfcRelDecomposes::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 OdIfc2x2_final::IfcRoot.

Member Data Documentation

◆ m_RelatedObjects

OdDAI::SetOfOdDAIObjectId OdIfc2x2_final::IfcRelDecomposes::m_RelatedObjects
protected

Definition at line 204 of file Ifc2x2_Final/IfcRelDecomposesAutoImpl.h.

◆ m_RelatingObject

OdDAIObjectId OdIfc2x2_final::IfcRelDecomposes::m_RelatingObject
protected

Definition at line 203 of file Ifc2x2_Final/IfcRelDecomposesAutoImpl.h.


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