CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4::IfcBuildingStorey Class Reference

#include <IfcBuildingStoreyAutoImpl.h>

Inheritance diagram for OdIfc4::IfcBuildingStorey:
OdIfc4::IfcSpatialStructureElement OdIfc4::IfcSpatialElement OdIfc4::IfcProduct OdIfc4::IfcObject OdIfc4::IfcObjectDefinition OdIfc4::IfcRoot OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

double getElevation () const
 
void setElevation (double Elevation)
 
 IfcBuildingStorey ()
 
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 OdIfc4::IfcSpatialStructureElement
IfcElementCompositionEnum getCompositionType () const
 
void setCompositionType (IfcElementCompositionEnum CompositionType)
 
 IfcSpatialStructureElement ()
 
- Public Member Functions inherited from OdIfc4::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
 
 IfcSpatialElement ()
 
- Public Member Functions inherited from OdIfc4::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 OdIfc4::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 OdIfc4::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 OdIfc4::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 OdIfc4::OdIfc4Instance
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

double m_Elevation
 
- Protected Attributes inherited from OdIfc4::IfcSpatialStructureElement
OdDAI::Enum m_CompositionType
 
- Protected Attributes inherited from OdIfc4::IfcSpatialElement
OdAnsiString m_LongName
 
- Protected Attributes inherited from OdIfc4::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc4::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4::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 building storey typically represents a (nearly) horizontal aggregation of spaces that are vertically bound. A storey (if specified) is associated to a building. A storey can span over several connected storeys. Therefore storey complex provides for a collection of storeys included in a building. A storey can also be decomposed in (horizontical) parts, where each part defines a partial storey. This is defined by the composition type attribute of the supertype IfcSpatialStructureElement which is interpreted as follow: COMPLEX: building storey complex ELEMENT: building storey PARTIAL: partial building storey

The image below shows the IfcBuildingStorey as part of the spatial structure. It also serves as the spatial container for building and other elements.

<IMAGE ifcbuildingstorey-spatialstructure>

The next image describes the heights and elevations of the IfcBuildingStorey.

Elevation of the structural slab level: provided by Pset_BuildingStoreyCommon with Name="ElevationOfSSLRelative" Elevation of the finish floor level: provided by Pset_BuildingStoreyCommon with Name="ElevationOfFFLRelative" Gross height of storey, also referred to as total height (top of construction slab to top of construction slab above): provided by Qto_BuildingStoreyBaseQuantities with Name="GrossHeight" Net height of storey (top of construction slab to bottom of construction slab above): provided by Qto_BuildingStoreyBaseQuantities with Name="NetHeight"

<IMAGE ifcbuildingstorey_heights>

  • FootPrint GeomSet Geometry - The foot print representation of IfcBuildingStorey is specified by either a single 2D curve, or by a list of 2D curves, if the building storey has an independent geometric representation.
  • Product Local Placement - The local placement for IfcBuildingStorey is defined in 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 IfcSpatialStructureElement of the IfcBuilding or IfcBuildingStorey type. 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_BuildingStoreyCommon
  • Quantity Sets - This concept can be applied to the following resources: Qto_BuildingStoreyBaseQuantities
  • Spatial Composition - This concept can be applied to the following resources: IfcBuilding IfcBuildingStorey
  • Spatial Container - If there are building elements and/or other elements directly related to the IfcBuildingStorey (like most building elements, such as walls, columns, etc.), they are associated with the IfcBuildingStorey by using the IfcRelContainedInSpatialStructure relationship. The IfcBuildingStorey references them by its inverse relationship: IfcBuildingStorey.ContainsElements - referencing any subtype of IfcProduct (with the exception of other spatial structure element) by IfcRelContainedInSpatialStructure.RelatedElements.
  • Spatial Decomposition - Spatial Decomposition concept uses the IfcBuildingStorey.IsDecomposedBy inverse relationship to reference IfcBuildingStorey or IfcSpace through IfcRelAggregates.RelatedObjects. If it refers to another instance of IfcBuildingStorey, the referenced IfcBuildingStorey needs to have a different and lower CompositionType, i.e. ELEMENT (if the other IfcBuildingStorey has COMPLEX), or PARTIAL (if the other IfcBuildingStorey has ELEMENT).

This concept can be applied to the following resources: IfcBuildingStorey IfcSpace

Definition at line 103 of file Ifc4/IfcBuildingStoreyAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcBuildingStorey()

OdIfc4::IfcBuildingStorey::IfcBuildingStorey ( )

Default constructor for the IfcBuildingStorey class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ getElevation()

double OdIfc4::IfcBuildingStorey::getElevation ( ) const

Returns the value of Elevation attribute. This attribute represents elevation of the base of this storey, relative to the 0,00 internal reference height of the building. The 0.00 level is specified by the absolute above sea level height by the ElevationOfRefHeight attribute specified at IfcBuilding.

Returns
Returns the value of Elevation attribute.
Remarks
If the geometric data is provided (ObjectPlacement is specified), the Elevation value will either not be included, or be equal to the local placement Z value.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ inFields()

virtual OdResult OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ isKindOf()

virtual bool OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ outFields()

virtual OdResult OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ setElevation()

void OdIfc4::IfcBuildingStorey::setElevation ( double Elevation)

Sets the value of Elevation attribute. This attribute represents elevation of the base of this storey, relative to the 0,00 internal reference height of the building. The 0.00 level is specified by the absolute above sea level height by the ElevationOfRefHeight attribute specified at IfcBuilding.

Parameters
Elevation[in] Elevation to set.
Remarks
If the geometric data is provided (ObjectPlacement is specified), the Elevation value will either not be included, or be equal to the local placement Z value.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcBuildingStorey::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcBuildingStorey::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 OdIfc4::IfcSpatialStructureElement.

Member Data Documentation

◆ m_Elevation

double OdIfc4::IfcBuildingStorey::m_Elevation
protected

Definition at line 269 of file Ifc4/IfcBuildingStoreyAutoImpl.h.


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