/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCMAINTENANCEWORKORDER_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCMAINTENANCEWORKORDER_AUTO_IMPL_H

#include "IfcWorkOrderAutoImpl.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
  An IfcMaintenanceWorkOrder is a detailed description of maintenance work that needs to be performed.
*/
class IFC2X_FINAL_EXPORT IfcMaintenanceWorkOrder : public IfcWorkOrder
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcMaintenanceWorkOrder);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Gets the value of SparesToolsEquipmentConsumables attribute. 
  This attribute represents spares, tools, equipment, consumables etc. required for the completion of a work order.
  \param SparesToolsEquipmentConsumables [out] Receives SparesToolsEquipmentConsumables attribute to set.
  */
  void getSparesToolsEquipmentConsumables(OdArray<OdAnsiString >& SparesToolsEquipmentConsumables) const;

  /** \details
  Returns the value of SparesToolsEquipmentConsumables attribute. 
  This attribute represents spares, tools, equipment, consumables etc. required for the completion of a work order.
  \returns
  Returns the value of SparesToolsEquipmentConsumables attribute.
  */
  OdDAI::BagOfOdAnsiString& sparesToolsEquipmentConsumables();

  /** \details
  Returns the value of MaintenanceType attribute. 
  This attribute represents the origination of the work order and consequently of the type of work being done.
  \returns
  Returns the value of MaintenanceType attribute.
  */
  IfcMaintenanceTypeEnum getMaintenanceType() const;

  /** \details
  Sets the value of MaintenanceType attribute. 
  This attribute represents the origination of the work order and consequently of the type of work being done.
  \param MaintenanceType [in] MaintenanceType attribute to set.
  */
  void setMaintenanceType(IfcMaintenanceTypeEnum MaintenanceType);

  /** \details
  Returns the value of FaultPriority attribute. 
  This attribute represents the priority assigned to a fault in respect of carrying out a work order.
  \returns
  Returns the value of FaultPriority attribute.
  */
  IfcPriorityEnum getFaultPriority() const;

  /** \details
  Sets the value of FaultPriority attribute. 
  This attribute represents the priority assigned to a fault in respect of carrying out a work order.
  \param FaultPriority [in] FaultPriority attribute to set.
  */
  void setFaultPriority(IfcPriorityEnum FaultPriority);

  /** \details
  Returns the value of LocationPriority attribute. 
  This attribute represents the priority assigned to a fault in respect of carrying out a work order.
  \returns
  Returns the value of LocationPriority attribute.
  */
  IfcPriorityEnum getLocationPriority() const;

  /** \details
  Sets the value of LocationPriority attribute. 
  This attribute represents the priority assigned to a fault in respect of carrying out a work order.
  \param LocationPriority [in] LocationPriority attribute to set.
  */
  void setLocationPriority(IfcPriorityEnum LocationPriority);

  /** \details
  Returns the value of AssetDowntime attribute. 
  This attribute represents the duration that an asset is actually not available for use as a result of maintenance work.
  \returns
  Returns the value of AssetDowntime attribute.
  */
  double getAssetDowntime() const;

  /** \details
  Sets the value of AssetDowntime attribute. 
  This attribute represents the duration that an asset is actually not available for use as a result of maintenance work.
  \param AssetDowntime [in] AssetDowntime attribute to set.
  */
  void setAssetDowntime(double AssetDowntime);

  /** \details
  Returns the value of ScheduledFrequency attribute. 
  This attribute represents the period of time between expected instances of a work order that may have been predefined.
  \returns
  Returns the value of ScheduledFrequency attribute.
  */
  double getScheduledFrequency() const;

  /** \details
  Sets the value of ScheduledFrequency attribute. 
  This attribute represents the period of time between expected instances of a work order that may have been predefined.
  \param ScheduledFrequency [in] ScheduledFrequency attribute to set.
  */
  void setScheduledFrequency(double ScheduledFrequency);

  /** \details
  Returns the value of RequiredResponseTime attribute. 
  This attribute represents the required time for response to the reporting of an event that needs a maintenance action.
  \returns
  Returns the value of RequiredResponseTime attribute.
  */
  double getRequiredResponseTime() const;

  /** \details
  Sets the value of RequiredResponseTime attribute. 
  This attribute represents the required time for response to the reporting of an event that needs a maintenance action.
  \param RequiredResponseTime [in] RequiredResponseTime attribute to set.
  */
  void setRequiredResponseTime(double RequiredResponseTime);

  /** \details
  Returns the value of LeadCraft attribute. 
  This attribute represents the craft or profession nominated to lead the work requirement 
  identified within the work order e.g. electrician, plumber, carpenter etc.
  \returns
  Returns the value of LeadCraft attribute.
  */
  const OdAnsiString& getLeadCraft() const;

  /** \details
  Sets the value of LeadCraft attribute. 
  This attribute represents the craft or profession nominated to lead the work requirement 
  identified within the work order e.g. electrician, plumber, carpenter etc.
  \param LeadCraft [in] LeadCraft attribute to set.
  */
  void setLeadCraft(const OdAnsiString& LeadCraft);


public:

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

  /** \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::BagOfOdAnsiString m_SparesToolsEquipmentConsumables; // BAG [1:?] of IfcLabel [optional]

  OdDAI::Enum m_MaintenanceType;   // IfcMaintenanceTypeEnum
  OdDAI::Enum m_FaultPriority;   // IfcPriorityEnum  [optional]
  OdDAI::Enum m_LocationPriority;   // IfcPriorityEnum  [optional]
  double m_AssetDowntime;   // IfcTimeMeasure  [optional]
  double m_ScheduledFrequency;   // IfcTimeMeasure  [optional]
  double m_RequiredResponseTime;   // IfcTimeMeasure  [optional]
  OdAnsiString m_LeadCraft;   // IfcLabel
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCMAINTENANCEWORKORDER_AUTO_IMPL_H