/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCOWNERHISTORY_AUTO_IMPL_H
#define _IFC4_IFCOWNERHISTORY_AUTO_IMPL_H

#include "Ifc4BaseClass.h"

#include "Ifc4Enum.h"
#include "Ifc4SelectTypes.h"
#include "Ifc4CollectionTypes.h"
#include "IfcPersonAndOrganizationAutoImpl.h"
#include "IfcApplicationAutoImpl.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
  IfcOwnerHistory defines all history and identification related information. 
  To provide fast access it is directly attached to all independent objects, relationships and properties.
  IfcOwnerHistory identifies the creating and owning application and user for the associated object, and captures the last modifying application and user.

  \changes
  
  * IFC4 changes: 
    * Attribute ChangeAction is now optional
*/
class IFC4_EXPORT IfcOwnerHistory : public OdIfc4Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcOwnerHistory);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of OwningUser attribute. 
  This attribute represents reference to the end user who currently "owns" this object. 
  IFC includes the concept of ownership transfer from one user to another and therefore distinguishes between the Owning User and Creating User.
  \returns
  Returns the value of OwningUser attribute.
  */
  const OdDAIObjectId& getOwningUser() const;

  /** \details
  Sets the value of OwningUser attribute. 
  This attribute represents reference to the end user who currently "owns" this object. 
  IFC includes the concept of ownership transfer from one user to another and therefore distinguishes between the Owning User and Creating User.
  \param OwningUser [in] Owning user to set.
  */
  void setOwningUser(const OdDAIObjectId& OwningUser);

  /** \details
  Returns the value of OwningApplication attribute. 
  This attribute represents reference to the application which currently "owns" this object on behalf of the owning user of the application. 
  IFC includes the concept of ownership transfer from one application 
  to another and therefore distinguishes between the Owning Application and Creating Application.
  \returns
  Returns the value of OwningApplication attribute.
  */
  const OdDAIObjectId& getOwningApplication() const;

  /** \details
  Sets the value of OwningApplication attribute. 
  This attribute represents reference to the application which currently "owns" this object on behalf of the owning user of the application. 
  IFC includes the concept of ownership transfer from one application 
  to another and therefore distinguishes between the Owning Application and Creating Application.
  \param OwningApplication [in] Owning application to set.
  */
  void setOwningApplication(const OdDAIObjectId& OwningApplication);

  /** \details
  Returns the value of State attribute. 
  This attribute represents enumeration that defines the current access state of the object.
  \returns
  Returns the value of State attribute.
  */
  IfcStateEnum getState() const;

  /** \details
  Sets the value of State attribute. 
  This attribute represents enumeration that defines the current access state of the object.
  \param State [in] Access state to set.
  */
  void setState(IfcStateEnum State);

  /** \details
  Returns the value of ChangeAction attribute. 
  This attribute represents enumeration that defines the actions associated with changes made to the object.
  \returns
  Returns the value of ChangeAction attribute.
  */
  IfcChangeActionEnum getChangeAction() const;

  /** \details
  Sets the value of ChangeAction attribute. 
  This attribute represents enumeration that defines the actions associated with changes made to the object.
  \param ChangeAction [in] ChangeAction attribute to set.
  */
  void setChangeAction(IfcChangeActionEnum ChangeAction);

  /** \details
  Returns the value of LastModifiedDate attribute. 
  This attribute represents date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) 
  at which the last modification was made by last modifying user 
  (LastModifyingUser attribute) and last modifying application (LastModifyingApplication attribute).
  \returns
  Returns the value of LastModifiedDate attribute.
  */
  int getLastModifiedDate() const;

  /** \details
  Sets the value of LastModifiedDate attribute. 
  This attribute represents date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) 
  at which the last modification was made by last modifying user 
  (LastModifyingUser attribute) and last modifying application (LastModifyingApplication attribute).
  \param LastModifiedDate [in] Last modified date to set.
  */
  void setLastModifiedDate(int LastModifiedDate);

  /** \details
  Returns the value of LastModifyingUser attribute. 
  This attribute represents user who made the last modification 
  using last modifying application (LastModifyingApplication attribute).
  \returns
  Returns the value of LastModifyingUser attribute.
  */
  const OdDAIObjectId& getLastModifyingUser() const;

  /** \details
  Sets the value of LastModifyingUser attribute. 
  This attribute represents user who made the last modification 
  using last modifying application (LastModifyingApplication attribute).
  \param LastModifyingUser [in] Last modifying user to set.
  */
  void setLastModifyingUser(const OdDAIObjectId& LastModifyingUser);

  /** \details
  Returns the value of LastModifyingApplication attribute. 
  This attribute represents application used to make the last modification.
  \returns
  Returns the value of LastModifyingApplication attribute.
  */
  const OdDAIObjectId& getLastModifyingApplication() const;

  /** \details
  Sets the value of LastModifyingApplication attribute. 
  This attribute represents application used to make the last modification.
  \param LastModifyingApplication [in] Last modifying application to set.
  */
  void setLastModifyingApplication(const OdDAIObjectId& LastModifyingApplication);

  /** \details
  Returns the value of CreationDate attribute. 
  This attribute represents the date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) 
  when first created by the original OwningApplication. Once defined this value remains unchanged through the lifetime of the entity.
  \returns
  Returns the value of CreationDate attribute.
  */
  int getCreationDate() const;

  /** \details
  Sets the value of CreationDate attribute. 
  This attribute represents the date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) 
  when first created by the original OwningApplication. Once defined this value remains unchanged through the lifetime of the entity.
  \param CreationDate [in] Creation date to set.
  */
  void setCreationDate(int CreationDate);


public:

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

  /** \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: 
  OdDAIObjectId m_OwningUser;   // IfcPersonAndOrganization
  OdDAIObjectId m_OwningApplication;   // IfcApplication
  OdDAI::Enum m_State;   // IfcStateEnum  [optional]
  OdDAI::Enum m_ChangeAction;   // IfcChangeActionEnum  [optional]
  int m_LastModifiedDate;   // IfcTimeStamp  [optional]
  OdDAIObjectId m_LastModifyingUser;   // IfcPersonAndOrganization  [optional]
  OdDAIObjectId m_LastModifyingApplication;   // IfcApplication  [optional]
  int m_CreationDate;   // IfcTimeStamp
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCOWNERHISTORY_AUTO_IMPL_H