#include <IfcCostValueAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcCostValue:

Public Member Functions
double	getBaseCostValue () const

void	setBaseCostValue (double BaseCostValue)

double	getFinalCostValue () const

void	setFinalCostValue (double FinalCostValue)

IfcCurrencyEnum	getCurrency () const

void	setCurrency (IfcCurrencyEnum Currency)

const OdDAIObjectId &	getUnitCostBasis () const

void	setUnitCostBasis (const OdDAIObjectId &UnitCostBasis)

const OdAnsiString &	getCostType () const

void	setCostType (const OdAnsiString &CostType)

const OdDAIObjectId &	getCostDate () const

void	setCostDate (const OdDAIObjectId &CostDate)

void	getCostModifiers (OdDAIObjectIds &CostModifiers) const

OdDAI::ListOfOdDAIObjectId &	costModifiers ()

void	getInvValueOfComponents (OdDAIObjectIds &ValueOfComponents) const

void	getInvIsComponentIn (OdDAIObjectIds &IsComponentIn) const

void	getInvCostsReferenced (OdDAIObjectIds &CostsReferenced) const

	IfcCostValue ()

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
double	m_BaseCostValue

double	m_FinalCostValue

OdDAI::Enum	m_Currency

OdDAIObjectId	m_UnitCostBasis

OdAnsiString	m_CostType

OdDAIObjectId	m_CostDate

OdDAI::ListOfOdDAIObjectId	m_CostModifiers

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcCostValueRelationship

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

IfcCostValue represents an amount of money or a value. Each instance of IfcCostValue can have a category. There are many possible types of cost value that can be identified. While there is a broad understanding of the meaning of names that can be assigned to different types of costs, there is no general standard for naming cost types nor are there any broadly defined classifications.

Definition at line 50 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCostValue()

OdIfc2x_final::IfcCostValue::IfcCostValue ( )

Default constructor for the IfcCostValue class.

Member Function Documentation

◆ costModifiers()

OdDAI::ListOfOdDAIObjectId & OdIfc2x_final::IfcCostValue::costModifiers ( )

Returns the value of CostModifiers attribute. This attribute represents the modifiers that can be applied to a cost to change its value.

Returns: Returns the value of CostModifiers attribute.

◆ getAttr() [1/2]

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

◆ getBaseCostValue()

double OdIfc2x_final::IfcCostValue::getBaseCostValue ( ) const

Returns the value of BaseCostValue attribute. This attribute represents the amount of this cost before applying cost modifiers.

Returns: Returns the value of BaseCostValue attribute.

◆ getCostDate()

const OdDAIObjectId & OdIfc2x_final::IfcCostValue::getCostDate ( ) const

Returns the value of CostDate attribute. This attribute represents the date at which the cost is assessed. For example, in an estimate it is the date at which the estimated cost value was made, while for a report of actual costs, it is the cost that the actual costs are recorded.

Returns: Returns the value of CostDate attribute.

◆ getCostModifiers()

void OdIfc2x_final::IfcCostValue::getCostModifiers ( OdDAIObjectIds & CostModifiers ) const

Sets the value of CostModifiers attribute. This attribute represents the modifiers that can be applied to a cost to change its value.

Parameters

CostModifiers [out] Cost modifiers to get.

◆ getCostType()

const OdAnsiString & OdIfc2x_final::IfcCostValue::getCostType ( ) const

Returns the value of CostType attribute. This attribute represents specification of the cost type that is used.

Returns: Returns the value of CostType attribute.

◆ getCurrency()

IfcCurrencyEnum OdIfc2x_final::IfcCostValue::getCurrency ( ) const

Returns the value of Currency attribute. This attribute represents currency for this cost that can override the global currency setting for the project.

Returns: Returns the value of Currency attribute.

◆ getFinalCostValue()

double OdIfc2x_final::IfcCostValue::getFinalCostValue ( ) const

Returns the value of FinalCostValue attribute. This attribute represents the amount of this cost after applying cost modifiers.

Returns: Returns the value of FinalCostValue attribute.

◆ getInstanceType()

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

◆ getInvCostsReferenced()

void OdIfc2x_final::IfcCostValue::getInvCostsReferenced ( OdDAIObjectIds & CostsReferenced ) const

Gets the value of CostsReferenced attribute. This attribute represents the IfcReferencesCostDocument relationship that refers to a document from which the cost value is referenced.

Parameters

CostsReferenced [out] Receives the CostsReferenced attribute.

◆ getInvIsComponentIn()

void OdIfc2x_final::IfcCostValue::getInvIsComponentIn ( OdDAIObjectIds & IsComponentIn ) const

Gets the value of IsComponentIn attribute. This attribute represents the value of the single cost value that is used by the cost value relationship to express a complex cost.

Parameters

IsComponentIn [out] Receives the IsComponentIn attribute.

◆ getInvValueOfComponents()

void OdIfc2x_final::IfcCostValue::getInvValueOfComponents ( OdDAIObjectIds & ValueOfComponents ) const

Gets the value of ValueOfComponents attribute. This attribute represents the aggregated value of the components within the cost value relationship expressed as a single cost value.

Parameters

ValueOfComponents [out] Receives the ValueOfComponents attribute.

◆ getUnitCostBasis()

const OdDAIObjectId & OdIfc2x_final::IfcCostValue::getUnitCostBasis ( ) const

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

Returns: Returns the value of UnitCostBasis attribute.

◆ inFields()

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

◆ setBaseCostValue()

void OdIfc2x_final::IfcCostValue::setBaseCostValue ( double BaseCostValue )

Sets the value of BaseCostValue attribute. This attribute represents the amount of this cost before applying cost modifiers.

Parameters

BaseCostValue [in] Base cost value to set.

◆ setCostDate()

void OdIfc2x_final::IfcCostValue::setCostDate ( const OdDAIObjectId & CostDate )

Sets the value of CostDate attribute. This attribute represents the date at which the cost is assessed. For example, in an estimate it is the date at which the estimated cost value was made, while for a report of actual costs, it is the cost that the actual costs are recorded.

Parameters

CostDate [in] Cost date to set.

◆ setCostType()

void OdIfc2x_final::IfcCostValue::setCostType ( const OdAnsiString & CostType )

Sets the value of CostType attribute. This attribute represents specification of the cost type that is used.

Parameters

CostType [in] Cost type to set.

◆ setCurrency()

void OdIfc2x_final::IfcCostValue::setCurrency ( IfcCurrencyEnum Currency )

Sets the value of Currency attribute. This attribute represents currency for this cost that can override the global currency setting for the project.

Parameters

Currency [in] Currency to set.

◆ setFinalCostValue()

void OdIfc2x_final::IfcCostValue::setFinalCostValue ( double FinalCostValue )

Sets the value of FinalCostValue attribute. This attribute represents the amount of this cost after applying cost modifiers.

Parameters

FinalCostValue [in] Final cost value to set.

◆ setUnitCostBasis()

void OdIfc2x_final::IfcCostValue::setUnitCostBasis ( const OdDAIObjectId & UnitCostBasis )

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

Parameters

UnitCostBasis [in] Unit cost basis to set.

◆ testAttr() [1/2]

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

◆ IfcCostValueRelationship

IfcCostValueRelationship

friend

Definition at line 316 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

◆ IfcReferencesCostDocument

friend class IfcReferencesCostDocument

friend

Definition at line 318 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

Member Data Documentation

◆ m_BaseCostValue

double OdIfc2x_final::IfcCostValue::m_BaseCostValue

protected

Definition at line 306 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

◆ m_CostDate

OdDAIObjectId OdIfc2x_final::IfcCostValue::m_CostDate

protected

Definition at line 311 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

◆ m_CostModifiers

OdDAI::ListOfOdDAIObjectId OdIfc2x_final::IfcCostValue::m_CostModifiers

protected

Definition at line 312 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

◆ m_CostType

OdAnsiString OdIfc2x_final::IfcCostValue::m_CostType

protected

Definition at line 310 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

◆ m_Currency

OdDAI::Enum OdIfc2x_final::IfcCostValue::m_Currency

protected

Definition at line 308 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

◆ m_FinalCostValue

double OdIfc2x_final::IfcCostValue::m_FinalCostValue

protected

Definition at line 307 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

◆ m_UnitCostBasis

OdDAIObjectId OdIfc2x_final::IfcCostValue::m_UnitCostBasis

protected

Definition at line 309 of file Ifc2x_Final/IfcCostValueAutoImpl.h.

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

Ifc2x_Final/IfcCostValueAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcCostValue()

Member Function Documentation

◆ costModifiers()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getBaseCostValue()

◆ getCostDate()

◆ getCostModifiers()

◆ getCostType()

◆ getCurrency()

◆ getFinalCostValue()

◆ getInstanceType()

◆ getInvCostsReferenced()

◆ getInvIsComponentIn()

◆ getInvValueOfComponents()

◆ getUnitCostBasis()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setBaseCostValue()

◆ setCostDate()

◆ setCostType()

◆ setCurrency()

◆ setFinalCostValue()

◆ setUnitCostBasis()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcCostValueRelationship

◆ IfcReferencesCostDocument

Member Data Documentation

◆ m_BaseCostValue

◆ m_CostDate

◆ m_CostModifiers

◆ m_CostType

◆ m_Currency

◆ m_FinalCostValue

◆ m_UnitCostBasis