CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x3_rc1::IfcSpatialElement Class Reference

#include <IfcSpatialElementAutoImpl.h>

Inheritance diagram for OdIfc4x3_rc1::IfcSpatialElement:
OdIfc4x3_rc1::IfcProduct OdIfc4x3_rc1::IfcObject OdIfc4x3_rc1::IfcObjectDefinition OdIfc4x3_rc1::IfcRoot OdIfc4x3_rc1::OdIfc4x3_RC1Instance OdIfc::OdIfcInstance OdIfc4x3_rc1::IfcExternalSpatialStructureElement OdIfc4x3_rc1::IfcSpatialStructureElement OdIfc4x3_rc1::IfcSpatialZone OdIfc4x3_rc1::IfcExternalSpatialElement OdIfc4x3_rc1::IfcBuildingStorey OdIfc4x3_rc1::IfcFacility OdIfc4x3_rc1::IfcFacilityPart OdIfc4x3_rc1::IfcSite OdIfc4x3_rc1::IfcSpace OdIfc4x3_rc1::IfcBridge OdIfc4x3_rc1::IfcBuilding OdIfc4x3_rc1::IfcMarineFacility OdIfc4x3_rc1::IfcRailway OdIfc4x3_rc1::IfcRoad OdIfc4x3_rc1::IfcBridgePart

Public Member Functions

const OdAnsiString & getLongName () const
 
void setLongName (const OdAnsiString &LongName)
 
void getInvContainsElements (OdDAIObjectIds &ContainsElements) const
 
void getInvServicedBySystems (OdDAIObjectIds &ServicedBySystems) const
 
void getInvReferencesElements (OdDAIObjectIds &ReferencesElements) const
 
 IfcSpatialElement ()
 
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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::OdIfc4x3_RC1Instance
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

OdAnsiString m_LongName
 
- Protected Attributes inherited from OdIfc4x3_rc1::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc4x3_rc1::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4x3_rc1::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
 

Friends

class IfcRelContainedInSpatialStructure
 
class IfcRelServicesBuildings
 
class IfcRelReferencedInSpatialStructure
 

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 element is the generalization of all spatial elements that might be used to define a spatial structure or to define spatial zones.

A hierarchical spatial structure element as IfcSpatialStructureElement A spatial structure is a hierarchical decomposition of the project. That spatial structure is often used to provide a project structure to organize a building project. A spatial project structure might define as many levels of decomposition as necessary for the building project. Elements within the spatial project structure are site, building, storey, and space or alternatively, site, bridge and bridge part. A spatial zone as IfcSpatialZone A spatial zone is a non-hierarchical and potentially overlapping decomposition of the project under some functional consideration. A spatial zone might be used to represent a thermal zone, a lighting zone, a usable area zone. A spatial zone might be used to represent a horizontal spatial structure as used in civil works. A spatial zone might have its independent placement and shape representation.

Remarks
This definition cannot be instantiated.

Definition at line 55 of file Ifc4x3_RC1/IfcSpatialElementAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSpatialElement()

OdIfc4x3_rc1::IfcSpatialElement::IfcSpatialElement ( )

Default constructor for the IfcSpatialElement class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBridgePart, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcExternalSpatialStructureElement, OdIfc4x3_rc1::IfcFacility, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcRailway, OdIfc4x3_rc1::IfcRoad, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_rc1::IfcSpatialElement::getInstanceType ( ) const
overridevirtual

◆ getInvContainsElements()

void OdIfc4x3_rc1::IfcSpatialElement::getInvContainsElements ( OdDAIObjectIds & ContainsElements) const

Returns the value of ContainsElements attribute. This attribute represents set of spatial containment relationships, that holds those elements, which are contained within this element of the project spatial structure.

Parameters
ContainsElements[out] Receives the value of ContainsElements attribute.
Remarks
The spatial containment relationship, established by IfcRelContainedInSpatialStructure, is required to be an hierarchical relationship, where each element can only be assigned to 0 or 1 spatial structure element.

◆ getInvReferencesElements()

void OdIfc4x3_rc1::IfcSpatialElement::getInvReferencesElements ( OdDAIObjectIds & ReferencesElements) const

Returns the value of ReferencesElements attribute. This attribute represents a set of spatial reference relationships, that holds those elements, which are referenced, but not contained, within this element of the project spatial structure.

Parameters
ReferencesElements[out] Receives the value of ReferencesElements attribute.
Remarks
The spatial reference relationship, established by IfcRelReferencedInSpatialStructure, is not required to be an hierarchical relationship, i.e. each element can be assigned to 0, 1 or many spatial structure elements. IFC2x3 CHANGE: The inverse attribute has been added with upward compatibility for file-based exchange.

◆ getInvServicedBySystems()

void OdIfc4x3_rc1::IfcSpatialElement::getInvServicedBySystems ( OdDAIObjectIds & ServicedBySystems) const

Returns the value of ServicedBySystems attribute. This attribute represents a set of relationships to systems, that provides a certain service to the spatial element for which it is defined. The relationship is handled by the objectified relationship IfcRelServicesBuildings.

Parameters
ServicedBySystems[out] Receives the value of ServicedBySystems attribute.
Remarks
IFC4 CHANGE: The inverse attribute has been promoted to the new supertype IfcSpatialElement with upward compatibility for file-based exchange.

◆ getLongName()

const OdAnsiString & OdIfc4x3_rc1::IfcSpatialElement::getLongName ( ) const

Returns the value of LongName attribute. This attribute represents long name for a spatial structure element, used for informal purposes. It should be used, if available, in conjunction with the inherited Name attribute.

Returns
Returns the value of LongName attribute.
Remarks
In many scenarios the Name attribute refers to the short name or number of a spacial element, and the LongName refers to the full descriptive name.

◆ inFields()

virtual OdResult OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ isKindOf()

virtual bool OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBridgePart, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcExternalSpatialStructureElement, OdIfc4x3_rc1::IfcFacility, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcRailway, OdIfc4x3_rc1::IfcRoad, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ outFields()

virtual OdResult OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ putAttr() [1/2]

virtual bool OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ putAttr() [2/2]

virtual bool OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ setLongName()

void OdIfc4x3_rc1::IfcSpatialElement::setLongName ( const OdAnsiString & LongName)

Sets the value of LongName attribute. This attribute represents long name for a spatial structure element, used for informal purposes. It should be used, if available, in conjunction with the inherited Name attribute.

Parameters
LongName[in] Long name to set.
Remarks
In many scenarios the Name attribute refers to the short name or number of a spacial element, and the LongName refers to the full descriptive name.

◆ testAttr() [1/2]

virtual bool OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ testAttr() [2/2]

virtual bool OdIfc4x3_rc1::IfcSpatialElement::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 OdIfc4x3_rc1::IfcProduct.

Reimplemented in OdIfc4x3_rc1::IfcBridge, OdIfc4x3_rc1::IfcBuilding, OdIfc4x3_rc1::IfcBuildingStorey, OdIfc4x3_rc1::IfcExternalSpatialElement, OdIfc4x3_rc1::IfcFacilityPart, OdIfc4x3_rc1::IfcMarineFacility, OdIfc4x3_rc1::IfcSite, OdIfc4x3_rc1::IfcSpace, OdIfc4x3_rc1::IfcSpatialStructureElement, and OdIfc4x3_rc1::IfcSpatialZone.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_rc1::IfcSpatialElement::type ( ) const
overridevirtual

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_rc1::IfcSpatialElement::unsetAttr ( const char * explicitAttrName)
overridevirtual

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_rc1::IfcSpatialElement::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Friends And Related Symbol Documentation

◆ IfcRelContainedInSpatialStructure

friend class IfcRelContainedInSpatialStructure
friend

Definition at line 255 of file Ifc4x3_RC1/IfcSpatialElementAutoImpl.h.

◆ IfcRelReferencedInSpatialStructure

Definition at line 257 of file Ifc4x3_RC1/IfcSpatialElementAutoImpl.h.

◆ IfcRelServicesBuildings

friend class IfcRelServicesBuildings
friend

Definition at line 256 of file Ifc4x3_RC1/IfcSpatialElementAutoImpl.h.

Member Data Documentation

◆ m_LongName

OdAnsiString OdIfc4x3_rc1::IfcSpatialElement::m_LongName
protected

Definition at line 252 of file Ifc4x3_RC1/IfcSpatialElementAutoImpl.h.


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