ichannelgroup.h

Go to the documentation of this file.

/*
 * Copyright 2021 Ingemar Hedvall
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
#include <algorithm>
#include <string>
#include <vector>
 
#include "ichannel.h"
#include "samplerecord.h"
 
#include "mdf/iblock.h"
#include "mdf/imetadata.h"
 
namespace mdf {
namespace CgFlag {
constexpr uint16_t VlsdChannel = 0x0001;
 
constexpr uint16_t BusEvent = 0x0002;
 
constexpr uint16_t PlainBusEvent = 0x0004;
 
constexpr uint16_t RemoteMaster = 0x0008;
 
constexpr uint16_t EventSignal = 0x00010;
}  // namespace CgFlag
 
class ISourceInformation;
 
class IChannelGroup : public IBlock {
 public:
 
  virtual void RecordId(uint64_t record_id) = 0; 
  [[nodiscard]] virtual uint64_t RecordId() const = 0; 
 
  virtual void Name(const std::string& name) = 0; 
  [[nodiscard]] virtual std::string Name() const = 0; 
 
  virtual void Description(const std::string& description)
      = 0; 
  [[nodiscard]] virtual std::string Description() const = 0; 
 
  [[nodiscard]] virtual uint64_t NofSamples() const
      = 0; 
  virtual void NofSamples(uint64_t nof_samples) = 0; 
 
  [[nodiscard]] virtual uint16_t Flags() const; 
  virtual void Flags(uint16_t flags); 
 
  [[nodiscard]] virtual char16_t PathSeparator(); 
  virtual void PathSeparator(char16_t path_separator); 
 
  [[nodiscard]] virtual std::vector<IChannel*> Channels() const = 0;
 
  [[nodiscard]] virtual IChannel* CreateChannel() = 0;
 
  [[nodiscard]] virtual IChannel* CreateChannel(const std::string_view& name);
 
  [[nodiscard]] virtual IChannel* GetChannel(const std::string_view& name) const;
 
 
  [[nodiscard]] virtual const IChannel* GetXChannel(
      const IChannel& reference) const = 0;
 
  [[nodiscard]] virtual ISourceInformation* CreateSourceInformation();
 
  [[nodiscard]] virtual ISourceInformation* SourceInformation()
      const; 
 
  [[nodiscard]] SampleRecord GetSampleRecord() const;
 
  void ResetSampleCounter() const { sample_ = 0;}
 
  virtual void ClearData(); 
  void IncrementSample() const; 
 
  [[nodiscard]] size_t Sample() const; 
 
  [[nodiscard]] virtual IMetaData* CreateMetaData();
 
  [[nodiscard]] virtual IMetaData* MetaData() const;
 
  [[nodiscard]] virtual const IDataGroup* DataGroup() const = 0;
 
 protected:
  mutable std::vector<uint8_t>
      sample_buffer_;  
 private:
  mutable size_t sample_ = 0;  
};
 
}  // namespace mdf