serialportinfo.h

Go to the documentation of this file.

/*
 * Copyright 2023 Ingemar Hedvall
 * SPDX-License-Identifier: MIT
 */
#pragma once
#include <map>
#include <string>
namespace util::serial {
class SerialPortInfo;
using SerialPortList = std::map<std::string, SerialPortInfo>;

class SerialPortInfo {
 public:
  [[nodiscard]] const std::string& Name() const { return name_; }
  [[nodiscard]] const std::string& DisplayName() const { return display_name_; }
  [[nodiscard]] const std::string& Location() const { return location_; }
  [[nodiscard]] const std::string& Description() const { return description_; }
  [[nodiscard]] const std::string& Manufacturer() const {
    return manufacturer_;
  }

  [[nodiscard]] const std::string& Type() const { return type_; }

  [[nodiscard]] const std::string& ApplicationType() const {
    return application_type_;
  }

  [[nodiscard]] static SerialPortList AvailableSerialPorts();

  [[nodiscard]] static SerialPortList AvailableUsbDevices();
 
 protected:
  std::string name_;              
  std::string display_name_;      
  std::string location_;          
  std::string description_;       
  std::string manufacturer_;      
  std::string type_;              
  std::string address_;           
  std::string application_type_;  
};
 
}  // namespace util::serial