/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCCOSTSCHEDULE_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCCOSTSCHEDULE_AUTO_IMPL_H

#include "IfcControlAutoImpl.h"
#include "IfcPersonAutoImpl.h"
#include "IfcCalendarDateAutoImpl.h"
#include "IfcCostValueAutoImpl.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 IfcCostSchedule brings together instances of IfcCostItem either for the purpose of 
  identifying purely cost information as in an estimate for constructions costs 
  or for including cost information within another presentation form such as a work order.
  
  - Approval -
  Approvals can be associated to indicate the status of acceptance or rejection using the IfcRelAssociatesApproval relationship 
  where RelatingApproval refers to an IfcApproval and RelatedObjects contains the IfcCostSchedule. 
  Approvals can be split into sub-approvals using IfcApprovalRelationship to track approval status separately for each party 
  where RelatingApproval refers to the higher-level approval and RelatedApprovals contains one or more lower-level approvals. 
  The hierarchy of approvals implies sequencing such that a higher-level approval is not executed until all of its lower-level approvals have been accepted.
  
  - Control Assignment -
  The Control Assignment concept applies to this entity.
  The IfcCostSchedule can be assigned to the following entities using relationships as indicated:
  * IfcActor (IfcRelAssignsToActor): Persons and organizations involved in the preparation, submittal, and as target users.
  
  The IfcCostSchedule can have assignments of its own using the IfcRelAssignsToControl relationship 
  where RelatingControl refers to the IfcCostSchedule and RelatedObjects contains one or more objects of the following types:
  * IfcCostItem: Indicates costs published within this cost schedule, typically a single root cost item forming a hierarchy of nested cost items.
*/
class IFC2X_FINAL_EXPORT IfcCostSchedule : public IfcControl
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcCostSchedule);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Title attribute. 
  This attribute represents the name by which the cost schedule is known.
  \returns
  Returns the value of Title attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  const OdAnsiString& getTitle() const;

  /** \details
  Sets the value of Title attribute. 
  This attribute represents the name by which the cost schedule is known.
  \param Title [in] Title to set.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  void setTitle(const OdAnsiString& Title);

  /** \details
  Returns the value of SubmittedBy attribute. 
  This attribute represents an actor by which a cost schedule is submitted.
  \returns
  Returns the value of SubmittedBy attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  IfcActorSelect submittedBy();

  /** \details
  Returns the value of ApprovedBy attribute. 
  This attribute represents an actor by which a cost schedule is approved.
  \param ApprovedBy [out] Receives the ApprovedBy attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  void getApprovedBy(OdArray<OdDAI::Select >& ApprovedBy) const;

  /** \details
  Returns the value of ApprovedBy attribute. 
  This attribute represents an actor by which a cost schedule is approved.
  \param ApprovedBy [out] Receives the ApprovedBy attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  void getApprovedByWrapperArray(OdArray<IfcActorSelect>& ApprovedBy) const;

  /** \details
  Returns the value of ApprovedBy attribute. 
  This attribute represents an actor by which a cost schedule is approved.
  \returns
  Returns the value of ApprovedBy attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  OdDAI::SetOfSelect& approvedBy();

  /** \details
  Returns the value of PreparedBy attribute. 
  This attribute represents an actor by which a cost schedule is prepared.
  \returns
  Returns the value of PreparedBy attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  const OdDAIObjectId& getPreparedBy() const;

  /** \details
  Sets the value of PreparedBy attribute. 
  This attribute represents an actor by which a cost schedule is prepared.
  \param PreparedBy [in] Actor by which the costs schedule is prepared.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  void setPreparedBy(const OdDAIObjectId& PreparedBy);

  /** \details
  Returns the value of SubmittedOn attribute. 
  This attribute represents the date and time on which the cost schedule was submitted.
  \returns
  Returns the value of SubmittedOn attribute.
  */
  const OdDAIObjectId& getSubmittedOn() const;

  /** \details
  Sets the value of SubmittedOn attribute. 
  This attribute represents the date and time on which the cost schedule was submitted.
  \param SubmittedOn [in] Value of the attribute to set.
  */
  void setSubmittedOn(const OdDAIObjectId& SubmittedOn);

  /** \details
  Returns the value of TotalCost attribute. 
  This attribute represents the total cost on the schedule.
  \returns
  Returns the value of TotalCost attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  const OdDAIObjectId& getTotalCost() const;

  /** \details
  Sets the value of TotalCost attribute. 
  This attribute represents the total cost on the schedule.
  \param TotalCost [in] Schedule number to set.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  void setTotalCost(const OdDAIObjectId& TotalCost);

  /** \details
  Gets the value of CostElements attribute. 
  This attribute represents the individual elements that form the cost schedule.
  \param CostElements [out] Receives the CostElements attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  void getCostElements(OdDAIObjectIds& CostElements) const;

  /** \details
  Returns the value of CostElements attribute. 
  This attribute represents the individual elements that form the cost schedule.
  \returns
  Returns the value of CostElements attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  OdDAI::ListOfOdDAIObjectId& costElements();

  /** \details
  Returns the value of Status attribute. 
  This attribute represents the current status of a cost schedule. 
  Examples of status values that might be used for a cost schedule status include:
  * PLANNED
  * APPROVED
  * AGREED
  * ISSUED
  * STARTED
  \returns
  Returns the value of Status attribute.
  */
  const OdAnsiString& getStatus() const;

  /** \details
  Sets the value of Status attribute.
  This attribute represents the current status of a cost schedule. 
  Examples of status values that might be used for a cost schedule status include:
  * PLANNED
  * APPROVED
  * AGREED
  * ISSUED
  * STARTED
  \param Status [in] Status to set.
  */
  void setStatus(const OdAnsiString& Status);

  /** \details
  Returns the value of IntendedUse attribute. 
  This attribute represents the intended use for the cost schedule.
  \returns
  Returns the value of IntendedUse attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  const OdAnsiString& getIntendedUse() const;

  /** \details
  Sets the value of IntendedUse attribute. 
  This attribute represents the intended use for the cost schedule.
  \param IntendedUse [in] Intended use to set.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  void setIntendedUse(const OdAnsiString& IntendedUse);

  /** \details
  Gets the value of Comments attribute. 
  This attribute represents the assumptions, qualifications, conditions, and other context information for the cost schedule.
  \param Comments [in] Receives the Comments attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  void getComments(OdArray<OdAnsiString >& Comments) const;

  /** \details
  Returns the value of Comments attribute. 
  This attribute represents the assumptions, qualifications, conditions, and other context information for the cost schedule.
  \returns
  Returns the value of Comments attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  OdDAI::ListOfOdAnsiString& comments();

  /** \details
  Returns the value of TargetUsers attribute. 
  This attribute represents the actors for whom the cost schedule was prepared.
  \param TargetUsers [out] Receives the TargetUsers attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  void getTargetUsers(OdArray<OdDAI::Select >& TargetUsers) const;

  /** \details
  Returns the value of TargetUsers attribute. 
  This attribute represents the actors for whom the cost schedule was prepared.
  \param TargetUsers [out] Receives the TargetUsers attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  void getTargetUsersWrapperArray(OdArray<IfcActorSelect>& TargetUsers) const;

  /** \details
  Returns the value of TargetUsers attribute. 
  This attribute represents the actors for whom the cost schedule was prepared.
  \returns
  Returns the value of TargetUsers attribute.
  \remarks
  IFC4 CHANGE: The attribute has been removed.
  */
  OdDAI::SetOfSelect& targetUsers();

  /** \details
  Returns the value of ValidFromDate attribute. 
  This attribute represents the commencing date from which a cost schedule is valid.
  \returns
  Returns the value of ValidFromDate attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  const OdDAIObjectId& getValidFromDate() const;

  /** \details
  Sets the value of ValidFromDate attribute. 
  This attribute represents the commencing date from which a cost schedule is valid.
  \param ValidFromDate [in] ValidFromDate attribute to set.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  void setValidFromDate(const OdDAIObjectId& ValidFromDate);

  /** \details
  Returns the value of ValidToDate attribute. 
  This attribute represents the terminating date on which a cost schedule is valid.
  \returns
  Returns the value of ValidToDate attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  const OdDAIObjectId& getValidToDate() const;

  /** \details
  Sets the value of ValidToDate attribute. 
  This attribute represents the terminating date on which a cost schedule is valid.
  \param ValidToDate [in] ValidToDate attribute to set.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  void setValidToDate(const OdDAIObjectId& ValidToDate);

  /** \details
  Returns the value of UpdateDate attribute. 
  This attribute represents the date and time that this cost schedule is updated; 
  this allows tracking the schedule history.
  \returns
  Returns the value of UpdateDate attribute.
  */
  const OdDAIObjectId& getUpdateDate() const;

  /** \details
  Sets the value of UpdateDate attribute. 
  This attribute represents the date and time that this cost schedule is updated; 
  this allows tracking the schedule history.
  \param UpdateDate [in] Update date to set.
  */
  void setUpdateDate(const OdDAIObjectId& UpdateDate);

  /** \details
  Returns the value of ScheduleNumber attribute. 
  This attribute represents the terminating date on which a cost schedule is valid.
  \returns
  Returns the value of ScheduleNumber attribute.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  const OdAnsiString& getScheduleNumber() const;

  /** \details
  Sets the value of ScheduleNumber attribute. 
  This attribute represents the terminating date on which a cost schedule is valid.
  \param ScheduleNumber [in] Schedule number to set.
  \remarks
  IFC2x2_FINAL CHANGE: The attribute has been removed.
  */
  void setScheduleNumber(const OdAnsiString& ScheduleNumber);


public:

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

  /** \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: 
  OdAnsiString m_Title;   // IfcLabel
  OdDAI::Select m_SubmittedBy;   // IfcActorSelect  [optional]
  OdDAI::SetOfSelect m_ApprovedBy; // SET [1:?] of IfcActorSelect [optional]

  OdDAIObjectId m_PreparedBy;   // IfcPerson
  OdDAIObjectId m_SubmittedOn;   // IfcCalendarDate  [optional]
  OdDAIObjectId m_TotalCost;   // IfcCostValue
  OdDAI::ListOfOdDAIObjectId m_CostElements; // LIST [1:?] of IfcCost [optional]

  OdAnsiString m_Status;   // IfcLabel
  OdAnsiString m_IntendedUse;   // IfcText  [optional]
  OdDAI::ListOfOdAnsiString m_Comments; // LIST [1:?] of IfcText [optional]

  OdDAI::SetOfSelect m_TargetUsers; // SET [1:?] of IfcActorSelect [optional]

  OdDAIObjectId m_ValidFromDate;   // IfcCalendarDate  [optional]
  OdDAIObjectId m_ValidToDate;   // IfcCalendarDate  [optional]
  OdDAIObjectId m_UpdateDate;   // IfcCalendarDate  [optional]
  OdAnsiString m_ScheduleNumber;   // IfcIdentifier
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCCOSTSCHEDULE_AUTO_IMPL_H