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

#include <IfcRelAssignsAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcRelAssigns:
OdIfc2x2_final::IfcRelationship OdIfc2x2_final::IfcRoot OdIfc2x2_final::OdIfc2x2_FinalInstance OdIfc::OdIfcInstance OdIfc2x2_final::IfcRelAssignsToActor OdIfc2x2_final::IfcRelAssignsToControl OdIfc2x2_final::IfcRelAssignsToGroup OdIfc2x2_final::IfcRelAssignsToProcess OdIfc2x2_final::IfcRelAssignsToProduct OdIfc2x2_final::IfcRelAssignsToResource OdIfc2x2_final::IfcRelOccupiesSpaces OdIfc2x2_final::IfcRelAssignsTasks OdIfc2x2_final::IfcRelAssignsToProjectOrder OdIfc2x2_final::IfcRelSchedulesCostItems

Public Member Functions

void getRelatedObjects (OdDAIObjectIds &RelatedObjects) const
 
OdDAI::SetOfOdDAIObjectId & relatedObjects ()
 
IfcObjectTypeEnum getRelatedObjectsType () const
 
void setRelatedObjectsType (IfcObjectTypeEnum RelatedObjectsType)
 
 IfcRelAssigns ()
 
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

OdDAI::SetOfOdDAIObjectId m_RelatedObjects
 
OdDAI::Enum m_RelatedObjectsType
 
- 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 assignment relationship, IfcRelAssigns, is a generalization of "link" relationships among instances of IfcObject and its various 1st level subtypes. A link denotes the specific association through which one object (the client) applies the services of other objects (the suppliers), or through which one object can navigate to other objects.

The client is denoted as the relating object and is established at the level of the specific, instantiable subtypes of IfcRelAssigns. The suppliers are denoted as the related objects and they are established by the RelatedObjects attribute.

Remarks
The terms "client" and "supplier" are used in a general concept and do not imply any meaning for implementations of systems (like client-server). EXAMPLE: A resource can receive information about its nature of representing real building products by establishing a link between IfcResource and IfcBuildingElement (subtype of IfcProduct) through the assignment relationship IfcRelAssignsToResource. The resource is then the client that applies the services of other objects (here building elements) to express the particular view of elements to be consumed as a resource in a process.

Definition at line 51 of file Ifc2x2_Final/IfcRelAssignsAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRelAssigns()

OdIfc2x2_final::IfcRelAssigns::IfcRelAssigns ( )

Default constructor for the IfcRelAssigns class.

Member Function Documentation

◆ getAttr() [1/2]

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

◆ getAttr() [2/2]

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcRelAssigns::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::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, OdIfc2x2_final::IfcRelAssignsToProjectOrder, OdIfc2x2_final::IfcRelAssignsToResource, OdIfc2x2_final::IfcRelOccupiesSpaces, and OdIfc2x2_final::IfcRelSchedulesCostItems.

◆ getRelatedObjects()

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

Returns the value of RelatedObjects attribute. RelatedObjects attribute represents related objects which are assigned to a single object. The type of the single (or relating) object is defined in the subtypes of IfcRelAssigns.

Parameters
RelatedObjects[out] Reveives the RelatedObjects attribute.

◆ getRelatedObjectsType()

IfcObjectTypeEnum OdIfc2x2_final::IfcRelAssigns::getRelatedObjectsType ( ) const

Returns the value of RelatedObjectsType attribute. RelatedObjectsType is particular type of the assignment relationship. It can constrain the applicable object types, used within the role of RelatedObjects.

Returns
Returns the value of RelatedObjectsType attribute.
Remarks
IFC4 CHANGE: The attribute is deprecated.

◆ inFields()

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcRelAssigns::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::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, OdIfc2x2_final::IfcRelAssignsToProjectOrder, OdIfc2x2_final::IfcRelAssignsToResource, OdIfc2x2_final::IfcRelOccupiesSpaces, and OdIfc2x2_final::IfcRelSchedulesCostItems.

◆ outFields()

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

◆ putAttr() [1/2]

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

◆ putAttr() [2/2]

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

◆ relatedObjects()

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

Returns the value of RelatedObjects attribute. RelatedObjects attribute represents related objects which are assigned to a single object. The type of the single (or relating) object is defined in the subtypes of IfcRelAssigns.

Returns
Returns the value of RelatedObjects attribute.

◆ setRelatedObjectsType()

void OdIfc2x2_final::IfcRelAssigns::setRelatedObjectsType ( IfcObjectTypeEnum RelatedObjectsType)

Sets the value of RelatedObjectsType attribute. RelatedObjectsType is particular type of the assignment relationship. It can constrain the applicable object types, used within the role of RelatedObjects.

Parameters
RelatedObjectsType[in] RelatedObjectsType to set.
Remarks
IFC4 CHANGE: The attribute is deprecated.

◆ testAttr() [1/2]

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcRelAssigns::type ( ) const
overridevirtual

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Reimplemented in OdIfc2x2_final::IfcRelAssignsTasks, OdIfc2x2_final::IfcRelAssignsToActor, OdIfc2x2_final::IfcRelAssignsToControl, OdIfc2x2_final::IfcRelAssignsToGroup, OdIfc2x2_final::IfcRelAssignsToProcess, OdIfc2x2_final::IfcRelAssignsToProduct, and OdIfc2x2_final::IfcRelAssignsToResource.

Member Data Documentation

◆ m_RelatedObjects

OdDAI::SetOfOdDAIObjectId OdIfc2x2_final::IfcRelAssigns::m_RelatedObjects
protected

Definition at line 209 of file Ifc2x2_Final/IfcRelAssignsAutoImpl.h.

◆ m_RelatedObjectsType

OdDAI::Enum OdIfc2x2_final::IfcRelAssigns::m_RelatedObjectsType
protected

Definition at line 210 of file Ifc2x2_Final/IfcRelAssignsAutoImpl.h.


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