#include <IfcAppliedValueRelationshipAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcAppliedValueRelationship:

Public Member Functions
const OdDAIObjectId &	getComponentOfTotal () const

void	setComponentOfTotal (const OdDAIObjectId &ComponentOfTotal)

void	getComponents (OdDAIObjectIds &Components) const

OdDAI::SetOfOdDAIObjectId &	components ()

IfcArithmeticOperatorEnum	getArithmeticOperator () const

void	setArithmeticOperator (IfcArithmeticOperatorEnum ArithmeticOperator)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

	IfcAppliedValueRelationship ()

virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual void	setInverseCounterParts () 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
OdDAIObjectId	m_ComponentOfTotal

OdDAI::SetOfOdDAIObjectId	m_Components

OdDAI::Enum	m_ArithmeticOperator

OdAnsiString	m_Name

OdAnsiString	m_Description

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

An IfcAppliedValueRelationship is a relationship class that enables applied values of cost or environmental impact to be aggregated together as components of another applied value.

Use Definitions - Dependency relationships can exist between applied values on the basis that one particular value can be determined by operations on one or more other values. This is captured through the IfcAppliedValueRelationship entity. In this relationship, one instance of IfcAppliedValue acts as the principal (IfcAppliedValueRelationship.ComponentOf) whose value can be determined from the instances of IfcAppliedValue that are defined as its components (IfcAppliedValueRelationship.Components).

An IfcAppliedValueRelationship has an ArithmeticOperator attribute that specifies the form of arithmetical operation implied by the relationship.

Example - A relationship exists between applied value A and applied values B, C and D such that the value of A is determined by the addition of B, C and D such that:

It is possible to develop more complex applied value specifications by creating hierarchies of applied value relationships. In the diagram below, the development of a applied value is shown whereby, because B = E * F and D = G * H * J, then:

Definition at line 62 of file Ifc2x3/IfcAppliedValueRelationshipAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcAppliedValueRelationship()

OdIfc2x3::IfcAppliedValueRelationship::IfcAppliedValueRelationship ( )

Default constructor for the IfcAppliedValueRelationship class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ components()

OdDAI::SetOfOdDAIObjectId & OdIfc2x3::IfcAppliedValueRelationship::components ( )

Returns the value of Components attribute. This attribute represents applied values that are components of another applied value and from which that applied value can be deduced.

Returns: Returns the value of Components attribute.

◆ getArithmeticOperator()

IfcArithmeticOperatorEnum OdIfc2x3::IfcAppliedValueRelationship::getArithmeticOperator ( ) const

Returns the value of ArithmeticOperator attribute. This attribute represents the arithmetic operator applied in an applied value relationship.

Returns: Returns the value of ArithmeticOperator attribute.

◆ getAttr() [1/2]

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

◆ getComponentOfTotal()

const OdDAIObjectId & OdIfc2x3::IfcAppliedValueRelationship::getComponentOfTotal ( ) const

Returns the value of ComponentOfTotal attribute. This attribute represents the applied value (total or subtotal) of which the value being considered is a component.

Returns: Returns the value of ComponentOfTotal attribute.

◆ getComponents()

void OdIfc2x3::IfcAppliedValueRelationship::getComponents ( OdDAIObjectIds & Components ) const

Sets the value of Components attribute. This attribute represents applied values that are components of another applied value and from which that applied value can be deduced.

Parameters

Components [out] Receives the Components attribute.

◆ getDescription()

const OdAnsiString & OdIfc2x3::IfcAppliedValueRelationship::getDescription ( ) const

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

Returns: Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcAppliedValueRelationship::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.

◆ getName()

const OdAnsiString & OdIfc2x3::IfcAppliedValueRelationship::getName ( ) const

Returns the value of Name attribute. This attribute represents a name used to identify or qualify the applied value relationship.

Returns: Returns the value of Name attribute.

◆ inFields()

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

◆ outFields()

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

◆ setArithmeticOperator()

void OdIfc2x3::IfcAppliedValueRelationship::setArithmeticOperator ( IfcArithmeticOperatorEnum ArithmeticOperator )

Sets the value of ArithmeticOperator attribute. This attribute represents the arithmetic operator applied in an applied value relationship.

Parameters

ArithmeticOperator [in] ArithmeticOperator attribute to set.

◆ setComponentOfTotal()

void OdIfc2x3::IfcAppliedValueRelationship::setComponentOfTotal ( const OdDAIObjectId & ComponentOfTotal )

Sets the value of ComponentOfTotal attribute. This attribute represents the applied value (total or subtotal) of which the value being considered is a component.

Parameters

ComponentOfTotal [in] ComponentOfTotal attribute to set.

◆ setDescription()

void OdIfc2x3::IfcAppliedValueRelationship::setDescription ( const OdAnsiString & Description )

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

Parameters

Description [in] Description attribute to set.

◆ setInverseCounterParts()

virtual void OdIfc2x3::IfcAppliedValueRelationship::setInverseCounterParts ( )

overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ setName()

void OdIfc2x3::IfcAppliedValueRelationship::setName ( const OdAnsiString & Name )

Sets the value of Name attribute. This attribute represents a name used to identify or qualify the applied value relationship.

Parameters

Name	[in] Name attribute to set.

◆ testAttr() [1/2]

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

◆ unsetAttr() [1/2]

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

Member Data Documentation

◆ m_ArithmeticOperator

OdDAI::Enum OdIfc2x3::IfcAppliedValueRelationship::m_ArithmeticOperator

protected

Definition at line 287 of file Ifc2x3/IfcAppliedValueRelationshipAutoImpl.h.

◆ m_ComponentOfTotal

OdDAIObjectId OdIfc2x3::IfcAppliedValueRelationship::m_ComponentOfTotal

protected

Definition at line 285 of file Ifc2x3/IfcAppliedValueRelationshipAutoImpl.h.

◆ m_Components

OdDAI::SetOfOdDAIObjectId OdIfc2x3::IfcAppliedValueRelationship::m_Components

protected

Definition at line 286 of file Ifc2x3/IfcAppliedValueRelationshipAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc2x3::IfcAppliedValueRelationship::m_Description

protected

Definition at line 289 of file Ifc2x3/IfcAppliedValueRelationshipAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc2x3::IfcAppliedValueRelationship::m_Name

protected

Definition at line 288 of file Ifc2x3/IfcAppliedValueRelationshipAutoImpl.h.

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

Ifc2x3/IfcAppliedValueRelationshipAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcAppliedValueRelationship()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ components()

◆ getArithmeticOperator()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getComponentOfTotal()

◆ getComponents()

◆ getDescription()

◆ getInstanceType()

◆ getName()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setArithmeticOperator()

◆ setComponentOfTotal()

◆ setDescription()

◆ setInverseCounterParts()

◆ setName()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_ArithmeticOperator

◆ m_ComponentOfTotal

◆ m_Components

◆ m_Description

◆ m_Name