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

#include "IfcProjectOrderAutoImpl.h"
#include "IfcCalendarDateAutoImpl.h"
#include "IfcCostScheduleAutoImpl.h"
#include "IfcCostValueAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcPurchaseOrder defines a set of properties for purchase orders in a project.
*/
class IFC2X_FINAL_EXPORT IfcPurchaseOrder : public IfcProjectOrder
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcPurchaseOrder);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of RequiredDate attribute. 
  This attribute represents the required date of receiving the requested items.
  \returns
  Returns the value of RequiredDate attribute.
  */
  const OdDAIObjectId& getRequiredDate() const;

  /** \details
  Sets the value of RequiredDate attribute. 
  This attribute represents the required date of receiving the requested items.
  \param RequiredDate [in] RequiredDate attribute to set.
  */
  void setRequiredDate(const OdDAIObjectId& RequiredDate);

  /** \details
  Returns the value of ScheduledDate attribute. 
  This attribute represents the scheduled date of receiving the requested items.
  \returns
  Returns the value of ScheduledDate attribute.
  */
  const OdDAIObjectId& getScheduledDate() const;

  /** \details
  Sets the value of ScheduledDate attribute. 
  This attribute represents the scheduled date of receiving the requested items.
  \param ScheduledDate [in] ScheduledDate attribute to set.
  */
  void setScheduledDate(const OdDAIObjectId& ScheduledDate);

  /** \details
  Returns the value of ActualDate attribute. 
  This attribute represents the actual date of receiving the purchased items.
  \returns
  Returns the value of ActualDate attribute.
  */
  const OdDAIObjectId& getActualDate() const;

  /** \details
  Sets the value of ActualDate attribute. 
  This attribute represents the actual date of receiving the purchased items.
  \param ActualDate [in] ActualDate attribute to set.
  */
  void setActualDate(const OdDAIObjectId& ActualDate);

  /** \details
  Returns the value of IsFOB attribute. 
  This attribute indicates whether the order is free on board.
  \returns
  Returns the value of IsFOB attribute.
  */
  OdDAI::Boolean getIsFOB() const;

  /** \details
  Sets the value of IsFOB attribute. 
  This attribute indicates whether the order is free on board.
  \param IsFOB [in] IsFOB attribute to set.
  */
  void setIsFOB(OdDAI::Boolean IsFOB);

  /** \details
  Returns the value of ShipMethod attribute. 
  This attribute represents the method of shipping.
  \returns
  Returns the value of ShipMethod attribute.
  */
  const OdAnsiString& getShipMethod() const;

  /** \details
  Sets the value of ShipMethod attribute. 
  This attribute represents the method of shipping.
  \param ShipMethod [in] ShipMethod attribute to set.
  */
  void setShipMethod(const OdAnsiString& ShipMethod);

  /** \details
  Returns the value of PurchaseItems attribute. 
  This attribute represents the use a cost schedule to handle the list of items with both item description and cost of each cost element in the cost schedule.
  \returns
  Returns the value of PurchaseItems attribute.
  */
  const OdDAIObjectId& getPurchaseItems() const;

  /** \details
  Sets the value of PurchaseItems attribute. 
  This attribute represents the use a cost schedule to handle the list of items with both item description and cost of each cost element in the cost schedule.
  \param PurchaseItems [in] PurchaseItems attribute to set.
  */
  void setPurchaseItems(const OdDAIObjectId& PurchaseItems);

  /** \details
  Returns the value of TotalCost attribute. 
  This attribute represents the total cost of the purchase. It is derived value from 'PurchaseItems'.
  \returns
  Returns the value of TotalCost attribute.
  */
  const OdDAIObjectId& getTotalCost() const;

  /** \details
  Sets the value of TotalCost attribute. 
  This attribute represents the total cost of the purchase. It is derived value from 'PurchaseItems'.
  \param TotalCost [in] TotalCost attribute to set.
  */
  void setTotalCost(const OdDAIObjectId& TotalCost);

  /** \details
  Returns the value of Status attribute. 
  This attribute represents the status of the purchase order.
  \returns
  Returns the value of Status attribute.
  */
  IfcPurchaseOrderStatusEnum getStatus() const;

  /** \details
  Sets the value of Status attribute. 
  This attribute represents the status of the purchase order.
  \param Status [in] Status attribute to set.
  */
  void setStatus(IfcPurchaseOrderStatusEnum Status);


public:

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

  /** \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: 
  OdDAIObjectId m_RequiredDate;   // IfcCalendarDate  [optional]
  OdDAIObjectId m_ScheduledDate;   // IfcCalendarDate  [optional]
  OdDAIObjectId m_ActualDate;   // IfcCalendarDate  [optional]
  OdDAI::Boolean m_IsFOB;   // BOOLEAN  [optional]
  OdAnsiString m_ShipMethod;   // IfcLabel  [optional]
  OdDAIObjectId m_PurchaseItems;   // IfcCostSchedule  [optional]
  OdDAIObjectId m_TotalCost;   // IfcCostValue  [optional]
  OdDAI::Enum m_Status;   // IfcPurchaseOrderStatusEnum
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCPURCHASEORDER_AUTO_IMPL_H