idatagroup.h

Go to the documentation of this file.

/*
 * Copyright 2021 Ingemar Hedvall
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
#include <string>
#include <vector>
#include <map>
 
#include "mdf/iblock.h"
 
 
namespace mdf {
 
class IMetaData;
class ISampleObserver;
class IChannelGroup;
class IChannel;
class IDataGroup : public IBlock {
 public:
 
  virtual void Description(const std::string& desc);
  [[nodiscard]] virtual std::string Description() const;
 
  virtual void RecordIdSize(uint8_t id_size);
  [[nodiscard]] virtual uint8_t RecordIdSize() const;
 
  [[nodiscard]] virtual std::vector<IChannelGroup*> ChannelGroups() const = 0;
 
  [[nodiscard]] virtual IChannelGroup* CreateChannelGroup() = 0;
 
  [[nodiscard]] IChannelGroup* CreateChannelGroup(
      const std::string_view& name);
 
  [[nodiscard]] IChannelGroup* GetChannelGroup(const std::string_view& name) const;
 
  [[nodiscard]] IChannelGroup* GetChannelGroup(uint64_t record_id) const;
 
  [[nodiscard]] virtual IMetaData* CreateMetaData();
  [[nodiscard]] virtual IMetaData* MetaData() const;
 
  void AttachSampleObserver(ISampleObserver* observer) const;
  void DetachSampleObserver(const ISampleObserver* observer) const;
  void DetachAllSampleObservers() const;
  bool NotifySampleObservers(size_t sample, uint64_t record_id,
                             const std::vector<uint8_t>& record) const;
 
  virtual void ClearData();
 
  void SetAsRead(bool mark_as_read = true) const {
    mark_as_read_ = mark_as_read;
  }
 
  [[nodiscard]] bool IsEmpty() const;
 
  [[nodiscard]] bool IsRead() const { return mark_as_read_; }
 
  [[nodiscard]] virtual IChannelGroup *FindParentChannelGroup(
      const IChannel &channel) const = 0;
 
  [[nodiscard]] bool IsSubscribingOnRecord(uint64_t record_id) const;
 
  [[nodiscard]] bool IsSubscribingOnChannel(const IChannel& channel) const;
 
  [[nodiscard]] bool IsSubscribingOnChannelVlsd(const IChannel& channel) const;
 protected:
  mutable std::vector<ISampleObserver*> observer_list_; 
 
  std::map<uint64_t, std::vector<ISampleObserver*> > fast_observer_list_;
 
  ~IDataGroup() override = default; 
 
  void InitFastObserverList();
 
 private:
  mutable bool mark_as_read_ = false; 
 
 
};
 
}  // namespace mdf