#include <IfcCostModifierAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcCostModifier:

Public Member Functions
const OdAnsiString &	getPurpose () const

void	setPurpose (const OdAnsiString &Purpose)

IfcCostModifierValueSelect	modifierValue ()

const OdDAIObjectId &	getModifierDate () const

void	setModifierDate (const OdDAIObjectId &ModifierDate)

IfcCostOperatorEnum	getCostOperator () const

void	setCostOperator (IfcCostOperatorEnum CostOperator)

IfcCostModifierBasisEnum	getModifierBasis () const

void	setModifierBasis (IfcCostModifierBasisEnum ModifierBasis)

void	getInvModifiedCost (OdDAIObjectIds &ModifiedCost) const

void	getInvModifiersReferenced (OdDAIObjectIds &ModifiersReferenced) const

	IfcCostModifier ()

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 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_Purpose

OdDAI::Select	m_ModifierValue

OdDAIObjectId	m_ModifierDate

OdDAI::Enum	m_CostOperator

OdDAI::Enum	m_ModifierBasis

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcCostValue

class	IfcReferencesCostDocument

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 IfcCostModifier is a modifier object which influences a cost. Cost modifiers can potentially be applied on quite complex bases (e.g., a percentage markup on hours of overtime labor). Cost modifiers can accommodate other cost modifiers calculated on a simple basis only (static/running and add/subtract/multiply). Modifiers applied on a more complex basis can be converted within cost applications to these simple bases (e.g., the more complex modifier can be resolved into a fixed currency value modifier).

Definition at line 49 of file IfcCostModifierAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCostModifier()

OdIfc2x_final::IfcCostModifier::IfcCostModifier ( )

Default constructor for the IfcCostModifier class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getCostOperator()

IfcCostOperatorEnum OdIfc2x_final::IfcCostModifier::getCostOperator ( ) const

Returns the value of CostOperator attribute. This attribute represents a mathematical operator that determines how the cost modifier is to be applied to the cost to vary its value.

Returns: Returns the value of CostOperator attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcCostModifier::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.

◆ getInvModifiedCost()

void OdIfc2x_final::IfcCostModifier::getInvModifiedCost ( OdDAIObjectIds & ModifiedCost ) const

Returns the value of ModifiedCost attribute. This attribute represents cost value the cost modifier is assigned to.

Returns: Returns the value of ModifiedCost attribute.

◆ getInvModifiersReferenced()

void OdIfc2x_final::IfcCostModifier::getInvModifiersReferenced ( OdDAIObjectIds & ModifiersReferenced ) const

Returns the value of ModifiersReferenced attribute. This attribute represents the IfcReferencesCostDocument relationship, which refers to a document from which the cost modifier is referenced.

Returns: Returns the value of ModifiersReferenced attribute.

◆ getModifierBasis()

IfcCostModifierBasisEnum OdIfc2x_final::IfcCostModifier::getModifierBasis ( ) const

Returns the value of ModifierBasis attribute. This attribute represents the manner in which cost modifiers are applied to a cost.

Returns: Returns the value of ModifierBasis attribute.

◆ getModifierDate()

const OdDAIObjectId & OdIfc2x_final::IfcCostModifier::getModifierDate ( ) const

Returns the value of ModifierDate attribute. This attribute represents the date at which a modifier is applicable.

Returns: Returns the value of ModifierDate attribute.

◆ getPurpose()

const OdAnsiString & OdIfc2x_final::IfcCostModifier::getPurpose ( ) const

Returns the value of Purpose attribute. This attribute represents the purpose for which a cost modifier is applied. Examples: trade discount, bulk purchase rebate, small quantity surcharge, large quantity discount, delivery charge, waste allowance, postage and packing charge, factor to allow for working conditions (working at height, working in a hazardous or dirty environment etc.), adjustments for costs derived from historical data (source date to project date adjustment, source location to project location adjustment), etc.

Returns: Returns the value of Purpose attribute.

◆ inFields()

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

◆ modifierValue()

IfcCostModifierValueSelect OdIfc2x_final::IfcCostModifier::modifierValue ( )

Returns the value of ModifierValue attribute. This attribute represents the value assigned to a cost modifier.

Returns: Returns the value of ModifierValue attribute.

◆ outFields()

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

◆ setCostOperator()

void OdIfc2x_final::IfcCostModifier::setCostOperator ( IfcCostOperatorEnum CostOperator )

Sets the value of CostOperator attribute. This attribute represents a mathematical operator that determines how the cost modifier is to be applied to the cost to vary its value.

Parameters

CostOperator [in] CostOperator attribute to set.

◆ setModifierBasis()

void OdIfc2x_final::IfcCostModifier::setModifierBasis ( IfcCostModifierBasisEnum ModifierBasis )

Sets the value of ModifierBasis attribute. This attribute represents the manner in which cost modifiers are applied to a cost.

Parameters

ModifierBasis [in] ModifierBasis attribute to set.

◆ setModifierDate()

void OdIfc2x_final::IfcCostModifier::setModifierDate ( const OdDAIObjectId & ModifierDate )

Sets the value of ModifierDate attribute. This attribute represents the date at which a modifier is applicable.

Parameters

ModifierDate [in] ModifierDate attribute to set.

◆ setPurpose()

void OdIfc2x_final::IfcCostModifier::setPurpose ( const OdAnsiString & Purpose )

Sets the value of Purpose attribute. This attribute represents the purpose for which a cost modifier is applied. Examples: trade discount, bulk purchase rebate, small quantity surcharge, large quantity discount, delivery charge, waste allowance, postage and packing charge, factor to allow for working conditions (working at height, working in a hazardous or dirty environment etc.), adjustments for costs derived from historical data (source date to project date adjustment, source location to project location adjustment), etc.

Parameters

Purpose [in] Purpose attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcCostModifier::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 OdIfc2x_final::IfcCostModifier::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 OdIfc2x_final::IfcCostModifier::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 OdIfc2x_final::IfcCostModifier::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 OdIfc2x_final::IfcCostModifier::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

◆ IfcCostValue

friend class IfcCostValue

friend

Definition at line 287 of file IfcCostModifierAutoImpl.h.

◆ IfcReferencesCostDocument

friend class IfcReferencesCostDocument

friend

Definition at line 288 of file IfcCostModifierAutoImpl.h.

Member Data Documentation

◆ m_CostOperator

OdDAI::Enum OdIfc2x_final::IfcCostModifier::m_CostOperator

protected

Definition at line 283 of file IfcCostModifierAutoImpl.h.

◆ m_ModifierBasis

OdDAI::Enum OdIfc2x_final::IfcCostModifier::m_ModifierBasis

protected

Definition at line 284 of file IfcCostModifierAutoImpl.h.

◆ m_ModifierDate

OdDAIObjectId OdIfc2x_final::IfcCostModifier::m_ModifierDate

protected

Definition at line 282 of file IfcCostModifierAutoImpl.h.

◆ m_ModifierValue

OdDAI::Select OdIfc2x_final::IfcCostModifier::m_ModifierValue

protected

Definition at line 281 of file IfcCostModifierAutoImpl.h.

◆ m_Purpose

OdAnsiString OdIfc2x_final::IfcCostModifier::m_Purpose

protected

Definition at line 280 of file IfcCostModifierAutoImpl.h.

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

IfcCostModifierAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcCostModifier()

Member Function Documentation

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCostOperator()

◆ getInstanceType()

◆ getInvModifiedCost()

◆ getInvModifiersReferenced()

◆ getModifierBasis()

◆ getModifierDate()

◆ getPurpose()

◆ inFields()

◆ isKindOf()

◆ modifierValue()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setCostOperator()

◆ setModifierBasis()

◆ setModifierDate()

◆ setPurpose()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcCostValue

◆ IfcReferencesCostDocument

Member Data Documentation

◆ m_CostOperator

◆ m_ModifierBasis

◆ m_ModifierDate

◆ m_ModifierValue

◆ m_Purpose