#include <IfcObjectiveAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcObjective:

Public Member Functions
void	getBenchmarkValues (OdDAIObjectIds &BenchmarkValues) const

OdDAI::ListOfOdDAIObjectId &	benchmarkValues ()

IfcLogicalOperatorEnum	getLogicalAggregator () const

void	setLogicalAggregator (IfcLogicalOperatorEnum LogicalAggregator)

IfcObjectiveEnum	getObjectiveQualifier () const

void	setObjectiveQualifier (IfcObjectiveEnum ObjectiveQualifier)

const OdAnsiString &	getUserDefinedQualifier () const

void	setUserDefinedQualifier (const OdAnsiString &UserDefinedQualifier)

	IfcObjective ()

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 OdIfc4x1::IfcConstraint
const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

IfcConstraintEnum	getConstraintGrade () const

void	setConstraintGrade (IfcConstraintEnum ConstraintGrade)

const OdAnsiString &	getConstraintSource () const

void	setConstraintSource (const OdAnsiString &ConstraintSource)

IfcActorSelect	creatingActor ()

const OdAnsiString &	getCreationTime () const

void	setCreationTime (const OdAnsiString &CreationTime)

const OdAnsiString &	getUserDefinedGrade () const

void	setUserDefinedGrade (const OdAnsiString &UserDefinedGrade)

void	getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const

void	getInvPropertiesForConstraint (OdDAIObjectIds &PropertiesForConstraint) const

	IfcConstraint ()

Public Member Functions inherited from OdIfc4x1::OdIfc4x1Instance
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
OdDAI::ListOfOdDAIObjectId	m_BenchmarkValues

OdDAI::Enum	m_LogicalAggregator

OdDAI::Enum	m_ObjectiveQualifier

OdAnsiString	m_UserDefinedQualifier

Protected Attributes inherited from OdIfc4x1::IfcConstraint
OdAnsiString	m_Name

OdAnsiString	m_Description

OdDAI::Enum	m_ConstraintGrade

OdAnsiString	m_ConstraintSource

OdDAI::Select	m_CreatingActor

OdAnsiString	m_CreationTime

OdAnsiString	m_UserDefinedGrade

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

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.

\changes

IFC4 changes: Type of the BenchmarkValues attribute changed from "IfcMetric" to "list[1:?] of IfcConstraint" Attribute ResultValues renamed to LogicalAggregator Type of the ResultValues attribute changed from "IfcMetric" to "IfcLogicalOperatorEnum"

Definition at line 48 of file Ifc4x1/IfcObjectiveAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcObjective()

OdIfc4x1::IfcObjective::IfcObjective ( )

Default constructor for the IfcObjective class.

Member Function Documentation

◆ benchmarkValues()

OdDAI::ListOfOdDAIObjectId & OdIfc4x1::IfcObjective::benchmarkValues ( )

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::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 OdIfc4x1::IfcConstraint.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x1::IfcObjective::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 OdIfc4x1::IfcConstraint.

◆ getBenchmarkValues()

void OdIfc4x1::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 * OdIfc4x1::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 OdIfc4x1::IfcConstraint.

◆ getLogicalAggregator()

IfcLogicalOperatorEnum OdIfc4x1::IfcObjective::getLogicalAggregator ( ) const

Returns the value of LogicalAggregator attribute. This attribute represents enumeration that identifies the logical type of aggregation for the benchmark metrics.

Returns: Returns the value of LogicalAggregator attribute.

◆ getObjectiveQualifier()

IfcObjectiveEnum OdIfc4x1::IfcObjective::getObjectiveQualifier ( ) const

Returns the value of ObjectiveQualifier attribute. This attribute represents enumeration that qualifies the type of objective constraint.

Returns: Returns the value of ObjectiveQualifier attribute.

◆ getUserDefinedQualifier()

const OdAnsiString & OdIfc4x1::IfcObjective::getUserDefinedQualifier ( ) const

Returns the value of UserDefinedQualifier attribute. This attribute represents a user defined value that qualifies the type of objective constraint when ObjectiveQualifier attribute of type IfcObjectiveEnum has value USERDEFINED.

Returns: Returns the value of UserDefinedQualifier attribute.

◆ inFields()

virtual OdResult OdIfc4x1::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 OdIfc4x1::IfcConstraint.

◆ isKindOf()

virtual bool OdIfc4x1::IfcObjective::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 OdIfc4x1::IfcConstraint.

◆ outFields()

virtual OdResult OdIfc4x1::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 OdIfc4x1::IfcConstraint.

◆ putAttr() [1/2]

virtual bool OdIfc4x1::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 OdIfc4x1::IfcConstraint.

◆ putAttr() [2/2]

virtual bool OdIfc4x1::IfcObjective::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 OdIfc4x1::IfcConstraint.

◆ setLogicalAggregator()

void OdIfc4x1::IfcObjective::setLogicalAggregator ( IfcLogicalOperatorEnum LogicalAggregator )

Sets the value of LogicalAggregator attribute. This attribute represents enumeration that identifies the logical type of aggregation for the benchmark metrics.

Parameters

LogicalAggregator [in] Logical aggregator to set.

◆ setObjectiveQualifier()

void OdIfc4x1::IfcObjective::setObjectiveQualifier ( IfcObjectiveEnum ObjectiveQualifier )

Sets the value of ObjectiveQualifier attribute. This attribute represents enumeration that qualifies the type of objective constraint.

Parameters

ObjectiveQualifier [in] Objective qualifier to set.

◆ setUserDefinedQualifier()

void OdIfc4x1::IfcObjective::setUserDefinedQualifier ( const OdAnsiString & UserDefinedQualifier )

Sets the value of UserDefinedQualifier attribute. This attribute represents a user defined value that qualifies the type of objective constraint when ObjectiveQualifier attribute of type IfcObjectiveEnum has value USERDEFINED.

Parameters

UserDefinedQualifier [in] User-defined qualifier to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::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 OdIfc4x1::IfcConstraint.

◆ testAttr() [2/2]

virtual bool OdIfc4x1::IfcObjective::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 OdIfc4x1::IfcConstraint.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x1::IfcObjective::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 OdIfc4x1::IfcConstraint.

◆ unsetAttr() [1/2]

virtual void OdIfc4x1::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 OdIfc4x1::IfcConstraint.

◆ unsetAttr() [2/2]

virtual void OdIfc4x1::IfcObjective::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 OdIfc4x1::IfcConstraint.

Member Data Documentation

◆ m_BenchmarkValues

OdDAI::ListOfOdDAIObjectId OdIfc4x1::IfcObjective::m_BenchmarkValues

protected

Definition at line 228 of file Ifc4x1/IfcObjectiveAutoImpl.h.

◆ m_LogicalAggregator

OdDAI::Enum OdIfc4x1::IfcObjective::m_LogicalAggregator

protected

Definition at line 230 of file Ifc4x1/IfcObjectiveAutoImpl.h.

◆ m_ObjectiveQualifier

OdDAI::Enum OdIfc4x1::IfcObjective::m_ObjectiveQualifier

protected

Definition at line 231 of file Ifc4x1/IfcObjectiveAutoImpl.h.

◆ m_UserDefinedQualifier

OdAnsiString OdIfc4x1::IfcObjective::m_UserDefinedQualifier

protected

Definition at line 232 of file Ifc4x1/IfcObjectiveAutoImpl.h.

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

Ifc4x1/IfcObjectiveAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcObjective()

Member Function Documentation

◆ benchmarkValues()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getBenchmarkValues()

◆ getInstanceType()

◆ getLogicalAggregator()

◆ getObjectiveQualifier()

◆ getUserDefinedQualifier()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setLogicalAggregator()

◆ setObjectiveQualifier()

◆ setUserDefinedQualifier()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_BenchmarkValues

◆ m_LogicalAggregator

◆ m_ObjectiveQualifier

◆ m_UserDefinedQualifier