#include <IfcFuelPropertiesAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcFuelProperties:

Public Member Functions
double	getCombustionTemperature () const

void	setCombustionTemperature (double CombustionTemperature)

double	getCarbonContent () const

void	setCarbonContent (double CarbonContent)

double	getLowerHeatingValue () const

void	setLowerHeatingValue (double LowerHeatingValue)

double	getHigherHeatingValue () const

void	setHigherHeatingValue (double HigherHeatingValue)

	IfcFuelProperties ()

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 bool	comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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 OdIfc2x3::IfcMaterialProperties
const OdDAIObjectId &	getMaterial () const

void	setMaterial (const OdDAIObjectId &Material)

Public Member Functions inherited from OdIfc2x3::OdIfc2x3Instance
void	setInverseCounterParts () override

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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
double	m_CombustionTemperature

IfcPositiveRatioMeasure	m_CarbonContent

double	m_LowerHeatingValue

double	m_HigherHeatingValue

Protected Attributes inherited from OdIfc2x3::IfcMaterialProperties
OdDAIObjectId	m_Material

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

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 Ifc2x3/IfcFuelPropertiesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcFuelProperties()

OdIfc2x3::IfcFuelProperties::IfcFuelProperties ( )

Default constructor for the IfcFuelProperties class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcFuelProperties::comparedToEarlyImpl	(	const OdDAI::ApplicationInstance *	pOther,
		OdRx::Ordering &	ordering ) const

overridevirtual

Early-bound version of instances comparison.

Parameters

pOther	[in] Other application instance.
ordering	[out] Receives the ordering (comparison) status.

Returns: true if comparison was performed, false if method has no implementation, so late-bound version could be applied.

Remarks

If the method returns true, the ordering parameter can receive one of the following statuses:

Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

Reimplemented from OdIfc2x3::IfcMaterialProperties.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::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 OdIfc2x3::IfcMaterialProperties.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcFuelProperties::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 OdIfc2x3::IfcMaterialProperties.

◆ getCarbonContent()

double OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::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 * OdIfc2x3::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 OdIfc2x3::IfcMaterialProperties.

◆ getLowerHeatingValue()

double OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::IfcMaterialProperties.

◆ isKindOf()

virtual bool OdIfc2x3::IfcFuelProperties::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 OdIfc2x3::IfcMaterialProperties.

◆ outFields()

virtual OdResult OdIfc2x3::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 OdIfc2x3::IfcMaterialProperties.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::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 OdIfc2x3::IfcMaterialProperties.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcFuelProperties::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 OdIfc2x3::IfcMaterialProperties.

◆ setCarbonContent()

void OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::IfcMaterialProperties.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::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 OdIfc2x3::IfcMaterialProperties.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcFuelProperties::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 OdIfc2x3::IfcMaterialProperties.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcFuelProperties::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrName [in] Explicit name of the attribute to reset.

Reimplemented from OdIfc2x3::IfcMaterialProperties.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcFuelProperties::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 OdIfc2x3::IfcMaterialProperties.

Member Data Documentation

◆ m_CarbonContent

IfcPositiveRatioMeasure OdIfc2x3::IfcFuelProperties::m_CarbonContent

protected

Definition at line 250 of file Ifc2x3/IfcFuelPropertiesAutoImpl.h.

◆ m_CombustionTemperature

double OdIfc2x3::IfcFuelProperties::m_CombustionTemperature

protected

Definition at line 249 of file Ifc2x3/IfcFuelPropertiesAutoImpl.h.

◆ m_HigherHeatingValue

double OdIfc2x3::IfcFuelProperties::m_HigherHeatingValue

protected

Definition at line 252 of file Ifc2x3/IfcFuelPropertiesAutoImpl.h.

◆ m_LowerHeatingValue

double OdIfc2x3::IfcFuelProperties::m_LowerHeatingValue

protected

Definition at line 251 of file Ifc2x3/IfcFuelPropertiesAutoImpl.h.

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

Ifc2x3/IfcFuelPropertiesAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcFuelProperties()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCarbonContent()

◆ getCombustionTemperature()

◆ getHigherHeatingValue()

◆ getInstanceType()

◆ getLowerHeatingValue()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setCarbonContent()

◆ setCombustionTemperature()

◆ setHigherHeatingValue()

◆ setLowerHeatingValue()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_CarbonContent

◆ m_CombustionTemperature

◆ m_HigherHeatingValue

◆ m_LowerHeatingValue