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

#include <IfcPropertyAutoImpl.h>

Inheritance diagram for OdIfc4::IfcProperty:
OdIfc4::IfcPropertyAbstraction OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance OdIfc4::IfcComplexProperty OdIfc4::IfcSimpleProperty OdIfc4::IfcPropertyBoundedValue OdIfc4::IfcPropertyEnumeratedValue OdIfc4::IfcPropertyListValue OdIfc4::IfcPropertyReferenceValue OdIfc4::IfcPropertySingleValue OdIfc4::IfcPropertyTableValue

Public Member Functions

const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
void getInvPartOfPset (OdDAIObjectIds &PartOfPset) const
 
void getInvPropertyForDependance (OdDAIObjectIds &PropertyForDependance) const
 
void getInvPropertyDependsOn (OdDAIObjectIds &PropertyDependsOn) const
 
void getInvPartOfComplex (OdDAIObjectIds &PartOfComplex) const
 
void getInvHasConstraints (OdDAIObjectIds &HasConstraints) const
 
void getInvHasApprovals (OdDAIObjectIds &HasApprovals) const
 
 IfcProperty ()
 
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::IfcPropertyAbstraction
void getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) 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
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcPropertySet
 
class IfcPropertyDependencyRelationship
 
class IfcComplexProperty
 
class IfcResourceConstraintRelationship
 
class IfcResourceApprovalRelationship
 

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

IfcProperty is an abstract generalization for all types of properties that can be associated with IFC objects through the property set mechanism.

\changes

IFC4 changes: Type of the inverse attribute PartOfComplex changed from "SET OF [0:1] IfcComplexProperty FOR HasProperties" to "SET OF [0:?] IfcComplexProperty FOR HasProperties"

Definition at line 45 of file Ifc4/IfcPropertyAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcProperty()

OdIfc4::IfcProperty::IfcProperty ( )

Default constructor for the IfcProperty class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, OdIfc4::IfcPropertyTableValue, and OdIfc4::IfcSimpleProperty.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcProperty::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::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcProperty::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::IfcPropertyAbstraction.

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ getDescription()

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

Returns the value of Description attribute. Description is informative text to explain the property.

Returns
Returns a string value representing the Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcProperty::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::IfcPropertyAbstraction.

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, OdIfc4::IfcPropertyTableValue, and OdIfc4::IfcSimpleProperty.

◆ getInvHasApprovals()

void OdIfc4::IfcProperty::getInvHasApprovals ( OdDAIObjectIds & HasApprovals) const

Returns the value of HasApprovals attribute. HasApprovals is user-defined approvals for the property.

Parameters
HasApprovals[out] Receives object identifiers representing the HasApprovals attribute.

◆ getInvHasConstraints()

void OdIfc4::IfcProperty::getInvHasConstraints ( OdDAIObjectIds & HasConstraints) const

Returns the value of HasConstraints attribute. HasConstraints attribute is user-defined constraints for the property.

Parameters
HasConstraints[out] Receives object identifiers representing the HasConstraints attribute.

◆ getInvPartOfComplex()

void OdIfc4::IfcProperty::getInvPartOfComplex ( OdDAIObjectIds & PartOfComplex) const

Returns the value of PartOfComplex attribute. PartOfComplex is reference to the IfcComplexProperty in which the IfcProperty is contained.

Parameters
PartOfComplex[out] Receives object identifiers representing the PartOfComplex attribute.

◆ getInvPartOfPset()

void OdIfc4::IfcProperty::getInvPartOfPset ( OdDAIObjectIds & PartOfPset) const

Returns the value of PartOfPset attribute. PartOfPset is reference to the IfcPropertySet by which the IfcProperty is referenced.

Parameters
PartOfPset[out] Receives object identifiers representing the PartOfPset attribute.

◆ getInvPropertyDependsOn()

void OdIfc4::IfcProperty::getInvPropertyDependsOn ( OdDAIObjectIds & PropertyDependsOn) const

Returns the value of PropertyDependsOn attribute. PropertyDependsOn is the relating property on which the value of the property depends.

Parameters
PropertyDependsOn[out] Receives object identifiers representing the PropertyDependsOn attribute.

◆ getInvPropertyForDependance()

void OdIfc4::IfcProperty::getInvPropertyForDependance ( OdDAIObjectIds & PropertyForDependance) const

Returns the value of PropertyForDependance attribute. PropertyForDependance is the property on the value of which value of another property depends.

Parameters
PropertyForDependance[out] Receives object identifiers representing the PropertyForDependance attribute.

◆ getName()

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

Returns the value of Name attribute that represents name for this property. This label is the significant name string that defines the semantic meaning for the property.

Returns
Returns a string value representing the Name attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcProperty::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::IfcPropertyAbstraction.

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ isKindOf()

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

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, OdIfc4::IfcPropertyTableValue, and OdIfc4::IfcSimpleProperty.

◆ outFields()

virtual OdResult OdIfc4::IfcProperty::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::IfcPropertyAbstraction.

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcProperty::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::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ putAttr() [2/2]

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

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ setDescription()

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

Sets the value of Description attribute. Description is informative text to explain the property.

Parameters
Description[in] Description to set.

◆ setName()

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

Sets the value of Name attribute that represents name for this property. This label is the significant name string that defines the semantic meaning for the property.

Parameters
Name[in] Name to set.

◆ testAttr() [1/2]

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

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcProperty::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::IfcPropertyAbstraction.

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, OdIfc4::IfcPropertyTableValue, and OdIfc4::IfcSimpleProperty.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcProperty::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::IfcPropertyAbstraction.

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcProperty::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::IfcPropertyAbstraction.

Reimplemented in OdIfc4::IfcComplexProperty, OdIfc4::IfcPropertyBoundedValue, OdIfc4::IfcPropertyEnumeratedValue, OdIfc4::IfcPropertyListValue, OdIfc4::IfcPropertyReferenceValue, OdIfc4::IfcPropertySingleValue, and OdIfc4::IfcPropertyTableValue.

Friends And Related Symbol Documentation

◆ IfcComplexProperty

friend class IfcComplexProperty
friend

Definition at line 259 of file Ifc4/IfcPropertyAutoImpl.h.

◆ IfcPropertyDependencyRelationship

◆ IfcPropertySet

friend class IfcPropertySet
friend

Definition at line 256 of file Ifc4/IfcPropertyAutoImpl.h.

◆ IfcResourceApprovalRelationship

friend class IfcResourceApprovalRelationship
friend

Definition at line 261 of file Ifc4/IfcPropertyAutoImpl.h.

◆ IfcResourceConstraintRelationship

friend class IfcResourceConstraintRelationship
friend

Definition at line 260 of file Ifc4/IfcPropertyAutoImpl.h.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4::IfcProperty::m_Description
protected

Definition at line 253 of file Ifc4/IfcPropertyAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4::IfcProperty::m_Name
protected

Definition at line 252 of file Ifc4/IfcPropertyAutoImpl.h.


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