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

#include <IfcHydronicHeaterAutoImpl.h>

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

IfcHydronicHeaterTypeEnum getHydronicHeaterType () const
 
void setHydronicHeaterType (IfcHydronicHeaterTypeEnum HydronicHeaterType)
 
double getHeatOutput () const
 
void setHeatOutput (double HeatOutput)
 
const OdAnsiString & getEnclosure () const
 
void setEnclosure (const OdAnsiString &Enclosure)
 
double getBodyMass () const
 
void setBodyMass (double BodyMass)
 
int getNumberOfPanels () const
 
void setNumberOfPanels (int NumberOfPanels)
 
int getNumberOfSections () const
 
void setNumberOfSections (int NumberOfSections)
 
 IfcHydronicHeater ()
 
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_HydronicHeaterType
 
double m_HeatOutput
 
OdAnsiString m_Enclosure
 
double m_BodyMass
 
int m_NumberOfPanels
 
int m_NumberOfSections
 
- 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 IfcHydronicHeater is a device which adds heat to a space utilizing a combination of radiation and natural convection. The heat source is typically steam or hot water. Examples of HydronicHeaters include radiators, convectors, baseboard and finned-tube heaters, etc. The physical dimensions and properties of the heating element can be defined by an aggregated coil element (IfcCoil).

Definition at line 48 of file IfcHydronicHeaterAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcHydronicHeater()

OdIfc2x_final::IfcHydronicHeater::IfcHydronicHeater ( )

Default constructor for the IfcHydronicHeater class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getBodyMass()

double OdIfc2x_final::IfcHydronicHeater::getBodyMass ( ) const

Returns the value of BodyMass attribute. This attribute represents the overall body mass of a HydronicHeater.

Returns
Returns the value of BodyMass attribute.

◆ getEnclosure()

const OdAnsiString & OdIfc2x_final::IfcHydronicHeater::getEnclosure ( ) const

Returns the value of Enclosure attribute. This attribute represents the description of the the type of enclosure around the HydronicHeater.

Returns
Returns the value of Enclosure attribute.

◆ getHeatOutput()

double OdIfc2x_final::IfcHydronicHeater::getHeatOutput ( ) const

Returns the value of HeatOutput attribute. This attribute represents the total nominal heat output as listed by the manufacturer.

Returns
Returns the value of HeatOutput attribute.

◆ getHydronicHeaterType()

IfcHydronicHeaterTypeEnum OdIfc2x_final::IfcHydronicHeater::getHydronicHeaterType ( ) const

Returns the value of HydronicHeaterType attribute. This attribute represents possible hydronic heater types (e.g., baseboard heater, convector, radiator, etc.).

Returns
Returns the value of HydronicHeaterType attribute.

◆ getInstanceType()

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

◆ getNumberOfPanels()

int OdIfc2x_final::IfcHydronicHeater::getNumberOfPanels ( ) const

Returns the value of NumberOfPanels attribute. This attribute represents the number of panels (panel radiators only).

Returns
Returns the value of NumberOfPanels attribute.

◆ getNumberOfSections()

int OdIfc2x_final::IfcHydronicHeater::getNumberOfSections ( ) const

Returns the value of NumberOfSections attribute. This attribute represents the number of vertical sections, measured in the direction of flow.

Returns
Returns the value of NumberOfSections attribute.

◆ inFields()

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

◆ setBodyMass()

void OdIfc2x_final::IfcHydronicHeater::setBodyMass ( double BodyMass)

Sets the value of BodyMass attribute. This attribute represents the overall body mass of a HydronicHeater.

Parameters
BodyMass[in] BodyMass attribute to set.

◆ setEnclosure()

void OdIfc2x_final::IfcHydronicHeater::setEnclosure ( const OdAnsiString & Enclosure)

Sets the value of Enclosure attribute. This attribute represents the description of the the type of enclosure around the HydronicHeater.

Parameters
Enclosure[in] Enclosure attribute to set.

◆ setHeatOutput()

void OdIfc2x_final::IfcHydronicHeater::setHeatOutput ( double HeatOutput)

Sets the value of HeatOutput attribute. This attribute represents the total nominal heat output as listed by the manufacturer.

Parameters
HeatOutput[in] HeatOutput attribute to set.

◆ setHydronicHeaterType()

void OdIfc2x_final::IfcHydronicHeater::setHydronicHeaterType ( IfcHydronicHeaterTypeEnum HydronicHeaterType)

Sets the value of HydronicHeaterType attribute. This attribute represents possible hydronic heater types (e.g., baseboard heater, convector, radiator, etc.).

Parameters
HydronicHeaterType[in] HydronicHeaterType attribute to set.

◆ setNumberOfPanels()

void OdIfc2x_final::IfcHydronicHeater::setNumberOfPanels ( int NumberOfPanels)

Sets the value of NumberOfPanels attribute. This attribute represents the number of panels (panel radiators only).

Parameters
NumberOfPanels[in] NumberOfPanels attribute to set.

◆ setNumberOfSections()

void OdIfc2x_final::IfcHydronicHeater::setNumberOfSections ( int NumberOfSections)

Sets the value of NumberOfSections attribute. This attribute represents the number of vertical sections, measured in the direction of flow.

Parameters
NumberOfSections[in] NumberOfSections attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcHydronicHeater::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::IfcHydronicHeater::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::IfcHydronicHeater::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::IfcHydronicHeater::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::IfcHydronicHeater::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_BodyMass

double OdIfc2x_final::IfcHydronicHeater::m_BodyMass
protected

Definition at line 265 of file IfcHydronicHeaterAutoImpl.h.

◆ m_Enclosure

OdAnsiString OdIfc2x_final::IfcHydronicHeater::m_Enclosure
protected

Definition at line 264 of file IfcHydronicHeaterAutoImpl.h.

◆ m_HeatOutput

double OdIfc2x_final::IfcHydronicHeater::m_HeatOutput
protected

Definition at line 263 of file IfcHydronicHeaterAutoImpl.h.

◆ m_HydronicHeaterType

OdDAI::Enum OdIfc2x_final::IfcHydronicHeater::m_HydronicHeaterType
protected

Definition at line 262 of file IfcHydronicHeaterAutoImpl.h.

◆ m_NumberOfPanels

int OdIfc2x_final::IfcHydronicHeater::m_NumberOfPanels
protected

Definition at line 266 of file IfcHydronicHeaterAutoImpl.h.

◆ m_NumberOfSections

int OdIfc2x_final::IfcHydronicHeater::m_NumberOfSections
protected

Definition at line 267 of file IfcHydronicHeaterAutoImpl.h.


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