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

#include <IfcGroupAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcGroup:
OdIfc2x2_final::IfcObject OdIfc2x2_final::IfcRoot OdIfc2x2_final::OdIfc2x2_FinalInstance OdIfc::OdIfcInstance OdIfc2x2_final::IfcAsset OdIfc2x2_final::IfcCondition OdIfc2x2_final::IfcInventory OdIfc2x2_final::IfcStructuralLoadGroup OdIfc2x2_final::IfcStructuralResultGroup OdIfc2x2_final::IfcSystem OdIfc2x2_final::IfcZone OdIfc2x2_final::IfcElectricalCircuit OdIfc2x2_final::IfcStructuralAnalysisModel

Public Member Functions

OdDAIObjectId getInvIsGroupedBy () const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const 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::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- 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 Member Functions

virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Friends

class IfcRelAssignsToGroup
 

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)
 
- Protected Attributes inherited from OdIfc2x2_final::IfcObject
OdAnsiString m_ObjectType
 
- 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
 

Detailed Description

IfcGroup is an generalization of any arbitrary group. A group is a logical collection of objects. It does not have its own position, nor can it hold its own shape representation. Therefore a group is an aggregation under some non-geometrical / topological grouping aspects.

EXAMPLE: An example for a group is a system, since it groups elements under the aspect of their role, regardless of their position in a building. One of the most important usage of a group representing a system is the IfcDistributionSystem, that groups distribution components, such as space heaters and valves into a heating system.

A group can hold any collection of objects, the relationship IfcRelAssignsToGroup is used to establish the group collection. Objects within a group are products, processes, controls, resources, actors or other groups, thus groups can be nested. An object can be part of zero, one, or many groups. Grouping relationships are not required to be hierarchical nor do they imply a dependency. Groups are assigned to other objects (such as a process or a resource) by the relationship object that refers to the corresponding object: Process: assigned using IfcRelAssignsToProcess Resource: assigned using IfcRelAssignsToResource Controls: affecting the group using IfcRelAssignsToControl

A group can be exchanged without having already objects within the group collection. IfcGroup does not define an own object coordinate system, nor does it have an independent shape representation.

Definition at line 57 of file Ifc2x2_Final/IfcGroupAutoImpl.h.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcObject::getAttr ( const char * attrName) const
overrideprotectedvirtual

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::IfcObject.

Reimplemented in OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ getAttr() [2/2]

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcGroup::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::IfcObject.

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcCondition, OdIfc2x2_final::IfcElectricalCircuit, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, OdIfc2x2_final::IfcSystem, and OdIfc2x2_final::IfcZone.

◆ getInvIsGroupedBy()

OdDAIObjectId OdIfc2x2_final::IfcGroup::getInvIsGroupedBy ( ) const

Returns the value of IsGroupedBy attribute. This attribute represents reference to the relationship IfcRelAssignsToGroup that assigns the one to many group members to the IfcGroup object.

Parameters
IsGroupedBy[out] Receives the value of IsGroupedBy attribute.
Remarks
IFC4 CHANGE: The cardinality has been changed from 1..1 to 0..? in order to allow the exchange of a group concept without having already group members assigned. It now also allows the use of many instances of IfcRelAssignsToGroup to assign the group members. The change has been done with upward compatibility for file based exchange.

◆ inFields()

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ isKindOf()

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcCondition, OdIfc2x2_final::IfcElectricalCircuit, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, OdIfc2x2_final::IfcSystem, and OdIfc2x2_final::IfcZone.

◆ outFields()

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcObject::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overrideprotectedvirtual

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::IfcObject.

Reimplemented in OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ putAttr() [2/2]

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ testAttr() [1/2]

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcGroup::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::IfcObject.

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcCondition, OdIfc2x2_final::IfcElectricalCircuit, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, OdIfc2x2_final::IfcSystem, and OdIfc2x2_final::IfcZone.

◆ unsetAttr() [1/2]

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

◆ unsetAttr() [2/2]

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

Reimplemented in OdIfc2x2_final::IfcAsset, OdIfc2x2_final::IfcInventory, OdIfc2x2_final::IfcStructuralAnalysisModel, OdIfc2x2_final::IfcStructuralLoadGroup, OdIfc2x2_final::IfcStructuralResultGroup, and OdIfc2x2_final::IfcSystem.

Friends And Related Symbol Documentation

◆ IfcRelAssignsToGroup

friend class IfcRelAssignsToGroup
friend

Definition at line 176 of file Ifc2x2_Final/IfcGroupAutoImpl.h.


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