CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcSpatialStructureElement Class Reference

#include <IfcSpatialStructureElementAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcSpatialStructureElement:
OdIfc4x4::IfcSpatialElement OdIfc4x4::IfcProduct OdIfc4x4::IfcObject OdIfc4x4::IfcObjectDefinition OdIfc4x4::IfcRoot OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance OdIfc4x4::IfcBuildingStorey OdIfc4x4::IfcFacility OdIfc4x4::IfcFacilityPart OdIfc4x4::IfcSite OdIfc4x4::IfcSpace OdIfc4x4::IfcBridge OdIfc4x4::IfcBuilding OdIfc4x4::IfcMarineFacility OdIfc4x4::IfcRailway OdIfc4x4::IfcRoad OdIfc4x4::IfcTunnel OdIfc4x4::IfcBridgePart OdIfc4x4::IfcFacilityPartCommon OdIfc4x4::IfcMarinePart OdIfc4x4::IfcRailwayPart OdIfc4x4::IfcRoadPart OdIfc4x4::IfcTunnelPart

Public Member Functions

IfcElementCompositionEnum getCompositionType () const
 
void setCompositionType (IfcElementCompositionEnum CompositionType)
 
 IfcSpatialStructureElement ()
 
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 OdIfc4x4::IfcSpatialElement
const OdAnsiString & getLongName () const
 
void setLongName (const OdAnsiString &LongName)
 
void getInvContainsElements (OdDAIObjectIds &ContainsElements) const
 
void getInvServicedBySystems (OdDAIObjectIds &ServicedBySystems) const
 
void getInvReferencesElements (OdDAIObjectIds &ReferencesElements) const
 
void getInvIsInterferedByElements (OdDAIObjectIds &IsInterferedByElements) const
 
void getInvInterferesElements (OdDAIObjectIds &InterferesElements) const
 
 IfcSpatialElement ()
 
- Public Member Functions inherited from OdIfc4x4::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
void getInvPositionedRelativeTo (OdDAIObjectIds &PositionedRelativeTo) const
 
void getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const
 
virtual void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc4x4::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const
 
void getInvDeclares (OdDAIObjectIds &Declares) const
 
void getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc4x4::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvNests (OdDAIObjectIds &Nests) const
 
void getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const
 
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc4x4::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 OdIfc4x4::OdIFC4X4Instance
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_CompositionType
 
- Protected Attributes inherited from OdIfc4x4::IfcSpatialElement
OdAnsiString m_LongName
 
- Protected Attributes inherited from OdIfc4x4::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc4x4::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4x4::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

A spatial structure element is the generalization of all spatial elements that can be used to define a spatial structure. That spatial structure tipically provides a project structure to organize a building project.

A spatial project structure can define as many levels of decomposition as necessary for the building project. Elements within the spatial project structure are: site as IfcSite facility as IfcFacility, or specifically building as IfcBuilding bridge as IfcBridge marine facility as IfcMarineFacility railway as IfcRailway road as IfcRoad facility part as IfcFacilityPart, or specifically storey as IfcBuildingStorey facility part as IfcFacilityPart space as IfcSpace

Also elements can be aggregations or parts of items from the list above. The composition type declares an element to be either an element itself, or an aggregation (complex) or a decomposition (part). The interpretation of these types is specified at each subtype of IfcSpatialStructureElement.

The image below shows the use of IfcRelAggregates to establish a spatial structure including site, building, building section and storey.

<IMAGE ifcspatialstructureelement-spatialstructure>

Remarks
This definition may not be instantiated.

Definition at line 66 of file IFC4X4/IfcSpatialStructureElementAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSpatialStructureElement()

OdIfc4x4::IfcSpatialStructureElement::IfcSpatialStructureElement ( )

Default constructor for the IfcSpatialStructureElement class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcSpatialStructureElement::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 OdIfc4x4::IfcSpatialElement.

Reimplemented in OdIfc4x4::IfcBridge, OdIfc4x4::IfcBridgePart, OdIfc4x4::IfcBuilding, OdIfc4x4::IfcBuildingStorey, OdIfc4x4::IfcFacility, OdIfc4x4::IfcFacilityPart, OdIfc4x4::IfcFacilityPartCommon, OdIfc4x4::IfcMarineFacility, OdIfc4x4::IfcMarinePart, OdIfc4x4::IfcRailway, OdIfc4x4::IfcRailwayPart, OdIfc4x4::IfcRoad, OdIfc4x4::IfcRoadPart, OdIfc4x4::IfcSite, OdIfc4x4::IfcSpace, OdIfc4x4::IfcTunnel, and OdIfc4x4::IfcTunnelPart.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcSpatialStructureElement::getAttr ( const char * attrName) const
overridevirtual

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcSpatialStructureElement::getAttr ( const OdIfc::OdIfcAttribute attrDef) const
overridevirtual

◆ getCompositionType()

IfcElementCompositionEnum OdIfc4x4::IfcSpatialStructureElement::getCompositionType ( ) const

Returns the value of CompositionType attribute. This attribute indicates whether the predefined spatial structure element represents itself, or an aggregate (complex) or a part (part). The interpretation is specified separately for each subtype of spatial structure element. If no CompositionType is asserted, the dafault value 'ELEMENT' applies.

Returns
Returns the value of CompositionType attribute.
Remarks
IFC4 CHANGE: Attribute made optional.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcSpatialStructureElement::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 OdIfc4x4::IfcSpatialElement.

Reimplemented in OdIfc4x4::IfcBridge, OdIfc4x4::IfcBridgePart, OdIfc4x4::IfcBuilding, OdIfc4x4::IfcBuildingStorey, OdIfc4x4::IfcFacility, OdIfc4x4::IfcFacilityPart, OdIfc4x4::IfcFacilityPartCommon, OdIfc4x4::IfcMarineFacility, OdIfc4x4::IfcMarinePart, OdIfc4x4::IfcRailway, OdIfc4x4::IfcRailwayPart, OdIfc4x4::IfcRoad, OdIfc4x4::IfcRoadPart, OdIfc4x4::IfcSite, OdIfc4x4::IfcSpace, OdIfc4x4::IfcTunnel, and OdIfc4x4::IfcTunnelPart.

◆ inFields()

virtual OdResult OdIfc4x4::IfcSpatialStructureElement::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 OdIfc4x4::IfcSpatialElement.

Reimplemented in OdIfc4x4::IfcBridge, OdIfc4x4::IfcBridgePart, OdIfc4x4::IfcBuilding, OdIfc4x4::IfcBuildingStorey, OdIfc4x4::IfcFacilityPart, OdIfc4x4::IfcFacilityPartCommon, OdIfc4x4::IfcMarineFacility, OdIfc4x4::IfcMarinePart, OdIfc4x4::IfcRailway, OdIfc4x4::IfcRailwayPart, OdIfc4x4::IfcRoad, OdIfc4x4::IfcRoadPart, OdIfc4x4::IfcSite, OdIfc4x4::IfcSpace, OdIfc4x4::IfcTunnel, and OdIfc4x4::IfcTunnelPart.

◆ isKindOf()

virtual bool OdIfc4x4::IfcSpatialStructureElement::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 OdIfc4x4::IfcSpatialElement.

Reimplemented in OdIfc4x4::IfcBridge, OdIfc4x4::IfcBridgePart, OdIfc4x4::IfcBuilding, OdIfc4x4::IfcBuildingStorey, OdIfc4x4::IfcFacility, OdIfc4x4::IfcFacilityPart, OdIfc4x4::IfcFacilityPartCommon, OdIfc4x4::IfcMarineFacility, OdIfc4x4::IfcMarinePart, OdIfc4x4::IfcRailway, OdIfc4x4::IfcRailwayPart, OdIfc4x4::IfcRoad, OdIfc4x4::IfcRoadPart, OdIfc4x4::IfcSite, OdIfc4x4::IfcSpace, OdIfc4x4::IfcTunnel, and OdIfc4x4::IfcTunnelPart.

◆ outFields()

virtual OdResult OdIfc4x4::IfcSpatialStructureElement::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 OdIfc4x4::IfcSpatialElement.

Reimplemented in OdIfc4x4::IfcBridge, OdIfc4x4::IfcBridgePart, OdIfc4x4::IfcBuilding, OdIfc4x4::IfcBuildingStorey, OdIfc4x4::IfcFacilityPart, OdIfc4x4::IfcFacilityPartCommon, OdIfc4x4::IfcMarineFacility, OdIfc4x4::IfcMarinePart, OdIfc4x4::IfcRailway, OdIfc4x4::IfcRailwayPart, OdIfc4x4::IfcRoad, OdIfc4x4::IfcRoadPart, OdIfc4x4::IfcSite, OdIfc4x4::IfcSpace, OdIfc4x4::IfcTunnel, and OdIfc4x4::IfcTunnelPart.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcSpatialStructureElement::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 OdIfc4x4::IfcSpatialElement.

Reimplemented in OdIfc4x4::IfcBridge, OdIfc4x4::IfcBridgePart, OdIfc4x4::IfcBuilding, OdIfc4x4::IfcBuildingStorey, OdIfc4x4::IfcFacilityPart, OdIfc4x4::IfcFacilityPartCommon, OdIfc4x4::IfcMarineFacility, OdIfc4x4::IfcMarinePart, OdIfc4x4::IfcRailway, OdIfc4x4::IfcRailwayPart, OdIfc4x4::IfcRoad, OdIfc4x4::IfcRoadPart, OdIfc4x4::IfcSite, OdIfc4x4::IfcSpace, OdIfc4x4::IfcTunnel, and OdIfc4x4::IfcTunnelPart.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcSpatialStructureElement::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 OdIfc4x4::IfcSpatialElement.

Reimplemented in OdIfc4x4::IfcBridge, OdIfc4x4::IfcBridgePart, OdIfc4x4::IfcBuilding, OdIfc4x4::IfcBuildingStorey, OdIfc4x4::IfcFacilityPart, OdIfc4x4::IfcFacilityPartCommon, OdIfc4x4::IfcMarineFacility, OdIfc4x4::IfcMarinePart, OdIfc4x4::IfcRailway, OdIfc4x4::IfcRailwayPart, OdIfc4x4::IfcRoad, OdIfc4x4::IfcRoadPart, OdIfc4x4::IfcSite, OdIfc4x4::IfcSpace, OdIfc4x4::IfcTunnel, and OdIfc4x4::IfcTunnelPart.

◆ setCompositionType()

void OdIfc4x4::IfcSpatialStructureElement::setCompositionType ( IfcElementCompositionEnum CompositionType)

Sets the value of CompositionType attribute. This attribute indicates whether the predefined spatial structure element represents itself, or an aggregate (complex) or a part (part). The interpretation is specified separately for each subtype of spatial structure element. If no CompositionType is asserted, the dafault value 'ELEMENT' applies.

Parameters
CompositionType[in] Composition type to set.
Remarks
IFC4 CHANGE: Attribute made optional.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcSpatialStructureElement::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 OdIfc4x4::IfcSpatialElement.

Reimplemented in OdIfc4x4::IfcBridge, OdIfc4x4::IfcBridgePart, OdIfc4x4::IfcBuilding, OdIfc4x4::IfcBuildingStorey, OdIfc4x4::IfcFacilityPart, OdIfc4x4::IfcFacilityPartCommon, OdIfc4x4::IfcMarineFacility, OdIfc4x4::IfcMarinePart, OdIfc4x4::IfcRailway, OdIfc4x4::IfcRailwayPart, OdIfc4x4::IfcRoad, OdIfc4x4::IfcRoadPart, OdIfc4x4::IfcSite, OdIfc4x4::IfcSpace, OdIfc4x4::IfcTunnel, and OdIfc4x4::IfcTunnelPart.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcSpatialStructureElement::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef) const
overridevirtual

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcSpatialStructureElement::type ( ) const
overridevirtual

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcSpatialStructureElement::unsetAttr ( const char * explicitAttrName)
overridevirtual

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcSpatialStructureElement::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Member Data Documentation

◆ m_CompositionType

OdDAI::Enum OdIfc4x4::IfcSpatialStructureElement::m_CompositionType
protected

Definition at line 232 of file IFC4X4/IfcSpatialStructureElementAutoImpl.h.


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