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

#include <IfcRelSpaceBoundaryAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcRelSpaceBoundary:
OdIfc4x4::IfcRelConnects OdIfc4x4::IfcRelationship OdIfc4x4::IfcRoot OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance OdIfc4x4::IfcRelSpaceBoundary1stLevel OdIfc4x4::IfcRelSpaceBoundary2ndLevel

Public Member Functions

IfcSpaceBoundarySelect relatingSpace ()
 
const OdDAIObjectId & getRelatedBuildingElement () const
 
void setRelatedBuildingElement (const OdDAIObjectId &RelatedBuildingElement)
 
const OdDAIObjectId & getConnectionGeometry () const
 
void setConnectionGeometry (const OdDAIObjectId &ConnectionGeometry)
 
IfcPhysicalOrVirtualEnum getPhysicalOrVirtualBoundary () const
 
void setPhysicalOrVirtualBoundary (IfcPhysicalOrVirtualEnum PhysicalOrVirtualBoundary)
 
IfcInternalOrExternalEnum getInternalOrExternalBoundary () const
 
void setInternalOrExternalBoundary (IfcInternalOrExternalEnum InternalOrExternalBoundary)
 
 IfcRelSpaceBoundary ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void setInverseCounterParts () 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::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::Select m_RelatingSpace
 
OdDAIObjectId m_RelatedBuildingElement
 
OdDAIObjectId m_ConnectionGeometry
 
OdDAI::Enum m_PhysicalOrVirtualBoundary
 
OdDAI::Enum m_InternalOrExternalBoundary
 
- 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

The space boundary defines the physical or virtual delimiter of a space by the relationship IfcRelSpaceBoundary to the surrounding elements.

The IfcRelSpaceBoundary is defined as an objectified relationship that handles the element to space relationship by objectifying the relationship between an element and the space it bounds. It is given as a one-to-one relationship, but allows each element (including virtual elements and openings) to define many such relationship and each space to be defined by many such relationships.

1st level space boundary: defined as boundaries of the space, not taking into account any change in building element or spaces on the other side. 2nd level space boundary: defined as boundary taking any change in building element or spaces on the other side into account. It can be further distinguished into: 2nd level type A: There is a space on the other side. 2nd level type B: There is a building element on the other side.

The exact definition of how space boundaries are broken down depends on the view definition, more detailed conventions on how space boundaries are decomposed can only be given at the domain or application type level. In an architectural or FM related view, a space boundary is defined totally from inside the space. This is a 1st level space boundary. In a thermal view, the decomposition of the space boundary depends on the material of the providing building element and the adjacent spaces behind. This is a 2nd level space boundary.

  • Examples - Space boundary at first level:

<IMAGE ifcrelspaceboundary_1stlevel>

Space boundary at second level:

<IMAGE ifcrelspaceboundary_2ndlevel>

Space boundary at second level type A:

<IMAGE ifcrelspaceboundary_2ndlevel_typea>

Space boundary at second level type B:

<IMAGE ifcrelspaceboundary_2ndlevel_typeb>

The differences between the 1st and 2nd level space boundaries is identified by: 1st level: SELF\IfcRoot.Name = "1stLevel" SELF\IfcRootDescription = NIL 2nd level: SELF\IfcRoot.Name = "2ndLevel" SELF\IfcRootDescription = "2a", or "2b"

As shown on the image below, if the IfcRelSpaceBoundary is used to express a virtual boundary, the attribute PhysicalOrVirtualBoundary has to be set to VIRTUAL. The attribute RelatedBuildingElement shall point to an instance of IfcVirtualElement. If the correct location is of interest, the attribute ConnectionGeometry is required.

<IMAGE ifcrelspaceboundary_virtual>

As shown on the image below, if the IfcRelSpaceBoundary is used to express a physical boundary between two spaces, the attribute PhysicalOrVirtualBoundary has to be set to PHYSICAL. The attribute RelatedBuildingElement has to be given and points to the element providing the space boundary. The attribute ConnectionGeometry can be inserted, in this case it describes the physical space boundary geometically, or it can be omitted, in that case it describes a physical space boundary logically.

<IMAGE ifcrelspaceboundary_physical>

The IfcRelSpaceBoundary can have geometry attached. If geometry is not attached, the relationship between space and building element is handled only on a logical level. If geometry is attached, it is given within the local coordinate systems of the space.

\changes

IFC2X_FINAL changes: The data type of the attribute_RelatedBuildingElement_ has been changed from IfcBuildingElement to its supertype IfcElement. The data type of the attribute ConnectionGeometry has been changed from IfcConnectionSurfaceGeometry to its supertype IfcConnectionGeometry. IFC4 changes: The attribute RelatedBuildingElement has been made mandatory. For virtual boundaries the reference to IfcVirtualElement is now mandatory. The RelatedBuildingElement attribute is no longer optional. Type of the RelatingSpace attribute changed from IfcSpace to IfcSpaceBoundarySelect.

Definition at line 105 of file IFC4X4/IfcRelSpaceBoundaryAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRelSpaceBoundary()

OdIfc4x4::IfcRelSpaceBoundary::IfcRelSpaceBoundary ( )

Default constructor for the IfcRelSpaceBoundary class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcRelSpaceBoundary::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::IfcRelConnects.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcRelSpaceBoundary::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 OdIfc4x4::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcRelSpaceBoundary::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 OdIfc4x4::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ getConnectionGeometry()

const OdDAIObjectId & OdIfc4x4::IfcRelSpaceBoundary::getConnectionGeometry ( ) const

Returns the value of ConnectionGeometry attribute. This attribute represents physical representation of the space boundary. Provided as a curve or surface given within the LCS of the space.

Returns
Returns the value of ConnectionGeometry attribute.
Remarks
IFC2x CHANGE:  The data type has been changed from IfcConnectionSurfaceGeometry to IfcConnectionGeometry with upward compatibility for file based exchange.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcRelSpaceBoundary::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::IfcRelConnects.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ getInternalOrExternalBoundary()

IfcInternalOrExternalEnum OdIfc4x4::IfcRelSpaceBoundary::getInternalOrExternalBoundary ( ) const

Returns the value of InternalOrExternalBoundary attribute. This attribute defines whether the Space Boundary is internal (Internal), or external, i.e. adjacent to open space (that can be an partially enclosed space, such as terrace (External).

Returns
Returns the value of InternalOrExternalBoundary attribute.

◆ getPhysicalOrVirtualBoundary()

IfcPhysicalOrVirtualEnum OdIfc4x4::IfcRelSpaceBoundary::getPhysicalOrVirtualBoundary ( ) const

Returns the value of PhysicalOrVirtualBoundary attribute. This attribute defines, whether the Space Boundary is physical (Physical) or virtual (Virtual).

Returns
Returns the value of PhysicalOrVirtualBoundary attribute.

◆ getRelatedBuildingElement()

const OdDAIObjectId & OdIfc4x4::IfcRelSpaceBoundary::getRelatedBuildingElement ( ) const

Returns the value of RelatedBuildingElement attribute. This attribute represents reference to Building Element, that defines the Space Boundaries.

Returns
Returns the value of RelatedBuildingElement attribute.
Remarks
IFC2x CHANGE:  The data type has been changed from IfcBuildingElement to IfcElement with upward compatibility for file based exchange. IFC4 CHANGE:  The attribute has been changed to be mandatory.

◆ inFields()

virtual OdResult OdIfc4x4::IfcRelSpaceBoundary::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::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ isKindOf()

virtual bool OdIfc4x4::IfcRelSpaceBoundary::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::IfcRelConnects.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ outFields()

virtual OdResult OdIfc4x4::IfcRelSpaceBoundary::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::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcRelSpaceBoundary::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::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcRelSpaceBoundary::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::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ relatingSpace()

IfcSpaceBoundarySelect OdIfc4x4::IfcRelSpaceBoundary::relatingSpace ( )

Returns the value of RelatingSpace attribute. This attribute represents reference to one spaces that is delimited by this boundary.

Returns
Returns the value of RelatingSpace attribute.

◆ setConnectionGeometry()

void OdIfc4x4::IfcRelSpaceBoundary::setConnectionGeometry ( const OdDAIObjectId & ConnectionGeometry)

Sets the value of ConnectionGeometry attribute. This attribute represents physical representation of the space boundary. Provided as a curve or surface given within the LCS of the space.

Parameters
ConnectionGeometry[in] ConnectionGeometry to set.
Remarks
IFC2x CHANGE:  The data type has been changed from IfcConnectionSurfaceGeometry to IfcConnectionGeometry with upward compatibility for file based exchange.

◆ setInternalOrExternalBoundary()

void OdIfc4x4::IfcRelSpaceBoundary::setInternalOrExternalBoundary ( IfcInternalOrExternalEnum InternalOrExternalBoundary)

Sets the value of InternalOrExternalBoundary attribute. This attribute defines whether the Space Boundary is internal (Internal), or external, i.e. adjacent to open space (that can be an partially enclosed space, such as terrace (External).

Parameters
InternalOrExternalBoundary[in] InternalOrExternalBoundary to set.

◆ setInverseCounterParts()

virtual void OdIfc4x4::IfcRelSpaceBoundary::setInverseCounterParts ( )
overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ setPhysicalOrVirtualBoundary()

void OdIfc4x4::IfcRelSpaceBoundary::setPhysicalOrVirtualBoundary ( IfcPhysicalOrVirtualEnum PhysicalOrVirtualBoundary)

Sets the value of PhysicalOrVirtualBoundary attribute. This attribute defines, whether the Space Boundary is physical (Physical) or virtual (Virtual).

Parameters
PhysicalOrVirtualBoundary[in] PhysicalOrVirtualBoundary to set.

◆ setRelatedBuildingElement()

void OdIfc4x4::IfcRelSpaceBoundary::setRelatedBuildingElement ( const OdDAIObjectId & RelatedBuildingElement)

Sets the value of RelatedBuildingElement attribute. This attribute represents reference to Building Element, that defines the Space Boundaries.

Parameters
RelatedBuildingElement[in] RelatedBuildingElement to set.
Remarks
IFC2x CHANGE:  The data type has been changed from IfcBuildingElement to IfcElement with upward compatibility for file based exchange. IFC4 CHANGE:  The attribute has been changed to be mandatory.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcRelSpaceBoundary::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::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcRelSpaceBoundary::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 OdIfc4x4::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcRelSpaceBoundary::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 OdIfc4x4::IfcRelConnects.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ unsetAttr() [1/2]

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

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x4::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcRelSpaceBoundary::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 OdIfc4x4::IfcRoot.

Reimplemented in OdIfc4x4::IfcRelSpaceBoundary1stLevel, and OdIfc4x4::IfcRelSpaceBoundary2ndLevel.

Member Data Documentation

◆ m_ConnectionGeometry

OdDAIObjectId OdIfc4x4::IfcRelSpaceBoundary::m_ConnectionGeometry
protected

Definition at line 341 of file IFC4X4/IfcRelSpaceBoundaryAutoImpl.h.

◆ m_InternalOrExternalBoundary

OdDAI::Enum OdIfc4x4::IfcRelSpaceBoundary::m_InternalOrExternalBoundary
protected

Definition at line 343 of file IFC4X4/IfcRelSpaceBoundaryAutoImpl.h.

◆ m_PhysicalOrVirtualBoundary

OdDAI::Enum OdIfc4x4::IfcRelSpaceBoundary::m_PhysicalOrVirtualBoundary
protected

Definition at line 342 of file IFC4X4/IfcRelSpaceBoundaryAutoImpl.h.

◆ m_RelatedBuildingElement

OdDAIObjectId OdIfc4x4::IfcRelSpaceBoundary::m_RelatedBuildingElement
protected

Definition at line 340 of file IFC4X4/IfcRelSpaceBoundaryAutoImpl.h.

◆ m_RelatingSpace

OdDAI::Select OdIfc4x4::IfcRelSpaceBoundary::m_RelatingSpace
protected

Definition at line 339 of file IFC4X4/IfcRelSpaceBoundaryAutoImpl.h.


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