/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCTIMESERIES_AUTO_IMPL_H
#define _IFC4_IFCTIMESERIES_AUTO_IMPL_H

#include "Ifc4BaseClass.h"

#include "Ifc4Enum.h"
#include "Ifc4SelectTypes.h"
#include "Ifc4CollectionTypes.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
  A time series is a set of a time-stamped data entries. 
  It allows a natural association of data collected over intervals of time. 
  Time series can be regular or irregular. In regular time series data arrive predictably at predefined intervals. 
  In irregular time series some or all time stamps do not follow 
  a repetitive pattern and unpredictable bursts of data can arrive at unspecified points in time.

  \remarks
  This definition may not be instantiated

  \changes
  
  * IFC4 changes: 
    * Type of the EndTime attribute changed from "IfcDateTimeSelect" to "IfcDateTime"
    * Type of the StartTime attribute changed from "IfcDateTimeSelect" to "IfcDateTime"
    * Attribute DocumentedBy renamed to HasExternalReference
    * Type of the inverse attribute DocumentedBy changed from "SET OF [0:1] IfcTimeSeriesReferenceRelationship FOR ReferencedTimeSeries" to "SET OF [1:?] IfcExternalReferenceRelationship FOR RelatedResourceObjects"
*/
class IFC4_EXPORT IfcTimeSeries : public OdIfc4Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4::IfcTimeSeries);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Name attribute. 
  This attribute represents an unique name for the time series.
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute. 
  This attribute represents an unique name for the time series.
  \param Name [in] Name to set.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the value of Description attribute. 
  This attribute represents a text description of the data that the series represents.
  \returns
  Returns the value of Description attribute.
  */
  const OdAnsiString& getDescription() const;

  /** \details
  Sets the value of Description attribute. 
  This attribute represents a text description of the data that the series represents.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of StartTime attribute. 
  This attribute represents the start time of a time series.
  \returns
  Returns the value of StartTime attribute.
  */
  const OdAnsiString& getStartTime() const;

  /** \details
  Sets the value of StartTime attribute. 
  This attribute represents the start time of a time series.
  \param StartTime [in] StartTime to set.
  */
  void setStartTime(const OdAnsiString& StartTime);

  /** \details
  Returns the value of EndTime attribute. 
  This attribute represents the end time of a time series.
  \returns
  Returns the value of EndTime attribute.
  */
  const OdAnsiString& getEndTime() const;

  /** \details
  Sets the value of EndTime attribute. 
  This attribute represents the end time of a time series.
  \param EndTime [in] EndTime to set.
  */
  void setEndTime(const OdAnsiString& EndTime);

  /** \details
  Returns the value of TimeSeriesDataType attribute. 
  This attribute represents the time series data type.
  \returns
  Returns the value of TimeSeriesDataType attribute.
  */
  IfcTimeSeriesDataTypeEnum getTimeSeriesDataType() const;

  /** \details
  Sets the value of TimeSeriesDataType attribute. 
  This attribute represents the time series data type.
  \param TimeSeriesDataType [in] Time series data type to set.
  */
  void setTimeSeriesDataType(IfcTimeSeriesDataTypeEnum TimeSeriesDataType);

  /** \details
  Returns the value of DataOrigin attribute. 
  This attribute represents the origin of a time series data.
  \returns
  Returns the value of DataOrigin attribute.
  */
  IfcDataOriginEnum getDataOrigin() const;

  /** \details
  Sets the value of DataOrigin attribute. 
  This attribute represents the origin of a time series data.
  \param DataOrigin [in] Data origin to set.
  */
  void setDataOrigin(IfcDataOriginEnum DataOrigin);

  /** \details
  Returns the value of UserDefinedDataOrigin attribute. 
  This attribute represents value of the data origin if DataOrigin attribute is USERDEFINED.
  \returns
  Returns the value of UserDefinedDataOrigin attribute.
  */
  const OdAnsiString& getUserDefinedDataOrigin() const;

  /** \details
  Sets the value of UserDefinedDataOrigin attribute. 
  This attribute represents value of the data origin if DataOrigin attribute is USERDEFINED.
  \param UserDefinedDataOrigin [in] UserDefinedDataOrigin to set.
  */
  void setUserDefinedDataOrigin(const OdAnsiString& UserDefinedDataOrigin);

  /** \details
  Returns the value of Unit attribute. 
  This attribute represents the unit to be assigned to all values within the time series.
  \returns
  Returns the value of Unit attribute.
  \remarks
  Mixing units is not allowed. If the value is not provided, the global unit for the type of IfcValue, 
  as defined at IfcProject.UnitsInContext is used.
  */
  IfcUnit unit();

  /** \details
  Returns the value of HasExternalReference attribute. 
  This attribute represents reference to an external reference, e.g. library, classification, 
  or document information, that is associated to the IfcTimeSeries.
  \param HasExternalReference [out] Receives the value of HasExternalReference attribute.
  */
  void getInvHasExternalReference(OdDAIObjectIds& HasExternalReference) const;


public:

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

  /** \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_Name;   // IfcLabel
  OdAnsiString m_Description;   // IfcText  [optional]
  OdAnsiString m_StartTime;   // IfcDateTime
  OdAnsiString m_EndTime;   // IfcDateTime
  OdDAI::Enum m_TimeSeriesDataType;   // IfcTimeSeriesDataTypeEnum
  OdDAI::Enum m_DataOrigin;   // IfcDataOriginEnum
  OdAnsiString m_UserDefinedDataOrigin;   // IfcLabel  [optional]
  OdDAI::Select m_Unit;   // IfcUnit  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcExternalReferenceRelationship;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCTIMESERIES_AUTO_IMPL_H