ESPEasy_EventStruct.h

#ifndef DATASTRUCTS_ESPEASY_EVENTSTRUCT_H
#define DATASTRUCTS_ESPEASY_EVENTSTRUCT_H

#include "../../ESPEasy_common.h"

#include "../DataTypes/ControllerIndex.h"
#include "../DataTypes/EventValueSource.h"
#include "../DataTypes/TaskIndex.h"
#include "../DataTypes/NotifierIndex.h"
#include "../DataStructs/DeviceStruct.h"


/*********************************************************************************************\
* EventStruct
* This should not be copied, only moved.
* When copy is really needed, use deep_copy
\*********************************************************************************************/
struct EventStruct
{
  EventStruct() = default;
  // Delete the copy constructor
  EventStruct(const struct EventStruct& event) = delete;
private:
  // Hide the copy assignment operator by making it private
  EventStruct& operator=(const EventStruct&) = default; 

public:
  EventStruct(struct EventStruct&& event) = default;
  EventStruct& operator=(struct EventStruct&& other) = default;

  explicit EventStruct(taskIndex_t taskIndex);

  // Explicit deep_copy function to make sure this object is not accidentally copied using the copy-constructor
  // Copy constructor and assignment operator should not be used.
  void deep_copy(const struct EventStruct& other);
  void deep_copy(const struct EventStruct* other);
  //  explicit EventStruct(const struct EventStruct& event);
  //  EventStruct& operator=(const struct EventStruct& other);


  void setTaskIndex(taskIndex_t taskIndex);

  void clear();

  // Check (and update) sensorType if not set, plus return (corrected) sensorType
  Sensor_VType getSensorType();

  String        String1;
  String        String2;
  String        String3;
  String        String4;
  String        String5;
  unsigned long timestamp = 0u;
  uint8_t      *Data = nullptr;
  int           idx  = 0;
  int           Par1 = 0;
  int           Par2 = 0;
  int           Par3 = 0;
  int           Par4 = 0;
  int           Par5 = 0;

  // The origin of the values in the event. See EventValueSource.h
  EventValueSource::Enum Source            = EventValueSource::Enum::VALUE_SOURCE_NOT_SET;
  taskIndex_t            TaskIndex         = INVALID_TASK_INDEX;       // index position in TaskSettings array, 0-11
  controllerIndex_t      ControllerIndex   = INVALID_CONTROLLER_INDEX; // index position in Settings.Controller, 0-3
#if FEATURE_NOTIFIER
  notifierIndex_t        NotificationIndex = INVALID_NOTIFIER_INDEX;   // index position in Settings.Notification, 0-3
#endif
  uint8_t                BaseVarIndex      = 0;
  Sensor_VType           sensorType        = Sensor_VType::SENSOR_TYPE_NOT_SET;
  uint8_t                OriginTaskIndex   = 0;
};

#endif // DATASTRUCTS_ESPEASY_EVENTSTRUCT_H