/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCPROPERTYDEFINITION_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCPROPERTYDEFINITION_AUTO_IMPL_H

#include "IfcRootAutoImpl.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
  IfcPropertyDefinition defines the generalization of all characteristics (i.e. a grouping of individual properties), 
  that can be assigned to objects. Currently, subtypes of IfcPropertyDefinition include property set occurrences, 
  property set templates and property templates.
  
    * Property set template - IfcPropertySetTemplate, a collection of property templates that determine the definition of properties used within a project context.
    * Property template - IfcPropertyTemplate, a single template that determines the definition of a particular property used in the same project context. 
      The template can determine the name, description, data type, the unit, or a standard expression for each property that is based on that template.
    * Property set occurrence - IfcPropertySet, a set of individual properties (that may or may not be determined by a property template) holding individual values, 
      measure types and units, and are associated to an object occurrence or object type.
  
  Property definitions define information that is shared among multiple instances of objects, either object occurrences or object types. 
  IfcPropertyDefinition's (by their instantiable subtypes) can participate within the following relationships:
    * Assignment to a project context - an HasContext relationship to IfcRelDeclares that establishes the project context in which this property definition is declared. 
      This relationship is mostly applicable to subtypes of IfcPropertyTemplateDefinition.
    * Association to external resources - an HasAssociation relationship to IfcRelAssociates that refers to external sources of information 
      (most notably a classification or document) and creates a uni-directional association. There is no dependency implied by the association.

  \remarks
  * The subtype hierarchy of IfcPropertyDefinition also includes statically defined property sets as IfcPreDefinedPropertySet. 
    Those are rarely used collections of fixed attributes combined in an entity definition. The IfcPreDefinedPropertySet can not be determined by an IfcPropertySetTemplate.
  * Individual properties, (subtypes of IfcProperty), are currently not included in the subtype hierarchy of IfcPropertyDefinition. 
    This is due to upward compatibility reasons with earlier releases of this standard.
*/
class IFC4X3_EXPORT IfcPropertyDefinition : public IfcRoot
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x3_add2::IfcPropertyDefinition);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of HasContext attribute.
  This attribute is an <em>assignment to a project context</em> 
  relationship that establishes the project context in which this property definition is declared.
  \param HasContext [out] Receives the value of HasContext attribute.
  */
  void getInvHasContext(OdDAIObjectIds& HasContext) const;

  /** \details
  Returns the value of HasAssociations attribute. 
  This attribute represents reference to the relationship IfcRelAssociates and thus to those externally defined concepts, 
  like classifications, documents, or library information, which are associated to the property definition.
  \param HasAssociations [out] Receives the value of HasAssociations attribute.
  */
  void getInvHasAssociations(OdDAIObjectIds& HasAssociations) 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 <exref target="OdDAI__Entity.html">OdDAI::Entity</exref> type that determines an entity definition within a schema.
  */
  virtual OdDAI::Entity* getInstanceType() 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:
  <table>
    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.
  </table>
  */
  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
  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 <exref target="OdIfc__OdIfcEntityType.html">OdIfc::OdIfcEntityType</exref> 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 IfcRelDeclares;
  friend class IfcRelAssociates;
};

/** \details
  A data type that represents a smart pointer to a <exref target="OdIfc4x3_add2__IfcPropertyDefinition.html">IfcPropertyDefinition</exref> object.
*/
typedef OdSmartPtr<IfcPropertyDefinition> IfcPropertyDefinitionPtr;

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCPROPERTYDEFINITION_AUTO_IMPL_H