/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCPERMIT_AUTO_IMPL_H
#define _IFC4_IFCPERMIT_AUTO_IMPL_H

#include "IfcControlAutoImpl.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 permit is a permission to perform work in places and on artifacts where regulatory, 
  security or other access restrictions apply.
  
  - 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 IfcPermit. 
  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.
  
  - Property Sets for Objects -
  The Property Sets for Objects concept template applies to this entity under <em>Pset_Permit</em> name as shown in table below:
  <table>
  <b>Template</b>               <b>PropertyName</b>                 <b>Value</b>
  Single Value                  EscortRequirement                   IfcBoolean
  Single Value                  StartDate                           IfcDateTime
  Single Value                  EndDate                             IfcDateTime
  Single Value                  SpecialRequirements                 IfcText
  </table>
  
  - Nesting -
  The Object Nesting concept template applies to this entity as shown in the table below:
  <table>
  <b>Type</b>               <b>Description</b>
  IfcPermit                 A permit can be nested to indicate permit amendments, in order of issue
  </table>
  
  - Control Assignment -
  The figure below illustrates assignment relationships as indicated:
  * IfcActor (IfcRelAssignsToActor): Organization issuing the permit such as a local government agency or security organization.
  <IMAGE ifcpermit-assignment>
  
  The IfcPermit can have assignments of its own using the IfcRelAssignsToControl relationship 
  where RelatingControl refers to the IfcPermit and RelatedObjects contains one or more objects of the following types:
  * IfcActor: Organization(s) bound to the permit, typically a single contractor.

  \changes
  
  * IFC4 changes: 
    Attribute PermitID renamed to Identification and promoted to supertype IfcControl.
*/
class IFC4_EXPORT IfcPermit : public IfcControl
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcPermit);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents the predefined types of permit that can be granted.
  \returns
  Returns the value of PredefinedType attribute.
  \remarks
  IFC4 CHANGE: The attribute has been added.
  */
  IfcPermitTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents the predefined types of permit that can be granted.
  \param PredefinedType [in] Predefined type to set.
  \remarks
  IFC4 CHANGE: The attribute has been added.
  */
  void setPredefinedType(IfcPermitTypeEnum PredefinedType);

  /** \details
  Returns the value of Status attribute. 
  This attribute represents the status currently assigned to the permit.
  \returns
  Returns the value of Status attribute.
  \remarks
  IFC4 CHANGE: The attribute has been added.
  */
  const OdAnsiString& getStatus() const;

  /** \details
  Sets the value of Status attribute. 
  This attribute represents the status currently assigned to the permit.
  \param Status [in] Status to set.
  \remarks
  IFC4 CHANGE: The attribute has been added.
  */
  void setStatus(const OdAnsiString& Status);

  /** \details
  Returns the value of LongDescription attribute. 
  This attribute represents detailed description of the request.
  \returns
  Returns the value of LongDescription attribute.
  \remarks
  IFC4 CHANGE: The attribute has been added.
  */
  const OdAnsiString& getLongDescription() const;

  /** \details
  Sets the value of LongDescription attribute. 
  This attribute represents detailed description of the request.
  \param LongDescription [in] Long description to set.
  \remarks
  IFC4 CHANGE: The attribute has been added.
  */
  void setLongDescription(const OdAnsiString& LongDescription);


public:

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

  /** \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: 
  OdDAI::Enum m_PredefinedType;   // IfcPermitTypeEnum  [optional]
  OdAnsiString m_Status;   // IfcLabel  [optional]
  OdAnsiString m_LongDescription;   // IfcText  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCPERMIT_AUTO_IMPL_H