CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x2_final::IfcConstructionResource Class Reference

#include <IfcConstructionResourceAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcConstructionResource:
OdIfc2x2_final::IfcResource OdIfc2x2_final::IfcObject OdIfc2x2_final::IfcRoot OdIfc2x2_final::OdIfc2x2_FinalInstance OdIfc::OdIfcInstance OdIfc2x2_final::IfcConstructionEquipmentResource OdIfc2x2_final::IfcConstructionMaterialResource OdIfc2x2_final::IfcConstructionProductResource OdIfc2x2_final::IfcCrewResource OdIfc2x2_final::IfcLaborResource OdIfc2x2_final::IfcSubContractResource

Public Member Functions

const OdAnsiString & getResourceIdentifier () const
 
void setResourceIdentifier (const OdAnsiString &ResourceIdentifier)
 
const OdAnsiString & getResourceGroup () const
 
void setResourceGroup (const OdAnsiString &ResourceGroup)
 
IfcResourceConsumptionEnum getResourceConsumption () const
 
void setResourceConsumption (IfcResourceConsumptionEnum ResourceConsumption)
 
const OdDAIObjectId & getBaseQuantity () const
 
void setBaseQuantity (const OdDAIObjectId &BaseQuantity)
 
 IfcConstructionResource ()
 
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 OdIfc2x2_final::IfcResource
void getInvResourceOf (OdDAIObjectIds &ResourceOf) const
 
- Public Member Functions inherited from OdIfc2x2_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 OdIfc2x2_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_ResourceIdentifier
 
OdAnsiString m_ResourceGroup
 
OdDAI::Enum m_ResourceConsumption
 
OdDAIObjectId m_BaseQuantity
 
- Protected Attributes inherited from OdIfc2x2_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x2_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
 

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)
 
- Protected Member Functions inherited from OdIfc2x2_final::IfcResource
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

IfcConstructionResource is an abstract generalization of the different resources used in construction projects, mainly labor, material, equipment and product resources, plus subcontracted resources and aggregations such as a crew resource.

A resource represents "use of something" and does not necessarily correspond to a single item such as a person or vehicle, but represents a pool of items having limited availability such as general labor or an equipment fleet. A resource can represent either a generic resource pool (not having any task assignment) or a task-specific resource allocation (having an IfcTask assignment).

  • Declaration use Definition - A root-level resource (specifically IfcCrewResource or IfcSubContractResource) is declared within the project by IfcRelDeclares where RelatingContext refers to the single IfcProject and RelatedObjects refers to one or more IfcConstructionResource, and other root-level objects within the project.
  • Assignment use Definition - A resource can be assigned to an actor by IfcRelAssignsToActor where RelatingActor refers to an IfcActor and RelatedObjects refers to one or more IfcConstructionResource or other objects. Such relationship indicates the actor responsible for allocating the resource such as partitioning into task-specific allocations, delegating to other actors, and/or scheduling over time. Note that this assignment does not indicate the person or organization performing the work; that is indicated by IfcRelAssignsToResource. The actor responsible for the resource may or may not be the same as any actor(s) performing work. A resource can be assigned to a control by IfcRelAssignsToControl where RelatingControl refers to an IfcControl and RelatedObjects refers to one or more IfcConstructionResource or other objects. Most commonly an IfcWorkCalendar is assigned indicating availability of the resource, where such calendar is nested within a base calendar or an IfcWorkPlan which in turn is assigned to the IfcProject. A resource can be assigned to a group by IfcRelAssignsToGroup where RelatingGroup refers to an IfcGroup and RelatedObjects refers to one or more IfcConstructionResource or other objects. Most commonly an IfcAsset is assigned indicating the asset to be tracked, where such asset is nested within an IfcInventory which in turn is assigned to the IfcProject. A resource can be assigned to a product by IfcRelAssignsToProduct where RelatingProduct refers to an IfcProduct and RelatedObjects refers to one or more IfcConstructionResource or other objects. Most commonly an IfcElement subtype is assigned indicating the product to be constructed, where such product is connected to a spatial structure which in turn is aggregated within the IfcProject. A resource can be assigned to a process by IfcRelAssignsToProcess where RelatingProcess refers to an IfcProcess and RelatedObjects refers to one or more IfcConstructionResource or other objects. Most commonly an IfcTask is assigned indicating the task to be performed by the resource, where such task is nested within a summary task which in turn is assigned to the IfcProject. A resource can have assignments of other objects using IfcRelAssignsToResource where RelatingResource refers to the IfcConstructionResource and RelatedObjects refers to one or more objects such as IfcActor or IfcProduct subtypes. This relationship indicates specific objects assigned to fulfill resource usage.

The image below illustrates resource assignment.

<IMAGE ifcconstructionresource-assignment>

  • Baseline use Definition - A resource can have any number of baselines defined using the relationship IfcRelDefinesByObject where RelatingObject is the "current" resource and RelatedObjects consists of multiple "baseline" resources, each representing a copy of the resource as it existed at an earlier point in time as shown on the image below. Each baseline IfcConstructionResource is identified by its nested IfcRelAssignsToControl relationship to an IfcWorkSchedule having PredefinedType=BASELINE, IfcWorkSchedule.CreationDate indicating the date of the baseline, and IfcWorkSchedule.Name indicating the name of the baseline.

<IMAGE ifcconstructionresource-baseline>

Remarks
This definition cannot be instantiated

Definition at line 95 of file Ifc2x2_Final/IfcConstructionResourceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcConstructionResource()

OdIfc2x2_final::IfcConstructionResource::IfcConstructionResource ( )

Default constructor for the IfcConstructionResource class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcObject.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ getBaseQuantity()

const OdDAIObjectId & OdIfc2x2_final::IfcConstructionResource::getBaseQuantity ( ) const

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionEquipmentResource, OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcConstructionProductResource, OdIfc2x2_final::IfcCrewResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ getResourceConsumption()

IfcResourceConsumptionEnum OdIfc2x2_final::IfcConstructionResource::getResourceConsumption ( ) const

Returns the value of ResourceConsumption attribute. This attribute represents a value that indicates how the resource is consumed during its use in a process (see IfcResourceConsumptionEnum for more details).

Returns
Returns the value of ResourceConsumption attribute.

◆ getResourceGroup()

const OdAnsiString & OdIfc2x2_final::IfcConstructionResource::getResourceGroup ( ) const

Returns the value of ResourceGroup attribute. This attribute represents the group label, or title of the type resource, e.g. the title of a labor resource as carpenter, crane operator, superintendent, etc.

Returns
Returns the value of ResourceGroup attribute.

◆ getResourceIdentifier()

const OdAnsiString & OdIfc2x2_final::IfcConstructionResource::getResourceIdentifier ( ) const

Returns the value of ResourceIdentifier attribute. This attribute represents optional identification of a code or ID for the construction resource.

Returns
Returns the value of ResourceIdentifier attribute.

◆ inFields()

virtual OdResult OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionEquipmentResource, OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcConstructionProductResource, OdIfc2x2_final::IfcCrewResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ outFields()

virtual OdResult OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcObject.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ putAttr() [2/2]

virtual bool OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ setBaseQuantity()

void OdIfc2x2_final::IfcConstructionResource::setBaseQuantity ( const OdDAIObjectId & BaseQuantity)

◆ setResourceConsumption()

void OdIfc2x2_final::IfcConstructionResource::setResourceConsumption ( IfcResourceConsumptionEnum ResourceConsumption)

Sets the value of ResourceConsumption attribute. This attribute represents a value that indicates how the resource is consumed during its use in a process (see IfcResourceConsumptionEnum for more details).

Parameters
ResourceConsumption[in] Resource consumption to set.

◆ setResourceGroup()

void OdIfc2x2_final::IfcConstructionResource::setResourceGroup ( const OdAnsiString & ResourceGroup)

Sets the value of ResourceGroup attribute. This attribute represents the group label, or title of the type resource, e.g. the title of a labor resource as carpenter, crane operator, superintendent, etc.

Parameters
ResourceGroup[in] Resource group to set.

◆ setResourceIdentifier()

void OdIfc2x2_final::IfcConstructionResource::setResourceIdentifier ( const OdAnsiString & ResourceIdentifier)

Sets the value of ResourceIdentifier attribute. This attribute represents optional identification of a code or ID for the construction resource.

Parameters
ResourceIdentifier[in] Resource identifier to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ testAttr() [2/2]

virtual bool OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionEquipmentResource, OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcConstructionProductResource, OdIfc2x2_final::IfcCrewResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ unsetAttr() [1/2]

virtual void OdIfc2x2_final::IfcConstructionResource::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

◆ unsetAttr() [2/2]

virtual void OdIfc2x2_final::IfcConstructionResource::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 OdIfc2x2_final::IfcResource.

Reimplemented in OdIfc2x2_final::IfcConstructionMaterialResource, OdIfc2x2_final::IfcLaborResource, and OdIfc2x2_final::IfcSubContractResource.

Member Data Documentation

◆ m_BaseQuantity

OdDAIObjectId OdIfc2x2_final::IfcConstructionResource::m_BaseQuantity
protected

◆ m_ResourceConsumption

OdDAI::Enum OdIfc2x2_final::IfcConstructionResource::m_ResourceConsumption
protected

◆ m_ResourceGroup

OdAnsiString OdIfc2x2_final::IfcConstructionResource::m_ResourceGroup
protected

◆ m_ResourceIdentifier

OdAnsiString OdIfc2x2_final::IfcConstructionResource::m_ResourceIdentifier
protected

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