process_data_dump.h

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <cstdint>
#include <expected>
#include <functional>
#include <ostream>
#include <string>
#include <vector>
 
#include "node/process_data_ring.h"
 
namespace mm::node {
 
 
inline constexpr std::array<char, 4> kDumpMagic = {'M', 'M', 'P', 'D'};
 
inline constexpr uint16_t kDumpFormatVersion = 1;
 
inline constexpr std::streamoff kDumpRowCountOffset = 16;
 
struct DumpPdoEntry {
  uint16_t index = 0;
  uint8_t subindex = 0;
  bool isOutput = false;   
  uint16_t dataType = 0;   
  uint16_t bitLength = 0;  
  uint32_t bitOffset = 0;  
  std::string name;        
};
 
struct DumpDevice {
  uint16_t slavePosition = 0;
  uint32_t vendorId = 0;
  uint32_t productCode = 0;
  uint32_t revisionNumber = 0;
  uint32_t serialNumber = 0;
  std::string name;
  std::vector<DumpPdoEntry> entries;
};
 
struct DumpHeader {
  uint32_t inputBytes = 0;   
  uint32_t outputBytes = 0;  
  std::vector<DumpDevice> devices;
};
 
using DumpRecordReader = std::function<bool(uint64_t seq, ProcessDataRing::Record& out)>;
 
std::expected<uint64_t, std::string> writeProcessDataDump(std::ostream& out,
                                                          const DumpHeader& header,
                                                          uint64_t startSeq, uint64_t endSeq,
                                                          const DumpRecordReader& read);
 
}  // namespace mm::node