CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcWaterProperties Class Reference

#include <IfcWaterPropertiesAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcWaterProperties:
OdIfc2x3::IfcMaterialProperties OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

OdDAI::Boolean getIsPotable () const
 
void setIsPotable (OdDAI::Boolean IsPotable)
 
double getHardness () const
 
void setHardness (double Hardness)
 
double getAlkalinityConcentration () const
 
void setAlkalinityConcentration (double AlkalinityConcentration)
 
double getAcidityConcentration () const
 
void setAcidityConcentration (double AcidityConcentration)
 
double getImpuritiesContent () const
 
void setImpuritiesContent (double ImpuritiesContent)
 
double getPHLevel () const
 
void setPHLevel (double PHLevel)
 
double getDissolvedSolidsContent () const
 
void setDissolvedSolidsContent (double DissolvedSolidsContent)
 
 IfcWaterProperties ()
 
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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAI::Boolean m_IsPotable
 
double m_Hardness
 
double m_AlkalinityConcentration
 
double m_AcidityConcentration
 
IfcNormalisedRatioMeasure m_ImpuritiesContent
 
double m_PHLevel
 
IfcNormalisedRatioMeasure m_DissolvedSolidsContent
 
- Protected Attributes inherited from OdIfc2x3::IfcMaterialProperties
OdDAIObjectId m_Material
 
- 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

This is a common definition that captures properties of water typically used within the context of building services and flow distribution systems.

Definition at line 40 of file Ifc2x3/IfcWaterPropertiesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcWaterProperties()

OdIfc2x3::IfcWaterProperties::IfcWaterProperties ( )

Default constructor for the IfcWaterProperties class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAcidityConcentration()

double OdIfc2x3::IfcWaterProperties::getAcidityConcentration ( ) const

Returns the value of AcidityConcentration attribute. This attribute represents the maximum CaCO3 equivalent that would neutralize the acid.

Returns
Returns the value of AcidityConcentration attribute.

◆ getAlkalinityConcentration()

double OdIfc2x3::IfcWaterProperties::getAlkalinityConcentration ( ) const

Returns the value of AlkalinityConcentration attribute. This attribute represents the maximum alkalinity concentration (maximum sum of concentrations of each of the negative ions substances measured as CaCO3).

Returns
Returns the value of AlkalinityConcentration attribute.

◆ getAttr() [1/2]

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

◆ getDissolvedSolidsContent()

double OdIfc2x3::IfcWaterProperties::getDissolvedSolidsContent ( ) const

Returns the value of DissolvedSolidsContent attribute. This attribute represents the fraction of the dissolved solids to the total amount of water. It is measured in weight of dissolved solids per weight of water and is therefore unitless.

Returns
Returns the value of DissolvedSolidsContent attribute.

◆ getHardness()

double OdIfc2x3::IfcWaterProperties::getHardness ( ) const

Returns the value of Hardness attribute. This attribute represents the water hardness as positive, multivalent ion concentration in the water (usually concentrations of calcium and magnesium ions in terms of calcium carbonate).

Returns
Returns the value of Hardness attribute.

◆ getImpuritiesContent()

double OdIfc2x3::IfcWaterProperties::getImpuritiesContent ( ) const

Returns the value of ImpuritiesContent attribute. This attribute represents the fraction of impurities such as dust to the total amount of water. This is measured in weight of impurities per weight of water and is therefore unitless.

Returns
Returns the value of ImpuritiesContent attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcWaterProperties::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.

◆ getIsPotable()

OdDAI::Boolean OdIfc2x3::IfcWaterProperties::getIsPotable ( ) const

Returns the value of IsPotable attribute. This attribute indicates whether the water is considered potable.

Returns
Returns the value of IsPotable attribute.

◆ getPHLevel()

double OdIfc2x3::IfcWaterProperties::getPHLevel ( ) const

Returns the value of PHLevel attribute. This attribute represents the maximum water PH in a range from 0-14.

Returns
Returns the value of PHLevel attribute.

◆ inFields()

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

◆ setAcidityConcentration()

void OdIfc2x3::IfcWaterProperties::setAcidityConcentration ( double AcidityConcentration)

Sets the value of AcidityConcentration attribute. This attribute represents the maximum CaCO3 equivalent that would neutralize the acid.

Parameters
AcidityConcentration[in] AcidityConcentration attribute to set.

◆ setAlkalinityConcentration()

void OdIfc2x3::IfcWaterProperties::setAlkalinityConcentration ( double AlkalinityConcentration)

Sets the value of AlkalinityConcentration attribute. This attribute represents the maximum alkalinity concentration (maximum sum of concentrations of each of the negative ions substances measured as CaCO3).

Parameters
AlkalinityConcentration[in] AlkalinityConcentration attribute to set.

◆ setDissolvedSolidsContent()

void OdIfc2x3::IfcWaterProperties::setDissolvedSolidsContent ( double DissolvedSolidsContent)

Sets the value of DissolvedSolidsContent attribute. This attribute represents the fraction of the dissolved solids to the total amount of water. It is measured in weight of dissolved solids per weight of water and is therefore unitless.

Parameters
DissolvedSolidsContent[in] DissolvedSolidsContent attribute to set.

◆ setHardness()

void OdIfc2x3::IfcWaterProperties::setHardness ( double Hardness)

Sets the value of Hardness attribute. This attribute represents the water hardness as positive, multivalent ion concentration in the water (usually concentrations of calcium and magnesium ions in terms of calcium carbonate).

Parameters
Hardness[in] Hardness attribute to set.

◆ setImpuritiesContent()

void OdIfc2x3::IfcWaterProperties::setImpuritiesContent ( double ImpuritiesContent)

Sets the value of ImpuritiesContent attribute. This attribute represents the fraction of impurities such as dust to the total amount of water. This is measured in weight of impurities per weight of water and is therefore unitless.

Parameters
ImpuritiesContent[in] ImpuritiesContent attribute to set.

◆ setIsPotable()

void OdIfc2x3::IfcWaterProperties::setIsPotable ( OdDAI::Boolean IsPotable)

Sets the value of IsPotable attribute. This attribute indicates whether the water is considered potable.

Parameters
IsPotable[in] IsPotable attribute to set.

◆ setPHLevel()

void OdIfc2x3::IfcWaterProperties::setPHLevel ( double PHLevel)

Sets the value of PHLevel attribute. This attribute represents the maximum water PH in a range from 0-14.

Parameters
PHLevel[in] PHLevel attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcWaterProperties::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::IfcWaterProperties::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::IfcWaterProperties::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::IfcWaterProperties::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::IfcWaterProperties::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_AcidityConcentration

double OdIfc2x3::IfcWaterProperties::m_AcidityConcentration
protected

Definition at line 299 of file Ifc2x3/IfcWaterPropertiesAutoImpl.h.

◆ m_AlkalinityConcentration

double OdIfc2x3::IfcWaterProperties::m_AlkalinityConcentration
protected

Definition at line 298 of file Ifc2x3/IfcWaterPropertiesAutoImpl.h.

◆ m_DissolvedSolidsContent

IfcNormalisedRatioMeasure OdIfc2x3::IfcWaterProperties::m_DissolvedSolidsContent
protected

Definition at line 302 of file Ifc2x3/IfcWaterPropertiesAutoImpl.h.

◆ m_Hardness

double OdIfc2x3::IfcWaterProperties::m_Hardness
protected

Definition at line 297 of file Ifc2x3/IfcWaterPropertiesAutoImpl.h.

◆ m_ImpuritiesContent

IfcNormalisedRatioMeasure OdIfc2x3::IfcWaterProperties::m_ImpuritiesContent
protected

Definition at line 300 of file Ifc2x3/IfcWaterPropertiesAutoImpl.h.

◆ m_IsPotable

OdDAI::Boolean OdIfc2x3::IfcWaterProperties::m_IsPotable
protected

Definition at line 296 of file Ifc2x3/IfcWaterPropertiesAutoImpl.h.

◆ m_PHLevel

double OdIfc2x3::IfcWaterProperties::m_PHLevel
protected

Definition at line 301 of file Ifc2x3/IfcWaterPropertiesAutoImpl.h.


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