CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
OdIfc::OdIfcCompound Class Reference

#include <IfcCompound.h>

Inheritance diagram for OdIfc::OdIfcCompound:
OdIfc::OdIfcCachedCompound OdIfc::OdIfcProfileDef OdIfc::OdIfcProductRepresentation OdIfc::OdIfcRepresentation OdIfc::OdIfcRepresentationItem OdIfc::OdIfcRepresentationMap OdIfc::OdIfcRoot OdIfc::OdIfcProductDefinitionShape OdIfc::OdIfcShapeRepresentation OdIfc::OdIfcGeometricRepresentationItem OdIfc::OdIfcMappedItem OdIfc::OdIfcTopologicalRepresentationItem OdIfc::OdIfcObjectDefinition OdIfc::OdIfcCurve OdIfc::OdIfcSegment OdIfc::OdIfcShellBasedSurfaceModel OdIfc::OdIfcConnectedFaceSet OdIfc::OdIfcProduct OdIfc::OdIfcProject OdIfc::OdIfcBoundedCurve OdIfc::OdIfcSpiral OdIfc::OdIfcCurveSegment OdIfc::OdIfcElement OdIfc::OdIfcSpatialStructureElement OdIfc::OdIfcCompositeCurve OdIfc::OdIfcBuilding OdIfc::OdIfcBuildingStorey OdIfc::OdIfcSite OdIfc::OdIfcGradientCurve OdIfc::OdIfcSegmentedReferenceCurve

Public Member Functions

void compose () override
 
OdIfcEntityType type ()
 
OdRxValue getAttr (const OdIfcAttribute attrDef) const
 
virtual OdRxValue getAttr (const OdAnsiString &attrName) const
 
OdIfcModel * owningModel () const
 
bool isKindOf (OdIfcEntityType type) const
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
const OdAnsiString & typeName ()
 
OdIfcFile * owningIfcFile () const
 
OdStepFile * owningStepFile () const override
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
virtual OdDbStub * ownerId () const
 
virtual void xmitPropagateModify ()
 

Static Public Member Functions

static const OdIfcInstance * earlyAccess (const OdIfcCompound *compound)
 

Protected Attributes

OdIfcInstance * m_pEntInst
 

Friends

class ::OdIfcEntResolver
 

Detailed Description

A class that implements working with an IFC compound object.

Definition at line 41 of file IfcCompound.h.

Member Function Documentation

◆ compose()

void OdIfc::OdIfcCompound::compose ( )
override

Composes the compound object into a specified model.

◆ earlyAccess()

static const OdIfcInstance * OdIfc::OdIfcCompound::earlyAccess ( const OdIfcCompound * compound)
inlinestatic

Retrieves the compound object's underlying IFC entity instance.

Parameters
compound[in] A raw pointer to the compound object.
Returns
A raw pointer to the IFC instance.

Definition at line 115 of file IfcCompound.h.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc::OdIfcCompound::getAttr ( const OdAnsiString & attrName) const
inlinevirtual

Retrieves the current value of an attribute specified by its name.

Parameters
attrName[in] An ANSI string that contains the attribute name.
Returns
The current value of the attribute.
Remarks
The method provides late binding access to the attribute value by its name. Attributes of select and aggregate data types are also supported.

Definition at line 82 of file IfcCompound.h.

◆ getAttr() [2/2]

OdRxValue OdIfc::OdIfcCompound::getAttr ( const OdIfcAttribute attrDef) const
inline

Retrieves the current value of an attribute specified by its definition.

Parameters
attrDef[in] A value of the <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdIfc__OdIfcAttribute.html>OdIfcAttribute</exref> OdIfcAttribute> enumeration that represents the attribute definition.
Returns
The current value of the attribute.
Remarks
The method provides late binding access to the attribute value by its definition. Attributes of select and aggregate data types are also supported.

Definition at line 72 of file IfcCompound.h.

◆ id()

virtual OdDbStub * OdIfc::OdIfcCompound::id ( ) const
inlinevirtual

Retrieves the identifier of the compound object's database.

Returns
A raw pointer to a stub object that provides access to the database.
Remarks
The method returns a NULL pointer if the compound object is not a persistent one.

Definition at line 147 of file IfcCompound.h.

◆ isInstanceOf()

bool OdIfc::OdIfcCompound::isInstanceOf ( OdIfcEntityType entityType) const
inline

Retrieves whether the compound object is an instance of a specified type.

Parameters
entityType[in] An instance of the <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdIfc__OdIfcEntityType.html>OdIfcEntityType</exref> OdIfcEntityType> enumeration that represents the entity type.
Returns
true if the compound object is an instance of the specified type; otherwise, the method returns false.

Definition at line 102 of file IfcCompound.h.

◆ isKindOf()

bool OdIfc::OdIfcCompound::isKindOf ( OdIfcEntityType type) const
inline

Retrieves whether the compound object belongs to a specified entity type.

Parameters
type[in] An entity type name.
Returns
true if the compound object belongs to the specified type; otherwise, the method returns false.

Definition at line 95 of file IfcCompound.h.

◆ isPersistent()

virtual bool OdIfc::OdIfcCompound::isPersistent ( ) const
inlinevirtual

Retrieves whether the compound object is a persistent one.

Returns
true if the compound object is a persistent one; otherwise, the method returns false.
Remarks
Persistent objects are database-resident objects (i.e., they are stored in a database).

Definition at line 139 of file IfcCompound.h.

◆ ownerId()

virtual OdDbStub * OdIfc::OdIfcCompound::ownerId ( ) const
virtual

Retrieves the identifier of the compound object's parent item.

Returns
A raw pointer to a stub object that provides access to the database.
Remarks
The method returns a NULL pointer if the compound object doesn't have parent item.

◆ owningIfcFile()

OdIfcFile * OdIfc::OdIfcCompound::owningIfcFile ( ) const

Retrieves the owning file for the IFC entity instance.

Returns
A raw pointer to the owning file.

◆ owningModel()

OdIfcModel * OdIfc::OdIfcCompound::owningModel ( ) const

Retrieves the model that currently owns the compound object.

Returns
A raw pointer to the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdIfcModel.html>OdIfcModel</exref> object representing the model that owns the entity.

◆ owningStepFile()

OdStepFile * OdIfc::OdIfcCompound::owningStepFile ( ) const
override

Retrieves the owning file for the STEP entity instance.

Returns
A raw pointer to the owning file.

◆ type()

OdIfcEntityType OdIfc::OdIfcCompound::type ( )

Retrieves the current type of the compound object.

Returns
An <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdIfc__OdIfcEntityType.html>OdIfcEntityType</exref> OdIfcEntityType> enumeration value that represents the current compound object type.

◆ typeName()

const OdAnsiString & OdIfc::OdIfcCompound::typeName ( )
inline

Retrieves the name of the current compound object's type.

Returns
An ANSI string value that contains the current compound object's type name.

Definition at line 108 of file IfcCompound.h.

◆ xmitPropagateModify()

virtual void OdIfc::OdIfcCompound::xmitPropagateModify ( )
virtual

Allows a OdIfcCompound of a complex object to notify its database object that it has been changed.

Friends And Related Symbol Documentation

◆ ::OdIfcEntResolver

friend class ::OdIfcEntResolver
friend

Definition at line 167 of file IfcCompound.h.

Member Data Documentation

◆ m_pEntInst

OdIfcInstance* OdIfc::OdIfcCompound::m_pEntInst
protected

Definition at line 48 of file IfcCompound.h.

The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:30:40