CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x_final::IfcCost Class Reference

#include <IfcCostAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcCost:
OdIfc2x_final::IfcControl OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getContextDescription () const
 
void setContextDescription (const OdAnsiString &ContextDescription)
 
const OdDAIObjectId & getElementCost () const
 
void setElementCost (const OdDAIObjectId &ElementCost)
 
const OdDAIObjectId & getExtensionCost () const
 
void setExtensionCost (const OdDAIObjectId &ExtensionCost)
 
IfcCostUseEnum getCostUse () const
 
void setCostUse (IfcCostUseEnum CostUse)
 
const OdDAIObjectId & getPreparedOn () const
 
void setPreparedOn (const OdDAIObjectId &PreparedOn)
 
void getQuantities (OdDAIObjectIds &Quantities) const
 
OdDAI::ListOfOdDAIObjectId & quantities ()
 
const OdAnsiString & getCostType () const
 
void setCostType (const OdAnsiString &CostType)
 
OdDAIObjectId getInvCostSchedule () const
 
 IfcCost ()
 
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 OdIfc2x_final::IfcControl
void getInvControls (OdDAIObjectIds &Controls) const
 
- Public Member Functions inherited from OdIfc2x_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x_final::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 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_ContextDescription
 
OdDAIObjectId m_ElementCost
 
OdDAIObjectId m_ExtensionCost
 
OdDAI::Enum m_CostUse
 
OdDAIObjectId m_PreparedOn
 
OdDAI::ListOfOdDAIObjectId m_Quantities
 
OdAnsiString m_CostType
 
- Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x_final::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcCostSchedule
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

An IfcCost is a cost with context information. It represents goods, services, or the execution of works of a described elemental nature in given conditions. This entity also has the capability of nesting other costs of the same type through its relationships to IfcRelNests.

<IMAGE IfcCost-Fig1>

The IfcRelNests provides a model mechanism to allow IfcCost to contain other items of the same type. It provides the relationships between the nesting IfcCost and nested IfcCost(s). The image below shows how cost elements can be grouped into one cost, represented by costs being nested within another cost (using the IfcRelNests relationship).

<IMAGE IfcCostSchedule-Fig2>

Definition at line 52 of file IfcCostAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCost()

OdIfc2x_final::IfcCost::IfcCost ( )

Default constructor for the IfcCost class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getContextDescription()

const OdAnsiString & OdIfc2x_final::IfcCost::getContextDescription ( ) const

Returns the value of ContextDescription attribute. This attribute represents the contextual information of the cost such as purchase cost, installation cost, consulting cost, etc.

Returns
Returns the value of ContextDescription attribute.

◆ getCostType()

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

Returns the value of CostType attribute. This attribute represents a type of cost that is expressed.

Returns
Returns the value of CostType attribute.

◆ getCostUse()

IfcCostUseEnum OdIfc2x_final::IfcCost::getCostUse ( ) const

Returns the value of CostUse attribute. This attribute indicates how the value of the ElementCost and ExtensionCost is provided and thus how they should be used.

Returns
Returns the value of CostUse attribute.

◆ getElementCost()

const OdDAIObjectId & OdIfc2x_final::IfcCost::getElementCost ( ) const

Returns the value of ElementCost attribute. This attribute represents the cost of a single item of each 'Quantity'. It can be either a unit cost or an item cost depending on the context of the cost element.

Returns
Returns the value of ElementCost attribute.

◆ getExtensionCost()

const OdDAIObjectId & OdIfc2x_final::IfcCost::getExtensionCost ( ) const

Returns the value of ExtensionCost attribute. This attribute represents the summarized the cost of this cost element.

Returns
Returns the value of ExtensionCost attribute.

◆ getInstanceType()

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

◆ getInvCostSchedule()

OdDAIObjectId OdIfc2x_final::IfcCost::getInvCostSchedule ( ) const

Returns the value of CostSchedule attribute. This attribute represents a reference to the cost schedule to which the cost element belongs.

Returns
Returns the value of CostSchedule attribute.

◆ getPreparedOn()

const OdDAIObjectId & OdIfc2x_final::IfcCost::getPreparedOn ( ) const

Returns the value of PreparedOn attribute. This attribute represents the date that the cost is provided.

Returns
Returns the value of PreparedOn attribute.

◆ getQuantities()

void OdIfc2x_final::IfcCost::getQuantities ( OdDAIObjectIds & Quantities) const

Returns the value of Quantities attribute. This attribute represents the quantities of the items referenced by the cost.

Returns
Returns the value of Quantities attribute.

◆ inFields()

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

◆ isKindOf()

virtual bool OdIfc2x_final::IfcCost::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 OdIfc2x_final::IfcControl.

◆ outFields()

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

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcCost::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 OdIfc2x_final::IfcControl.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcCost::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 OdIfc2x_final::IfcControl.

◆ quantities()

OdDAI::ListOfOdDAIObjectId & OdIfc2x_final::IfcCost::quantities ( )

◆ setContextDescription()

void OdIfc2x_final::IfcCost::setContextDescription ( const OdAnsiString & ContextDescription)

Sets the value of ContextDescription attribute. This attribute represents the contextual information of the cost such as purchase cost, installation cost, consulting cost, etc.

Parameters
ContextDescription[in] ContextDescription attribute to set.

◆ setCostType()

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

Sets the value of CostType attribute. This attribute represents a type of cost that is expressed.

Parameters
CostType[in] CostType attribute to set.

◆ setCostUse()

void OdIfc2x_final::IfcCost::setCostUse ( IfcCostUseEnum CostUse)

Sets the value of CostUse attribute. This attribute indicates how the value of the ElementCost and ExtensionCost is provided and thus how they should be used.

Parameters
CostUse[in] CostUse attribute to set.

◆ setElementCost()

void OdIfc2x_final::IfcCost::setElementCost ( const OdDAIObjectId & ElementCost)

Sets the value of ElementCost attribute. This attribute represents the cost of a single item of each 'Quantity'. It can be either a unit cost or an item cost depending on the context of the cost element.

Parameters
ElementCost[in] ElementCost attribute to set.

◆ setExtensionCost()

void OdIfc2x_final::IfcCost::setExtensionCost ( const OdDAIObjectId & ExtensionCost)

Sets the value of ExtensionCost attribute. This attribute represents the summarized the cost of this cost element.

Parameters
ExtensionCost[in] ExtensionCost attribute to set.

◆ setPreparedOn()

void OdIfc2x_final::IfcCost::setPreparedOn ( const OdDAIObjectId & PreparedOn)

Sets the value of PreparedOn attribute. This attribute represents the date that the cost is provided.

Parameters
PreparedOn[in] PreparedOn attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcCost::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 OdIfc2x_final::IfcControl.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcCost::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 OdIfc2x_final::IfcControl.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcCost::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 OdIfc2x_final::IfcControl.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcCost::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x_final::IfcControl.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcCost::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 OdIfc2x_final::IfcControl.

Friends And Related Symbol Documentation

◆ IfcCostSchedule

friend class IfcCostSchedule
friend

Definition at line 295 of file IfcCostAutoImpl.h.

Member Data Documentation

◆ m_ContextDescription

OdAnsiString OdIfc2x_final::IfcCost::m_ContextDescription
protected

Definition at line 285 of file IfcCostAutoImpl.h.

◆ m_CostType

OdAnsiString OdIfc2x_final::IfcCost::m_CostType
protected

Definition at line 292 of file IfcCostAutoImpl.h.

◆ m_CostUse

OdDAI::Enum OdIfc2x_final::IfcCost::m_CostUse
protected

Definition at line 288 of file IfcCostAutoImpl.h.

◆ m_ElementCost

OdDAIObjectId OdIfc2x_final::IfcCost::m_ElementCost
protected

Definition at line 286 of file IfcCostAutoImpl.h.

◆ m_ExtensionCost

OdDAIObjectId OdIfc2x_final::IfcCost::m_ExtensionCost
protected

Definition at line 287 of file IfcCostAutoImpl.h.

◆ m_PreparedOn

OdDAIObjectId OdIfc2x_final::IfcCost::m_PreparedOn
protected

Definition at line 289 of file IfcCostAutoImpl.h.

◆ m_Quantities

OdDAI::ListOfOdDAIObjectId OdIfc2x_final::IfcCost::m_Quantities
protected

Definition at line 290 of file IfcCostAutoImpl.h.


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