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

#include <IfcPropertyReferenceValueAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcPropertyReferenceValue:
OdIfc4x4::IfcSimpleProperty OdIfc4x4::IfcProperty OdIfc4x4::IfcPropertyAbstraction OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getUsageName () const
 
void setUsageName (const OdAnsiString &UsageName)
 
IfcObjectReferenceSelect propertyReference ()
 
 IfcPropertyReferenceValue ()
 
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 OdIfc4x4::IfcProperty
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getSpecification () const
 
void setSpecification (const OdAnsiString &Specification)
 
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 ()
 
- Public Member Functions inherited from OdIfc4x4::IfcPropertyAbstraction
void getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const
 
- 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 Attributes

OdAnsiString m_UsageName
 
OdDAI::Select m_PropertyReference
 
- Protected Attributes inherited from OdIfc4x4::IfcProperty
OdAnsiString m_Name
 
OdAnsiString m_Specification
 
- 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)
 

Detailed Description

The IfcPropertyReferenceValue allows a property value to have the same type as a resource level entity. The applicable entities that can be used as value references are given by the IfcObjectReferenceSelect.

\changes

IFC4 changes: Attribute PropertyReference has been made OPTIONAL with upward compatibility for file based exchange. Type of the UsageName attribute changed from IfcLabel to IfcText.

Definition at line 47 of file IFC4X4/IfcPropertyReferenceValueAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPropertyReferenceValue()

OdIfc4x4::IfcPropertyReferenceValue::IfcPropertyReferenceValue ( )

Default constructor for the IfcPropertyReferenceValue class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcPropertyReferenceValue::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::IfcSimpleProperty.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcPropertyReferenceValue::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 OdIfc4x4::IfcProperty.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcPropertyReferenceValue::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::IfcProperty.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcPropertyReferenceValue::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::IfcSimpleProperty.

◆ getUsageName()

const OdAnsiString & OdIfc4x4::IfcPropertyReferenceValue::getUsageName ( ) const

Returns the value of UsageName attribute. UsageName is description of the use of the referenced value within the property. It is a descriptive text that can hold an expression or other additional information.

Returns
Returns a string representing the UsageName attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcPropertyReferenceValue::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::IfcProperty.

◆ isKindOf()

virtual bool OdIfc4x4::IfcPropertyReferenceValue::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::IfcSimpleProperty.

◆ outFields()

virtual OdResult OdIfc4x4::IfcPropertyReferenceValue::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::IfcProperty.

◆ propertyReference()

IfcObjectReferenceSelect OdIfc4x4::IfcPropertyReferenceValue::propertyReference ( )

Returns the value of PropertyReference attribute. PropertyReference is reference to another property entity through one of the select types in the IfcObjectReferenceSelect.

Returns
Returns the value of PropertyReference attribute.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcPropertyReferenceValue::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 OdIfc4x4::IfcProperty.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcPropertyReferenceValue::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::IfcProperty.

◆ setUsageName()

void OdIfc4x4::IfcPropertyReferenceValue::setUsageName ( const OdAnsiString & UsageName)

Sets the value of UsageName attribute. UsageName is description of the use of the referenced value within the property. It is a descriptive text that can hold an expression or other additional information.

Parameters
UsageName[in] Usage name to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcPropertyReferenceValue::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::IfcProperty.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcPropertyReferenceValue::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::IfcProperty.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcPropertyReferenceValue::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::IfcSimpleProperty.

◆ unsetAttr() [1/2]

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

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x4::IfcProperty.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcPropertyReferenceValue::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 OdIfc4x4::IfcProperty.

Member Data Documentation

◆ m_PropertyReference

OdDAI::Select OdIfc4x4::IfcPropertyReferenceValue::m_PropertyReference
protected

Definition at line 214 of file IFC4X4/IfcPropertyReferenceValueAutoImpl.h.

◆ m_UsageName

OdAnsiString OdIfc4x4::IfcPropertyReferenceValue::m_UsageName
protected

Definition at line 213 of file IFC4X4/IfcPropertyReferenceValueAutoImpl.h.


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