CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcConstructionMaterialResource Class Reference

#include <IfcConstructionMaterialResourceAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcConstructionMaterialResource:
OdIfc2x3::IfcConstructionResource OdIfc2x3::IfcResource OdIfc2x3::IfcObject OdIfc2x3::IfcObjectDefinition OdIfc2x3::IfcRoot OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

void getSuppliers (OdArray< OdDAI::Select > &Suppliers) const
 
void getSuppliersWrapperArray (OdArray< IfcActorSelect > &Suppliers) const
 
OdDAI::SetOfSelect & suppliers ()
 
double getUsageRatio () const
 
void setUsageRatio (double UsageRatio)
 
 IfcConstructionMaterialResource ()
 
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 OdIfc2x3::IfcConstructionResource
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 ()
 
- Public Member Functions inherited from OdIfc2x3::IfcResource
void getInvResourceOf (OdDAIObjectIds &ResourceOf) const
 
- Public Member Functions inherited from OdIfc2x3::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x3::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAI::SetOfSelect m_Suppliers
 
double m_UsageRatio
 
- Protected Attributes inherited from OdIfc2x3::IfcConstructionResource
OdAnsiString m_ResourceIdentifier
 
OdAnsiString m_ResourceGroup
 
OdDAI::Enum m_ResourceConsumption
 
OdDAIObjectId m_BaseQuantity
 
- Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x3::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 OdIfc2x3::IfcResource
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

IfcConstructionMaterialResource identifies a material resource type in a construction project. Occurrences of IfcConstructionMaterialResource are consumed (wholly or partially), or occupied during a construction work task (IfcTask).

  • Object Typing - This concept can be applied to the following resources: IfcConstructionMaterialResourceType
  • Quantity Sets - This concept can be applied to the following resources: Qto_ConstructionMaterialResourceBaseQuantities
  • Resource Cost - This concept can be applied with the following combinations:
    CostType

CostName ValueType IfcCostValue Material IfcMonetaryMeasure

  • Resource Quantity - This concept can be applied with the following combinations:
    QuantityType

QuantityName IfcQuantityTime Labor

  • Resource Type Assignment - This concept can be applied to the following resources: IfcGeographicElement - Indicates a physical element manifesting the resource such as a pile of sand.
Remarks
This entity is not the same as IfcMaterial. IfcConstructionMaterialResource represents usage of bulk materials such as sand, gravels, nails, etc. while IfcMaterial is about physical materials that a physical building element consists of, possibly with detailed material layering information.

Definition at line 71 of file Ifc2x3/IfcConstructionMaterialResourceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcConstructionMaterialResource()

OdIfc2x3::IfcConstructionMaterialResource::IfcConstructionMaterialResource ( )

Default constructor for the IfcConstructionMaterialResource class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ getSuppliers()

void OdIfc2x3::IfcConstructionMaterialResource::getSuppliers ( OdArray< OdDAI::Select > & Suppliers) const

Returns the value of Suppliers attribute. This attribute represents possible suppliers of the type of materials.

Returns
Returns the value of Suppliers attribute.

◆ getSuppliersWrapperArray()

void OdIfc2x3::IfcConstructionMaterialResource::getSuppliersWrapperArray ( OdArray< IfcActorSelect > & Suppliers) const

Returns the value of Suppliers attribute. This attribute represents possible suppliers of the type of materials.

Returns
Returns the value of Suppliers attribute.

◆ getUsageRatio()

double OdIfc2x3::IfcConstructionMaterialResource::getUsageRatio ( ) const

Returns the value of UsageRatio attribute. This attribute represents the ratio of the amount of a construction material used to the amount provided (determined as a quantity).

Returns
Returns the value of UsageRatio attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ isKindOf()

virtual bool OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ outFields()

virtual OdResult OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ setUsageRatio()

void OdIfc2x3::IfcConstructionMaterialResource::setUsageRatio ( double UsageRatio)

Sets the value of UsageRatio attribute. This attribute represents the ratio of the amount of a construction material used to the amount provided (determined as a quantity).

Parameters
UsageRatio[in] Usage ratio to set.

◆ suppliers()

OdDAI::SetOfSelect & OdIfc2x3::IfcConstructionMaterialResource::suppliers ( )

Gets the value of Suppliers attribute. This attribute represents possible suppliers of the type of materials.

Parameters
Suppliers[out] Receives the Suppliers attribute.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcConstructionMaterialResource::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x3::IfcConstructionResource.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcConstructionMaterialResource::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 OdIfc2x3::IfcConstructionResource.

Member Data Documentation

◆ m_Suppliers

OdDAI::SetOfSelect OdIfc2x3::IfcConstructionMaterialResource::m_Suppliers
protected

◆ m_UsageRatio

double OdIfc2x3::IfcConstructionMaterialResource::m_UsageRatio
protected

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