CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcElementAssembly Class Reference

#include <IfcElementAssemblyAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcElementAssembly:
OdIfc2x3::IfcElement OdIfc2x3::IfcProduct OdIfc2x3::IfcObject OdIfc2x3::IfcObjectDefinition OdIfc2x3::IfcRoot OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

IfcAssemblyPlaceEnum getAssemblyPlace () const
 
void setAssemblyPlace (IfcAssemblyPlaceEnum AssemblyPlace)
 
IfcElementAssemblyTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcElementAssemblyTypeEnum PredefinedType)
 
 IfcElementAssembly ()
 
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 bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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 OdIfc2x3::IfcElement
const OdAnsiString & getTag () const
 
void setTag (const OdAnsiString &Tag)
 
void getInvHasStructuralMember (OdDAIObjectIds &HasStructuralMember) const
 
void getInvFillsVoids (OdDAIObjectIds &FillsVoids) const
 
void getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const
 
void getInvHasCoverings (OdDAIObjectIds &HasCoverings) const
 
void getInvHasProjections (OdDAIObjectIds &HasProjections) const
 
void getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const
 
void getInvHasPorts (OdDAIObjectIds &HasPorts) const
 
void getInvHasOpenings (OdDAIObjectIds &HasOpenings) const
 
void getInvIsConnectionRealization (OdDAIObjectIds &IsConnectionRealization) const
 
void getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const
 
void getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
 IfcElement ()
 
- Public Member Functions inherited from OdIfc2x3::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
virtual void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc2x3::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x3::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
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

OdDAI::Enum m_AssemblyPlace
 
OdDAI::Enum m_PredefinedType
 
- Protected Attributes inherited from OdIfc2x3::IfcElement
OdAnsiString m_Tag
 
- Protected Attributes inherited from OdIfc2x3::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x3::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 IfcElementAssembly represents complex element assemblies aggregated from several elements, such as discrete elements, building elements, or other elements. The geometry of an IfcElementAssembly is generally formed from its components, in which case it does not need to have an explicit geometric representation. In some cases it can be useful to also expose an own explicit representation of the aggregate.

  • Aggregation - The IfcElementAssembly represents an aggregate, i.e. it should have other elements of IfcElement subtypes as contained (sub)parts.

    The IfcElementAssembly is an aggregate i.e. being composed by other elements and acting as an assembly using the objectified relationship IfcRelAggregates, referring to it by its inverse attribute SELF\IfcObjectDefinition.IsDecomposedBy. Components of an assembly are described by instances of subtypes of IfcElement. In this case, the contained subtypes of IfcElement is not additionally contained in the project spatial hierarchy, i.e. the inverse attribute SELF\IfcElement.ContainedInStructure of those IfcElement's should be NIL.

The image below illustrates spatial containment and element aggregation relationships:

<IMAGE ifcelementassembly-containment>

  • Spatial Containment - The Spatial Containment concept template applies to this entity as shown in the table below:
    RelatingStructure

Description IfcBuildingStorey Default spatial container IfcBuilding Spatial container for element assemblies not assignable to a building storey IfcSite Spatial container for element assemblies that are placed on site (outside of building)

The IfcElementAssembly should have a relationship for its containment in the hierarchical spatial structure of the project. Only if the IfcElementAssembly is itself a part of another assembly this relationship should be omitted.

Remarks
The IfcElementAssembly is a general purpose entity that is required to be decomposed. Also other subtypes of IfcElement can be decomposed. The assembly structure can be nested, i.e. an IfcElementAssembly could be an aggregated part within another IfcElementAssembly. View definitions and/or implementer agreements can restrict the number of allowed levels of nesting. View definitions or implementer agreements can further constrain the applicability of certain shape representations at the IfcElementAssembly in respect of the shape representations of its parts.

Definition at line 75 of file Ifc2x3/IfcElementAssemblyAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcElementAssembly()

OdIfc2x3::IfcElementAssembly::IfcElementAssembly ( )

Default constructor for the IfcElementAssembly class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcElementAssembly::comparedToEarlyImpl ( const OdDAI::ApplicationInstance * pOther,
OdRx::Ordering & ordering ) const
overridevirtual

Early-bound version of instances comparison.

Parameters
pOther[in] Other application instance.
ordering[out] Receives the ordering (comparison) status.
Returns
true if comparison was performed, false if method has no implementation, so late-bound version could be applied.
Remarks
If the method returns true, the ordering parameter can receive one of the following statuses:
Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

Reimplemented from OdIfc2x3::IfcElement.

◆ getAssemblyPlace()

IfcAssemblyPlaceEnum OdIfc2x3::IfcElementAssembly::getAssemblyPlace ( ) const

Returns the value of AssemblyPlace attribute. This attribute represents a designation of where the assembly is intended to take place defined by an enumeration value.

Returns
Returns the value of AssemblyPlace attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ getPredefinedType()

IfcElementAssemblyTypeEnum OdIfc2x3::IfcElementAssembly::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents a list of types to further identify the object. Some property sets can be specifically applicable to one of these types.

Returns
Returns the value of PredefinedType attribute.
Remarks
If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not used.

◆ inFields()

virtual OdResult OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ isKindOf()

virtual bool OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ outFields()

virtual OdResult OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ setAssemblyPlace()

void OdIfc2x3::IfcElementAssembly::setAssemblyPlace ( IfcAssemblyPlaceEnum AssemblyPlace)

Sets the value of AssemblyPlace attribute. This attribute represents a designation of where the assembly is intended to take place defined by an enumeration value.

Parameters
AssemblyPlace[in] Assembly place to set.

◆ setPredefinedType()

void OdIfc2x3::IfcElementAssembly::setPredefinedType ( IfcElementAssemblyTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents a list of types to further identify the object. Some property sets can be specifically applicable to one of these types.

Parameters
PredefinedType[in] Predefined type to set.
Remarks
If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not used.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcElementAssembly::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x3::IfcElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcElementAssembly::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 OdIfc2x3::IfcElement.

Member Data Documentation

◆ m_AssemblyPlace

OdDAI::Enum OdIfc2x3::IfcElementAssembly::m_AssemblyPlace
protected

Definition at line 254 of file Ifc2x3/IfcElementAssemblyAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc2x3::IfcElementAssembly::m_PredefinedType
protected

Definition at line 255 of file Ifc2x3/IfcElementAssemblyAutoImpl.h.


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