/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCLIBRARYREFERENCE_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCLIBRARYREFERENCE_AUTO_IMPL_H

#include "IfcExternalReferenceAutoImpl.h"
#include "IfcLibraryInformationAutoImpl.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
  An IfcLibraryReference is a reference into a library of information by Location (provided as a URI). 
  It also provides an optional inherited Identification key to allow more specific references to library sections or tables. 
  The inherited Name attribute provides a human interpretable identification of the library item. 
  Also, general information on the library from which the reference is taken, 
  is provided by the ReferencedLibrary relation which identifies the relevant occurrence of IfcLibraryInformation.
  
  Depending on the type of technology used by the library, different IfcLibraryReference.Identification identifiers are appropriate:
  
  <table>
  <b>Publisher</b>         <b>Technology</b>       <b>Identifier</b>
  ASHRAE                   BACnet                  32-bit decimal BACnetObjectIdentifier indicating type ID and instance ID (e.g.'12.15' for Digital Input #15)
  Brick Development Team   Brick                   Full URI with no abbreviation (e.g. 'http://example.org/digitaltwin#AHU01', not 'digitaltwin:AHU01')
  IETF                     IPv4                    32-bit decimal address for an IPv4 network (e.g.'192.168.1.1')
  IETF                     IPv6                    128-bit hexadecimal address for an IPv6 network
  IETF                     MAC                     48-bit hexadecimal form of MAC address
  ISOIEC                   LonTalk                 48-bit hexadecimal neuron ID
  OPCFoundation            OPC                     Hierarchical ItemID in alphanumeric form (i.e. 'B204.Tank2.Temperature)
  SmartLabs                Insteon                 24-bit hexadecimal instance address
  </table>

  \changes
  
  * IFC4 changes: 
    * Inverse attribute ReferenceIntoLibrary renamed to LibraryRefForObjects
    * Type of the inverse attribute ReferenceIntoLibrary changed from "SET OF [0:1] IfcLibraryInformation FOR LibraryReference" to "SET OF [0:?] IfcRelAssociatesLibrary FOR RelatingLibrary"
*/
class IFC4X3_EXPORT IfcLibraryReference : public IfcExternalReference
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcLibraryReference);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


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

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

  /** \details
  Returns the value of Language attribute. 
  This attribute represents the language in which a library reference is expressed.
  \returns
  Returns the value of Language attribute.
  */
  const OdAnsiString& getLanguage() const;

  /** \details
  Sets the value of Language attribute. 
  This attribute represents the language in which a library reference is expressed.
  \param Language [in] Language to set.
  */
  void setLanguage(const OdAnsiString& Language);

  /** \details
  Returns the value of ReferencedLibrary attribute. 
  This attribute represents the library information that is referenced.
  \returns
  Returns the value of ReferencedLibrary attribute.
  */
  const OdDAIObjectId& getReferencedLibrary() const;

  /** \details
  Sets the value of ReferencedLibrary attribute. 
  This attribute represents the library information that is referenced.
  \param ReferencedLibrary [in] Referenced library to set.
  */
  void setReferencedLibrary(const OdDAIObjectId& ReferencedLibrary);

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


public:

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

  /** \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: 
  OdAnsiString m_Description;   // IfcText  [optional]
  IfcLanguageId m_Language;   // IfcLanguageId  [optional]
  OdDAIObjectId m_ReferencedLibrary;   // IfcLibraryInformation  [optional]

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCLIBRARYREFERENCE_AUTO_IMPL_H