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

#include <IfcMetricBenchmarkAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcMetricBenchmark:
OdIfc2x_final::IfcMetric OdIfc2x_final::IfcConstraint OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

IfcBenchmarkEnum getBenchmark () const
 
void setBenchmark (IfcBenchmarkEnum Benchmark)
 
 IfcMetricBenchmark ()
 
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::IfcMetric
void getValues (OdDAIObjectIds &Values) const
 
OdDAI::ListOfOdDAIObjectId & values ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcConstraint
IfcConstraintEnum getConstraintGrade () const
 
void setConstraintGrade (IfcConstraintEnum ConstraintGrade)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
const OdAnsiString & getConstraintSource () const
 
void setConstraintSource (const OdAnsiString &ConstraintSource)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
IfcActorSelect creatingActor ()
 
IfcDateTimeSelect creationTime ()
 
void getInvAggregates (OdDAIObjectIds &Aggregates) const
 
void getInvIsAggregatedIn (OdDAIObjectIds &IsAggregatedIn) const
 
 IfcConstraint ()
 
- 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_Benchmark
 
- Protected Attributes inherited from OdIfc2x_final::IfcMetric
OdDAI::ListOfOdDAIObjectId m_Values
 
- Protected Attributes inherited from OdIfc2x_final::IfcConstraint
OdDAI::Enum m_ConstraintGrade
 
OdAnsiString m_Description
 
OdAnsiString m_ConstraintSource
 
OdAnsiString m_Name
 
OdDAI::Select m_CreatingActor
 
OdDAI::Select m_CreationTime
 
- 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

The class IfcMetricBenchmark is used to capture quantitative benchmark metrics that can be applied to objectives. It is subtype of IfcConstraint and therefore referenced by IfcConstraintUsage in IfcControlExtension schema, and thereby can be related to IfcObjects through appropriate objectified relationship declared in IfcKernel schema.

Definition at line 42 of file IfcMetricBenchmarkAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcMetricBenchmark()

OdIfc2x_final::IfcMetricBenchmark::IfcMetricBenchmark ( )

Default constructor for the IfcMetricBenchmark class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getBenchmark()

IfcBenchmarkEnum OdIfc2x_final::IfcMetricBenchmark::getBenchmark ( ) const

Returns the value of Benchmark attribute. This attribute represents the type of benchmark data.

Returns
Returns the value of Benchmark attribute.

◆ getInstanceType()

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

◆ inFields()

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

◆ isKindOf()

virtual bool OdIfc2x_final::IfcMetricBenchmark::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::IfcMetric.

◆ outFields()

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

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcMetricBenchmark::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::IfcMetric.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcMetricBenchmark::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::IfcMetric.

◆ setBenchmark()

void OdIfc2x_final::IfcMetricBenchmark::setBenchmark ( IfcBenchmarkEnum Benchmark)

Sets the value of Benchmark attribute. This attribute represents the type of benchmark data.

Parameters
Benchmark[in] Benchmark attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcMetricBenchmark::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::IfcMetric.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcMetricBenchmark::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::IfcMetric.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcMetricBenchmark::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::IfcMetric.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcMetricBenchmark::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::IfcMetric.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcMetricBenchmark::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::IfcMetric.

Member Data Documentation

◆ m_Benchmark

OdDAI::Enum OdIfc2x_final::IfcMetricBenchmark::m_Benchmark
protected

Definition at line 181 of file IfcMetricBenchmarkAutoImpl.h.


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