#include <IfcObjectiveAutoImpl.h>
The IfcObjective definition captures qualitative information for an objective-based constraint. IfcObjective specifies the purpose for which the constraint is applied and to capture the benchmark metrics of the constraint.
Definition at line 41 of file Ifc2x_Final/IfcObjectiveAutoImpl.h.
◆ IfcObjective()
| OdIfc2x_final::IfcObjective::IfcObjective |
( |
| ) |
|
◆ benchmarkValues()
| OdDAI::ListOfOdDAIObjectId & OdIfc2x_final::IfcObjective::benchmarkValues |
( |
| ) |
|
◆ getAttr() [1/2]
| virtual OdRxValue OdIfc2x_final::IfcObjective::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::IfcConstraint.
◆ 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 OdIfc2x_final::IfcConstraint.
◆ getBenchmarkValues()
| void OdIfc2x_final::IfcObjective::getBenchmarkValues |
( |
OdDAIObjectIds & | BenchmarkValues | ) |
const |
Returns the value of BenchmarkValues attribute. This attribute represents a list of benchmark values used for comparison purposes.
- Returns
- Returns the value of BenchmarkValues attribute.
◆ getInstanceType()
| virtual OdDAI::Entity * OdIfc2x_final::IfcObjective::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::IfcConstraint.
◆ getObjectiveQualifier()
Returns the value of ObjectiveQualifier attribute. This attribute represents enumeration that qualifies the type of objective constraint.
- Returns
- Returns the value of ObjectiveQualifier attribute.
◆ getResultValues()
| void OdIfc2x_final::IfcObjective::getResultValues |
( |
OdDAIObjectIds & | ResultValues | ) |
const |
Returns the value of BenchmarkValues attribute. This attribute represents a list of resultant values used for comparison purposes.
- Returns
- Returns the value of BenchmarkValues attribute.
◆ inFields()
| virtual OdResult OdIfc2x_final::IfcObjective::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::IfcConstraint.
◆ 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 OdIfc2x_final::IfcConstraint.
◆ outFields()
| virtual OdResult OdIfc2x_final::IfcObjective::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::IfcConstraint.
◆ putAttr() [1/2]
| virtual bool OdIfc2x_final::IfcObjective::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::IfcConstraint.
◆ 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 OdIfc2x_final::IfcConstraint.
◆ resultValues()
| OdDAI::ListOfOdDAIObjectId & OdIfc2x_final::IfcObjective::resultValues |
( |
| ) |
|
◆ setObjectiveQualifier()
Sets the value of ObjectiveQualifier attribute. This attribute represents enumeration that qualifies the type of objective constraint.
- Parameters
-
| ObjectiveQualifier | [in] Objective qualifier to set. |
◆ testAttr() [1/2]
| virtual bool OdIfc2x_final::IfcObjective::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::IfcConstraint.
◆ testAttr() [2/2]
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::IfcConstraint.
◆ type()
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::IfcConstraint.
◆ unsetAttr() [1/2]
| virtual void OdIfc2x_final::IfcObjective::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::IfcConstraint.
◆ unsetAttr() [2/2]
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrDef | [in] Explicit definition that represents an attribute to reset. |
Reimplemented from OdIfc2x_final::IfcConstraint.
◆ m_BenchmarkValues
| OdDAI::ListOfOdDAIObjectId OdIfc2x_final::IfcObjective::m_BenchmarkValues |
|
protected |
◆ m_ObjectiveQualifier
| OdDAI::Enum OdIfc2x_final::IfcObjective::m_ObjectiveQualifier |
|
protected |
◆ m_ResultValues
| OdDAI::ListOfOdDAIObjectId OdIfc2x_final::IfcObjective::m_ResultValues |
|
protected |
The documentation for this class was generated from the following file: