#include <IfcAppliedValueAutoImpl.h>

Inheritance diagram for OdIfc4x3_rc1::IfcAppliedValue:

Public Member Functions
const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

IfcAppliedValueSelect	appliedValue ()

const OdDAIObjectId &	getUnitBasis () const

void	setUnitBasis (const OdDAIObjectId &UnitBasis)

const OdAnsiString &	getApplicableDate () const

void	setApplicableDate (const OdAnsiString &ApplicableDate)

const OdAnsiString &	getFixedUntilDate () const

void	setFixedUntilDate (const OdAnsiString &FixedUntilDate)

const OdAnsiString &	getCategory () const

void	setCategory (const OdAnsiString &Category)

const OdAnsiString &	getCondition () const

void	setCondition (const OdAnsiString &Condition)

IfcArithmeticOperatorEnum	getArithmeticOperator () const

void	setArithmeticOperator (IfcArithmeticOperatorEnum ArithmeticOperator)

void	getComponents (OdDAIObjectIds &Components) const

OdDAI::ListOfOdDAIObjectId &	components ()

void	getInvHasExternalReference (OdDAIObjectIds &HasExternalReference) const

	IfcAppliedValue ()

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 OdIfc4x3_rc1::OdIfc4x3_RC1Instance
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
OdAnsiString	m_Name

OdAnsiString	m_Description

OdDAI::Select	m_AppliedValue

OdDAIObjectId	m_UnitBasis

OdAnsiString	m_ApplicableDate

OdAnsiString	m_FixedUntilDate

OdAnsiString	m_Category

OdAnsiString	m_Condition

OdDAI::Enum	m_ArithmeticOperator

OdDAI::ListOfOdDAIObjectId	m_Components

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcExternalReferenceRelationship

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

This entity captures a value driven by a formula, with additional qualifications including unit basis, valid date range, and categorization.

The extent of the IfcAppliedValue is determined by the AppliedValue attribute which can be defined either as an IfcMeasureWithUnit or as an IfcMonetaryMeasure or as an IfcRatioMeasure via the IfcAppliedValueSelect type.

Optionally, an IfcAppliedValue can have an applicable date. This is intended to fix the date on which the value became relevant for use. It can be the date on which the value was set in the model or it can be a prior or future date when the value becomes operable. Similarly, an IfcAppliedValue can have a 'fixed until' date. This is intended to fix the date on which the value ceases to be relevant for use.

\changes

IFC4 changes: Type of the ApplicableDate attribute changed from "IfcDateTimeSelect" to "IfcDate" Type of the FixedUntilDate attribute changed from "IfcDateTimeSelect" to "IfcDate" Inverse attribute ValuesReferenced renamed to HasExternalReference Type of the inverse attribute ValuesReferenced changed from "SET OF [0:?] IfcReferencesValueDocument FOR ReferencingValues" to "SET OF [0:?] IfcExternalReferenceRelationship FOR RelatedResourceObjects"

Definition at line 64 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcAppliedValue()

OdIfc4x3_rc1::IfcAppliedValue::IfcAppliedValue ( )

Default constructor for the IfcAppliedValue class.

Member Function Documentation

◆ appliedValue()

IfcAppliedValueSelect OdIfc4x3_rc1::IfcAppliedValue::appliedValue ( )

Returns the value of AppliedValue attribute. This attribute represents the extent (or quantity, or amount) of an applied value.

Returns: Returns the value of AppliedValue attribute.

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_rc1::IfcAppliedValue::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 in OdIfc4x3_rc1::IfcCostValue.

◆ components()

OdDAI::ListOfOdDAIObjectId & OdIfc4x3_rc1::IfcAppliedValue::components ( )

Returns the value of Components attribute. This attribute represents optional component values from which AppliedValue is calculated.

Returns: Returns the value of Components attribute.

◆ getApplicableDate()

const OdAnsiString & OdIfc4x3_rc1::IfcAppliedValue::getApplicableDate ( ) const

Returns the value of ApplicableDate attribute. This attribute represents the date on or from which an applied value is applicable.

Returns: Returns the value of ApplicableDate attribute.

◆ getArithmeticOperator()

IfcArithmeticOperatorEnum OdIfc4x3_rc1::IfcAppliedValue::getArithmeticOperator ( ) const

Returns the value of ArithmeticOperator attribute. This attribute represents the arithmetic operator applied to component values.

Returns: Returns the value of ArithmeticOperator attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_rc1::IfcAppliedValue::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 OdIfc4x3_rc1::IfcAppliedValue::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.

◆ getCategory()

const OdAnsiString & OdIfc4x3_rc1::IfcAppliedValue::getCategory ( ) const

Returns the value of Category attribute. This attribute represents specification of the type of cost used.

Returns: Returns the value of Category attribute.

◆ getComponents()

void OdIfc4x3_rc1::IfcAppliedValue::getComponents ( OdDAIObjectIds & Components ) const

Gets the value of Components attribute. This attribute represents optional component values from which AppliedValue is calculated.

Parameters

Components [out] Receives the components.

◆ getCondition()

const OdAnsiString & OdIfc4x3_rc1::IfcAppliedValue::getCondition ( ) const

Returns the value of Condition attribute. This attribute represents the condition under which a cost value applies. For example, within the context of a bid submission, this can refer to an option that may or may not be elected.

Returns: Returns the value of Condition attribute.

◆ getDescription()

const OdAnsiString & OdIfc4x3_rc1::IfcAppliedValue::getDescription ( ) const

Returns the value of Description attribute. This attribute represents the description that can apply additional information about a cost value.

Returns: Returns the value of Description attribute.

◆ getFixedUntilDate()

const OdAnsiString & OdIfc4x3_rc1::IfcAppliedValue::getFixedUntilDate ( ) const

Returns the value of FixedUntilDate attribute. This attribute represents the date until which applied value is applicable.

Returns: Returns the value of FixedUntilDate attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_rc1::IfcAppliedValue::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 in OdIfc4x3_rc1::IfcCostValue.

◆ getInvHasExternalReference()

void OdIfc4x3_rc1::IfcAppliedValue::getInvHasExternalReference ( OdDAIObjectIds & HasExternalReference ) const

Returns the value of HasExternalReference attribute. This attribute represents reference to an external reference, e.g. library, classification, or document information, that is associated to the IfcAppliedValue.

Parameters

HasExternalReference [out] Receives the value of HasExternalReference attribute.

◆ getName()

const OdAnsiString & OdIfc4x3_rc1::IfcAppliedValue::getName ( ) const

Returns the value of Name attribute. This attribute represents a name or additional clarification given to a cost value.

Returns: Returns the value of Name attribute.

◆ getUnitBasis()

const OdDAIObjectId & OdIfc4x3_rc1::IfcAppliedValue::getUnitBasis ( ) const

Returns the value of UnitBasis attribute. This attribute represents the number and unit of measure on which the unit cost is based.

Returns: Returns the value of UnitBasis attribute.

Remarks: As well as the normally expected units of measure such as length, area, volume etc., costs can be based on units of measure which need to be defined e.g. sack, drum, pallet, item etc. Unit costs can be based on quantities greater (or lesser) than a unitary value of the basis measure.

◆ inFields()

virtual OdResult OdIfc4x3_rc1::IfcAppliedValue::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 OdIfc4x3_rc1::IfcAppliedValue::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.

Reimplemented in OdIfc4x3_rc1::IfcCostValue.

◆ outFields()

virtual OdResult OdIfc4x3_rc1::IfcAppliedValue::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 OdIfc4x3_rc1::IfcAppliedValue::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 OdIfc4x3_rc1::IfcAppliedValue::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.

◆ setApplicableDate()

void OdIfc4x3_rc1::IfcAppliedValue::setApplicableDate ( const OdAnsiString & ApplicableDate )

Sets the value of ApplicableDate attribute. This attribute represents the date on or from which an applied value is applicable.

Parameters

ApplicableDate [in] Applicable date to set.

◆ setArithmeticOperator()

void OdIfc4x3_rc1::IfcAppliedValue::setArithmeticOperator ( IfcArithmeticOperatorEnum ArithmeticOperator )

Sets the value of ArithmeticOperator attribute. This attribute represents the arithmetic operator applied to component values.

Parameters

ArithmeticOperator [in] Arithmetic operator to set.

◆ setCategory()

void OdIfc4x3_rc1::IfcAppliedValue::setCategory ( const OdAnsiString & Category )

Sets the value of Category attribute. This attribute represents specification of the type of cost used.

Parameters

Category [in] Category to set.

◆ setCondition()

void OdIfc4x3_rc1::IfcAppliedValue::setCondition ( const OdAnsiString & Condition )

Sets the value of Condition attribute. This attribute represents the condition under which a cost value applies. For example, within the context of a bid submission, this can refer to an option that may or may not be elected.

Parameters

Condition [in] Condition to set.

◆ setDescription()

void OdIfc4x3_rc1::IfcAppliedValue::setDescription ( const OdAnsiString & Description )

Sets the value of Description attribute. This attribute represents the description that can apply additional information about a cost value.

Parameters

Description [in] Description to set.

◆ setFixedUntilDate()

void OdIfc4x3_rc1::IfcAppliedValue::setFixedUntilDate ( const OdAnsiString & FixedUntilDate )

Sets the value of FixedUntilDate attribute. This attribute represents the date until which applied value is applicable.

Parameters

FixedUntilDate [in] Fixed until date to set.

◆ setName()

void OdIfc4x3_rc1::IfcAppliedValue::setName ( const OdAnsiString & Name )

Sets the value of Name attribute. This attribute represents a name or additional clarification given to a cost value.

Parameters

Name	[in] Name to set.

◆ setUnitBasis()

void OdIfc4x3_rc1::IfcAppliedValue::setUnitBasis ( const OdDAIObjectId & UnitBasis )

Sets the value of UnitBasis attribute. This attribute represents the number and unit of measure on which the unit cost is based.

Parameters

UnitBasis [in] Unit basis to set.

Remarks: As well as the normally expected units of measure such as length, area, volume etc., costs can be based on units of measure which need to be defined e.g. sack, drum, pallet, item etc. Unit costs can be based on quantities greater (or lesser) than a unitary value of the basis measure.

◆ testAttr() [1/2]

virtual bool OdIfc4x3_rc1::IfcAppliedValue::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 OdIfc4x3_rc1::IfcAppliedValue::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 OdIfc4x3_rc1::IfcAppliedValue::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.

Reimplemented in OdIfc4x3_rc1::IfcCostValue.

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_rc1::IfcAppliedValue::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 OdIfc4x3_rc1::IfcAppliedValue::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.

Friends And Related Symbol Documentation

◆ IfcExternalReferenceRelationship

friend class IfcExternalReferenceRelationship

friend

Definition at line 381 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

Member Data Documentation

◆ m_ApplicableDate

OdAnsiString OdIfc4x3_rc1::IfcAppliedValue::m_ApplicableDate

protected

Definition at line 372 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_AppliedValue

OdDAI::Select OdIfc4x3_rc1::IfcAppliedValue::m_AppliedValue

protected

Definition at line 370 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_ArithmeticOperator

OdDAI::Enum OdIfc4x3_rc1::IfcAppliedValue::m_ArithmeticOperator

protected

Definition at line 376 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_Category

OdAnsiString OdIfc4x3_rc1::IfcAppliedValue::m_Category

protected

Definition at line 374 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_Components

OdDAI::ListOfOdDAIObjectId OdIfc4x3_rc1::IfcAppliedValue::m_Components

protected

Definition at line 377 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_Condition

OdAnsiString OdIfc4x3_rc1::IfcAppliedValue::m_Condition

protected

Definition at line 375 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc4x3_rc1::IfcAppliedValue::m_Description

protected

Definition at line 369 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_FixedUntilDate

OdAnsiString OdIfc4x3_rc1::IfcAppliedValue::m_FixedUntilDate

protected

Definition at line 373 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x3_rc1::IfcAppliedValue::m_Name

protected

Definition at line 368 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

◆ m_UnitBasis

OdDAIObjectId OdIfc4x3_rc1::IfcAppliedValue::m_UnitBasis

protected

Definition at line 371 of file Ifc4x3_RC1/IfcAppliedValueAutoImpl.h.

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

Ifc4x3_RC1/IfcAppliedValueAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcAppliedValue()

Member Function Documentation

◆ appliedValue()

◆ comparedToEarlyImpl()

◆ components()

◆ getApplicableDate()

◆ getArithmeticOperator()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCategory()

◆ getComponents()

◆ getCondition()

◆ getDescription()

◆ getFixedUntilDate()

◆ getInstanceType()

◆ getInvHasExternalReference()

◆ getName()

◆ getUnitBasis()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setApplicableDate()

◆ setArithmeticOperator()

◆ setCategory()

◆ setCondition()

◆ setDescription()

◆ setFixedUntilDate()

◆ setName()

◆ setUnitBasis()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcExternalReferenceRelationship

Member Data Documentation

◆ m_ApplicableDate

◆ m_AppliedValue

◆ m_ArithmeticOperator

◆ m_Category

◆ m_Components

◆ m_Condition

◆ m_Description

◆ m_FixedUntilDate

◆ m_Name

◆ m_UnitBasis