Channel.hpp

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <string>
 
#include "Types.hpp"
 
using SizeType = AQNWB::Types::SizeType;
 
namespace AQNWB
{
class Channel
{
public:
  Channel(const std::string name,
          const std::string groupName,
          const SizeType groupIndex,
          const SizeType localIndex,
          const SizeType globalIndex,
          const float conversion = 1e6f,  // uV to V
          const float samplingRate = 30000.f,  // placeholder
          const float bitVolts = 0.05f,  // least significant bit needed to
                                         // convert 16-bit int to volts
                                         // currently a placeholder
          const std::array<float, 3> position = {0.f, 0.f, 0.f},
          const std::string comments = "no comments");

  ~Channel();

  Channel(const Channel& other) = default;

  Channel(Channel&& other) = default;

  Channel& operator=(const Channel& other) = default;

  Channel& operator=(Channel&& other) = default;

  inline float getConversion() const { return m_bitVolts / m_conversion; }

  inline float getSamplingRate() const { return m_samplingRate; }

  inline float getBitVolts() const { return m_bitVolts; }

  inline std::string getGroupName() const { return m_groupName; }

  inline std::string getName() const { return m_name; }

  inline SizeType getGroupIndex() const { return m_groupIndex; }

  inline SizeType getLocalIndex() const { return m_localIndex; }

  inline SizeType getGlobalIndex() const { return m_globalIndex; }

  inline const std::array<float, 3>& getPosition() const { return m_position; }

  inline std::string getComments() const { return m_comments; }

  inline void setComments(const std::string& comments)
  {
    m_comments = comments;
  }

  inline void setPosition(const std::array<float, 3>& position)
  {
    m_position = position;
  }

  inline void setName(const std::string& name) { m_name = name; }
 
private:
  std::string m_name;

  std::string m_groupName;

  SizeType m_groupIndex;

  SizeType m_localIndex;

  SizeType m_globalIndex;

  float m_conversion;

  float m_samplingRate;

  float m_bitVolts;

  std::array<float, 3> m_position;

  std::string m_comments;
};
}  // namespace AQNWB