/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCROOT_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCROOT_AUTO_IMPL_H

#include "Ifc4x3BaseClass.h"

#include "Ifc4x3Enum.h"
#include "Ifc4x3SelectTypes.h"
#include "Ifc4x3CollectionTypes.h"
#include "IfcOwnerHistoryAutoImpl.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
  IfcRoot is the most abstract and root class for all entity definitions that roots in the kernel or in subsequent layers of the IFC specification. 
  It is therefore the common supertype of all IFC entities, beside those defined in an IFC resource schema. 
  All entities that are subtypes of IfcRoot can be used independently, whereas resource schema entities, that are not subtypes of IfcRoot, are not supposed to be independent entities.
  The IfcRoot assigns the globally unique ID, and the ownership and history information to the entity. In addition it can provide for a name and a description about the concepts.

  \remarks
  View definitions and implementation agreement can impose additional restrictions on the use of the OwnerHistory to handle object versioning.

  \changes
  
  * IFC4 changes: 
    The attribute <c>OwnerHistory</c> has been made OPTIONAL.
*/
class IFC4X3_EXPORT IfcRoot : public OdIfc4x3Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x3_add2::IfcRoot);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns a globally unique identifier within the entire software world.
  \returns
  The globally unique identifier value.
  */
  OdDAI::CompressedGUID getGlobalId() const;

  /** \details
  Assigns a globally unique identifier within the entire software world.
  \param GlobalId [in] Value that represents a globally unique identifier to assign.
  */
  void setGlobalId(OdDAI::CompressedGUID GlobalId);

  /** \details
  Returns the information about the current ownership of that object, including owning actor, application, local identification and information captured about the recent changes of the object.
  \returns
  The <a href="OdDAIObjectId.html">OdDAIObjectId</a> object that contains information about ownership of that object.
  */
  const OdDAIObjectId& getOwnerHistory() const;

  /** \details
  Assigns the information about the current ownership of that object, including owning actor, application, local identification and information captured about the recent changes of the object.
  \param OwnerHistory [in] Ownership information.
  */
  void setOwnerHistory(const OdDAIObjectId& OwnerHistory);

  /** \details
  Returns a name that is used by the participating software systems or users.
  \returns
  A strings that contains a name of the object.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the name of the object.
  \param Name String that contains name of the object.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the description of an object.
  \returns
  String that contains description of the object.
  */
  const OdAnsiString& getDescription() const;

  /** \details
  Sets the object description.
  \param Description String that contains comments that describe an object.
  */
  void setDescription(const OdAnsiString& Description);


public:

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

  /** \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: 
  OdDAI::CompressedGUID m_GlobalId;   // IfcGloballyUniqueId
  OdDAIObjectId m_OwnerHistory;   // IfcOwnerHistory  [optional]
  OdAnsiString m_Name;   // IfcLabel  [optional]
  OdAnsiString m_Description;   // IfcText  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCROOT_AUTO_IMPL_H