ievent.h

Go to the documentation of this file.

/*
 * Copyright 2022 Ingemar Hedvall
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
#include <mdf/iattachment.h>
#include <mdf/iblock.h>
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace mdf {
enum class EventType : uint8_t {
  RecordingPeriod = 0,       
  RecordingInterrupt = 1,    
  AcquisitionInterrupt = 2,  
  StartRecording = 3,        
  StopRecording = 4,         
  Trigger = 5,               
  Marker = 6                 
};
 
enum class SyncType : uint8_t {
  SyncTime = 1,      
  SyncAngle = 2,     
  SyncDistance = 3,  
  SyncIndex = 4,     
};
 
enum class RangeType : uint8_t {
  RangePoint = 0,  
  RangeStart = 1,  
  RangeEnd = 2     
};
 
enum class EventCause : uint8_t {
  CauseOther = 0,   
  CauseError = 1,   
  CauseTool = 2,    
  CauseScript = 3,  
  CauseUser = 4,    
};
 
class IEvent : public IBlock {
 public:
  virtual void Name(const std::string& name) = 0; 
  [[nodiscard]] virtual const std::string& Name() const = 0; 
 
  virtual void GroupName(const std::string& group_name) = 0;
  [[nodiscard]] virtual const std::string& GroupName() const = 0;
 
 
  virtual void Type(EventType event_type) = 0; 
  [[nodiscard]] virtual EventType Type() const = 0; 
  [[nodiscard]] std::string TypeToString() const; 
 
  virtual void Sync(SyncType sync_type) = 0; 
  [[nodiscard]] virtual SyncType Sync() const = 0; 
 
  virtual void Range(RangeType range_type) = 0; 
  [[nodiscard]] virtual RangeType Range() const = 0; 
  [[nodiscard]] std::string RangeToString() const; 
 
  virtual void Cause(EventCause cause) = 0; 
  [[nodiscard]] virtual EventCause Cause() const = 0; 
  [[nodiscard]] std::string CauseToString() const; 
 
  virtual void CreatorIndex(size_t index) = 0; 
  [[nodiscard]] virtual size_t CreatorIndex() const = 0; 
 
  virtual void SyncValue(int64_t value) = 0; 
  [[nodiscard]] virtual int64_t SyncValue() const = 0; 
 
  virtual void SyncFactor(double factor) = 0; 
  [[nodiscard]] virtual double SyncFactor() const = 0; 
  [[nodiscard]] std::string ValueToString() const; 
 
  virtual void ParentEvent(const IEvent* parent) = 0;
  [[nodiscard]] virtual const IEvent* ParentEvent() const = 0;
 
  virtual void RangeEvent(const IEvent* range_event) = 0;
  [[nodiscard]] virtual const IEvent* RangeEvent() const = 0;
 
  virtual void AddScope(const void* scope) = 0;
  [[nodiscard]] virtual const std::vector<const void*>& Scopes() const = 0;
 
  virtual void AddAttachment(const IAttachment* attachment) = 0;
  [[nodiscard]] virtual const std::vector<const IAttachment*>& Attachments()
      const = 0;
 
  [[nodiscard]] virtual IMetaData* CreateMetaData() = 0;
 
  [[nodiscard]] virtual const IMetaData* MetaData() const = 0;
 
  void Description(const std::string& description); 
  [[nodiscard]] std::string Description() const; 
 
  void PreTrig(double pre_trig); 
 
  [[nodiscard]] double PreTrig() const; 
 
  void PostTrig(double post_trig); 
 
  [[nodiscard]] double PostTrig() const; 
};
 
}  // namespace mdf