#include <IfcPropertySetTemplateAutoImpl.h>

Inheritance diagram for OdIfc4::IfcPropertySetTemplate:

Public Member Functions
IfcPropertySetTemplateTypeEnum	getTemplateType () const

void	setTemplateType (IfcPropertySetTemplateTypeEnum TemplateType)

const OdAnsiString &	getApplicableEntity () const

void	setApplicableEntity (const OdAnsiString &ApplicableEntity)

void	getHasPropertyTemplates (OdDAIObjectIds &HasPropertyTemplates) const

OdDAI::SetOfOdDAIObjectId &	hasPropertyTemplates ()

void	getInvDefines (OdDAIObjectIds &Defines) const

	IfcPropertySetTemplate ()

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::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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdDAI::Enum	m_TemplateType

OdAnsiString	m_ApplicableEntity

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
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcRelDefinesByTemplate

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

IfcPropertySetTemplate defines the template for all dynamically extensible property sets represented by IfcPropertySet. The property set template is a container of property templates within a property tree. The individual property templates are interpreted according to their Name attribute and will have no values assigned. Property set templates can form part of a property library used and declared within a project. Depending on the TemplateType the IfcPropertySetTemplate defines a template for: "Pset_" - occurrences of IfcPropertySet "QTO_" - occurrences of IfcElementQuantity

Remarks: By convention an IfcPropertySetTemplate can also be used as a template for an IfcElementQuantity, being a particular type of a property set definition.

Definition at line 50 of file Ifc4/IfcPropertySetTemplateAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPropertySetTemplate()

OdIfc4::IfcPropertySetTemplate::IfcPropertySetTemplate ( )

Default constructor for the IfcPropertySetTemplate class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcPropertySetTemplate::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::IfcPropertyTemplateDefinition.

◆ getApplicableEntity()

const OdAnsiString & OdIfc4::IfcPropertySetTemplate::getApplicableEntity ( ) const

Returns the value of ApplicableEntity attribute. ApplicableEntity is the attribute that optionally defines the data type of the applicable type or occurrence object, to which the assigned property set template can relate. If not present, no instruction is given to which type or occurrence object the property set template is applicable. The following conventions are used: The IFC entity name of the applicable entity using the IFC naming convention, CamelCase with IFC prefix It can be optionally followed by the predefined type after the separator "/" (forward slash), using upper case If a performance history object of a particular distribution object is attributes by the property set template, then the entity name (and potentially amended by the predefined type) is expanded by adding '[PerformanceHistory]' If one property set template is applicable to many type and/or occurrence objects, then those object names should be separated by comma "," forming a comma separated string.

EXAMPLE - Referring to a boiler type as applicable entity would be expressed as 'IfcBoilerType'. Referring to a steam boiler type as applicable entity would be expressed as 'IfcBoilerType/STEAM'. Referring to a wall and wall standard case and a wall type would be expressed as 'IfcWall, IfcWallStandardCase, IfcWallType'. An applicable IfcPerformanceHistory assigned to an occurrence or type object would be indicated by IfcBoilerType[PerformanceHistory] or IfcBoilerType/STEAM[PerformanceHistory] respectively.
Returns
Returns the value of ApplicableEntity attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ getHasPropertyTemplates()

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

Returns the value of HasPropertyTemplates attribute. HasPropertyTemplates is a set of IfcPropertyTemplate instances that are defined within the scope of the IfcPropertySetTemplate.

Returns: Returns an array of object identifiers representing the HasPropertyTemplates attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcPropertySetTemplate::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::IfcPropertyTemplateDefinition.

◆ getInvDefines()

void OdIfc4::IfcPropertySetTemplate::getInvDefines ( OdDAIObjectIds & Defines ) const

Returns the value of Defines attribute. This attribute is a relation to the property sets, via the objectified relationship IfcRelDefinesByTemplate, that, if given, utilizes the definition template.

Parameters

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

◆ getTemplateType()

IfcPropertySetTemplateTypeEnum OdIfc4::IfcPropertySetTemplate::getTemplateType ( ) const

Returns the value of TemplateType attribute. TemplateType is property set type defining whether the property set is applicable to a type (subtypes of IfcTypeObject), to an occurrence (subtypes of IfcObject), or as a special case to a performance history. The attribute ApplicableEntity can further refine the applicability to a single or multiple entity type(s).

Returns: Returns the value of TemplateType attribute.

◆ hasPropertyTemplates()

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

Returns the value of HasPropertyTemplates attribute. HasPropertyTemplates is a set of IfcPropertyTemplate's instances that are defined within the scope of the IfcPropertySetTemplate.

Parameters

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

◆ inFields()

virtual OdResult OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ isKindOf()

virtual bool OdIfc4::IfcPropertySetTemplate::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::IfcPropertyTemplateDefinition.

◆ outFields()

virtual OdResult OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ setApplicableEntity()

void OdIfc4::IfcPropertySetTemplate::setApplicableEntity ( const OdAnsiString & ApplicableEntity )

Sets the value of ApplicableEntity attribute. ApplicableEntity is the attribute that optionally defines the data type of the applicable type or occurrence object, to which the assigned property set template can relate. If not present, no instruction is given to which type or occurrence object the property set template is applicable. The following conventions are used: The IFC entity name of the applicable entity using the IFC naming convention, CamelCase with IFC prefix It can be optionally followed by the predefined type after the separator "/" (forward slash), using upper case If a performance history object of a particular distribution object is attributes by the property set template, then the entity name (and potentially amended by the predefined type) is expanded by adding '[PerformanceHistory]' If one property set template is applicable to many type and/or occurrence objects, then those object names should be separated by comma "," forming a comma separated string.

EXAMPLE - Referring to a boiler type as applicable entity would be expressed as 'IfcBoilerType'. Referring to a steam boiler type as applicable entity would be expressed as 'IfcBoilerType/STEAM'. Referring to a wall and wall standard case and a wall type would be expressed as 'IfcWall, IfcWallStandardCase, IfcWallType'. An applicable IfcPerformanceHistory assigned to an occurrence or type object would be indicated by IfcBoilerType[PerformanceHistory] or IfcBoilerType/STEAM[PerformanceHistory] respectively.
Parameters

ApplicableEntity [in] Applicable entity to set.

◆ setInverseCounterParts()

virtual void OdIfc4::IfcPropertySetTemplate::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::IfcPropertySetTemplate::setTemplateType ( IfcPropertySetTemplateTypeEnum TemplateType )

Sets the value of TemplateType attribute. TemplateType is property set type defining whether the property set is applicable to a type (subtypes of IfcTypeObject), to an occurrence (subtypes of IfcObject), or as a special case to a performance history. The attribute ApplicableEntity can further refine the applicability to a single or multiple entity type(s).

Parameters

TemplateType [in] Template type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcPropertySetTemplate::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::IfcPropertyTemplateDefinition.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcPropertySetTemplate::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::IfcPropertyDefinition.

Friends And Related Symbol Documentation

◆ IfcRelDefinesByTemplate

friend class IfcRelDefinesByTemplate

friend

Definition at line 291 of file Ifc4/IfcPropertySetTemplateAutoImpl.h.

Member Data Documentation

◆ m_ApplicableEntity

OdAnsiString OdIfc4::IfcPropertySetTemplate::m_ApplicableEntity

protected

Definition at line 287 of file Ifc4/IfcPropertySetTemplateAutoImpl.h.

◆ m_HasPropertyTemplates

OdDAI::SetOfOdDAIObjectId OdIfc4::IfcPropertySetTemplate::m_HasPropertyTemplates

protected

Definition at line 288 of file Ifc4/IfcPropertySetTemplateAutoImpl.h.

◆ m_TemplateType

OdDAI::Enum OdIfc4::IfcPropertySetTemplate::m_TemplateType

protected

Definition at line 286 of file Ifc4/IfcPropertySetTemplateAutoImpl.h.

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

Ifc4/IfcPropertySetTemplateAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcPropertySetTemplate()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getApplicableEntity()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getHasPropertyTemplates()

◆ getInstanceType()

◆ getInvDefines()

◆ getTemplateType()

◆ hasPropertyTemplates()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setApplicableEntity()

◆ setInverseCounterParts()

◆ setTemplateType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcRelDefinesByTemplate

Member Data Documentation

◆ m_ApplicableEntity

◆ m_HasPropertyTemplates

◆ m_TemplateType