CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4::IfcMaterialProfile Class Reference

#include <IfcMaterialProfileAutoImpl.h>

Inheritance diagram for OdIfc4::IfcMaterialProfile:
OdIfc4::IfcMaterialDefinition OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance OdIfc4::IfcMaterialProfileWithOffsets

Public Member Functions

const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
const OdDAIObjectId & getMaterial () const
 
void setMaterial (const OdDAIObjectId &Material)
 
const OdDAIObjectId & getProfile () const
 
void setProfile (const OdDAIObjectId &Profile)
 
int getPriority () const
 
void setPriority (int Priority)
 
const OdAnsiString & getCategory () const
 
void setCategory (const OdAnsiString &Category)
 
OdDAIObjectId getInvToMaterialProfileSet () const
 
 IfcMaterialProfile ()
 
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 OdIfc4::IfcMaterialDefinition
void getInvAssociatedTo (OdDAIObjectIds &AssociatedTo) const
 
void getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const
 
void getInvHasProperties (OdDAIObjectIds &HasProperties) const
 
- Public Member Functions inherited from OdIfc4::OdIfc4Instance
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
 
OdDAIObjectId m_Material
 
OdDAIObjectId m_Profile
 
int m_Priority
 
OdAnsiString m_Category
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcMaterialProfileSet
 

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

IfcMaterialProfile is a single and identifiable cross section of an element which is constructed of a number of profiles (one or more).

Definition at line 42 of file Ifc4/IfcMaterialProfileAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcMaterialProfile()

OdIfc4::IfcMaterialProfile::IfcMaterialProfile ( )

Default constructor for the IfcMaterialProfile class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcMaterialProfile::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 in OdIfc4::IfcMaterialProfileWithOffsets.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ getCategory()

const OdAnsiString & OdIfc4::IfcMaterialProfile::getCategory ( ) const

Returns the value of Category attribute. This attribute represents category of the material profile, e.g. the role it has in the profile set it belongs to. The list of keywords can be extended by model view definitions, however the following keywords apply in general: 'LoadBearing' — the material profile having a load bearing function. 'Insulation' — the material profile having an insulating function. 'Finish' — the material profile being the finish.

Returns
Returns the value of Category attribute.

◆ getDescription()

const OdAnsiString & OdIfc4::IfcMaterialProfile::getDescription ( ) const

Returns the value of Description attribute. This attribute represents definition of the material profile in descriptive terms.

Returns
Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ getInvToMaterialProfileSet()

OdDAIObjectId OdIfc4::IfcMaterialProfile::getInvToMaterialProfileSet ( ) const

Returns the value of ToMaterialProfileSet attribute. This attribute represents material profile set in which this material profile is included.

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

◆ getMaterial()

const OdDAIObjectId & OdIfc4::IfcMaterialProfile::getMaterial ( ) const

Returns the value of Material attribute. This attribute represents optional reference to the material from which the profile is constructed.

Returns
Returns the value of Material attribute.

◆ getName()

const OdAnsiString & OdIfc4::IfcMaterialProfile::getName ( ) const

Returns the value of Name attribute. This attribute represents the name by which the material profile is known.

Returns
Returns the value of Name attribute.

◆ getPriority()

int OdIfc4::IfcMaterialProfile::getPriority ( ) const

Returns the value of Priority attribute. This attribute represents the relative priority of the profile, expressed as normalized integer range [0..100]. This attribute controls how profiles intersect in connections and corners of building elements. A profile from one element protrudes into (i.e. displaces) a profile from another element in a joint of these elements if the former element's profile has higher priority than the latter. The priority value for a material profile in an element needs to be set and maintained by software applications in relation to the material profiles in connected elements.

Returns
Returns the value of Priority attribute.

◆ getProfile()

const OdDAIObjectId & OdIfc4::IfcMaterialProfile::getProfile ( ) const

Returns the value of Profile attribute. This attribute represents identification of the profile for which this material profile is associating material.

Returns
Returns the value of Profile attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ isKindOf()

virtual bool OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ outFields()

virtual OdResult OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcMaterialProfile::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.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ setCategory()

void OdIfc4::IfcMaterialProfile::setCategory ( const OdAnsiString & Category)

Sets the value of Category attribute. This attribute represents category of the material profile, e.g. the role it has in the profile set it belongs to. The list of keywords can be extended by model view definitions, however the following keywords apply in general: 'LoadBearing' — the material profile having a load bearing function. 'Insulation' — the material profile having an insulating function. 'Finish' — the material profile being the finish.

Parameters
Category[in] Category to set.

◆ setDescription()

void OdIfc4::IfcMaterialProfile::setDescription ( const OdAnsiString & Description)

Sets the value of Description attribute. This attribute represents definition of the material profile in descriptive terms.

Parameters
Description[in] Description to set.

◆ setMaterial()

void OdIfc4::IfcMaterialProfile::setMaterial ( const OdDAIObjectId & Material)

Sets the value of Material attribute. This attribute represents optional reference to the material from which the profile is constructed.

Parameters
Material[in] Material to set.

◆ setName()

void OdIfc4::IfcMaterialProfile::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute represents the name by which the material profile is known.

Parameters
Name[in] Name to set.

◆ setPriority()

void OdIfc4::IfcMaterialProfile::setPriority ( int Priority)

Sets the value of Priority attribute. This attribute represents the relative priority of the profile, expressed as normalized integer range [0..100]. This attribute controls how profiles intersect in connections and corners of building elements. A profile from one element protrudes into (i.e. displaces) a profile from another element in a joint of these elements if the former element's profile has higher priority than the latter. The priority value for a material profile in an element needs to be set and maintained by software applications in relation to the material profiles in connected elements.

Parameters
Priority[in] Priority to set.

◆ setProfile()

void OdIfc4::IfcMaterialProfile::setProfile ( const OdDAIObjectId & Profile)

Sets the value of Profile attribute. This attribute represents identification of the profile for which this material profile is associating material.

Parameters
Profile[in] Profile to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcMaterialProfile::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcMaterialProfile::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 OdIfc4::IfcMaterialDefinition.

Reimplemented in OdIfc4::IfcMaterialProfileWithOffsets.

Friends And Related Symbol Documentation

◆ IfcMaterialProfileSet

friend class IfcMaterialProfileSet
friend

Definition at line 308 of file Ifc4/IfcMaterialProfileAutoImpl.h.

Member Data Documentation

◆ m_Category

OdAnsiString OdIfc4::IfcMaterialProfile::m_Category
protected

Definition at line 305 of file Ifc4/IfcMaterialProfileAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc4::IfcMaterialProfile::m_Description
protected

Definition at line 301 of file Ifc4/IfcMaterialProfileAutoImpl.h.

◆ m_Material

OdDAIObjectId OdIfc4::IfcMaterialProfile::m_Material
protected

Definition at line 302 of file Ifc4/IfcMaterialProfileAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4::IfcMaterialProfile::m_Name
protected

Definition at line 300 of file Ifc4/IfcMaterialProfileAutoImpl.h.

◆ m_Priority

int OdIfc4::IfcMaterialProfile::m_Priority
protected

Definition at line 304 of file Ifc4/IfcMaterialProfileAutoImpl.h.

◆ m_Profile

OdDAIObjectId OdIfc4::IfcMaterialProfile::m_Profile
protected

Definition at line 303 of file Ifc4/IfcMaterialProfileAutoImpl.h.


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