#include <IfcAppliedValueAutoImpl.h>

Inheritance diagram for OdIfc2x3::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)

IfcDateTimeSelect	applicableDate ()

IfcDateTimeSelect	fixedUntilDate ()

void	getInvValuesReferenced (OdDAIObjectIds &ValuesReferenced) const

void	getInvValueOfComponents (OdDAIObjectIds &ValueOfComponents) const

void	getInvIsComponentIn (OdDAIObjectIds &IsComponentIn) 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 OdIfc2x3::OdIfc2x3Instance
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

OdDAI::Select	m_ApplicableDate

OdDAI::Select	m_FixedUntilDate

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcReferencesValueDocument

class	IfcAppliedValueRelationship

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.

Definition at line 56 of file Ifc2x3/IfcAppliedValueAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcAppliedValue()

OdIfc2x3::IfcAppliedValue::IfcAppliedValue ( )

Default constructor for the IfcAppliedValue class.

Member Function Documentation

◆ applicableDate()

IfcDateTimeSelect OdIfc2x3::IfcAppliedValue::applicableDate ( )

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.

◆ appliedValue()

IfcAppliedValueSelect OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ fixedUntilDate()

IfcDateTimeSelect OdIfc2x3::IfcAppliedValue::fixedUntilDate ( )

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

Returns: Returns the value of FixedUntilDate attribute.

◆ getAttr() [1/2]

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

Reimplemented in OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ getAttr() [2/2]

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

Reimplemented in OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ getDescription()

const OdAnsiString & OdIfc2x3::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.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::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 OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ getInvIsComponentIn()

void OdIfc2x3::IfcAppliedValue::getInvIsComponentIn ( OdDAIObjectIds & IsComponentIn ) const

◆ getInvValueOfComponents()

void OdIfc2x3::IfcAppliedValue::getInvValueOfComponents ( OdDAIObjectIds & ValueOfComponents ) const

◆ getInvValuesReferenced()

void OdIfc2x3::IfcAppliedValue::getInvValuesReferenced ( OdDAIObjectIds & ValuesReferenced ) const

◆ getName()

const OdAnsiString & OdIfc2x3::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 & OdIfc2x3::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 OdIfc2x3::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.

Reimplemented in OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ isKindOf()

virtual bool OdIfc2x3::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 OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ outFields()

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

Reimplemented in OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ putAttr() [1/2]

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

Reimplemented in OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ putAttr() [2/2]

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

Reimplemented in OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ setDescription()

void OdIfc2x3::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.

◆ setName()

void OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::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.

Reimplemented in OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::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 OdIfc2x3::IfcCostValue, and OdIfc2x3::IfcEnvironmentalImpactValue.