/////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). // All rights reserved. // // This software and its documentation and related materials are owned by // the Alliance. The software may only be incorporated into application // programs owned by members of the Alliance, subject to a signed // Membership Agreement and Supplemental Software License Agreement with the // Alliance. The structure and organization of this software are the valuable // trade secrets of the Alliance and its suppliers. The software is also // protected by copyright law and international treaty provisions. Application // programs incorporating this software must include the following statement // with their copyright notices: // // This application incorporates Open Design Alliance software pursuant to a license // agreement with Open Design Alliance. // Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. // All rights reserved. // // By use of this software, its documentation or related materials, you // acknowledge and accept the above terms. /////////////////////////////////////////////////////////////////////////////// // This file is generated automatically. #ifndef _IFC4X3_ADD2_IFCSIMPLEPROPERTYTEMPLATE_AUTO_IMPL_H #define _IFC4X3_ADD2_IFCSIMPLEPROPERTYTEMPLATE_AUTO_IMPL_H #include "IfcPropertyTemplateAutoImpl.h" #include "IfcPropertyEnumerationAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X3_ADD2 express schema definitions. */ namespace OdIfc4x3_add2 { /** \details 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 - Details - The IfcSimplePropertyTemplate is part of the set of templates included in the IfcPropertySetTemplate. The template can be accessed through the inverse attribute PartOfPsetTemplate. The IfcPropertySetTemplate can define one or several instances of IfcPropertySet (or IfcElementQuantity). The definition assignment is established by the objectified relationship IfcRelDefinesByTemplate as shown on the image below. There is no direct link between an IfcSimplePropertyTemplate and a subtype of either IfcSimpleProperty or IfcPhysicalSimpleQuantity. The definition relationship between the template and the individual properties (or quantities) is established by the Name attributes. \remarks Constraints at IfcPropertySetTemplate and IfcPropertySet (and IfcElementQuantity) guarantee that the Name attributes of included property templates and individual properties are unique. */ class IFC4X3_EXPORT IfcSimplePropertyTemplate : public IfcPropertyTemplate { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcSimplePropertyTemplate); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details 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. \remarks The value of this property determines the correct use of the PrimaryUnit, SecondaryUnit, PrimaryDataType, SecondaryDataType, and Expression attributes. */ IfcSimplePropertyTemplateTypeEnum getTemplateType() const; /** \details 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. \param TemplateType [in] Template type to set. \remarks The value of this property determines the correct use of the PrimaryUnit, SecondaryUnit, PrimaryDataType, SecondaryDataType, and Expression attributes. */ void setTemplateType(IfcSimplePropertyTemplateTypeEnum TemplateType); /** \details 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. \remarks The value range of the measure type is within the select type IfcValue for all PropertyType's with the exception of kIfcSimplePropertyTemplateTypeEnum_P_REFERENCEVALUE. Here it is within the IfcObjectReferenceSelect type. */ const OdAnsiString& getPrimaryMeasureType() const; /** \details 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. \param PrimaryMeasureType [in] Primary measure type to set. \remarks The value range of the measure type is within the select type IfcValue for all PropertyType's with the exception of kIfcSimplePropertyTemplateTypeEnum_P_REFERENCEVALUE. Here it is within the IfcObjectReferenceSelect type. */ void setPrimaryMeasureType(const OdAnsiString& PrimaryMeasureType); /** \details 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. \remarks The measure type of IfcPropertyEnumeration.EnumerationValues is provided as PrimaryDataType. */ const OdAnsiString& getSecondaryMeasureType() const; /** \details 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. \param SecondaryMeasureType [in] Secondary measure type to set. \remarks The measure type of IfcPropertyEnumeration.EnumerationValues is provided as PrimaryDataType. */ void setSecondaryMeasureType(const OdAnsiString& SecondaryMeasureType); /** \details 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. */ const OdDAIObjectId& getEnumerators() const; /** \details 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. \param Enumerators [in] Enumerators to set. */ void setEnumerators(const OdDAIObjectId& Enumerators); /** \details 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. */ IfcUnit primaryUnit(); /** \details 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. */ IfcUnit secondaryUnit(); /** \details 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. \remarks No value shall be asserted if the PropertyType is not listed above. */ const OdAnsiString& getExpression() const; /** \details 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. \param Expression [in] Expression to set. \remarks No value shall be asserted if the PropertyType is not listed above. */ void setExpression(const OdAnsiString& Expression); /** \details 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. */ IfcStateEnum getAccessState() const; /** \details 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. \param AccessState [in] Access state to set. */ void setAccessState(IfcStateEnum AccessState); public: /** \details Default constructor for the IfcSimplePropertyTemplate class. */ IfcSimplePropertyTemplate(); /** \details Reads object's data from the specified filer. \param 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. */ virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override; /** \details Writes object's data the the specified filer. \param 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. */ virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override; /** \details Returns a type of a class instance. \returns Pointer to the OdDAI::Entity type that determines an entity definition within a schema. */ virtual OdDAI::Entity* getInstanceType() const override; /** \details Returns an attribute value for the specified attribute name. \param attrName [in] Name of an attribute to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const char * attrName) const override; /** \details Early-bound version of instances comparison. \param pOther [in] Other application instance. \param 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: Name 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.
*/ virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override; /** \details Resets a value for the specified attribute. \param explicitAttrName [in] Explicit name of the attribute to reset. */ virtual void unsetAttr(const char * explicitAttrName) override; /** \details Checks whether the specified attribute is set. \param explicitAttrName [in] Explicit name of the attribute to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const char * explicitAttrName) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrName [in] Explicit name of the attribute to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override; /** \details Checks whether the specified instance is the object derived from or belongs to this class. \param entityType [in] Entity to check. \returns true if the specified instance is the object derived from or belongs to this class, false otherwise. */ virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override; /** \details Returns the type of this entity. \returns A value of the OdIfc::OdIfcEntityType type that represents type of this entity. */ virtual OdIfc::OdIfcEntityType type() const override; /** \details Returns an attribute value for the specified attribute definition. \param attrDef [in] Attribute definition to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override; /** \details Resets a value for the specified attribute. \param explicitAttrDef [in] Explicit definition that represents an attribute to reset. */ virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override; /** \details Checks whether the specified attribute is set. \param explicitAttrDef [in] Attribute definition to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrDef [in] Explicit attribute definition to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override; protected: // Fields declaration: OdDAI::Enum m_TemplateType; // IfcSimplePropertyTemplateTypeEnum [optional] OdAnsiString m_PrimaryMeasureType; // IfcLabel [optional] OdAnsiString m_SecondaryMeasureType; // IfcLabel [optional] OdDAIObjectId m_Enumerators; // IfcPropertyEnumeration [optional] OdDAI::Select m_PrimaryUnit; // IfcUnit [optional] OdDAI::Select m_SecondaryUnit; // IfcUnit [optional] OdAnsiString m_Expression; // IfcLabel [optional] OdDAI::Enum m_AccessState; // IfcStateEnum [optional] }; /** \details A data type that represents a smart pointer to a IfcSimplePropertyTemplate object. */ typedef OdSmartPtr IfcSimplePropertyTemplatePtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X3_ADD2_IFCSIMPLEPROPERTYTEMPLATE_AUTO_IMPL_H