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

#include <IfcResourceAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcResource:
OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance OdIfc2x_final::IfcConstructionEquipmentResource OdIfc2x_final::IfcConstructionMaterialResource OdIfc2x_final::IfcConstructionProductResource OdIfc2x_final::IfcCrewResource OdIfc2x_final::IfcLaborResource OdIfc2x_final::IfcSubContractResource

Public Member Functions

IfcResourceConsumptionEnum getResourceConsumption () const
 
void setResourceConsumption (IfcResourceConsumptionEnum ResourceConsumption)
 
const OdDAIObjectId & getBaseUnit () const
 
void setBaseUnit (const OdDAIObjectId &BaseUnit)
 
void getInvResourceOf (OdDAIObjectIds &ResourceOf) const
 
 IfcResource ()
 
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::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

OdDAI::Enum m_ResourceConsumption
 
OdDAIObjectId m_BaseUnit
 
- 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 IfcRelAssignsToResource
 

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

IfcResource contains the information needed to represent the costs, schedule, and other impacts from the use of a thing in a process. It is not intended to use IfcResource to model the general properties of the things themselves, while an optional linkage from IfcResource to the things to be used can be specified (specifically, the relationship from subtypes of IfcResource to IfcProduct through the IfcRelAssignsToResource relationship).

There are two basic intended uses of IfcResource. First, if the attributes of the thing are not needed for the purpose of the use of IfcResource, or the types of things are not explicitly modeled in IFC yet, then the linkage between the resource and the thing doesn't have to be instantiated in the system. That is, the attributes of IfcResource (or its subtypes) alone are sufficient to represent the use of the thing as a resource for the purpose of the project.

If the attributes of the thing are needed for the use of IfcResource objects, and they are modeled explicitly as objects, then the IfcResource instances can be linked to the instances of the type of the things being referenced. Things that might be used as resources and that are already modeled in the IFC include physical products, people and organizations, and materials. The relationship object IfcRelAssignsToResource is provided for this approach. The inherited attribute ObjectType is used as a textual code that identifies the resource type.

Remarks
This definition cannot be instantiated

Definition at line 62 of file Ifc2x_Final/IfcResourceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcResource()

OdIfc2x_final::IfcResource::IfcResource ( )

Default constructor for the IfcResource class.

Member Function Documentation

◆ getAttr() [1/2]

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

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

◆ getAttr() [2/2]

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

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

◆ getBaseUnit()

const OdDAIObjectId & OdIfc2x_final::IfcResource::getBaseUnit ( ) const

Returns the value of BaseUnit attribute. This attribute represents the basic (i.e. default, or recommended) unit that should be used for measuring the volume (or amount) of the resource.

Returns
Returns the value of BaseUnit attribute.

◆ getInstanceType()

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

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

◆ getInvResourceOf()

void OdIfc2x_final::IfcResource::getInvResourceOf ( OdDAIObjectIds & ResourceOf) const

Returns the value of ResourceOf attribute. This attribute represents set of relationships to other objects, e.g. products, processes, controls, resources or actors, for which this resource object is a resource.

Parameters
ResourceOf[out] Receives the value of ResourceOf attribute.

◆ getResourceConsumption()

IfcResourceConsumptionEnum OdIfc2x_final::IfcResource::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 detail).

Returns
Returns the value of ResourceConsumption attribute.

◆ inFields()

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

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

◆ isKindOf()

virtual bool OdIfc2x_final::IfcResource::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::IfcObject.

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

◆ outFields()

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

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

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcResource::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::IfcObject.

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

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcResource::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::IfcObject.

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

◆ setBaseUnit()

void OdIfc2x_final::IfcResource::setBaseUnit ( const OdDAIObjectId & BaseUnit)

Sets the value of BaseUnit attribute. This attribute represents the basic (i.e. default, or recommended) unit that should be used for measuring the volume (or amount) of the resource.

Parameters
BaseUnit[in] Base unit to set.

◆ setResourceConsumption()

void OdIfc2x_final::IfcResource::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 detail).

Parameters
ResourceConsumption[in] Resource consumption to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcResource::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::IfcObject.

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

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcResource::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::IfcObject.

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

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcResource::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::IfcObject.

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

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcResource::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::IfcObject.

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

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcResource::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::IfcObject.

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

Friends And Related Symbol Documentation

◆ IfcRelAssignsToResource

friend class IfcRelAssignsToResource
friend

Definition at line 232 of file Ifc2x_Final/IfcResourceAutoImpl.h.

Member Data Documentation

◆ m_BaseUnit

OdDAIObjectId OdIfc2x_final::IfcResource::m_BaseUnit
protected

Definition at line 229 of file Ifc2x_Final/IfcResourceAutoImpl.h.

◆ m_ResourceConsumption

OdDAI::Enum OdIfc2x_final::IfcResource::m_ResourceConsumption
protected

Definition at line 228 of file Ifc2x_Final/IfcResourceAutoImpl.h.


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