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

#include <IfcCoilAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcCoil:
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

IfcCoilTypeEnum getCoilType () const
 
void setCoilType (IfcCoilTypeEnum CoilType)
 
double getBypassFactor () const
 
void setBypassFactor (double BypassFactor)
 
double getFaceVelocity () const
 
void setFaceVelocity (double FaceVelocity)
 
IfcCoilFlowArrangementEnum getFlowArrangement () const
 
void setFlowArrangement (IfcCoilFlowArrangementEnum FlowArrangement)
 
 IfcCoil ()
 
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_CoilType
 
double m_BypassFactor
 
double m_FaceVelocity
 
OdDAI::Enum m_FlowArrangement
 
- 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

A coil is a device that provides heat transfer between non-mixing media. A common example is a cooling coil, which utilizes a finned coil in which circulates chilled water, antifreeze, or refrigerant that is used to remove heat from air moving across the surface of the coil. A coil can be used either for heating or cooling purposes by placing a series of tubes (the coil) carrying a heating or cooling fluid into an air stream. The coil can be constructed from tubes bundled in a serpentine form or from finned tubes that give a extended heat transfer surface.

Coils can also be used for non-airflow cases such as embedded in a floor slab.

  • Material Set - This concept can be applied to the following resources: Casing - Material from which the casing is constructed.
  • Object Typing - This concept can be applied to the following resources: IfcCoilType
  • Port Nesting - This concept can be applied with the following combinations:
    PortName

Flow PredefinedType RefrigerantIn SINK REFRIGERATION RefrigerantOut SOURCE DXCOOLINGCOIL AirIn SINK DXCOOLINGCOIL AirOut SOURCE AIRCONDITIONING ChilledWaterIn SINK WATERCOOLINGCOIL ChilledWaterOut SOURCE WATERCOOLINGCOIL AirIn SINK WATERCOOLINGCOIL AirOut SOURCE WATERCOOLINGCOIL HeatingIn SINK HEATING HeatingOut SOURCE HEATING AirIn SINK WATERHEATINGCOIL AirOut SOURCE WATERHEATINGCOIL

  • Property Sets for Objects - This concept can be applied to the following resources: Pset_CoilOccurrence Pset_CoilTypeCommon Pset_CoilTypeHydronic
  • Quantity Sets - This concept can be applied to the following resources: Qto_CoilBaseQuantities
  • Property Sets for Performance - This concept can be applied to the following resources: Pset_CoilPHistory

Definition at line 86 of file Ifc2x_Final/IfcCoilAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCoil()

OdIfc2x_final::IfcCoil::IfcCoil ( )

Default constructor for the IfcCoil class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getBypassFactor()

double OdIfc2x_final::IfcCoil::getBypassFactor ( ) const

Returns the value of BypassFactor attribute. This attribute represents coil bypass factor.

Returns
Returns the value of BypassFactor attribute.

◆ getCoilType()

IfcCoilTypeEnum OdIfc2x_final::IfcCoil::getCoilType ( ) const

Returns the value of CoilType attribute. This attribute represents typical types of coils.

Returns
Returns the value of CoilType attribute.

◆ getFaceVelocity()

double OdIfc2x_final::IfcCoil::getFaceVelocity ( ) const

Returns the value of FaceVelocity attribute. This attribute represents air velocity through the coil.

Returns
Returns the value of FaceVelocity attribute.

◆ getFlowArrangement()

IfcCoilFlowArrangementEnum OdIfc2x_final::IfcCoil::getFlowArrangement ( ) const

Returns the value of FlowArrangement attribute. This attribute represents coil flow arrangement.

Returns
Returns the value of FlowArrangement attribute.

◆ getInstanceType()

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

◆ inFields()

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

◆ setBypassFactor()

void OdIfc2x_final::IfcCoil::setBypassFactor ( double BypassFactor)

Sets the value of BypassFactor attribute. This attribute represents coil bypass factor.

Parameters
BypassFactor[in] BypassFactor attribute to set.

◆ setCoilType()

void OdIfc2x_final::IfcCoil::setCoilType ( IfcCoilTypeEnum CoilType)

Sets the value of CoilType attribute. This attribute represents typical types of coils.

Parameters
CoilType[in] Coil type to set.

◆ setFaceVelocity()

void OdIfc2x_final::IfcCoil::setFaceVelocity ( double FaceVelocity)

Sets the value of FaceVelocity attribute. This attribute represents air velocity through the coil.

Parameters
FaceVelocity[in] FaceVelocity attribute to set.

◆ setFlowArrangement()

void OdIfc2x_final::IfcCoil::setFlowArrangement ( IfcCoilFlowArrangementEnum FlowArrangement)

Sets the value of FlowArrangement attribute. This attribute represents coil flow arrangement.

Parameters
FlowArrangement[in] FlowArrangement attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcCoil::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::IfcCoil::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::IfcCoil::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::IfcCoil::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::IfcCoil::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_BypassFactor

double OdIfc2x_final::IfcCoil::m_BypassFactor
protected

Definition at line 271 of file Ifc2x_Final/IfcCoilAutoImpl.h.

◆ m_CoilType

OdDAI::Enum OdIfc2x_final::IfcCoil::m_CoilType
protected

Definition at line 270 of file Ifc2x_Final/IfcCoilAutoImpl.h.

◆ m_FaceVelocity

double OdIfc2x_final::IfcCoil::m_FaceVelocity
protected

Definition at line 272 of file Ifc2x_Final/IfcCoilAutoImpl.h.

◆ m_FlowArrangement

OdDAI::Enum OdIfc2x_final::IfcCoil::m_FlowArrangement
protected

Definition at line 273 of file Ifc2x_Final/IfcCoilAutoImpl.h.


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