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

#include <IfcPropertySetAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcPropertySet:
OdIfc2x_final::IfcPropertySetDefinition OdIfc2x_final::IfcPropertyDefinition OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

void getHasProperties (OdDAIObjectIds &HasProperties) const
 
OdDAI::SetOfOdDAIObjectId & hasProperties ()
 
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::IfcPropertySetDefinition
void getInvPropertyDefinitionOf (OdDAIObjectIds &PropertyDefinitionOf) const
 
void getInvDefinesType (OdDAIObjectIds &DefinesType) const
 
- Public Member Functions inherited from OdIfc2x_final::IfcPropertyDefinition
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- 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::SetOfOdDAIObjectId m_HasProperties
 
- 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
 

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 OdIfc2x_final::IfcPropertySetDefinition
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

The IfcPropertySet contains properties within a property tree. These properties are interpreted according to their name attribute.
Property sets applicable to certain objects are listed in the object specification. The specification supposes usage of the naming convention "Pset_Xxx". Such naming convention is applied to the property sets that are defined as part of this specification and be used as the value of the Name attribute.

IfcPropertySet can be assigned to object occurrences and object types. An IfcPropertySet assigned to an object type is shared among all occurrences of the same object type.

Property sets are related to other objects by using the relationship object that refers to the corresponding object: Occurrence Object: IfcRelDefinesByProperties using the inverse attribute DefinesOccurrence. Type Object: using a direct link by inverse attribute DefinesType. Underlying template: IfcRelDefinesByTemplate using the inverse attribute IsDefinedBy. External reference: subtypes of IfcRelAssociates are used to provide a link to a classification system, or external library providing further reference to the property set. Accessible by inverse attribute HasAssociations.

Definition at line 55 of file Ifc2x_Final/IfcPropertySetAutoImpl.h.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcPropertySet::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::IfcPropertyDefinition.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ getHasProperties()

void OdIfc2x_final::IfcPropertySet::getHasProperties ( OdDAIObjectIds & HasProperties) const

Retrieves the contained set of properties.

Parameters
HasProperties[out] Receives an array of Data Access Interface (DAI) identifiers that represent properties in the property set.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ hasProperties()

OdDAI::SetOfOdDAIObjectId & OdIfc2x_final::IfcPropertySet::hasProperties ( )

Retrieves the contained set of properties.

Returns
An array of Data Access Interface (DAI) identifiers that represent properties in the property set.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcPropertySet::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::IfcPropertyDefinition.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcPropertySet::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::IfcPropertySetDefinition.

Member Data Documentation

◆ m_HasProperties

OdDAI::SetOfOdDAIObjectId OdIfc2x_final::IfcPropertySet::m_HasProperties
protected

Definition at line 187 of file Ifc2x_Final/IfcPropertySetAutoImpl.h.


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