/////////////////////////////////////////////////////////////////////////////// 
// 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_RC1_IFCDOCUMENTREFERENCE_AUTO_IMPL_H
#define _IFC4X3_RC1_IFCDOCUMENTREFERENCE_AUTO_IMPL_H

#include "IfcExternalReferenceAutoImpl.h"
#include "IfcDocumentInformationAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  An IfcDocumentReference is a reference to the location of a document. 
  The reference is provided by a system interpretable Location attribute (a URL string) 
  where the document can be found, and an optional inherited internal reference Identification, 
  which refers to a system interpretable position within the document. 
  The optional inherited Name attribute provides meaning for human readers. 
  Optional document metadata can also be captured through reference to IfcDocumentInformation.

  \changes
  
  * IFC4 changes: 
    * Inverse attribute ReferenceToDocument renamed to DocumentRefForObjects
    * Type of the inverse attribute ReferenceToDocument changed from "SET OF [0:1] IfcDocumentInformation FOR DocumentReferences" to "SET OF [0:?] IfcRelAssociatesDocument FOR RelatingDocument"
*/
class IFC4X3_RC1_EXPORT IfcDocumentReference : public IfcExternalReference
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcDocumentReference);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Description attribute. 
  This attribute represents description of the document 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 document reference for informational purposes.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of ReferencedDocument attribute. 
  This attribute represents the document that is referenced.
  \returns
  Returns the value of ReferencedDocument attribute.
  */
  const OdDAIObjectId& getReferencedDocument() const;

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

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


public:

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

  /** \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]
  OdDAIObjectId m_ReferencedDocument;   // IfcDocumentInformation  [optional]

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCDOCUMENTREFERENCE_AUTO_IMPL_H