CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x_final::IfcSpace Class Reference

#include <IfcSpaceAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcSpace:
OdIfc2x_final::IfcSpatialStructureElement OdIfc2x_final::IfcProduct OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

IfcInternalOrExternalEnum getInteriorOrExteriorSpace () const
 
void setInteriorOrExteriorSpace (IfcInternalOrExternalEnum InteriorOrExteriorSpace)
 
double getElevationWithFlooring () const
 
void setElevationWithFlooring (double ElevationWithFlooring)
 
void getInvBoundedBy (OdDAIObjectIds &BoundedBy) const
 
 IfcSpace ()
 
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 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 OdIfc2x_final::IfcSpatialStructureElement
const OdAnsiString & getLongName () const
 
void setLongName (const OdAnsiString &LongName)
 
IfcElementCompositionEnum getCompositionType () const
 
void setCompositionType (IfcElementCompositionEnum CompositionType)
 
void getInvContainsElements (OdDAIObjectIds &ContainsElements) const
 
 IfcSpatialStructureElement ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
- Public Member Functions inherited from OdIfc2x_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x_final::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 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_InteriorOrExteriorSpace
 
double m_ElevationWithFlooring
 
- Protected Attributes inherited from OdIfc2x_final::IfcSpatialStructureElement
OdAnsiString m_LongName
 
OdDAI::Enum m_CompositionType
 
- Protected Attributes inherited from OdIfc2x_final::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x_final::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 IfcRelSpaceBoundary
 

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 space represents an area or volume bounded actually or theoretically. Spaces are areas or volumes that provide for certain functions within a building.

A space is associated to a building storey (or in case of exterior spaces to a site). A space can span over several connected spaces. Therefore a space group provides for a collection of spaces included in a storey. A space can also be decomposed in parts, where each part defines a partial space. This is defined by the CompositionType attribute of the supertype IfcSpatialStructureElement which is interpreted as follow: COMPLEX = space group ELEMENT = space PARTIAL = partial space

The image below shows the IfcSpace as part of the spatial structure. It also serves as the spatial container for space related elements.

<IMAGE ifcspace-spatialstructure>

The next image describes the heights and elevations of the IfcSpace. Elevation of the space (top of construction slab) equals elevation of storey: provided by IfcBuildingStorey.Elevation relative to IfcBuilding.ElevationOfRefHeight Elevation of the space flooring (top of flooring on top of slab): provided by IfcSpace.ElevationWithFlooring relative to IfcBuilding.ElevationOfRefHeight Height of space (top of slab below to bottom of slab above): provided by BaseQuantity with Name="Height" Floor height of space (top of slab below to top of flooring): provided by BaseQuantity with Name="FinishFloorHeight" Net height of space (top of flooring to bottom of suspended ceiling): provided by BaseQuantity with Name="FinishCeilingHeight"

<IMAGE ifcspace_heights>

  • FootPrint GeomSet Geometry - The following constraints apply to the 2D representation: An IfcBoundedCurve is required, using IfcPolyline for faceted space contours or IfcCompositeCurve for space contours with arc segments. For spaces with inner boundaries, a set of IfcBoundedCurve's is used, that should be grouped into an IfcGeometricCurveSet.
  • Object Typing - This concept can be applied to the following resources: IfcSpaceType
  • Product Local Placement - The local placement for IfcSpace is defined at its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. The PlacementRelTo relationship of IfcLocalPlacement points to the local placement of the IfcSpatialStructureElement of IfcBuildingStorey type or of IfcSite type if relative placement is used. If the relative placement is not used, the absolute placement is defined within the world coordinate system.
  • Property Sets for Objects - This concept can be applied to the following resources: Pset_ProcessCapacity Pset_BerthCommon (only applies to BERTH) Pset_FenderDesignCriteria (only applies to BERTH) Pset_SpaceParking (only applies to PARKING)
  • Quantity Sets - This concept can be applied to the following resources: Qto_SpaceBaseQuantities
  • Spatial Composition - The Spatial Composition concept uses the inverse relationship IfcSpace.IsDecomposedBy to reference IfcSpace by IfcRelAggregates.RelatedObjects. If it refers to another instance of IfcSpace, the referenced IfcSpace needs to have a different and lower CompositionType, i.e. ELEMENT (if the other IfcSpace has COMPLEX), or PARTIAL (if the other IfcSpace has ELEMENT). This concept can be applied to the following resources: IfcProject IfcSite IfcBuilding IfcBuildingStorey IfcSpace IfcFacility IfcBridge IfcMarineFacility IfcRailway IfcRoad IfcFacilityPartCommon IfcBridgePart IfcMarinePart IfcRailwayPart IfcRoadPart
  • Spatial Container - If there are building elements and/or other elements directly related to the IfcSpace (like most furniture and distribution elements), they are associated with the IfcSpace by using the objectified relationship IfcRelContainedInSpatialStructure. The IfcSpace references them by its inverse relationship: IfcSpace.ContainsElements - referencing any subtype of IfcProduct (with the exception of other spatial structure element) by IfcRelContainedInSpatialStructure.RelatedElements.
  • Spatial Decomposition - Spatial Decomposition concept uses the IfcSpace.Decomposes inverse relationship to reference IfcSite, or IfcBuildingStorey, or IfcSpace by IfcRelAggregates.RelatingObject. If it refers to another instance of IfcSpace, the referenced IfcSpace needs to have a different and higher CompositionType, i.e. COMPLEX (if the other IfcSpace has ELEMENT), or ELEMENT (if the other IfcSpace has PARTIAL). This concept can be applied to the following resources: IfcSpace

Definition at line 129 of file Ifc2x_Final/IfcSpaceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSpace()

OdIfc2x_final::IfcSpace::IfcSpace ( )

Default constructor for the IfcSpace class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ getElevationWithFlooring()

double OdIfc2x_final::IfcSpace::getElevationWithFlooring ( ) const

Returns the value of ElevationWithFlooring attribute. This attribute represents level of flooring of this space; the average is taken, if the space ground surface is sloping or if there are level differences within this space.

Returns
Returns the value of ElevationWithFlooring attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ getInteriorOrExteriorSpace()

IfcInternalOrExternalEnum OdIfc2x_final::IfcSpace::getInteriorOrExteriorSpace ( ) const

Returns the value of InteriorOrExteriorSpace attribute. This attribute indicates whether the Space is interior (Internal), or exterior (External), i.e. part of the outer space.

Returns
Returns the value of InteriorOrExteriorSpace attribute.

◆ getInvBoundedBy()

void OdIfc2x_final::IfcSpace::getInvBoundedBy ( OdDAIObjectIds & BoundedBy) const

Returns the value of BoundedBy attribute. This attribute represents reference to a set of IfcRelSpaceBoundary's that defines the physical or virtual delimitation of that space against physical or virtual boundaries.

Parameters
BoundedBy[out] Receives the value of BoundedBy attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ setElevationWithFlooring()

void OdIfc2x_final::IfcSpace::setElevationWithFlooring ( double ElevationWithFlooring)

Sets the value of ElevationWithFlooring attribute. This attribute represents level of flooring of this space; the average is taken, if the space ground surface is sloping or if there are level differences within this space.

Parameters
ElevationWithFlooring[in] Elevation with flooring to set.

◆ setInteriorOrExteriorSpace()

void OdIfc2x_final::IfcSpace::setInteriorOrExteriorSpace ( IfcInternalOrExternalEnum InteriorOrExteriorSpace)

Sets the value of InteriorOrExteriorSpace attribute. This attribute indicates whether the Space is interior (Internal), or exterior (External), i.e. part of the outer space.

Parameters
InteriorOrExteriorSpace[in] Attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcSpace::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x_final::IfcSpatialStructureElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcSpace::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 OdIfc2x_final::IfcSpatialStructureElement.

Friends And Related Symbol Documentation

◆ IfcRelSpaceBoundary

friend class IfcRelSpaceBoundary
friend

Definition at line 297 of file Ifc2x_Final/IfcSpaceAutoImpl.h.

Member Data Documentation

◆ m_ElevationWithFlooring

double OdIfc2x_final::IfcSpace::m_ElevationWithFlooring
protected

Definition at line 294 of file Ifc2x_Final/IfcSpaceAutoImpl.h.

◆ m_InteriorOrExteriorSpace

OdDAI::Enum OdIfc2x_final::IfcSpace::m_InteriorOrExteriorSpace
protected

Definition at line 293 of file Ifc2x_Final/IfcSpaceAutoImpl.h.


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