CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x2::IfcZone Class Reference

#include <IfcZoneAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcZone:
OdIfc4x2::IfcSystem OdIfc4x2::IfcGroup OdIfc4x2::IfcObject OdIfc4x2::IfcObjectDefinition OdIfc4x2::IfcRoot OdIfc4x2::OdIfc4x2Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getLongName () const
 
void setLongName (const OdAnsiString &LongName)
 
 IfcZone ()
 
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 OdIfc4x2::IfcSystem
void getInvServicesBuildings (OdDAIObjectIds &ServicesBuildings) const
 
- Public Member Functions inherited from OdIfc4x2::IfcGroup
void getInvIsGroupedBy (OdDAIObjectIds &IsGroupedBy) const
 
- Public Member Functions inherited from OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::OdIfc4x2Instance
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 OdIfc4x2::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4x2::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 zone is a group of spaces, partial spaces or other zones. Zone structures may not be hierarchical (in contrary to the spatial structure of a project - see IfcSpatialStructureElement), i.e. one individual IfcSpace can be associated with zero, one, or several IfcZone's. IfcSpace's are grouped into an IfcZone by using the objectified relationship IfcRelAssignsToGroup as specified at the supertype IfcGroup.

  • Property Sets for Objects - The Property Sets for Objects concept template applies to this entity under Pset_ZoneCommon name as shown in table below:
    Template

PropertyName Value Single Value Reference IfcIdentifier Single Value IsExternal IfcBoolean Single Value GrossPlannedArea IfcAreaMeasure Single Value NetPlannedArea IfcAreaMeasure Single Value PubliclyAccessible IfcBoolean Single Value HandicapAccessible IfcBoolean

The concept also applies to this entity under the Pset_ZoneCommon name:

Template PropertyName Value Single Value Name IfcLabel Single Value Description IfcLabel Single Value TotalAirflow IfcVolumetricFlowRateMeasure Single Value EnergyGainTotal IfcPowerMeasure Single Value AirflowSensible IfcVolumetricFlowRateMeasure Single Value EnergyGainSensible IfcPowerMeasure Single Value EnergyLoss IfcPowerMeasure Single Value LightingDiversity IfcPositiveRatioMeasure Single Value InfiltrationDiversitySummer IfcPositiveRatioMeasure Single Value InfiltrationDiversityWinter IfcPositiveRatioMeasure Single Value ApplianceDiversity IfcPositiveRatioMeasure Single Value LoadSafetyFactor IfcPositiveRatioMeasure Single Value HeatingTemperatureDelta IfcThermodynamicTemperatureMeasure Single Value CoolingTemperatureDelta IfcThermodynamicTemperatureMeasure Single Value Ventilation IfcVolumetricFlowRateMeasure Single Value FanPower IfcPowerMeasure Enumerated Value AirSideSystemType IfcLabel Enumerated Value AirSideSystemDistributionType IfcLabel

  • Group Assignment - An IfcZone is a spatial system under which individual IfcSpace's (and other IfcZone's) are grouped. In contrary to the IfcSpatialZone entity, IfcZone is a mere grouping, it can not define an own geometric representation and placement. Therefore it cannot be used for spatial zones having a different shape and size compared to the shape and size of aggregated spaces.

In case of a zone denoting a (fire) compartment, the following types should be used, if applicable, as values of the ObjectType attribute: 'FireCompartment': a zone of spaces, collected to represent a single fire compartment. 'ElevatorShaft': a collection of spaces within an elevator, potentially going through many storeys. 'RisingDuct': A collection of vertical airspaces. 'RunningDuct': A collection of horizontal airspaces.

\changes

IFC4 changes: The entity is now subtyped from IfcSystem (not its supertype IfcGroup) with upward compatibility for file-based exchange.

Definition at line 94 of file Ifc4x2/IfcZoneAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcZone()

OdIfc4x2::IfcZone::IfcZone ( )

Default constructor for the IfcZone class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ getLongName()

const OdAnsiString & OdIfc4x2::IfcZone::getLongName ( ) const

Returns the value of LongName attribute. This attribute represents long name for a zone, 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 zone, and the LongName refers to the full name. IFC4 CHANGE: The attribute has been added at the end of the entity definition.

◆ inFields()

virtual OdResult OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ isKindOf()

virtual bool OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ outFields()

virtual OdResult OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ setLongName()

void OdIfc4x2::IfcZone::setLongName ( const OdAnsiString & LongName)

Sets the value of LongName attribute. This attribute represents long name for a zone, 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 zone, and the LongName refers to the full name. IFC4 CHANGE: The attribute has been added at the end of the entity definition.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::IfcZone::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x2::IfcSystem.

◆ unsetAttr() [2/2]

virtual void OdIfc4x2::IfcZone::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 OdIfc4x2::IfcSystem.

Member Data Documentation

◆ m_LongName

OdAnsiString OdIfc4x2::IfcZone::m_LongName
protected

Definition at line 241 of file Ifc4x2/IfcZoneAutoImpl.h.


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