/////////////////////////////////////////////////////////////////////////////// 
// 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 _IFC4_IFCCLASSIFICATIONREFERENCE_AUTO_IMPL_H
#define _IFC4_IFCCLASSIFICATIONREFERENCE_AUTO_IMPL_H

#include "IfcExternalReferenceAutoImpl.h"

#include "TD_PackPush.h"

/** \details
  The namespace contains schema-dependent classes, definitions and sub routines
  for work with IFC4 express schema definitions.
*/
namespace OdIfc4 {

/** \details
  IfcClassificationReference is a reference into a classification system or source 
  (see IfcClassification) for a specific classification key (or notation).
  The inherited attributes:
  * Identification: holds the key provided for a specific references to classification items (or tables).
  * Name: provides a human-interpretable designation of a classification notation.
  * Location: optionally holds a direct URI link into the classification system (or source) to hyperlink the classification key.
  
  The IfcClassificationReference can either be assigned directly to the IfcClassification, 
  such as if no classification hierarchy has to be included, or it references the parent classification notation, 
  if the full classification hierarchy is included in the data set.
  The first is referred to as "lightweight classification", and the second as "full classification".

  \changes
  
  * IFC4 changes: 
    Type of the ReferencedSource attribute changed from "IfcClassification" to "IfcClassificationReferenceSelect"
*/
class IFC4_EXPORT IfcClassificationReference : public IfcExternalReference
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcClassificationReference);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ReferencedSource attribute. 
  This attribute represents the classification system or source that is referenced.
  \returns
  Returns the value of ReferencedSource attribute.
  */
  IfcClassificationReferenceSelect referencedSource();

  /** \details
  Returns the value of Description attribute. 
  This attribute represents description of the classification reference for informational purposes.
  \returns
  Returns the value of Description attribute.
  */
  const OdAnsiString& getDescription() const;

  /** \details
  Sets the value of Description attribute. 
  This attribute represents description of the classification reference for informational purposes.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of Sort attribute. 
  This attribute represents optional identifier to sort the set of classification references 
  within the referenced source (either a classification facet of higher level, or the classification system itself).
  \returns
  Returns the value of Sort attribute.
  */
  const OdAnsiString& getSort() const;

  /** \details
  Sets the value of Sort attribute. 
  This attribute represents optional identifier to sort the set of classification references 
  within the referenced source (either a classification facet of higher level, or the classification system itself).
  \param Sort [in] Sort to set.
  */
  void setSort(const OdAnsiString& Sort);

  /** \details
  Returns the value of ClassificationRefForObjects attribute. 
  This attribute represents the classification reference with which objects are associated.
  \param ClassificationRefForObjects [out] Receives the value of ClassificationRefForObjects attribute.
  */
  void getInvClassificationRefForObjects(OdDAIObjectIds& ClassificationRefForObjects) const;

  /** \details
  Returns the value of HasReferences attribute. 
  This attribute represents the parent classification references to which this child classification reference applies. 
  It can either be the final classification item leaf node, or an intermediate classification item.
  \param HasReferences [out] Receives the value of HasReferences attribute.
  */
  void getInvHasReferences(OdDAIObjectIds& HasReferences) const;


public:

  /** \details
  Default constructor for the IfcClassificationReference class.
  */
  IfcClassificationReference();

  /** \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
  Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.
  */
  virtual void setInverseCounterParts() 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
  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:
  <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
  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 <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:
  // Fields declaration: 
  OdDAI::Select m_ReferencedSource;   // IfcClassificationReferenceSelect  [optional]
  OdAnsiString m_Description;   // IfcText  [optional]
  OdAnsiString m_Sort;   // IfcIdentifier  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRelAssociatesClassification;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCCLASSIFICATIONREFERENCE_AUTO_IMPL_H