/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCWORKCONTROL_AUTO_IMPL_H
#define _IFC2X3_IFCWORKCONTROL_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
  An IfcWorkControl is an abstract supertype which captures 
  information that is common to both IfcWorkPlan and IfcWorkSchedule.
  
  A work control can have resources assigned to it. This is handled by the IfcRelAssignsToControl relationship. 
  A work control should also define a context that gives further information about its usage. 
  If no special context information is required then the IfcProject instance as a global context should be used instead. 
  An explicit link between the work control and the IfcProject via IfcRelDeclares should then be provided.
  
  - Control Assignment -
  From IFC4 the assignment of tasks to the work control is handled by the IfcRelAssignsToControl relationship. 
  IfcRelAssignsTasks as used in previous IFC releases has been deleted and cannot be used anymore. 
  From IFC4 it is not necessary to assign each task to a work control 
  as it is regarded to be sufficient if the summary task (root task in the task hierarchy defined through IfcRelNests relationships) is assigned to a work control.
*/
class IFC2X3_EXPORT IfcWorkControl : public IfcControl
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc2x3::IfcWorkControl);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Identifier attribute. 
  This attribute represents an identifying designation given to a control. It is the identifier at the occurrence level.
  \returns
  Returns the value of Identifier attribute.
  \remarks
  IFC4 CHANGE: Attribute Identifier renamed to Identification and promoted to supertype IfcControl.
  */
  const OdAnsiString& getIdentifier() const;

  /** \details
  Sets the value of Identifier attribute. 
  This attribute represents an identifying designation given to a control. It is the identifier at the occurrence level.
  \param Identifier [in] Identifier to set.
  \remarks
  IFC4 CHANGE: Attribute Identifier renamed to Identification and promoted to supertype IfcControl.
  */
  void setIdentifier(const OdAnsiString& Identifier);

  /** \details
  Returns the value of CreationDate attribute. 
  This attribute represents the date that the plan is created.
  \returns
  Returns the value of CreationDate attribute.
  */
  IfcDateTimeSelect creationDate();

  /** \details
  Gets the value of Creators attribute. 
  This attribute represents the authors of the work plan.
  \param Creators [out] Receives the Creators attribute.
  */
  void getCreators(OdDAIObjectIds& Creators) const;

  /** \details
  Returns the value of Creators attribute. 
  This attribute represents the authors of the work plan.
  \returns
  Returns the value of Creators attribute.
  */
  OdDAI::SetOfOdDAIObjectId& creators();

  /** \details
  Returns the value of Purpose attribute. 
  This attribute represents a description of the purpose of the work schedule.
  \returns
  Returns the value of Purpose attribute.
  */
  const OdAnsiString& getPurpose() const;

  /** \details
  Sets the value of Purpose attribute. 
  This attribute represents a description of the purpose of the work schedule.
  \param Purpose [in] Purpose to set.
  */
  void setPurpose(const OdAnsiString& Purpose);

  /** \details
  Returns the value of Duration attribute. 
  This attribute represents the total duration of the entire work schedule.
  \returns
  Returns the value of Duration attribute.
  */
  double getDuration() const;

  /** \details
  Sets the value of Duration attribute. 
  This attribute represents the total duration of the entire work schedule.
  \param Duration [in] Duration to set.
  */
  void setDuration(double Duration);

  /** \details
  Returns the value of TotalFloat attribute. 
  This attribute represents the total time float of the entire work schedule.
  \returns
  Returns the value of TotalFloat attribute.
  */
  double getTotalFloat() const;

  /** \details
  Sets the value of TotalFloat attribute. 
  This attribute represents the total time float of the entire work schedule.
  \param TotalFloat [in] Total float to set.
  */
  void setTotalFloat(double TotalFloat);

  /** \details
  Returns the value of StartTime attribute. 
  This attribute represents the start time of the schedule.
  \returns
  Returns the value of StartTime attribute.
  */
  IfcDateTimeSelect startTime();

  /** \details
  Returns the value of FinishTime attribute. 
  This attribute represents the finish time of the schedule.
  \returns
  Returns the value of FinishTime attribute.
  */
  IfcDateTimeSelect finishTime();

  /** \details
  Returns the value of WorkControlType attribute. 
  This attribute represents the predefined work control types from which the required type can be set.
  \returns
  Returns the value of WorkControlType attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  IfcWorkControlTypeEnum getWorkControlType() const;

  /** \details
  Sets the value of WorkControlType attribute. 
  This attribute represents the predefined work control types from which the required type can be set.
  \param WorkControlType [in] Work control type to set.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  void setWorkControlType(IfcWorkControlTypeEnum WorkControlType);

  /** \details
  Returns the value of UserDefinedControlType attribute. 
  This attribute represents a user-defined work control type.
  \returns
  Returns the value of UserDefinedControlType attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  const OdAnsiString& getUserDefinedControlType() const;

  /** \details
  Sets the value of UserDefinedControlType attribute. 
  This attribute represents a user defined work control type.
  \param UserDefinedControlType [in] User-defined control type to set.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  void setUserDefinedControlType(const OdAnsiString& UserDefinedControlType);


public:

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

  /** \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_Identifier;   // IfcIdentifier
  OdDAI::Select m_CreationDate;   // IfcDateTimeSelect
  OdDAI::SetOfOdDAIObjectId m_Creators; // SET [1:?] of IfcPerson [optional]

  OdAnsiString m_Purpose;   // IfcLabel  [optional]
  double m_Duration;   // IfcTimeMeasure  [optional]
  double m_TotalFloat;   // IfcTimeMeasure  [optional]
  OdDAI::Select m_StartTime;   // IfcDateTimeSelect
  OdDAI::Select m_FinishTime;   // IfcDateTimeSelect  [optional]
  OdDAI::Enum m_WorkControlType;   // IfcWorkControlTypeEnum  [optional]
  OdAnsiString m_UserDefinedControlType;   // IfcLabel  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCWORKCONTROL_AUTO_IMPL_H