buffer_entry_type.h

Go to the documentation of this file.

// Copyright (C) 2021 Christian Brommer, Control of Networked Systems, University of Klagenfurt, Austria.
//
// All rights reserved.
//
// This software is licensed under the terms of the BSD-2-Clause-License with
// no commercial use allowed, the full terms of which are made available
// in the LICENSE file. No license in patents is granted.
//
// You can contact the author at <christian.brommer@ieee.org>
 
#ifndef BUFFERENTRYTYPE_H
#define BUFFERENTRYTYPE_H
 
#include <mars/sensors/sensor_abs_class.h>
#include <mars/time.h>
#include <mars/type_definitions/buffer_data_type.h>
#include <iostream>
#include <set>
 
namespace BufferMetadataTypes
{
enum BufferMetadataType
{
  none,
  invalid,
  init,
  out_of_order,
  auto_add,  
};
}  // namespace BufferMetadataTypes
 
namespace mars
{
using BufferMetadataType = BufferMetadataTypes::BufferMetadataType;
 
class BufferEntryType
{
public:
  Time timestamp_{ 0.0 };
  BufferDataType data_{};
  std::shared_ptr<SensorAbsClass> sensor_handle_{ nullptr };
  int metadata_{ BufferMetadataType::invalid };
 
  BufferEntryType() = default;
 
  BufferEntryType(const Time& timestamp, BufferDataType data, std::shared_ptr<SensorAbsClass> sensor,
                  const int& metadata = BufferMetadataType::none);
 
  bool operator<(const BufferEntryType& rhs) const;
  bool operator<=(const BufferEntryType& rhs) const;
  bool operator>(const BufferEntryType& rhs) const;
  bool operator>=(const BufferEntryType& rhs) const;
  friend std::ostream& operator<<(std::ostream& out, const BufferEntryType& entry);
 
  static std::string get_metadata_label(int label);
 
  bool IsMeasurement() const;
 
  bool IsValid() const;
 
  bool IsAutoGenerated() const;
 
  bool HasStates() const;
 
  void ClearStates();
 
private:
  std::set<int> metadata_valid_filter_;
  std::set<int> metadata_auto_filter_;
};
}  // namespace mars
#endif  // BUFFERENTRYTYPE_H