CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcMaterial Class Reference

#include <IfcMaterialAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcMaterial:
OdIfc4x4::IfcMaterialDefinition OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
const OdAnsiString & getCategory () const
 
void setCategory (const OdAnsiString &Category)
 
void getInvHasRepresentation (OdDAIObjectIds &HasRepresentation) const
 
void getInvIsRelatedWith (OdDAIObjectIds &IsRelatedWith) const
 
void getInvRelatesTo (OdDAIObjectIds &RelatesTo) const
 
 IfcMaterial ()
 
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::IfcMaterialDefinition
void getInvAssociatedTo (OdDAIObjectIds &AssociatedTo) const
 
void getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const
 
void getInvHasProperties (OdDAIObjectIds &HasProperties) const
 
- 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_Name
 
OdAnsiString m_Description
 
OdAnsiString m_Category
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcMaterialDefinitionRepresentation
 
class IfcMaterialRelationship
 

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

IfcMaterial is a homogeneous or inhomogeneous substance that can be used to form elements (physical products or their components). IfcMaterial is the basic entity for material designation and definition; this includes identification by name and classification (via reference to an external classification), as well as association of material properties (isotropic or anisotropic) defined by (subtypes of) IfcMaterialProperties. An instance of IfcMaterial can be associated to an element or element type using the IfcRelAssociatesMaterial relationship. The assignment can either be direct as a single material information, or via Material layer set Material profile set Material constituent set

An IfcMaterial can also have presentation information associated. Such presentation information is provided by IfcMaterialDefinitionRepresentation, associating curve styles, hatching definitions or surface coloring/rendering information to a material.

\changes

IFC4 changes: Attribute ClassifiedAs renamed to IsRelatedWith Type of the ClassifiedAs inverse attribute changed from "SET OF [0:1] IfcMaterialClassificationRelationship FOR ClassifiedMaterial" to "SET OF [0:?] IfcMaterialRelationship FOR RelatedMaterials"

Definition at line 57 of file IFC4X4/IfcMaterialAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcMaterial()

OdIfc4x4::IfcMaterial::IfcMaterial ( )

Default constructor for the IfcMaterial class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ getCategory()

const OdAnsiString & OdIfc4x4::IfcMaterial::getCategory ( ) const

Returns the value of Category attribute. This attribute represents the category (group or type) of material, in more general terms than specified by attribute Name. For example, a view definition can require each Material.Name to be unique, e.g. for each concrete or steel grade used in a project, in which case Material.Category could take the values 'Concrete' or 'Steel'.

Returns
Returns the value of Category attribute.

◆ getDescription()

const OdAnsiString & OdIfc4x4::IfcMaterial::getDescription ( ) const

Returns the value of Description attribute. This attribute represents definition of the material in more descriptive terms than specified by attributes Name or Category.

Returns
Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ getInvHasRepresentation()

void OdIfc4x4::IfcMaterial::getInvHasRepresentation ( OdDAIObjectIds & HasRepresentation) const

Returns the value of HasRepresentation attribute. This attribute represents reference to the IfcMaterialDefinitionRepresentation that provides presentation information relating to IfcMaterial.

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

◆ getInvIsRelatedWith()

void OdIfc4x4::IfcMaterial::getInvIsRelatedWith ( OdDAIObjectIds & IsRelatedWith) const

Returns the value of IsRelatedWith attribute. This attribute represents reference to a material relationship indicating that this material is a part (or constituent) in a material composite.

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

◆ getInvRelatesTo()

void OdIfc4x4::IfcMaterial::getInvRelatesTo ( OdDAIObjectIds & RelatesTo) const

Returns the value of RelatesTo attribute. This attribute represents reference to a material relationship indicating that this material composite has parts (or constituents).

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

◆ getName()

const OdAnsiString & OdIfc4x4::IfcMaterial::getName ( ) const

Returns the value of Name attribute. This attribute represents name of the material. For example, a view definition can require Material.Name to uniquely specify e.g. concrete or steel grade, in which case the attribute Material.Category could take the value 'Concrete' or 'Steel'.

Returns
Returns the value of Name attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ isKindOf()

virtual bool OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ outFields()

virtual OdResult OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcMaterial::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 OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ setCategory()

void OdIfc4x4::IfcMaterial::setCategory ( const OdAnsiString & Category)

Sets the value of Category attribute. This attribute represents the category (group or type) of material, in more general terms than specified by attribute Name. For example, a view definition can require each Material.Name to be unique, e.g. for each concrete or steel grade used in a project, in which case Material.Category could take the values 'Concrete' or 'Steel'.

Parameters
Category[in] Category to set.

◆ setDescription()

void OdIfc4x4::IfcMaterial::setDescription ( const OdAnsiString & Description)

Sets the value of Description attribute. This attribute represents definition of the material in more descriptive terms than specified by attributes Name or Category.

Parameters
Description[in] Description to set.

◆ setName()

void OdIfc4x4::IfcMaterial::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. For example, a view definition can require Material.Name to uniquely specify e.g. concrete or steel grade, in which case the attribute Material.Category could take the value 'Concrete' or 'Steel'.

Parameters
Name[in] Name to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcMaterial::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::IfcMaterialDefinition.

Friends And Related Symbol Documentation

◆ IfcMaterialDefinitionRepresentation

Definition at line 278 of file IFC4X4/IfcMaterialAutoImpl.h.

◆ IfcMaterialRelationship

Definition at line 279 of file IFC4X4/IfcMaterialAutoImpl.h.

Member Data Documentation

◆ m_Category

OdAnsiString OdIfc4x4::IfcMaterial::m_Category
protected

Definition at line 275 of file IFC4X4/IfcMaterialAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc4x4::IfcMaterial::m_Description
protected

Definition at line 274 of file IFC4X4/IfcMaterialAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x4::IfcMaterial::m_Name
protected

Definition at line 273 of file IFC4X4/IfcMaterialAutoImpl.h.


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