///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
// This application incorporates Open Design Alliance software pursuant to a license
// agreement with Open Design Alliance.
// Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
// All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
// This file is generated automatically.
#ifndef _IFC4X4_IFCZONE_AUTO_IMPL_H
#define _IFC4X4_IFCZONE_AUTO_IMPL_H
#include "IfcSystemAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X4 express schema definitions.
*/
namespace OdIfc4x4 {
/** \details
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.
*/
class IFC4X4_EXPORT IfcZone : public IfcSystem
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcZone);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
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.
*/
const OdAnsiString& getLongName() const;
/** \details
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.
\param 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.
*/
void setLongName(const OdAnsiString& LongName);
public:
/** \details
Default constructor for the IfcZone class.
*/
IfcZone();
/** \details
Reads object's data from the specified filer.
\param 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.
*/
virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override;
/** \details
Writes object's data the the specified filer.
\param 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.
*/
virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override;
/** \details
Returns a type of a class instance.
\returns
Pointer to the OdDAI::Entity type that determines an entity definition within a schema.
*/
virtual OdDAI::Entity* getInstanceType() const override;
/** \details
Returns an attribute value for the specified attribute name.
\param attrName [in] Name of an attribute to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const char * attrName) const override;
/** \details
Early-bound version of instances comparison.
\param pOther [in] Other application instance.
\param 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:
Name 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.
*/
virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrName [in] Explicit name of the attribute to reset.
*/
virtual void unsetAttr(const char * explicitAttrName) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrName [in] Explicit name of the attribute to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const char * explicitAttrName) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrName [in] Explicit name of the attribute to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override;
/** \details
Checks whether the specified instance is the object derived from or belongs to this class.
\param entityType [in] Entity to check.
\returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.
*/
virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override;
/** \details
Returns the type of this entity.
\returns
A value of the OdIfc::OdIfcEntityType type that represents type of this entity.
*/
virtual OdIfc::OdIfcEntityType type() const override;
/** \details
Returns an attribute value for the specified attribute definition.
\param attrDef [in] Attribute definition to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrDef [in] Explicit definition that represents an attribute to reset.
*/
virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrDef [in] Attribute definition to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrDef [in] Explicit attribute definition to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override;
protected:
// Fields declaration:
OdAnsiString m_LongName; // IfcLabel [optional]
};
/** \details
A data type that represents a smart pointer to a IfcZone object.
*/
typedef OdSmartPtr IfcZonePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X4_IFCZONE_AUTO_IMPL_H