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

#include "Ifc4x3BaseClass.h"

#include "Ifc4x3Enum.h"
#include "Ifc4x3SelectTypes.h"
#include "Ifc4x3CollectionTypes.h"

#include "TD_PackPush.h"

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

/** \details
  An IfcApproval represents information about approval processes such as for a plan, a design, a proposal, 
  or a change order in a construction or facilities management project. 
  IfcApproval is referenced by IfcRelAssociatesApproval in IfcControlExtension schema, 
  and thereby can be related to all subtypes of IfcRoot. 
  An approval can also be provided to resource objects using IfcResourceApprovalRelationship.

  \changes
  
  * IFC4 changes: 
    * Attribute ApprovalDateTime renamed to Name
    * Attribute ApprovalDateTime made optional, changed from "False" to "True"
    * Type of the ApprovalDateTime attribute changed from "IfcDateTimeSelect" to "IfcLabel"
    * Attribute ApprovalLevel renamed to TimeOfApproval
    * Type of the ApprovalLevel attribute changed from "IfcLabel" to "IfcDateTime"
    * Attribute ApprovalQualifier renamed to Status
    * Type of the ApprovalQualifier attribute changed from "IfcText" to "IfcLabel"
    * Attribute Identifier renamed to Qualifier
    * Attribute Identifier made optional, changed from "False" to "True"
    * Type of the Identifier attribute changed from "IfcIdentifier" to "IfcText"
    * Attribute Name renamed to Level
    * Attribute Name made optional changed from "False" to "True"
    * Inverse attribute Actors renamed to HasExternalReferences
    * Type of the inverse attribute Actors changed from "SET OF [0:?] IfcApprovalActorRelationship FOR Approval" to "SET OF [0:?] IfcExternalReferenceRelationship FOR RelatedResourceObjects"
    * Attribute IsRelatedWith renamed to ApprovedObjects
    * Type of the inverse attribute IsRelatedWith changed from "SET OF [0:?] IfcApprovalRelationship FOR RelatedApproval" to "SET OF [0:?] IfcRelAssociatesApproval FOR RelatingApproval"
*/
class IFC4X3_EXPORT IfcApproval : public OdIfc4x3Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcApproval);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Identifier attribute. 
  This attribute represents a computer-interpretable identifier by which the approval is known.
  \returns
  Returns the value of Identifier attribute.
  */
  const OdAnsiString& getIdentifier() const;

  /** \details
  Sets the value of Identifier attribute. 
  This attribute represents a computer-interpretable identifier by which the approval is known.
  \param Identifier [in] Identifier to set.
  */
  void setIdentifier(const OdAnsiString& Identifier);

  /** \details
  Returns the value of Name attribute. 
  This attribute represents a human-readable name provided to an approval.
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute. 
  This attribute represents a human-readable name provided to an approval.
  \param Name [in] Name to set.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the value of Description attribute. 
  This attribute represents a general textual description of a design, work task, plan, etc. that is being approved for.
  \returns
  Returns the value of Description attribute.
  */
  const OdAnsiString& getDescription() const;

  /** \details
  Sets the value of Description attribute. 
  This attribute represents a general textual description of a design, work task, plan, etc. that is being approved for.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of TimeOfApproval attribute. 
  This attribute represents date and time when the result of the approval process is produced.
  \returns
  Returns the value of TimeOfApproval attribute.
  */
  const OdAnsiString& getTimeOfApproval() const;

  /** \details
  Sets the value of TimeOfApproval attribute. 
  This attribute represents date and time when the result of the approval process is produced.
  \param TimeOfApproval [in] Time of approval to set.
  */
  void setTimeOfApproval(const OdAnsiString& TimeOfApproval);

  /** \details
  Returns the value of Status attribute. 
  This attribute represents the result or current status of the approval, e.g. Requested, Processed, Approved, Not Approved.
  \returns
  Returns the value of Status attribute.
  */
  const OdAnsiString& getStatus() const;

  /** \details
  Sets the value of Status attribute. 
  This attribute represents the result or current status of the approval, e.g. Requested, Processed, Approved, Not Approved.
  \param Status [in] Status to set.
  */
  void setStatus(const OdAnsiString& Status);

  /** \details
  Returns the value of Level attribute. 
  This attribute represents level of the approval e.g. Draft vs Completed design.
  \returns
  Returns the value of Level attribute.
  */
  const OdAnsiString& getLevel() const;

  /** \details
  Sets the value of Level attribute. 
  This attribute represents level of the approval e.g. Draft vs Completed design.
  \param Level [in] Level to set.
  */
  void setLevel(const OdAnsiString& Level);

  /** \details
  Returns the value of Qualifier attribute. 
  This attribute represents textual description of special constraints or conditions for the approval.
  \returns
  Returns the value of Qualifier attribute.
  */
  const OdAnsiString& getQualifier() const;

  /** \details
  Sets the value of Qualifier attribute. 
  This attribute represents textual description of special constraints or conditions for the approval.
  \param Qualifier [in] Qualifier to set.
  */
  void setQualifier(const OdAnsiString& Qualifier);

  /** \details
  Returns the value of RequestingApproval attribute. 
  This attribute represents the actor that is acting in the role specified at IfcOrganization 
  or individually at IfcPerson and requesting an approval.
  \returns
  Returns the value of RequestingApproval attribute.
  */
  IfcActorSelect requestingApproval();

  /** \details
  Returns the value of GivingApproval attribute. 
  This attribute represents the actor that is acting in the role specified at IfcOrganization 
  or individually at IfcPerson and giving an approval.
  \returns
  Returns the value of GivingApproval attribute.
  */
  IfcActorSelect givingApproval();

  /** \details
  Returns the value of HasExternalReferences attribute. 
  This attribute represents reference to external references, e.g. library, 
  classification, or document information, that are associated to the Approval.
  \param HasExternalReferences [out] Receives the value of HasExternalReferences attribute.
  */
  void getInvHasExternalReferences(OdDAIObjectIds& HasExternalReferences) const;

  /** \details
  Returns the value of ApprovedObjects attribute. 
  This attribute represents reference to the IfcRelAssociatesApproval instances associating this approval to objects (subtypes of IfcRoot)
  \param ApprovedObjects [out] Receives the value of ApprovedObjects attribute.
  */
  void getInvApprovedObjects(OdDAIObjectIds& ApprovedObjects) const;

  /** \details
  Returns the value of ApprovedResources attribute. 
  This attribute represents the set of relationships by which resource objects that are approved by this approval are known.
  \param ApprovedResources [out] Receives the value of ApprovedResources attribute.
  */
  void getInvApprovedResources(OdDAIObjectIds& ApprovedResources) const;

  /** \details
  Returns the value of IsRelatedWith attribute. 
  This attribute represents the set of relationships by which this approval is related to others.
  \param IsRelatedWith [out] Receives the value of IsRelatedWith attribute.
  */
  void getInvIsRelatedWith(OdDAIObjectIds& IsRelatedWith) const;

  /** \details
  Returns the value of Relates attribute. 
  This attribute represents the set of relationships by which other approvals are related to this one.
  \param Relates [out] Receives the value of Relates attribute.
  */
  void getInvRelates(OdDAIObjectIds& Relates) const;


public:

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

  /** \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  [optional]
  OdAnsiString m_Name;   // IfcLabel  [optional]
  OdAnsiString m_Description;   // IfcText  [optional]
  OdAnsiString m_TimeOfApproval;   // IfcDateTime  [optional]
  OdAnsiString m_Status;   // IfcLabel  [optional]
  OdAnsiString m_Level;   // IfcLabel  [optional]
  OdAnsiString m_Qualifier;   // IfcText  [optional]
  OdDAI::Select m_RequestingApproval;   // IfcActorSelect  [optional]
  OdDAI::Select m_GivingApproval;   // IfcActorSelect  [optional]

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCAPPROVAL_AUTO_IMPL_H