#include <IfcFuelPropertiesAutoImpl.h>
Common definition to capture the properties of fuel energy typically used within the context of building services and flow distribution systems.
Definition at line 40 of file Ifc2x2_Final/IfcFuelPropertiesAutoImpl.h.
◆ IfcFuelProperties()
| OdIfc2x2_final::IfcFuelProperties::IfcFuelProperties |
( |
| ) |
|
◆ getAttr() [1/2]
| virtual OdRxValue OdIfc2x2_final::IfcFuelProperties::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 OdIfc2x2_final::IfcMaterialProperties.
◆ getAttr() [2/2]
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 OdIfc2x2_final::IfcMaterialProperties.
◆ getCarbonContent()
| double OdIfc2x2_final::IfcFuelProperties::getCarbonContent |
( |
| ) |
const |
Returns the value of CarbonContent attribute. This attribute represents the carbon content in the fuel. This is measured in weight of carbon per unit weight of fuel and is therefore unitless.
- Returns
- Returns the value of CarbonContent attribute.
◆ getCombustionTemperature()
| double OdIfc2x2_final::IfcFuelProperties::getCombustionTemperature |
( |
| ) |
const |
Returns the value of CombustionTemperature attribute. This attribute represents the combustion temperature of the material when air is at 298 K and 100 kPa.
- Returns
- Returns the value of CombustionTemperature attribute.
◆ getHigherHeatingValue()
| double OdIfc2x2_final::IfcFuelProperties::getHigherHeatingValue |
( |
| ) |
const |
Returns the value of HigherHeatingValue attribute. This attribute represents the higher heating value that is defined as the amount of energy released (MJ/kg) when a fuel is burned completely, and H2O is in liquid form in the combustion products.
- Returns
- Returns the value of HigherHeatingValue attribute.
◆ getInstanceType()
| virtual OdDAI::Entity * OdIfc2x2_final::IfcFuelProperties::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 OdIfc2x2_final::IfcMaterialProperties.
◆ getLowerHeatingValue()
| double OdIfc2x2_final::IfcFuelProperties::getLowerHeatingValue |
( |
| ) |
const |
Returns the value of LowerHeatingValue attribute. This attribute represents the lower heating value that is defined as the amount of energy released (MJ/kg) when a fuel is burned completely, and H2O is in vapor form in the combustion products.
- Returns
- Returns the value of LowerHeatingValue attribute.
◆ inFields()
| virtual OdResult OdIfc2x2_final::IfcFuelProperties::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 OdIfc2x2_final::IfcMaterialProperties.
◆ isKindOf()
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 OdIfc2x2_final::IfcMaterialProperties.
◆ outFields()
| virtual OdResult OdIfc2x2_final::IfcFuelProperties::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 OdIfc2x2_final::IfcMaterialProperties.
◆ putAttr() [1/2]
| virtual bool OdIfc2x2_final::IfcFuelProperties::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 OdIfc2x2_final::IfcMaterialProperties.
◆ putAttr() [2/2]
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 OdIfc2x2_final::IfcMaterialProperties.
◆ setCarbonContent()
| void OdIfc2x2_final::IfcFuelProperties::setCarbonContent |
( |
double | CarbonContent | ) |
|
Sets the value of CarbonContent attribute. This attribute represents the carbon content in the fuel. This is measured in weight of carbon per unit weight of fuel and is therefore unitless.
- Parameters
-
| CarbonContent | [in] CarbonContent attribute to set. |
◆ setCombustionTemperature()
| void OdIfc2x2_final::IfcFuelProperties::setCombustionTemperature |
( |
double | CombustionTemperature | ) |
|
Sets the value of CombustionTemperature attribute. This attribute represents the combustion temperature of the material when air is at 298 K and 100 kPa.
- Parameters
-
| CombustionTemperature | [in] CombustionTemperature attribute to set. |
◆ setHigherHeatingValue()
| void OdIfc2x2_final::IfcFuelProperties::setHigherHeatingValue |
( |
double | HigherHeatingValue | ) |
|
Sets the value of HigherHeatingValue attribute. This attribute represents the higher heating value that is defined as the amount of energy released (MJ/kg) when a fuel is burned completely, and H2O is in liquid form in the combustion products.
- Parameters
-
| HigherHeatingValue | [in] HigherHeatingValue attribute to set. |
◆ setLowerHeatingValue()
| void OdIfc2x2_final::IfcFuelProperties::setLowerHeatingValue |
( |
double | LowerHeatingValue | ) |
|
Sets the value of LowerHeatingValue attribute. This attribute represents the lower heating value that is defined as the amount of energy released (MJ/kg) when a fuel is burned completely, and H2O is in vapor form in the combustion products.
- Parameters
-
| LowerHeatingValue | [in] LowerHeatingValue attribute to set. |
◆ testAttr() [1/2]
| virtual bool OdIfc2x2_final::IfcFuelProperties::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 OdIfc2x2_final::IfcMaterialProperties.
◆ testAttr() [2/2]
| virtual bool OdIfc2x2_final::IfcFuelProperties::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 OdIfc2x2_final::IfcMaterialProperties.
◆ type()
◆ unsetAttr() [1/2]
| virtual void OdIfc2x2_final::IfcFuelProperties::unsetAttr |
( |
const char * | explicitAttrName | ) |
|
|
overridevirtual |
◆ unsetAttr() [2/2]
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrDef | [in] Explicit definition that represents an attribute to reset. |
Reimplemented from OdIfc2x2_final::IfcMaterialProperties.
◆ m_CarbonContent
◆ m_CombustionTemperature
| double OdIfc2x2_final::IfcFuelProperties::m_CombustionTemperature |
|
protected |
◆ m_HigherHeatingValue
| double OdIfc2x2_final::IfcFuelProperties::m_HigherHeatingValue |
|
protected |
◆ m_LowerHeatingValue
| double OdIfc2x2_final::IfcFuelProperties::m_LowerHeatingValue |
|
protected |
The documentation for this class was generated from the following file: