#include <IfcSimplePropertyTemplateAutoImpl.h>
The IfcSimplePropertyTemplate defines the template for all dynamically extensible properties, either the subtypes of IfcSimpleProperty or the subtypes of IfcPhysicalSimpleQuantity. The individual property templates are interpreted according to their Name attribute and can have a predefined template type, property units, and property measure types. The correct interpretation of the attributes: PrimaryUnit SecondaryUnit PrimaryMeasureType SecondaryMeasureType
<IMAGE ifcsimplepropertytemplate_fig-1>
Definition at line 63 of file Ifc4x2/IfcSimplePropertyTemplateAutoImpl.h.
◆ IfcSimplePropertyTemplate()
| OdIfc4x2::IfcSimplePropertyTemplate::IfcSimplePropertyTemplate |
( |
| ) |
|
◆ getAccessState()
| IfcStateEnum OdIfc4x2::IfcSimplePropertyTemplate::getAccessState |
( |
| ) |
const |
Returns the value of AccessState attribute. This attribute represents information about the access state of the property. It determines whether a property be viewed and/or modified by any receiving application without specific knowledge of it. Attribute use definition for IfcStateEnum: READWRITE: Properties of this template are readable and writable. They can be viewed and modified by users of any application. These are typical informational properties set by a user. READONLY: Properties of this template are read-only. They can be viewed but not modified by users of any application. (Applications can generate such values). These are typical automatically generated properties that should be displayed only, but not written back. LOCKED: Properties of this template are locked. They can only be accessed by the owning application (the publisher of the property set template). These are typically application depended, internal properties that should not be published. READWRITELOCKED: Properties of this template are locked, readable, and writable. They can only be accessed by the owning application. READONLYLOCKED: Properties of this template are locked and read-only. They can only be accessed by the owning application.
- Returns
- Returns the value of AccessState attribute.
◆ getAttr() [1/2]
| virtual OdRxValue OdIfc4x2::IfcSimplePropertyTemplate::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 OdIfc4x2::IfcPropertyTemplate.
◆ getAttr() [2/2]
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 OdIfc4x2::IfcPropertyTemplate.
◆ getEnumerators()
| const OdDAIObjectId & OdIfc4x2::IfcSimplePropertyTemplate::getEnumerators |
( |
| ) |
const |
Returns the value of Enumerators attribute. This attribute represents name of the property enumeration, and list of all valid enumerators being selectable values, assigned to the definition of the property.This attribute shall only be provided, if the PropertyType is set to: kIfcSimplePropertyTemplateTypeEnum_P_ENUMERATEDVALUE.
- Returns
- Returns the value of Enumerators attribute.
◆ getExpression()
| const OdAnsiString & OdIfc4x2::IfcSimplePropertyTemplate::getExpression |
( |
| ) |
const |
Returns the value of Expression attribute. This attribute represents the expression used to store additional information for the property template depending on the PropertyType. It should the following definitions, if the PropertyType is set to: kIfcSimplePropertyTemplateTypeEnum_P_TABLEVALUE: the expression that could be evaluated to define the correlation between the defining values and the defined values. kIfcSimplePropertyTemplateTypeEnum_Q_LENGTH, kIfcSimplePropertyTemplateTypeEnum_Q_AREA, kIfcSimplePropertyTemplateTypeEnum_Q_VOLUME, kIfcSimplePropertyTemplateTypeEnum_Q_COUNT, kIfcSimplePropertyTemplateTypeEnum_Q_WEIGHT, kIfcSimplePropertyTemplateTypeEnum_Q_TIME: the formula to be used to calculate the quantity.
- Returns
- Returns the value of Expression attribute.
◆ getInstanceType()
| virtual OdDAI::Entity * OdIfc4x2::IfcSimplePropertyTemplate::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 OdIfc4x2::IfcPropertyTemplate.
◆ getPrimaryMeasureType()
| const OdAnsiString & OdIfc4x2::IfcSimplePropertyTemplate::getPrimaryMeasureType |
( |
| ) |
const |
Returns the value of PrimaryMeasureType attribute. This attribute represents primary measure type assigned to the definition of the property. It should be provided, if the PropertyType is set to: kIfcSimplePropertyTemplateTypeEnum_P_SINGLEVALUE: determining the measure type of IfcPropertySingleValue.NominalValue. kIfcSimplePropertyTemplateTypeEnum_P_ENUMERATEDVALUE: determining the measure type of IfcPropertyEnumeratedValue.EnumerationValues. kIfcSimplePropertyTemplateTypeEnum_P_BOUNDEDVALUE: determining the measure type of IfcPropertyBoundedValue.LowerBoundValue. kIfcSimplePropertyTemplateTypeEnum_P_LISTVALUE: determining the measure type of IfcPropertyListValue.ListValues. kIfcSimplePropertyTemplateTypeEnum_P_TABLEVALUE: determining the measure type of IfcPropertyTableValue.DefiningValues. kIfcSimplePropertyTemplateTypeEnum_P_REFERENCEVALUE: determining the measure type of IfcPropertyTableValue.PropertyReference.
- Returns
- Returns the value of PrimaryMeasureType attribute.
◆ getSecondaryMeasureType()
| const OdAnsiString & OdIfc4x2::IfcSimplePropertyTemplate::getSecondaryMeasureType |
( |
| ) |
const |
Returns the value of SecondaryMeasureType attribute. This attribute represents secondary measure type assigned to the definition of the property. It should be provided, if the PropertyType is set to: kIfcSimplePropertyTemplateTypeEnum_P_BOUNDEDVALUE: determining the measure type of IfcPropertyBoundedValue.UpperBoundValue. kIfcSimplePropertyTemplateTypeEnum_P_TABLEVALUE: determining the measure type of IfcPropertyTableValue.DefinedValues.
The value range of the measure type is within the select type IfcValue for all PropertyType's with the exception of kIfcSimplePropertyTemplateTypeEnum_P_ENUMERATEDVALUE.
- Returns
- Returns the value of SecondaryMeasureType attribute.
◆ getTemplateType()
Returns the value of TemplateType attribute. This attribute represents property type defining whether the property template defines a property with a single value, a bounded value, a list value, a table value, an enumerated value, or a reference value. Or the quantity type defining whether the template defines a quantity with a length, area, volume, weight or time value.
- Returns
- Returns the value of TemplateType attribute.
◆ inFields()
| virtual OdResult OdIfc4x2::IfcSimplePropertyTemplate::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 OdIfc4x2::IfcPropertyTemplate.
◆ isKindOf()
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 OdIfc4x2::IfcPropertyTemplate.
◆ outFields()
| virtual OdResult OdIfc4x2::IfcSimplePropertyTemplate::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 OdIfc4x2::IfcPropertyTemplate.
◆ primaryUnit()
| IfcUnit OdIfc4x2::IfcSimplePropertyTemplate::primaryUnit |
( |
| ) |
|
Returns the value of PrimaryUnit attribute. This attribute represents primary unit assigned to the definition of the property. It should be provided, if the PropertyType is set to: P_SINGLEVALUE: determining the IfcPropertySingleValue.Unit. P_ENUMERATEDVALUE: determining the IfcPropertyEnumeration.Unit. P_BOUNDEDVALUE: determining the IfcPropertyBoundedValue.Unit. P_LISTVALUE: determining the IfcPropertyListValue.Unit. P_TABLEVALUE: determining the IfcPropertyTableValue.DefiningUnit.
- Returns
- Returns the value of PrimaryUnit attribute.
◆ putAttr() [1/2]
| virtual bool OdIfc4x2::IfcSimplePropertyTemplate::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 OdIfc4x2::IfcPropertyTemplate.
◆ putAttr() [2/2]
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 OdIfc4x2::IfcPropertyTemplate.
◆ secondaryUnit()
| IfcUnit OdIfc4x2::IfcSimplePropertyTemplate::secondaryUnit |
( |
| ) |
|
Returns the value of SecondaryUnit attribute. This attribute represents secondary unit assigned to the definition of the property. It should be provided, if the PropertyType is set to: P_TABLEVALUE: determining the IfcPropertyTableValue.DefinedUnit.
- Returns
- Returns the value of SecondaryUnit attribute.
◆ setAccessState()
| void OdIfc4x2::IfcSimplePropertyTemplate::setAccessState |
( |
IfcStateEnum | AccessState | ) |
|
Sets the value of AccessState attribute. This attribute represents information about the access state of the property. It determines whether a property be viewed and/or modified by any receiving application without specific knowledge of it. Attribute use definition for IfcStateEnum READWRITE: Properties of this template are readable and writable. They can be viewed and modified by users of any application. These are typical informational properties set by a user. READONLY: Properties of this template are read-only. They can be viewed but not modified by users of any application. (Applications can generate such values). These are typical automatically generated properties that should be displayed only, but not written back. LOCKED: Properties of this template are locked. They can only be accessed by the owning application (the publisher of the property set template). These are typically application depended, internal properties that should not be published. READWRITELOCKED: Properties of this template are locked, readable, and writable. They can only be accessed by the owning application. READONLYLOCKED: Properties of this template are locked and read-only. They can only be accessed by the owning application.
- Parameters
-
| AccessState | [in] Access state to set. |
◆ setEnumerators()
| void OdIfc4x2::IfcSimplePropertyTemplate::setEnumerators |
( |
const OdDAIObjectId & | Enumerators | ) |
|
Sets the value of Enumerators attribute. This attribute represents name of the property enumeration, and list of all valid enumerators being selectable values, assigned to the definition of the property.This attribute shall only be provided, if the PropertyType is set to: kIfcSimplePropertyTemplateTypeEnum_P_ENUMERATEDVALUE.
- Parameters
-
| Enumerators | [in] Enumerators to set. |
◆ setExpression()
| void OdIfc4x2::IfcSimplePropertyTemplate::setExpression |
( |
const OdAnsiString & | Expression | ) |
|
Sets the value of Expression attribute. This attribute represents the expression used to store additional information for the property template depending on the PropertyType. It should the following definitions, if the PropertyType is set to: kIfcSimplePropertyTemplateTypeEnum_P_TABLEVALUE: the expression that could be evaluated to define the correlation between the defining values and the defined values. kIfcSimplePropertyTemplateTypeEnum_Q_LENGTH, kIfcSimplePropertyTemplateTypeEnum_Q_AREA, kIfcSimplePropertyTemplateTypeEnum_Q_VOLUME, kIfcSimplePropertyTemplateTypeEnum_Q_COUNT, kIfcSimplePropertyTemplateTypeEnum_Q_WEIGHT, kIfcSimplePropertyTemplateTypeEnum_Q_TIME: the formula to be used to calculate the quantity.
- Parameters
-
| Expression | [in] Expression to set. |
◆ setPrimaryMeasureType()
| void OdIfc4x2::IfcSimplePropertyTemplate::setPrimaryMeasureType |
( |
const OdAnsiString & | PrimaryMeasureType | ) |
|
Sets the value of PrimaryMeasureType attribute. This attribute represents primary measure type assigned to the definition of the property. It should be provided, if the PropertyType is set to: kIfcSimplePropertyTemplateTypeEnum_P_SINGLEVALUE: determining the measure type of IfcPropertySingleValue.NominalValue. kIfcSimplePropertyTemplateTypeEnum_P_ENUMERATEDVALUE: determining the measure type of IfcPropertyEnumeratedValue.EnumerationValues. kIfcSimplePropertyTemplateTypeEnum_P_BOUNDEDVALUE: determining the measure type of IfcPropertyBoundedValue.LowerBoundValue. kIfcSimplePropertyTemplateTypeEnum_P_LISTVALUE: determining the measure type of IfcPropertyListValue.ListValues. kIfcSimplePropertyTemplateTypeEnum_P_TABLEVALUE: determining the measure type of IfcPropertyTableValue.DefiningValues. kIfcSimplePropertyTemplateTypeEnum_P_REFERENCEVALUE: determining the measure type of IfcPropertyTableValue.PropertyReference.
- Parameters
-
| PrimaryMeasureType | [in] Primary measure type to set. |
◆ setSecondaryMeasureType()
| void OdIfc4x2::IfcSimplePropertyTemplate::setSecondaryMeasureType |
( |
const OdAnsiString & | SecondaryMeasureType | ) |
|
Sets the value of SecondaryMeasureType attribute. This attribute represents secondary measure type assigned to the definition of the property. It should be provided, if the PropertyType is set to: kIfcSimplePropertyTemplateTypeEnum_P_BOUNDEDVALUE: determining the measure type of IfcPropertyBoundedValue.UpperBoundValue. kIfcSimplePropertyTemplateTypeEnum_P_TABLEVALUE: determining the measure type of IfcPropertyTableValue.DefinedValues.
The value range of the measure type is within the select type IfcValue for all PropertyType's with the exception of kIfcSimplePropertyTemplateTypeEnum_P_ENUMERATEDVALUE.
- Parameters
-
| SecondaryMeasureType | [in] Secondary measure type to set. |
◆ setTemplateType()
Sets the value of TemplateType attribute. This attribute represents property type defining whether the property template defines a property with a single value, a bounded value, a list value, a table value, an enumerated value, or a reference value. Or the quantity type defining whether the template defines a quantity with a length, area, volume, weight or time value.
- Parameters
-
| TemplateType | [in] Template type to set. |
◆ testAttr() [1/2]
| virtual bool OdIfc4x2::IfcSimplePropertyTemplate::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 OdIfc4x2::IfcPropertyTemplate.
◆ testAttr() [2/2]
| virtual bool OdIfc4x2::IfcSimplePropertyTemplate::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 OdIfc4x2::IfcPropertyTemplate.
◆ type()
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 OdIfc4x2::IfcPropertyTemplate.
◆ unsetAttr() [1/2]
| virtual void OdIfc4x2::IfcSimplePropertyTemplate::unsetAttr |
( |
const char * | explicitAttrName | ) |
|
|
overridevirtual |
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrName | [in] Explicit name of the attribute to reset. |
Reimplemented from OdIfc4x2::IfcPropertyTemplate.
◆ unsetAttr() [2/2]
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrDef | [in] Explicit definition that represents an attribute to reset. |
Reimplemented from OdIfc4x2::IfcPropertyTemplate.
◆ m_AccessState
| OdDAI::Enum OdIfc4x2::IfcSimplePropertyTemplate::m_AccessState |
|
protected |
◆ m_Enumerators
| OdDAIObjectId OdIfc4x2::IfcSimplePropertyTemplate::m_Enumerators |
|
protected |
◆ m_Expression
| OdAnsiString OdIfc4x2::IfcSimplePropertyTemplate::m_Expression |
|
protected |
◆ m_PrimaryMeasureType
| OdAnsiString OdIfc4x2::IfcSimplePropertyTemplate::m_PrimaryMeasureType |
|
protected |
◆ m_PrimaryUnit
| OdDAI::Select OdIfc4x2::IfcSimplePropertyTemplate::m_PrimaryUnit |
|
protected |
◆ m_SecondaryMeasureType
| OdAnsiString OdIfc4x2::IfcSimplePropertyTemplate::m_SecondaryMeasureType |
|
protected |
◆ m_SecondaryUnit
| OdDAI::Select OdIfc4x2::IfcSimplePropertyTemplate::m_SecondaryUnit |
|
protected |
◆ m_TemplateType
| OdDAI::Enum OdIfc4x2::IfcSimplePropertyTemplate::m_TemplateType |
|
protected |
The documentation for this class was generated from the following file: