CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
OdIfc4x3_rc1::IfcPropertySet Class Reference

#include <IfcPropertySetAutoImpl.h>

Inheritance diagram for OdIfc4x3_rc1::IfcPropertySet:
OdIfc4x3_rc1::IfcPropertySetDefinition OdIfc4x3_rc1::IfcPropertyDefinition OdIfc4x3_rc1::IfcRoot OdIfc::OdIfcEntity

Public Member Functions

void getHasProperties (OdDAIObjectIds &HasProperties) const
 
OdDAI::OdDAIObjectIdSet & hasProperties ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual void setInverseCounterParts ()
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4x3_rc1::IfcPropertySetDefinition
void getInvDefinesType (OdDAIObjectIds &DefinesType) const
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvDefinesOccurrence (OdDAIObjectIds &DefinesOccurrence) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4x3_rc1::IfcPropertyDefinition
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4x3_rc1::IfcRoot
OdIfcGUID getGlobalId () const
 
void setGlobalId (OdIfcGUID 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 ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc::OdIfcEntity
 ODRX_DECLARE_MEMBERS (OdIfcEntity)
 
 OdIfcEntity ()
 
 ~OdIfcEntity ()
 
virtual bool isKindOf (OdIfcEntityType entityType) const
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
virtual OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfcAttribute attrDef) const
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool testAttr (const OdIfcAttribute explicitAttrDef) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual void unsetAttr (const OdIfcAttribute explicitAttrDef)
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
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
 

Protected Attributes

OdDAI::OdDAIObjectIdSet m_HasProperties
 
- Protected Attributes inherited from OdIfc4x3_rc1::IfcRoot
OdIfcGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcEntity
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcEntity
static const OdGePoint3dasPoint3d (const OdIfcEntity *pEnt)
 
static const OdGePoint2dasPoint2d (const OdIfcEntity *pEnt)
 
static const OdGeVector3dasVector3d (const OdIfcEntity *pEnt)
 
static const OdGeVector2dasVector2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcEntity *pEnt)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcEntity > pEnt)
 
static const OdCmEntityColorasRgbColor (const OdIfcEntity *pEnt)
 
- Protected Member Functions inherited from OdIfc4x3_rc1::IfcPropertySetDefinition
virtual OdRxValue getAttr (const char *attrName) const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 

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 Ifc4x3_RC1/IfcPropertySetAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_rc1::IfcPropertySet::comparedToEarlyImpl ( const OdDAI::ApplicationInstance *  pOther,
OdRx::Ordering ordering 
) const
virtual

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 OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_rc1::IfcPropertySet::getAttr ( const char *  attrName) const
virtual

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 OdIfc4x3_rc1::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x3_rc1::IfcPropertySet::getAttr ( const OdIfc::OdIfcAttribute  attrDef) const
virtual

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 OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ getHasProperties()

void OdIfc4x3_rc1::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 * OdIfc4x3_rc1::IfcPropertySet::getInstanceType ( ) const
virtual

Returns a type of a class instance.

Returns
Pointer to the <link OdDAI__Entity, OdDAI::Entity> type that determines an entity definition within a schema.

Reimplemented from OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ hasProperties()

OdDAI::OdDAIObjectIdSet & OdIfc4x3_rc1::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 OdIfc4x3_rc1::IfcPropertySet::inFields ( OdDAI::OdSpfFilerBase *  rdFiler)
virtual

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 OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ isKindOf()

virtual bool OdIfc4x3_rc1::IfcPropertySet::isKindOf ( OdIfc::OdIfcEntityType  entityType) const
virtual

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 OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ outFields()

virtual OdResult OdIfc4x3_rc1::IfcPropertySet::outFields ( OdDAI::OdSpfFilerBase *  wrFiler)
virtual

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 OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ putAttr() [1/2]

virtual bool OdIfc4x3_rc1::IfcPropertySet::putAttr ( const char *  explicitAttrName,
const OdRxValue val 
)
virtual

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 OdIfc4x3_rc1::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc4x3_rc1::IfcPropertySet::putAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef,
const OdRxValue val 
)
virtual

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 OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ setInverseCounterParts()

virtual void OdIfc4x3_rc1::IfcPropertySet::setInverseCounterParts ( )
virtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ testAttr() [1/2]

virtual bool OdIfc4x3_rc1::IfcPropertySet::testAttr ( const char *  explicitAttrName) const
virtual

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 OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ testAttr() [2/2]

virtual bool OdIfc4x3_rc1::IfcPropertySet::testAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef) const
virtual

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 OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_rc1::IfcPropertySet::type ( ) const
virtual

Returns the type of this entity.

Returns
A value of the <link OdIfc__OdIfcEntityType, OdIfc::OdIfcEntityType> type that represents type of this entity.

Reimplemented from OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_rc1::IfcPropertySet::unsetAttr ( const char *  explicitAttrName)
virtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x3_rc1::IfcPropertySetDefinition.

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_rc1::IfcPropertySet::unsetAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef)
virtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc4x3_rc1::IfcPropertySetDefinition.

Member Data Documentation

◆ m_HasProperties

OdDAI::OdDAIObjectIdSet OdIfc4x3_rc1::IfcPropertySet::m_HasProperties
protected

Definition at line 211 of file Ifc4x3_RC1/IfcPropertySetAutoImpl.h.


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