///////////////////////////////////////////////////////////////////////////////
// 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 _IFC4X2_IFCPROPERTYTEMPLATE_AUTO_IMPL_H
#define _IFC4X2_IFCPROPERTYTEMPLATE_AUTO_IMPL_H
#include "IfcPropertyTemplateDefinitionAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X2 express schema definitions.
*/
namespace OdIfc4x2 {
/** \details
The IfcPropertyTemplate is an abstract supertype comprising the templates for all dynamically extensible properties,
either as an IfcComplexPropertyTemplate, or an IfcSimplePropertyTemplate. These templates determine the structure of:
* in case of IfcComplexPropertyTemplate:
* an IfcComplexProperty
* an IfcPhysicalComplexQuantity
* in case of IfcSimplePropertyTemplate
* a subtype of IfcSimpleProperty
* a subtype of IfcPhysicalSimpleQuantity
The individual property templates are interpreted according to their Name attribute
and can have a predefined property type, property unit, and property data type.
A template however does not have measure values, or quantity values assigned.
\remarks
This definition may not be instantiated.
*/
class IFC4X2_EXPORT IfcPropertyTemplate : public IfcPropertyTemplateDefinition
{
//DOM-IGNORE-BEGIN
OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x2::IfcPropertyTemplate);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of PartOfComplexTemplate attribute.
This attribute represents reference to a complex property templates.
It should only be provided, if the PropertyType of the referenced complex property template is set to COMPLEX.
\param PartOfComplexTemplate [out] Receives the value of PartOfComplexTemplate attribute.
*/
void getInvPartOfComplexTemplate(OdDAIObjectIds& PartOfComplexTemplate) const;
/** \details
Returns the value of PartOfPsetTemplate attribute.
This attribute represents reference to the IfcPropertySetTemplate that defines the scope for the IfcPropertyTemplate.
A single IfcPropertyTemplate can be defined within the scope of zero, one or many IfcPropertySetTemplate'.
\param PartOfPsetTemplate [out] Receives the value of PartOfPsetTemplate attribute.
*/
void getInvPartOfPsetTemplate(OdDAIObjectIds& PartOfPsetTemplate) const;
public:
/** \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
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
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:
using IfcRoot::getAttr;
using IfcRoot::putAttr;
protected:
// Declare friend classes for inverse attributes functionality:
friend class IfcComplexPropertyTemplate;
friend class IfcPropertySetTemplate;
};
/** \details
A data type that represents a smart pointer to a IfcPropertyTemplate object.
*/
typedef OdSmartPtr IfcPropertyTemplatePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X2_IFCPROPERTYTEMPLATE_AUTO_IMPL_H