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

#include <IfcAirTerminalAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcAirTerminal:
OdIfc2x_final::IfcFlowTerminal OdIfc2x_final::IfcDistributionFlowElement OdIfc2x_final::IfcDistributionElement OdIfc2x_final::IfcElement OdIfc2x_final::IfcProduct OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

IfcAirFlowTypeEnum getAirFlowType () const
 
void setAirFlowType (IfcAirFlowTypeEnum AirFlowType)
 
double getThrow () const
 
void setThrow (double Throw)
 
double getAirDiffusionPerformanceIndex () const
 
void setAirDiffusionPerformanceIndex (double AirDiffusionPerformanceIndex)
 
IfcAirTerminalFinishTypeEnum getFinishType () const
 
void setFinishType (IfcAirTerminalFinishTypeEnum FinishType)
 
const OdAnsiString & getFinishColor () const
 
void setFinishColor (const OdAnsiString &FinishColor)
 
IfcAirTerminalMountingTypeEnum getMountingType () const
 
void setMountingType (IfcAirTerminalMountingTypeEnum MountingType)
 
IfcAirTerminalFaceTypeEnum getFaceType () const
 
void setFaceType (IfcAirTerminalFaceTypeEnum FaceType)
 
IfcAirTerminalCoreTypeEnum getCoreType () const
 
void setCoreType (IfcAirTerminalCoreTypeEnum CoreType)
 
double getCoreSetVertical () const
 
void setCoreSetVertical (double CoreSetVertical)
 
double getCoreSetHorizontal () const
 
void setCoreSetHorizontal (double CoreSetHorizontal)
 
OdDAI::Boolean getIntegralControl () const
 
void setIntegralControl (OdDAI::Boolean IntegralControl)
 
 IfcAirTerminal ()
 
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::IfcDistributionFlowElement
IfcDistributionFlowElementTypeEnum getFlowElementType () const
 
void setFlowElementType (IfcDistributionFlowElementTypeEnum FlowElementType)
 
void getInvHasControlElements (OdDAIObjectIds &HasControlElements) const
 
 IfcDistributionFlowElement ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcElement
const OdAnsiString & getTag () const
 
void setTag (const OdAnsiString &Tag)
 
void getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const
 
void getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
 IfcElement ()
 
- 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_AirFlowType
 
double m_Throw
 
double m_AirDiffusionPerformanceIndex
 
OdDAI::Enum m_FinishType
 
OdAnsiString m_FinishColor
 
OdDAI::Enum m_MountingType
 
OdDAI::Enum m_FaceType
 
OdDAI::Enum m_CoreType
 
double m_CoreSetVertical
 
double m_CoreSetHorizontal
 
OdDAI::Boolean m_IntegralControl
 
- Protected Attributes inherited from OdIfc2x_final::IfcDistributionFlowElement
OdDAI::Enum m_FlowElementType
 
- Protected Attributes inherited from OdIfc2x_final::IfcElement
OdAnsiString m_Tag
 
- 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
 

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

An air terminal is a terminating or origination point for the transfer of air between distribution system(s) and one or more spaces. It can also be used for the transfer of air between adjacent spaces.

Definition at line 41 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcAirTerminal()

OdIfc2x_final::IfcAirTerminal::IfcAirTerminal ( )

Default constructor for the IfcAirTerminal class.

Member Function Documentation

◆ getAirDiffusionPerformanceIndex()

double OdIfc2x_final::IfcAirTerminal::getAirDiffusionPerformanceIndex ( ) const

Returns the value of AirDiffusionPerformanceIndex attribute. This attribute represents the Air Diffusion Performance Index (ADPI) that is used for cooling mode conditions. If several measurements of air velocity and air temperature are made throughout the occupied zone of a space, the ADPI is the percentage of locations where measurements were taken that meet the specifications for effective draft temperature and air velocity.

Returns
Returns the value of AirDiffusionPerformanceIndex attribute.

◆ getAirFlowType()

IfcAirFlowTypeEnum OdIfc2x_final::IfcAirTerminal::getAirFlowType ( ) const

Returns the value of AirFlowType attribute. This attribute represents possible AirTerminal types (e.g., Supply, Return, Exhaust, etc.).

Returns
Returns the value of AirFlowType attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ getCoreSetHorizontal()

double OdIfc2x_final::IfcAirTerminal::getCoreSetHorizontal ( ) const

Returns the value of CoreSetHorizontal attribute. This attribute represents degree of blade set from the centerline.

Returns
Returns the value of CoreSetHorizontal attribute.

◆ getCoreSetVertical()

double OdIfc2x_final::IfcAirTerminal::getCoreSetVertical ( ) const

Returns the value of CoreSetVertical attribute. This attribute represents degree of blade set from the center line.

Returns
Returns the value of CoreSetVertical attribute.

◆ getCoreType()

IfcAirTerminalCoreTypeEnum OdIfc2x_final::IfcAirTerminal::getCoreType ( ) const

Returns the value of CoreType attribute. This attribute identifies the way the core of the AirTerminal is constructed.

Returns
Returns the value of CoreType attribute.

◆ getFaceType()

IfcAirTerminalFaceTypeEnum OdIfc2x_final::IfcAirTerminal::getFaceType ( ) const

Returns the value of FaceType attribute. This attribute identifies how the terminal face of an AirTerminal is constructed.

Returns
Returns the value of FaceType attribute.

◆ getFinishColor()

const OdAnsiString & OdIfc2x_final::IfcAirTerminal::getFinishColor ( ) const

Returns the value of FinishColor attribute. This attribute represents the finish color for the air terminal.

Returns
Returns the value of FinishColor attribute.

◆ getFinishType()

IfcAirTerminalFinishTypeEnum OdIfc2x_final::IfcAirTerminal::getFinishType ( ) const

Returns the value of FinishType attribute. This attribute represents the type of finish for the AirTerminal.

Returns
Returns the value of FinishType attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcAirTerminal::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::IfcFlowTerminal.

◆ getIntegralControl()

OdDAI::Boolean OdIfc2x_final::IfcAirTerminal::getIntegralControl ( ) const

Returns the value of IntegralControl attribute. This attribute indicates whether a self-powered temperature control is included in the AirTerminal.

Returns
Returns the value of IntegralControl attribute.

◆ getMountingType()

IfcAirTerminalMountingTypeEnum OdIfc2x_final::IfcAirTerminal::getMountingType ( ) const

Returns the value of MountingType attribute. This attribute represents the way the AirTerminal is mounted to the ceiling, wall, etc.

Returns
Returns the value of MountingType attribute.

◆ getThrow()

double OdIfc2x_final::IfcAirTerminal::getThrow ( ) const

Returns the value of Throw attribute. This attribute represents horizontal or vertical axial distance an air stream travels after leaving an AirTerminal before the maximum stream velocity is reduced to a specified terminal velocity.

Returns
Returns the value of Throw attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcAirTerminal::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::IfcFlowTerminal.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ setAirDiffusionPerformanceIndex()

void OdIfc2x_final::IfcAirTerminal::setAirDiffusionPerformanceIndex ( double AirDiffusionPerformanceIndex)

Sets the value of AirDiffusionPerformanceIndex attribute. This attribute represents the Air Diffusion Performance Index (ADPI) that is used for cooling mode conditions. If several measurements of air velocity and air temperature are made throughout the occupied zone of a space, the ADPI is the percentage of locations where measurements were taken that meet the specifications for effective draft temperature and air velocity.

Parameters
AirDiffusionPerformanceIndex[in] AirDiffusionPerformanceIndex attribute to set.

◆ setAirFlowType()

void OdIfc2x_final::IfcAirTerminal::setAirFlowType ( IfcAirFlowTypeEnum AirFlowType)

Sets the value of AirFlowType attribute. This attribute represents possible AirTerminal types (e.g., Supply, Return, Exhaust, etc.).

Parameters
AirFlowType[in] AirFlowType attribute to set.

◆ setCoreSetHorizontal()

void OdIfc2x_final::IfcAirTerminal::setCoreSetHorizontal ( double CoreSetHorizontal)

Sets the value of CoreSetHorizontal attribute. This attribute represents degree of blade set from the centerline.

Parameters
CoreSetHorizontal[in] CoreSetHorizontal attribute to set.

◆ setCoreSetVertical()

void OdIfc2x_final::IfcAirTerminal::setCoreSetVertical ( double CoreSetVertical)

Sets the value of CoreSetVertical attribute. This attribute represents degree of blade set from the center line.

Parameters
CoreSetVertical[in] CoreSetVertical attribute to set.

◆ setCoreType()

void OdIfc2x_final::IfcAirTerminal::setCoreType ( IfcAirTerminalCoreTypeEnum CoreType)

Sets the value of CoreType attribute. This attribute identifies the way the core of the AirTerminal is constructed.

Parameters
CoreType[in] CoreType attribute to set.

◆ setFaceType()

void OdIfc2x_final::IfcAirTerminal::setFaceType ( IfcAirTerminalFaceTypeEnum FaceType)

Sets the value of FaceType attribute. This attribute identifies how the terminal face of an AirTerminal is constructed.

Parameters
FaceType[in] FaceType attribute to set.

◆ setFinishColor()

void OdIfc2x_final::IfcAirTerminal::setFinishColor ( const OdAnsiString & FinishColor)

Sets the value of FinishColor attribute. This attribute represents the finish color for the air terminal.

Parameters
FinishColor[in] FinishColor attribute to set.

◆ setFinishType()

void OdIfc2x_final::IfcAirTerminal::setFinishType ( IfcAirTerminalFinishTypeEnum FinishType)

Sets the value of FinishType attribute. This attribute represents the type of finish for the AirTerminal.

Parameters
FinishType[in] FinishType attribute to set.

◆ setIntegralControl()

void OdIfc2x_final::IfcAirTerminal::setIntegralControl ( OdDAI::Boolean IntegralControl)

Sets the value of IntegralControl attribute. This attribute indicates whether a self-powered temperature control is included in the AirTerminal.

Parameters
IntegralControl[in] IntegralControl attribute to set.

◆ setMountingType()

void OdIfc2x_final::IfcAirTerminal::setMountingType ( IfcAirTerminalMountingTypeEnum MountingType)

Sets the value of MountingType attribute. This attribute represents the way the AirTerminal is mounted to the ceiling, wall, etc.

Parameters
MountingType[in] MountingType attribute to set.

◆ setThrow()

void OdIfc2x_final::IfcAirTerminal::setThrow ( double Throw)

Sets the value of Throw attribute. This attribute represents horizontal or vertical axial distance an air stream travels after leaving an AirTerminal before the maximum stream velocity is reduced to a specified terminal velocity.

Parameters
Throw[in] Throw attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcAirTerminal::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::IfcFlowTerminal.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcAirTerminal::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::IfcDistributionFlowElement.

Member Data Documentation

◆ m_AirDiffusionPerformanceIndex

double OdIfc2x_final::IfcAirTerminal::m_AirDiffusionPerformanceIndex
protected

Definition at line 338 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_AirFlowType

OdDAI::Enum OdIfc2x_final::IfcAirTerminal::m_AirFlowType
protected

Definition at line 336 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_CoreSetHorizontal

double OdIfc2x_final::IfcAirTerminal::m_CoreSetHorizontal
protected

Definition at line 345 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_CoreSetVertical

double OdIfc2x_final::IfcAirTerminal::m_CoreSetVertical
protected

Definition at line 344 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_CoreType

OdDAI::Enum OdIfc2x_final::IfcAirTerminal::m_CoreType
protected

Definition at line 343 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_FaceType

OdDAI::Enum OdIfc2x_final::IfcAirTerminal::m_FaceType
protected

Definition at line 342 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_FinishColor

OdAnsiString OdIfc2x_final::IfcAirTerminal::m_FinishColor
protected

Definition at line 340 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_FinishType

OdDAI::Enum OdIfc2x_final::IfcAirTerminal::m_FinishType
protected

Definition at line 339 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_IntegralControl

OdDAI::Boolean OdIfc2x_final::IfcAirTerminal::m_IntegralControl
protected

Definition at line 346 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_MountingType

OdDAI::Enum OdIfc2x_final::IfcAirTerminal::m_MountingType
protected

Definition at line 341 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.

◆ m_Throw

double OdIfc2x_final::IfcAirTerminal::m_Throw
protected

Definition at line 337 of file Ifc2x_Final/IfcAirTerminalAutoImpl.h.


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