#include <IfcCostItemAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcCostItem:

Public Member Functions
IfcCostItemTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcCostItemTypeEnum PredefinedType)

void	getCostValues (OdDAIObjectIds &CostValues) const

OdDAI::ListOfOdDAIObjectId &	costValues ()

void	getCostQuantities (OdDAIObjectIds &CostQuantities) const

OdDAI::ListOfOdDAIObjectId &	costQuantities ()

	IfcCostItem ()

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 OdIfc4x4::IfcControl
const OdAnsiString &	getIdentification () const

void	setIdentification (const OdAnsiString &Identification)

void	getInvControls (OdDAIObjectIds &Controls) const

	IfcControl ()

Public Member Functions inherited from OdIfc4x4::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const

void	getInvDeclares (OdDAIObjectIds &Declares) const

void	getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc4x4::IfcObjectDefinition
void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvNests (OdDAIObjectIds &Nests) const

void	getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const

void	getInvHasContext (OdDAIObjectIds &HasContext) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc4x4::IfcRoot
OdDAI::CompressedGUID	getGlobalId () const

void	setGlobalId (OdDAI::CompressedGUID GlobalId)

const OdDAIObjectId &	getOwnerHistory () const

void	setOwnerHistory (const OdDAIObjectId &OwnerHistory)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

	IfcRoot ()

Public Member Functions inherited from OdIfc4x4::OdIFC4X4Instance
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
OdDAI::Enum	m_PredefinedType

OdDAI::ListOfOdDAIObjectId	m_CostValues

OdDAI::ListOfOdDAIObjectId	m_CostQuantities

Protected Attributes inherited from OdIfc4x4::IfcControl
OdAnsiString	m_Identification

Protected Attributes inherited from OdIfc4x4::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4x4::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

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)

Protected Member Functions inherited from OdIfc4x4::IfcObjectDefinition
virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

Detailed Description

An IfcCostItem describes a cost or financial value together with descriptive information that describes its context in a form that enables it to be used within a cost schedule. An IfcCostItem can be used to represent the cost of goods and services, the execution of works by a process, lifecycle cost and more.

Each instance of IfcCostItem can have a name and a description. Depending on the use for which the cost is intended, these values should be asserted on the basis of agreement. For instance, the Name attribute could be used to provide a common value that enables distinct instances to be brought together in a nesting arrangement while the Description attribute can be used to provide text used for item description in a costing schedule.

Classification - The Classification Association concept applies to this entity.

Instances of IfcCostItem are used for cost estimates, budgets, and other forms, where a variety of identification codes are used extensively to identify the meaning of the cost. Examples include project phase codes, CSI codes, takeoff sequence numbers, and cost accounts. The model allows for all classes that are ultimately subtypes of IfcObject to inherit the ability to have one or more instances of IfcClassificationReference to be assigned. Where identification codes are required, the generic IfcRelAssociatesClassification facility should be used.

Control Assignment - The Control Assignment concept template applies to this entity as shown in the table below

Type

Description IfcProduct For quantity-based costs based on product occurrences, spatial structures, or other physical artifacts IfcProcess For quantity-based costs based on tasks, procedures, or events IfcResource For quantity-based costs based on resource allocations IfcTypeProduct For cost rates based on product models IfcTypeProcess For cost rates based on process models of historical or projected duration IfcTypeResource For cost rates based on resource models of historical or projected productivity

The figure below illustrates cost item assignment derived from building elements. The IfcRelAssignsToControl relationship indicates building elements for which quantities are derived. Costs can also be derived from building elements by traversing assignment relationships from the assigned IfcProduct to IfcProcess to IfcResource, where all costs ultimately originate at resources. It is also possible for cost items to have assignments from processes or resources directly.

Definition at line 81 of file IFC4X4/IfcCostItemAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCostItem()

OdIfc4x4::IfcCostItem::IfcCostItem ( )

Default constructor for the IfcCostItem class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcCostItem::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 from OdIfc4x4::IfcControl.

◆ costQuantities()

OdDAI::ListOfOdDAIObjectId & OdIfc4x4::IfcCostItem::costQuantities ( )

Returns the value of CostQuantities attribute. This attribute represents component quantities of the same type for which the total quantity for the cost item is calculated as the sum.

Returns: Returns the value of CostQuantities attribute.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ costValues()

OdDAI::ListOfOdDAIObjectId & OdIfc4x4::IfcCostItem::costValues ( )

Returns the value of CostValues attribute. This attribute represents component costs for which the total cost for the cost item is calculated, and then multiplied by the total CostQuantities if provided. If CostQuantities is provided then values indicate unit costs, otherwise values indicate total costs. For calculation purposes, the cost values can be directly added unless they have qualifications. Cost values with qualifications (e.g. IfcCostValue.ApplicableDate, IfcCostValue.FixedUntilDate) should be excluded from such calculation if they do not apply.

Returns: Returns the value of CostValues attribute.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcCostItem::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 from OdIfc4x4::IfcControl.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcCostItem::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 OdIfc4x4::IfcControl.

◆ getCostQuantities()

void OdIfc4x4::IfcCostItem::getCostQuantities ( OdDAIObjectIds & CostQuantities ) const

Gets the value of CostQuantities attribute. This attribute represents component quantities of the same type for which the total quantity for the cost item is calculated as the sum.

Parameters

CostQuantities [out] Receives cost quantities.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ getCostValues()

void OdIfc4x4::IfcCostItem::getCostValues ( OdDAIObjectIds & CostValues ) const

Gets the value of CostValues attribute. This attribute represents component costs for which the total cost for the cost item is calculated, and then multiplied by the total CostQuantities if provided. If CostQuantities is provided then values indicate unit costs, otherwise values indicate total costs. For calculation purposes, the cost values can be directly added unless they have qualifications. Cost values with qualifications (e.g. IfcCostValue.ApplicableDate, IfcCostValue.FixedUntilDate) should be excluded from such calculation if they do not apply.

Parameters

CostValues [out] Receives the cost values.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcCostItem::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 from OdIfc4x4::IfcControl.

◆ getPredefinedType()

IfcCostItemTypeEnum OdIfc4x4::IfcCostItem::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined generic type for a cost item that is specified in an enumeration. There can be a property set given specifically for the predefined types.

Returns: Returns the value of PredefinedType attribute.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ inFields()

virtual OdResult OdIfc4x4::IfcCostItem::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 from OdIfc4x4::IfcControl.

◆ isKindOf()

virtual bool OdIfc4x4::IfcCostItem::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 OdIfc4x4::IfcControl.

◆ outFields()

virtual OdResult OdIfc4x4::IfcCostItem::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 from OdIfc4x4::IfcControl.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcCostItem::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 OdIfc4x4::IfcControl.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcCostItem::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 OdIfc4x4::IfcControl.

◆ setPredefinedType()

void OdIfc4x4::IfcCostItem::setPredefinedType ( IfcCostItemTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents predefined generic type for a cost item that is specified in an enumeration. There can be a property set given specifically for the predefined types.

Parameters

PredefinedType [in] Predefined type to set.

Remarks: IFC4 CHANGE: The attribute has been added.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcCostItem::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 OdIfc4x4::IfcControl.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcCostItem::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 OdIfc4x4::IfcControl.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcCostItem::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 OdIfc4x4::IfcControl.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcCostItem::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrName [in] Explicit name of the attribute to reset.

Reimplemented from OdIfc4x4::IfcControl.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcCostItem::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 OdIfc4x4::IfcControl.

Member Data Documentation

◆ m_CostQuantities

OdDAI::ListOfOdDAIObjectId OdIfc4x4::IfcCostItem::m_CostQuantities

protected

Definition at line 298 of file IFC4X4/IfcCostItemAutoImpl.h.

◆ m_CostValues

OdDAI::ListOfOdDAIObjectId OdIfc4x4::IfcCostItem::m_CostValues

protected

Definition at line 296 of file IFC4X4/IfcCostItemAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x4::IfcCostItem::m_PredefinedType

protected

Definition at line 295 of file IFC4X4/IfcCostItemAutoImpl.h.

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

IFC4X4/IfcCostItemAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcCostItem()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ costQuantities()

◆ costValues()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCostQuantities()

◆ getCostValues()

◆ getInstanceType()

◆ getPredefinedType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setPredefinedType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_CostQuantities

◆ m_CostValues

◆ m_PredefinedType