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

#include <IfcPropertySetDefinitionAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcPropertySetDefinition:
OdIfc4x4::IfcPropertyDefinition OdIfc4x4::IfcRoot OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance OdIfc4x4::IfcPreDefinedPropertySet OdIfc4x4::IfcPropertySet OdIfc4x4::IfcQuantitySet OdIfc4x4::IfcDoorLiningProperties OdIfc4x4::IfcDoorPanelProperties OdIfc4x4::IfcPermeableCoveringProperties OdIfc4x4::IfcReinforcementDefinitionProperties OdIfc4x4::IfcWindowLiningProperties OdIfc4x4::IfcWindowPanelProperties OdIfc4x4::IfcElementQuantity

Public Member Functions

void getInvDefinesType (OdDAIObjectIds &DefinesType) const
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvDefinesOccurrence (OdDAIObjectIds &DefinesOccurrence) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () 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 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::IfcPropertyDefinition
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc4x4::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 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 Member Functions

virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Friends

class IfcTypeObject
 
class IfcRelDefinesByTemplate
 
class IfcRelDefinesByProperties
 

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 Attributes inherited from OdIfc4x4::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
 

Detailed Description

IfcPropertySetDefinition is a generalization of all individual property sets that can be assigned to an object or type object. The property set definition can be either: Dynamically extendable property sets - IfcPropertySet, a set of properties for which the IFC specification only provides a kind of "meta model", to be further declared by agreement. This means that no entity definition of the properties exists within the IFC specification. The declaration is done by assigning a significant string value to the Name attribute of the entity as defined in the entity IfcPropertySet and at each subtype of IfcProperty, referenced by the property set. Dynamically defined property sets can have an underlying template provided by IfcPropertySetTemplate. Statically defined property sets - IfcPreDefinedPropertySet, a property set entity that exists within the IFC specification. The semantic meaning of each statically defined property set is declared by its entity type and the meaning of the properties is defined by the name and data type of the explicit attribute representing it.

Property set definitions define information that is shared among multiple instances of objects, either object occurrences or object types. IfcPropertySetDefinition's (by their instantiable subtypes) can participate within the following relationships: Assignment to object types - a DefinesType direct relationship to IfcTypeObject that applies the property set, with all included properties, to the object type. Those properties apply to all object occurrences having the same object type. Assignment to object occurrences - an DefinesOccurrence relationship to IfcRelDefinesByProperties that applies the property set, with all included properties, to the object occurrence.

\changes

IFC4 changes: The subtype IfcPreDefinedPropertySet has been added. Name of the inverse attribute DefinesType changed to IsDefinedBy. Type of the inverse attribute DefinesType type changed from "SET OF [0:1] IfcTypeObject FOR HasPropertySets" to "SET OF [0:?] IfcRelDefinesByTemplate FOR RelatedPropertySets". Name of the inverse attribute PropertyDefinitionOf changed to DefinesType. Type of the inverse attribute PropertyDefinitionOf changed from "SET OF [0:1] IfcRelDefinesByProperties FOR RelatingPropertyDefinition" to "SET OF [0:?] IfcTypeObject FOR HasPropertySets".

Definition at line 65 of file IFC4X4/IfcPropertySetDefinitionAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPreDefinedPropertySet, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcQuantitySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcRoot::getAttr ( const char * attrName) const
overrideprotectedvirtual

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 OdIfc4x4::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ getAttr() [2/2]

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

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPreDefinedPropertySet, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcQuantitySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ getInvDefinesOccurrence()

void OdIfc4x4::IfcPropertySetDefinition::getInvDefinesOccurrence ( OdDAIObjectIds & DefinesOccurrence) const

Returns the value of DefinesOccurrence attribute. DefinesOccurrence is reference to the relation to one or many object occurrences that are characterized by the property set definition. A single property set can be assigned to multiple object occurrences using the objectified relationship IfcRefDefinesByProperties.

Parameters
DefinesOccurrence[out] Receives an array of object identifiers representing the IsDefinedBy attribute.

◆ getInvDefinesType()

void OdIfc4x4::IfcPropertySetDefinition::getInvDefinesType ( OdDAIObjectIds & DefinesType) const

Returns the value of DefinesType attribute. DefinesType is the type of an object to which the property set is assigned. The property set acts as a shared property set to all occurrences of the type object.

Parameters
DefinesType[out] Receives an array of object identifiers representing the DefinesType attribute.
Remarks
The relationship between the IfcPropertySetDefinition and the IfcTypeObject is a direct relationship, not utilizing IfcRelDefinesByProperties, for maintaining compatibility with earlier releases of this standard.

◆ getInvIsDefinedBy()

void OdIfc4x4::IfcPropertySetDefinition::getInvIsDefinedBy ( OdDAIObjectIds & IsDefinedBy) const

Returns the value of IsDefinedBy attribute. IsDefinedBy is a relation to the property set template, via the objectified relationship IfcRelDefinesByTemplate, that provides the definition template for the property set or quantity set and its properties, if it is specified.

Parameters
IsDefinedBy[out] Receives an array of object identifiers representing the IsDefinedBy attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ isKindOf()

virtual bool OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPreDefinedPropertySet, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcQuantitySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ outFields()

virtual OdResult OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcRoot::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overrideprotectedvirtual

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 OdIfc4x4::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcPropertySetDefinition::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::IfcPropertyDefinition.

Reimplemented in OdIfc4x4::IfcDoorLiningProperties, OdIfc4x4::IfcDoorPanelProperties, OdIfc4x4::IfcElementQuantity, OdIfc4x4::IfcPermeableCoveringProperties, OdIfc4x4::IfcPreDefinedPropertySet, OdIfc4x4::IfcPropertySet, OdIfc4x4::IfcQuantitySet, OdIfc4x4::IfcReinforcementDefinitionProperties, OdIfc4x4::IfcWindowLiningProperties, and OdIfc4x4::IfcWindowPanelProperties.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcPropertySetDefinition::unsetAttr ( const char * explicitAttrName)
overridevirtual

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcPropertySetDefinition::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Friends And Related Symbol Documentation

◆ IfcRelDefinesByProperties

friend class IfcRelDefinesByProperties
friend

Definition at line 220 of file IFC4X4/IfcPropertySetDefinitionAutoImpl.h.

◆ IfcRelDefinesByTemplate

friend class IfcRelDefinesByTemplate
friend

Definition at line 219 of file IFC4X4/IfcPropertySetDefinitionAutoImpl.h.

◆ IfcTypeObject

friend class IfcTypeObject
friend

Definition at line 218 of file IFC4X4/IfcPropertySetDefinitionAutoImpl.h.


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