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

#include <IfcBoilerAutoImpl.h>

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

IfcBoilerTypeEnum getBoilerType () const
 
void setBoilerType (IfcBoilerTypeEnum BoilerType)
 
double getHeatOutput () const
 
void setHeatOutput (double HeatOutput)
 
double getPressureRating () const
 
void setPressureRating (double PressureRating)
 
double getEnergyInputRate () const
 
void setEnergyInputRate (double EnergyInputRate)
 
 IfcBoiler ()
 
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::IfcHeatTransferDevice
double getHeatTransferRate () const
 
void setHeatTransferRate (double HeatTransferRate)
 
double getThermalEfficiency () const
 
void setThermalEfficiency (double ThermalEfficiency)
 
IfcEnergySourceEnum getPrimaryEnergySource () const
 
void setPrimaryEnergySource (IfcEnergySourceEnum PrimaryEnergySource)
 
 IfcHeatTransferDevice ()
 
- 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_BoilerType
 
double m_HeatOutput
 
double m_PressureRating
 
double m_EnergyInputRate
 
- Protected Attributes inherited from OdIfc2x_final::IfcHeatTransferDevice
double m_HeatTransferRate
 
IfcPositiveRatioMeasure m_ThermalEfficiency
 
OdDAI::Enum m_PrimaryEnergySource
 
- 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 boiler is a closed, pressure-rated vessel in which water or other fluid is heated using an energy source such as natural gas, heating oil, or electricity. The fluid in the vessel is then circulated out of the boiler for use in various processes or heating applications.

IfcBoiler is a vessel that is used for heating of water or other fluids. Storage vessels, such as for drinking water storage are considered as tanks (IfcTank entity should be used instead).

Definition at line 44 of file Ifc2x_Final/IfcBoilerAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcBoiler()

OdIfc2x_final::IfcBoiler::IfcBoiler ( )

Default constructor for the IfcBoiler class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getBoilerType()

IfcBoilerTypeEnum OdIfc2x_final::IfcBoiler::getBoilerType ( ) const

Returns the value of BoilerType attribute. This attribute represents boiler types by heat transfer medium.

Returns
Returns the value of BoilerType attribute.

◆ getEnergyInputRate()

double OdIfc2x_final::IfcBoiler::getEnergyInputRate ( ) const

Returns the value of EnergyInputRate attribute. This attribute represents nominal fuel consumption rate required to produce the total boiler heat output.

Returns
Returns the value of EnergyInputRate attribute.

◆ getHeatOutput()

double OdIfc2x_final::IfcBoiler::getHeatOutput ( ) const

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

Returns
Returns the value of HeatOutput attribute.

◆ getInstanceType()

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

◆ getPressureRating()

double OdIfc2x_final::IfcBoiler::getPressureRating ( ) const

Returns the value of PressureRating attribute. This attribute represents nominal pressure rating of the boiler as rated by ASME Boiler and Pressure Vessel Code Section IV, Rules for Construction of Heating Boilers, and Section I, Rules for Construction of Power Boilers.

Returns
Returns the value of PressureRating attribute.

◆ inFields()

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

◆ isKindOf()

virtual bool OdIfc2x_final::IfcBoiler::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::IfcHeatTransferDevice.

◆ outFields()

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

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcBoiler::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::IfcHeatTransferDevice.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcBoiler::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::IfcHeatTransferDevice.

◆ setBoilerType()

void OdIfc2x_final::IfcBoiler::setBoilerType ( IfcBoilerTypeEnum BoilerType)

Sets the value of BoilerType attribute. This attribute represents boiler types by heat transfer medium.

Parameters
BoilerType[in] Boiler type to set.

◆ setEnergyInputRate()

void OdIfc2x_final::IfcBoiler::setEnergyInputRate ( double EnergyInputRate)

Sets the value of EnergyInputRate attribute. This attribute represents nominal fuel consumption rate required to produce the total boiler heat output.

Parameters
EnergyInputRate[in] EnergyInputRate attribute to set.

◆ setHeatOutput()

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

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

Parameters
HeatOutput[in] HeatOutput attribute to set.

◆ setPressureRating()

void OdIfc2x_final::IfcBoiler::setPressureRating ( double PressureRating)

Sets the value of PressureRating attribute. This attribute represents nominal pressure rating of the boiler as rated by ASME Boiler and Pressure Vessel Code Section IV, Rules for Construction of Heating Boilers, and Section I, Rules for Construction of Power Boilers.

Parameters
PressureRating[in] PressureRating attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcBoiler::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::IfcHeatTransferDevice.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcBoiler::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::IfcHeatTransferDevice.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcBoiler::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::IfcHeatTransferDevice.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcBoiler::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::IfcHeatTransferDevice.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcBoiler::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::IfcHeatTransferDevice.

Member Data Documentation

◆ m_BoilerType

OdDAI::Enum OdIfc2x_final::IfcBoiler::m_BoilerType
protected

Definition at line 232 of file Ifc2x_Final/IfcBoilerAutoImpl.h.

◆ m_EnergyInputRate

double OdIfc2x_final::IfcBoiler::m_EnergyInputRate
protected

Definition at line 235 of file Ifc2x_Final/IfcBoilerAutoImpl.h.

◆ m_HeatOutput

double OdIfc2x_final::IfcBoiler::m_HeatOutput
protected

Definition at line 233 of file Ifc2x_Final/IfcBoilerAutoImpl.h.

◆ m_PressureRating

double OdIfc2x_final::IfcBoiler::m_PressureRating
protected

Definition at line 234 of file Ifc2x_Final/IfcBoilerAutoImpl.h.


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