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

#include <IfcCostQuantityAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcCostQuantity:
OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

const OdDAIObjectId & getBaseQuantity () const
 
void setBaseQuantity (const OdDAIObjectId &BaseQuantity)
 
const OdDAIObjectId & getFinalQuantity () const
 
void setFinalQuantity (const OdDAIObjectId &FinalQuantity)
 
double getWasteFactor () const
 
void setWasteFactor (double WasteFactor)
 
double getRoundOffIncrement () const
 
void setRoundOffIncrement (double RoundOffIncrement)
 
IfcQuantityRoundOffBasisEnum getRoundOffBasis () const
 
void setRoundOffBasis (IfcQuantityRoundOffBasisEnum RoundOffBasis)
 
 IfcCostQuantity ()
 
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 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

OdDAIObjectId m_BaseQuantity
 
OdDAIObjectId m_FinalQuantity
 
IfcPositiveRatioMeasure m_WasteFactor
 
double m_RoundOffIncrement
 
OdDAI::Enum m_RoundOffBasis
 
- 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 IfcCostQuantity contains quantities that can be applied to a cost.

Definition at line 45 of file IfcCostQuantityAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCostQuantity()

OdIfc2x_final::IfcCostQuantity::IfcCostQuantity ( )

Default constructor for the IfcCostQuantity class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcCostQuantity::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 OdIfc::OdIfcInstance.

◆ getBaseQuantity()

const OdDAIObjectId & OdIfc2x_final::IfcCostQuantity::getBaseQuantity ( ) const

Returns the value of BaseQuantity attribute. This attribute represents the "as measured" quantity resulting from a quantity takeoff or similar operation.

Returns
Returns the value of BaseQuantity attribute.

◆ getFinalQuantity()

const OdDAIObjectId & OdIfc2x_final::IfcCostQuantity::getFinalQuantity ( ) const

Returns the value of FinalQuantity attribute. This attribute represents a value used for the actual price calculations and the only quantity used if no modifications are used.

Returns
Returns the value of FinalQuantity attribute.

◆ getInstanceType()

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

◆ getRoundOffBasis()

IfcQuantityRoundOffBasisEnum OdIfc2x_final::IfcCostQuantity::getRoundOffBasis ( ) const

Returns the value of RoundOffBasis attribute. This attribute represents the basis on which quantities are 'rounded off' i.e. the nearest unit for quantification purposes that can be used. For instance, a numerical quantity can be determined to be 4.886 but should be rounded up with an increment of 0.1 meters or 1 decimal place. In this case, a value of 4.9 would be applied.

Returns
Returns the value of RoundOffBasis attribute.

◆ getRoundOffIncrement()

double OdIfc2x_final::IfcCostQuantity::getRoundOffIncrement ( ) const

Returns the value of RoundOffIncrement attribute. This attribute represents a number indicating the size of units that quantities should be rounded off to, particularly in the case of materials that must be ordered in specific size lots.

Returns
Returns the value of RoundOffIncrement attribute.

◆ getWasteFactor()

double OdIfc2x_final::IfcCostQuantity::getWasteFactor ( ) const

Returns the value of WasteFactor attribute. This attribute represents a quantity to be added to base quantities to account for wasteage.

Returns
Returns the value of WasteFactor attribute.

◆ inFields()

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

◆ isKindOf()

virtual bool OdIfc2x_final::IfcCostQuantity::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 OdIfc::OdIfcInstance.

◆ outFields()

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

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcCostQuantity::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 OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcCostQuantity::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 OdIfc::OdIfcInstance.

◆ setBaseQuantity()

void OdIfc2x_final::IfcCostQuantity::setBaseQuantity ( const OdDAIObjectId & BaseQuantity)

Sets the value of BaseQuantity attribute. This attribute represents the "as measured" quantity resulting from a quantity takeoff or similar operation.

Parameters
BaseQuantity[in] BaseQuantity attribute to set.

◆ setFinalQuantity()

void OdIfc2x_final::IfcCostQuantity::setFinalQuantity ( const OdDAIObjectId & FinalQuantity)

Sets the value of FinalQuantity attribute. This attribute represents a value used for the actual price calculations and the only quantity used if no modifications are used.

Parameters
FinalQuantity[in] FinalQuantity attribute to set.

◆ setRoundOffBasis()

void OdIfc2x_final::IfcCostQuantity::setRoundOffBasis ( IfcQuantityRoundOffBasisEnum RoundOffBasis)

Sets the value of RoundOffBasis attribute. This attribute represents the basis on which quantities are 'rounded off' i.e. the nearest unit for quantification purposes that can be used. For instance, a numerical quantity can be determined to be 4.886 but should be rounded up with an increment of 0.1 meters or 1 decimal place. In this case, a value of 4.9 would be applied.

Parameters
RoundOffBasis[in] RoundOffBasis attribute to set.

◆ setRoundOffIncrement()

void OdIfc2x_final::IfcCostQuantity::setRoundOffIncrement ( double RoundOffIncrement)

Sets the value of RoundOffIncrement attribute. This attribute represents a number indicating the size of units that quantities should be rounded off to, particularly in the case of materials that must be ordered in specific size lots.

Parameters
RoundOffIncrement[in] RoundOffIncrement attribute to set.

◆ setWasteFactor()

void OdIfc2x_final::IfcCostQuantity::setWasteFactor ( double WasteFactor)

Sets the value of WasteFactor attribute. This attribute represents a quantity to be added to base quantities to account for wasteage.

Parameters
WasteFactor[in] WasteFactor attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcCostQuantity::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 OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcCostQuantity::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 OdIfc::OdIfcInstance.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcCostQuantity::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 OdIfc::OdIfcInstance.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcCostQuantity::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcCostQuantity::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 OdIfc::OdIfcInstance.

Member Data Documentation

◆ m_BaseQuantity

OdDAIObjectId OdIfc2x_final::IfcCostQuantity::m_BaseQuantity
protected

Definition at line 252 of file IfcCostQuantityAutoImpl.h.

◆ m_FinalQuantity

OdDAIObjectId OdIfc2x_final::IfcCostQuantity::m_FinalQuantity
protected

Definition at line 253 of file IfcCostQuantityAutoImpl.h.

◆ m_RoundOffBasis

OdDAI::Enum OdIfc2x_final::IfcCostQuantity::m_RoundOffBasis
protected

Definition at line 256 of file IfcCostQuantityAutoImpl.h.

◆ m_RoundOffIncrement

double OdIfc2x_final::IfcCostQuantity::m_RoundOffIncrement
protected

Definition at line 255 of file IfcCostQuantityAutoImpl.h.

◆ m_WasteFactor

IfcPositiveRatioMeasure OdIfc2x_final::IfcCostQuantity::m_WasteFactor
protected

Definition at line 254 of file IfcCostQuantityAutoImpl.h.


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