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

#include "IfcControlAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The IfcScheduleTimeControl captures the time-related information about a process including the different types 
  (i.e. actual, or scheduled) of starting and ending times, duration, float times, etc.
*/
class IFC2X2_FINAL_EXPORT IfcScheduleTimeControl : public IfcControl
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcScheduleTimeControl);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ActualStart attribute. 
  This attribute represents the date on which a task is actually started.
  \returns
  Returns the value of ActualStart attribute.
  */
  IfcDateTimeSelect actualStart();

  /** \details
  Returns the value of EarlyStart attribute. 
  This attribute represents the earliest date on which a task can be started.
  \returns
  Returns the value of EarlyStart attribute.
  */
  IfcDateTimeSelect earlyStart();

  /** \details
  Returns the value of LateStart attribute. 
  This attribute represents the latest date on which a task can be started.
  \returns
  Returns the value of LateStart attribute.
  */
  IfcDateTimeSelect lateStart();

  /** \details
  Returns the value of ScheduleStart attribute. 
  This attribute represents the date on which a task is scheduled to be started.
  \returns
  Returns the value of ScheduleStart attribute.
  */
  IfcDateTimeSelect scheduleStart();

  /** \details
  Returns the value of ActualFinish attribute. 
  This attribute represents the date on which a task is actually finished.
  \returns
  Returns the value of ActualFinish attribute.
  */
  IfcDateTimeSelect actualFinish();

  /** \details
  Returns the value of EarlyFinish attribute. 
  This attribute represents the earliest date on which a task can be finished.
  \returns
  Returns the value of EarlyFinish attribute.
  */
  IfcDateTimeSelect earlyFinish();

  /** \details
  Returns the value of LateFinish attribute. 
  This attribute represents the latest date on which a task can be finished.
  \returns
  Returns the value of LateFinish attribute.
  */
  IfcDateTimeSelect lateFinish();

  /** \details
  Returns the value of ScheduleFinish attribute. 
  This attribute represents the date on which a task is scheduled to be finished.
  \returns
  Returns the value of ScheduleFinish attribute.
  */
  IfcDateTimeSelect scheduleFinish();

  /** \details
  Returns the value of ScheduleDuration attribute. 
  This attribute represents the amount of time which is scheduled for completion of a task.
  \returns
  Returns the value of ScheduleDuration attribute.
  */
  double getScheduleDuration() const;

  /** \details
  Sets the value of ScheduleDuration attribute. 
  This attribute represents the amount of time which is scheduled for completion of a task.
  \param ScheduleDuration [in] ScheduleDuration attribute to set.
  */
  void setScheduleDuration(double ScheduleDuration);

  /** \details
  Returns the value of ActualDuration attribute. 
  This attribute represents the actual duration of the task.
  \returns
  Returns the value of ActualDuration attribute.
  */
  double getActualDuration() const;

  /** \details
  Sets the value of ActualDuration attribute. 
  This attribute represents the actual duration of the task.
  \param ActualDuration [in] ActualDuration attribute to set.
  */
  void setActualDuration(double ActualDuration);

  /** \details
  Returns the value of RemainingTime attribute. 
  This attribute represents the amount of time remaining to complete a task.
  \returns
  Returns the value of RemainingTime attribute.
  */
  double getRemainingTime() const;

  /** \details
  Sets the value of RemainingTime attribute. 
  This attribute represents the amount of time remaining to complete a task.
  \param RemainingTime [in] RemainingTime attribute to set.
  */
  void setRemainingTime(double RemainingTime);

  /** \details
  Returns the value of FreeFloat attribute. 
  This attribute represents the amount of time during which the start or finish of a task 
  can be varied without any effect on the overall program of work.
  \returns
  Returns the value of FreeFloat attribute.
  */
  double getFreeFloat() const;

  /** \details
  Sets the value of FreeFloat attribute. 
  This attribute represents the amount of time during which the start or finish of a task 
  can be varied without any effect on the overall program of work.
  \param FreeFloat [in] FreeFloat attribute to set.
  */
  void setFreeFloat(double FreeFloat);

  /** \details
  Returns the value of TotalFloat attribute. 
  This attribute represents the difference between the duration available to carry out a task and the scheduled duration of the task.
  \returns
  Returns the value of TotalFloat attribute.
  */
  double getTotalFloat() const;

  /** \details
  Sets the value of TotalFloat attribute. 
  This attribute represents the difference between the duration available to carry out a task and the scheduled duration of the task.
  \param TotalFloat [in] TotalFloat attribute to set.
  */
  void setTotalFloat(double TotalFloat);

  /** \details
  Returns the value of IsCritical attribute. 
  This attribute indicates whether a scheduled task is a critical item within the program.
  \returns
  Returns the value of IsCritical attribute.
  */
  OdDAI::Boolean getIsCritical() const;

  /** \details
  Sets the value of IsCritical attribute. 
  This attribute indicates whether a scheduled task is a critical item within the program.
  \param IsCritical [in] IsCritical attribute to set.
  */
  void setIsCritical(OdDAI::Boolean IsCritical);

  /** \details
  Returns the value of StatusTime attribute. 
  This attribute represents the date or time at which the status of the tasks within the schedule is analyzed.
  \returns
  Returns the value of StatusTime attribute.
  */
  IfcDateTimeSelect statusTime();

  /** \details
  Returns the value of StartFloat attribute. 
  This attribute represents the difference between the late start and early start of a task. 
  Start float measures how long an task's start can be delayed and still not have an impact on the overall duration of a schedule.
  \returns
  Returns the value of StartFloat attribute.
  */
  double getStartFloat() const;

  /** \details
  Sets the value of StartFloat attribute. 
  This attribute represents the difference between the late start and early start of a task. 
  Start float measures how long an task's start can be delayed and still not have an impact on the overall duration of a schedule.
  \param StartFloat [in] StartFloat attribute to set.
  */
  void setStartFloat(double StartFloat);

  /** \details
  Returns the value of FinishFloat attribute. 
  This attribute represents the difference between the late finish and early finish of a task. 
  Finish float measures how long an task's finish can be delayed and still not have an impact on the overall duration of a schedule.
  \returns
  Returns the value of FinishFloat attribute.
  */
  double getFinishFloat() const;

  /** \details
  Sets the value of FinishFloat attribute. 
  This attribute represents the difference between the late finish and early finish of a task. 
  Finish float measures how long an task's finish can be delayed and still not have an impact on the overall duration of a schedule.
  \param FinishFloat [in] FinishFloat attribute to set.
  */
  void setFinishFloat(double FinishFloat);

  /** \details
  Returns the value of Completion attribute. 
  This attribute represents the extent of completion expressed as a ratio or percentage.
  \returns
  Returns the value of Completion attribute.
  */
  double getCompletion() const;

  /** \details
  Sets the value of Completion attribute. 
  This attribute represents the extent of completion expressed as a ratio or percentage.
  \param Completion [in] Completion attribute to set.
  */
  void setCompletion(double Completion);

  /** \details
  Returns the value of ScheduleTimeControlAssigned attribute. 
  This attribute represents the assigned schedule time control in the relationship.
  \returns
  Returns the value of ScheduleTimeControlAssigned attribute.
  */
  OdDAIObjectId getInvScheduleTimeControlAssigned() const;


public:

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

  /** \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::Select m_ActualStart;   // IfcDateTimeSelect  [optional]
  OdDAI::Select m_EarlyStart;   // IfcDateTimeSelect  [optional]
  OdDAI::Select m_LateStart;   // IfcDateTimeSelect  [optional]
  OdDAI::Select m_ScheduleStart;   // IfcDateTimeSelect  [optional]
  OdDAI::Select m_ActualFinish;   // IfcDateTimeSelect  [optional]
  OdDAI::Select m_EarlyFinish;   // IfcDateTimeSelect  [optional]
  OdDAI::Select m_LateFinish;   // IfcDateTimeSelect  [optional]
  OdDAI::Select m_ScheduleFinish;   // IfcDateTimeSelect  [optional]
  double m_ScheduleDuration;   // IfcTimeMeasure  [optional]
  double m_ActualDuration;   // IfcTimeMeasure  [optional]
  double m_RemainingTime;   // IfcTimeMeasure  [optional]
  double m_FreeFloat;   // IfcTimeMeasure  [optional]
  double m_TotalFloat;   // IfcTimeMeasure  [optional]
  OdDAI::Boolean m_IsCritical;   // BOOLEAN  [optional]
  OdDAI::Select m_StatusTime;   // IfcDateTimeSelect  [optional]
  double m_StartFloat;   // IfcTimeMeasure  [optional]
  double m_FinishFloat;   // IfcTimeMeasure  [optional]
  IfcPositiveRatioMeasure m_Completion;   // IfcPositiveRatioMeasure  [optional]

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X2_FINAL_IFCSCHEDULETIMECONTROL_AUTO_IMPL_H