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

#include <IfcComplexPropertyTemplateAutoImpl.h>

Inheritance diagram for OdIfc4::IfcComplexPropertyTemplate:
OdIfc4::IfcPropertyTemplate OdIfc4::IfcPropertyTemplateDefinition OdIfc4::IfcPropertyDefinition OdIfc4::IfcRoot OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getUsageName () const
 
void setUsageName (const OdAnsiString &UsageName)
 
IfcComplexPropertyTemplateTypeEnum getTemplateType () const
 
void setTemplateType (IfcComplexPropertyTemplateTypeEnum TemplateType)
 
void getHasPropertyTemplates (OdDAIObjectIds &HasPropertyTemplates) const
 
OdDAI::SetOfOdDAIObjectId & hasPropertyTemplates ()
 
 IfcComplexPropertyTemplate ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void setInverseCounterParts () 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::IfcPropertyTemplate
void getInvPartOfComplexTemplate (OdDAIObjectIds &PartOfComplexTemplate) const
 
void getInvPartOfPsetTemplate (OdDAIObjectIds &PartOfPsetTemplate) const
 
- Public Member Functions inherited from OdIfc4::IfcPropertyDefinition
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc4::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 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_UsageName
 
OdDAI::Enum m_TemplateType
 
OdDAI::SetOfOdDAIObjectId m_HasPropertyTemplates
 
- Protected Attributes inherited from OdIfc4::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 OdIfc4::IfcPropertyTemplate
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

The IfcComplexPropertyTemplate defines the template for all complex properties, either the IfcComplexProperty's or the IfcPhysicalComplexQuantity's. The individual complex property templates are interpreted according to their Name attribute and optional UsageName attribute.

Definition at line 41 of file Ifc4/IfcComplexPropertyTemplateAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcComplexPropertyTemplate()

OdIfc4::IfcComplexPropertyTemplate::IfcComplexPropertyTemplate ( )

Default constructor for the IfcComplexPropertyTemplate class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcComplexPropertyTemplate::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 OdIfc4::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ getHasPropertyTemplates()

void OdIfc4::IfcComplexPropertyTemplate::getHasPropertyTemplates ( OdDAIObjectIds & HasPropertyTemplates) const

Sets the value of HasPropertyTemplates attribute. This attribute represents reference to a set of property templates. It should only be provided, if the PropertyType is set to kIfcComplexPropertyTemplateTypeEnum_Q_COMPLEX.

Parameters
HasPropertyTemplates[out] Receives the HasPropertyTemplates attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ getTemplateType()

IfcComplexPropertyTemplateTypeEnum OdIfc4::IfcComplexPropertyTemplate::getTemplateType ( ) const

Returns the value of TemplateType attribute. This attribute represents a template type that can be: kIfcComplexPropertyTemplateTypeEnum_P_COMPLEX: occurrences of IfcPropertySet. kIfcComplexPropertyTemplateTypeEnum_Q_COMPLEX: occurrences of IfcElementQuantity. kIfcComplexPropertyTemplateTypeEnum_unset: unset.

Returns
Returns the value of TemplateType attribute.

◆ getUsageName()

const OdAnsiString & OdIfc4::IfcComplexPropertyTemplate::getUsageName ( ) const

Returns the value of UsageName attribute. This attribute represents usage description of the IfcComplexProperty within the property set which references the IfcComplexProperty.

Returns
Returns the value of UsageName attribute.

◆ hasPropertyTemplates()

OdDAI::SetOfOdDAIObjectId & OdIfc4::IfcComplexPropertyTemplate::hasPropertyTemplates ( )

Returns the value of HasPropertyTemplates attribute. This attribute represents reference to a set of property templates. It should only be provided, if the PropertyType is set to kIfcComplexPropertyTemplateTypeEnum_Q_COMPLEX.

Returns
Returns the value of HasPropertyTemplates attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ isKindOf()

virtual bool OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ outFields()

virtual OdResult OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcComplexPropertyTemplate::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 OdIfc4::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ setInverseCounterParts()

virtual void OdIfc4::IfcComplexPropertyTemplate::setInverseCounterParts ( )
overridevirtual

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

◆ setTemplateType()

void OdIfc4::IfcComplexPropertyTemplate::setTemplateType ( IfcComplexPropertyTemplateTypeEnum TemplateType)

Sets the value of TemplateType attribute. This attribute represents a template type that can be: kIfcComplexPropertyTemplateTypeEnum_P_COMPLEX: occurrences of IfcPropertySet. kIfcComplexPropertyTemplateTypeEnum_Q_COMPLEX: occurrences of IfcElementQuantity. kIfcComplexPropertyTemplateTypeEnum_unset: unset.

Parameters
TemplateType[in] Template type to set.

◆ setUsageName()

void OdIfc4::IfcComplexPropertyTemplate::setUsageName ( const OdAnsiString & UsageName)

Sets the value of UsageName attribute. This attribute represents usage description of the IfcComplexProperty within the property set which references the IfcComplexProperty.

Parameters
UsageName[in] Usage name to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcComplexPropertyTemplate::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::IfcPropertyTemplate.

Member Data Documentation

◆ m_HasPropertyTemplates

OdDAI::SetOfOdDAIObjectId OdIfc4::IfcComplexPropertyTemplate::m_HasPropertyTemplates
protected

Definition at line 244 of file Ifc4/IfcComplexPropertyTemplateAutoImpl.h.

◆ m_TemplateType

OdDAI::Enum OdIfc4::IfcComplexPropertyTemplate::m_TemplateType
protected

Definition at line 243 of file Ifc4/IfcComplexPropertyTemplateAutoImpl.h.

◆ m_UsageName

OdAnsiString OdIfc4::IfcComplexPropertyTemplate::m_UsageName
protected

Definition at line 242 of file Ifc4/IfcComplexPropertyTemplateAutoImpl.h.


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