/////////////////////////////////////////////////////////////////////////////// 
// 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 _IFC4X2_IFCINVENTORY_AUTO_IMPL_H
#define _IFC4X2_IFCINVENTORY_AUTO_IMPL_H

#include "IfcGroupAutoImpl.h"
#include "IfcCostValueAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  An inventory is a list of items within an enterprise.
  Various types of inventory can be included. These are identified by the range of values within the inventory type enumeration which includes space, asset, and furniture. 
  User defined inventories can also be defined for lists of particular types of element such as can be required in operating and maintenance instructions. 
  Such inventories should be constrained to contain a list of elements of a restricted type.
  
  There are a number of actors that can be associated with an inventory, each actor having a role. 
  Actors within the scope of the project are indicated using the IfcRelAssignsToActor relationship 
  in which case roles should be defined through the IfcActorRole class; 
  otherwise principal actors are identified as attributes of the class. 
  In the existence of both, direct attributes take precedence.
*/
class IFC4X2_EXPORT IfcInventory : public IfcGroup
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcInventory);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents a list of the types of inventories from which that required type can be selected.
  \returns
  Returns the value of PredefinedType attribute.
  \remarks
  IFC4 CHANGE: Attribute made optional.
  */
  IfcInventoryTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents a list of the types of inventories from which that required type can be selected.
  \param PredefinedType [in] Predefined type to set.
  \remarks
  IFC4 CHANGE: Attribute made optional.
  */
  void setPredefinedType(IfcInventoryTypeEnum PredefinedType);

  /** \details
  Returns the value of Jurisdiction attribute. 
  This attribute represents the organizational unit to which the inventory is applicable.
  \returns
  Returns the value of Jurisdiction attribute.
  */
  IfcActorSelect jurisdiction();

  /** \details
  Gets the value of ResponsiblePersons attribute. 
  This attribute represents persons who are responsible for the inventory.
  \param ResponsiblePersons [out] Receives the ResponsiblePersons attribute.
  */
  void getResponsiblePersons(OdDAIObjectIds& ResponsiblePersons) const;

  /** \details
  Returns the value of ResponsiblePersons attribute. 
  This attribute represents persons who are responsible for the inventory.
  \returns
  Returns the value of ResponsiblePersons attribute.
  */
  OdDAI::SetOfOdDAIObjectId& responsiblePersons();

  /** \details
  Returns the value of LastUpdateDate attribute. 
  This attribute represents the date on which the last update of the inventory was carried out.
  \returns
  Returns the value of LastUpdateDate attribute.
  \remarks
  IFC4 CHANGE: Type changed from IfcDateTimeSelect.
  */
  const OdAnsiString& getLastUpdateDate() const;

  /** \details
  Sets the value of LastUpdateDate attribute. 
  This attribute represents the date on which the last update of the inventory was carried out.
  \param LastUpdateDate [in] Last update date to set.
  \remarks
  IFC4 CHANGE: Type changed from IfcDateTimeSelect.
  */
  void setLastUpdateDate(const OdAnsiString& LastUpdateDate);

  /** \details
  Returns the value of CurrentValue attribute. 
  This attribute represents an estimate of the current cost value of the inventory.
  \returns
  Returns the value of CurrentValue attribute.
  */
  const OdDAIObjectId& getCurrentValue() const;

  /** \details
  Sets the value of CurrentValue attribute. 
  This attribute represents an estimate of the current cost value of the inventory.
  \param CurrentValue [in] Current value to set.
  */
  void setCurrentValue(const OdDAIObjectId& CurrentValue);

  /** \details
  Returns the value of OriginalValue attribute. 
  This attribute represents an estimate of the original cost value of the inventory.
  \returns
  Returns the value of OriginalValue attribute.
  */
  const OdDAIObjectId& getOriginalValue() const;

  /** \details
  Sets the value of OriginalValue attribute. 
  This attribute represents an estimate of the original cost value of the inventory.
  \param OriginalValue [in] Original value to set.
  */
  void setOriginalValue(const OdDAIObjectId& OriginalValue);


public:

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

  /** \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
  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::Enum m_PredefinedType;   // IfcInventoryTypeEnum  [optional]
  OdDAI::Select m_Jurisdiction;   // IfcActorSelect  [optional]
  OdDAI::SetOfOdDAIObjectId m_ResponsiblePersons; // SET [1:?] of IfcPerson [optional]

  OdAnsiString m_LastUpdateDate;   // IfcDate  [optional]
  OdDAIObjectId m_CurrentValue;   // IfcCostValue  [optional]
  OdDAIObjectId m_OriginalValue;   // IfcCostValue  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X2_IFCINVENTORY_AUTO_IMPL_H