/////////////////////////////////////////////////////////////////////////////// 
// 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_RC1_IFCEVENT_AUTO_IMPL_H
#define _IFC4X3_RC1_IFCEVENT_AUTO_IMPL_H

#include "IfcProcessAutoImpl.h"
#include "IfcEventTimeAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcEvent is used to capture information about particular things that happen or that can happen. 
  Particularly used in work plans (or process maps) they identify e.g. a point at which 
  a message containing information can be issued or at which a rule or constraint is invoked.
  
  - Nesting -
  IfcEvent can be contained within an IfcTask using the IfcRelNests relationship. 
  The event is considered active during the time period of the enclosing task (including any assigned IfcWorkCalendar); 
  that is such event can be triggered within the task time period but not outside of it. 
  As an IfcEvent is considered to be atomic, no use is anticipated for nesting processes inside the event.
  
  - Sequential Connectivity -
  The relationship IfcRelSequence is used to indicate control flow. An IfcEvent as a predecessor (IfcRelSequence.RelatingProcess) 
  indicates that the succeeding process (typically IfcProcedure or IfcTask) is triggered in response to the event. 
  An IfcEvent as a successor (IfcRelSequence.RelatedProcess) indicates that the completion of the preceding process causes the event to be triggered. 
  As events have zero duration, the IfcRelSequence.SequenceType attribute has no effect on 
  an IfcEvent but still applies to the opposite end of the relationship if IfcTask is used.
  
  - Control Assignment -
  An IfcEvent can be assigned to an IfcWorkCalendar to indicate times when such event is active using IfcRelAssignsToControl; 
  otherwise the effective calendar is determined by the nearest IfcProcess ancestor with a calendar assigned.
  
  - Product Assignment -
  For building operation scenarios, IfcEvent can be assigned to a product (IfcElement subtype) 
  using IfcRelAssignsToProduct to indicate a specific product occurrence that sources the event.
  * EXAMPLE:  An IfcSensor for a motion sensor can have a "Motion Sensed" event. 
    If the IfcEvent is defined by an IfcEventType and the IfcEventType is assigned to a product type (using IfcRelAssignsToProduct), 
    then the IfcEvent must be assigned to one or more occurrences of the specified product type using IfcRelAssignsToProduct.
*/
class IFC4X3_RC1_EXPORT IfcEvent : public IfcProcess
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcEvent);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents the predefined types of an event from which the required type can be set.
  \returns
  Returns the value of PredefinedType attribute.
  */
  IfcEventTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents the predefined types of an event from which the required type can be set.
  \param PredefinedType [in] Predefined type to set.
  */
  void setPredefinedType(IfcEventTypeEnum PredefinedType);

  /** \details
  Returns the value of EventTriggerType attribute. 
  This attribute represents the predefined types of event trigger from which the required type can be set.
  \returns
  Returns the value of EventTriggerType attribute.
  */
  IfcEventTriggerTypeEnum getEventTriggerType() const;

  /** \details
  Sets the value of EventTriggerType attribute. 
  This attribute represents the predefined types of event trigger from which the required type can be set.
  \param EventTriggerType [in] Event trigger type to set.
  */
  void setEventTriggerType(IfcEventTriggerTypeEnum EventTriggerType);

  /** \details
  Returns the value of UserDefinedEventTriggerType attribute. 
  This attribute represents a user defined event trigger type, 
  the value of which is asserted when the value of an event trigger type is declared as USERDEFINED.
  \returns
  Returns the value of UserDefinedEventTriggerType attribute.
  */
  const OdAnsiString& getUserDefinedEventTriggerType() const;

  /** \details
  Sets the value of UserDefinedEventTriggerType attribute. 
  This attribute represents a user defined event trigger type, 
  the value of which is asserted when the value of an event trigger type is declared as USERDEFINED.
  \param UserDefinedEventTriggerType [in] User-defined event triggerType to set.
  */
  void setUserDefinedEventTriggerType(const OdAnsiString& UserDefinedEventTriggerType);

  /** \details
  Returns the value of EventOccurenceTime attribute. 
  This attribute represents the date and/or time at which an event occurs.
  \returns
  Returns the value of EventOccurenceTime attribute.
  */
  const OdDAIObjectId& getEventOccurenceTime() const;

  /** \details
  Sets the value of EventOccurenceTime attribute. 
  This attribute represents the date and/or time at which an event occurs.
  \param EventOccurenceTime [in] Event occurrence time to set.
  */
  void setEventOccurenceTime(const OdDAIObjectId& EventOccurenceTime);


public:

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

  /** \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;   // IfcEventTypeEnum  [optional]
  OdDAI::Enum m_EventTriggerType;   // IfcEventTriggerTypeEnum  [optional]
  OdAnsiString m_UserDefinedEventTriggerType;   // IfcLabel  [optional]
  OdDAIObjectId m_EventOccurenceTime;   // IfcEventTime  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCEVENT_AUTO_IMPL_H