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

#include "IfcControlAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcPerformanceHistory is used to document the actual performance of an occurrence instance over time. 
  It includes machine-measured data from building automation systems and human-specified data such as task and resource usage. 
  The data can represent actual conditions, predictions, or simulations.
  
  The realtime data tracked by performance history takes the form of property sets where all properties are based on time series. 
  Unlike design-based data at occurrences and types, performance-driven data is time-sensitive and can change in realtime by some measurement device. 
  Data can be captured at irregular intervals such as when values change beyond established thresholds, or at regular intervals of specified duration.
  
  IfcPerformanceHistory can be declared within a project using IfcRelDeclares where RelatingContext refers to the IfcProject and RelatedDefinitions includes the IfcPerformanceHistory. 
  Default units (used for property sets) are indicated by the declaring project. 
  Only top-level objects are declared; nested performance history objects (through IfcRelNests) do not participate in such relationship.
  
  - Property Sets for Performance -
  The property sets relating to this entity are defined by IfcPropertySet and attached by the IfcRelDefinesByProperties relationship. 
  They are accessible by the IsDefinedBy inverse attribute. 
  Applicable property sets are defined at assigned entities (primarily IfcDistributionElement subtypes) where IfcPropertySetTemplate.PropertySetType is PSET_PERFORMANCEDRIVEN.
  
  - Classification -
  IfcPerformanceHistory can be classified using IfcRelAssociatesClassification where RelatingClassification 
  refers to an IfcClassificationReference indicating a classification notation. 
  Such classification notation can be used to identify the information such as an address within a building automation system, 
  a work breakdown structure code for tasks, or a cost code for resource allocation.
  
  - Aggregation -
  IfcPerformanceHistory can be decomposed into components using IfcRelNests where RelatingObject refers to the enclosing 
  IfcPerformanceHistory and RelatedObjects contains one or more IfcPerformanceHistory components. 
  Composition indicates breakdown of further detail and can correspond to the hierarchy of objects it represents.
  
  - Control Assignment -
  The Control Assignment concept template applies to this entity as shown in the table below:
  <table>
  <b>Type</b>                   <b>Description</b>
  IfcGroup                      A system or zone for which time-based system information is provided, such as overall status parameters of a building control system
  IfcProduct                    A building space, physical device, or port for which time-based information is provided, such as a chiller or an analog input within a device
  IfcProcess                    A process for which time-based information is provided, such as an alarm event being raised and acknowledged, or regular and overtime costs incurred for a task
  IfcResource                   A resource for which usage is recorded or planned over time, such as wage rates and number of workers at particular times
  </table>
*/
class IFC2X3_EXPORT IfcPerformanceHistory : public IfcControl
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcPerformanceHistory);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of LifeCyclePhase attribute. 
  This attribute represents describes the applicable building life-cycle phase. 
  Typical values should be DESIGNDEVELOPMENT, SCHEMATICDEVELOPMENT, CONSTRUCTIONDOCUMENT, CONSTRUCTION, ASBUILT, COMMISSIONING, OPERATION, etc.
  \returns
  Returns the value of LifeCyclePhase attribute.
  */
  const OdAnsiString& getLifeCyclePhase() const;

  /** \details
  Sets the value of LifeCyclePhase attribute. 
  This attribute represents describes the applicable building life-cycle phase. 
  Typical values should be DESIGNDEVELOPMENT, SCHEMATICDEVELOPMENT, CONSTRUCTIONDOCUMENT, CONSTRUCTION, ASBUILT, COMMISSIONING, OPERATION, etc.
  \param LifeCyclePhase [in] Life cycle phase to set.
  */
  void setLifeCyclePhase(const OdAnsiString& LifeCyclePhase);


public:

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

  /** \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: 
  OdAnsiString m_LifeCyclePhase;   // IfcLabel
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCPERFORMANCEHISTORY_AUTO_IMPL_H