/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCEXTERNALREFERENCE_AUTO_IMPL_H
#define _IFC4_IFCEXTERNALREFERENCE_AUTO_IMPL_H

#include "Ifc4BaseClass.h"

#include "Ifc4Enum.h"
#include "Ifc4SelectTypes.h"
#include "Ifc4CollectionTypes.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
  An IfcExternalReference is the identification of information that is not explicitly represented 
  in the current model or in the project database (as an implementation of the current model). 
  Such information can be contained in classifications, documents or libraries. 
  The IfcExternalReference identifies a particular item, such as a dictionary entry, 
  a classification notation, or a document reference within the external source.
  
  Only the Location (as a URL) is provided to describe the place where the information can be found. 
  Also an optional Identification as a key to allow more specific references (as to sections or tables) is provided. 
  The Identification defines a system interpretable method to identify the relevant part of information at the source. 
  In addition a human interpretable Name can be assigned to identify the information subject, such as a classification code.

  \remarks
  This definition may not be instantiated.

  \changes
  
  * IFC4 changes: 
    * Attribute ItemReference renamed to Identification
    * Type of the Location attribute changed from "IfcLabel" to "IfcURIReference"
*/
class IFC4_EXPORT IfcExternalReference : public OdIfc4Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4::IfcExternalReference);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Location attribute.
  This attribute represents location, where the external source (classification, document or library) can be accessed by electronic means. 
  The electronic location is provided as an URI, and would normally be provided as an URL location string.
  \returns
  Returns the value of Location attribute.
  */
  const OdAnsiString& getLocation() const;

  /** \details
  Sets the value of Location attribute. 
  This attribute represents location, where the external source (classification, document or library) can be accessed by electronic means. 
  The electronic location is provided as an URI, and would normally be provided as an URL location string.
  \param Location [in] Location to set.
  */
  void setLocation(const OdAnsiString& Location);

  /** \details
  Returns the value of Identification attribute. 
  This attribute represents a unique identifier 
  of the referenced item within the external source (classification, document or library).
  \returns
  Returns the value of Identification attribute.
  */
  const OdAnsiString& getIdentification() const;

  /** \details
  Sets the value of Identification attribute. 
  This attribute represents a unique identifier 
  of the referenced item within the external source (classification, document or library).
  \param Identification [in] Identification to set.
  */
  void setIdentification(const OdAnsiString& Identification);

  /** \details
  Returns the value of Name attribute. 
  This attribute represents optional name to further specify the reference. 
  It can provide a human-readable identifier (which does not necessarily need to have a counterpart in the internal structure of the document).
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute. 
  This attribute represents optional name to further specify the reference. 
  It can provide a human-readable identifier (which does not necessarily need to have a counterpart in the internal structure of the document).
  \param Name [in] Name to set.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the value of ExternalReferenceForResources attribute. 
  This attribute represents reference to all associations between this external reference 
  and objects within the IfcResourceObjectSelect that are tagged by the external reference.
  \param ExternalReferenceForResources [out] Receives the value of ExternalReferenceForResources attribute.
  */
  void getInvExternalReferenceForResources(OdDAIObjectIds& ExternalReferenceForResources) const;


public:

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

  /** \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
  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_Location;   // IfcURIReference  [optional]
  OdAnsiString m_Identification;   // IfcIdentifier  [optional]
  OdAnsiString m_Name;   // IfcLabel  [optional]

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCEXTERNALREFERENCE_AUTO_IMPL_H