IOSignal.h

Go to the documentation of this file.

 
 
#pragma once
 
#include <cstddef>
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
 
#include "profinet/gsdml.h"
 
namespace profinet::io
{
 
enum class IoSignalDirection
{
  Sensor,
  Actuator,
};
 
enum class IoSignalValueType
{
  Boolean,
  SignedInteger,
  UnsignedInteger,
  FloatingPoint,
  Unsupported,
};
 
struct GSDMLBitDataItem
{
  std::size_t bitOffset = 0;
 
  std::string textId;
};
 
struct IoSignal
{
  IoSignalDirection direction = IoSignalDirection::Sensor;
 
  std::string name;
 
  std::string textId;
 
  bool bitSignal = false;
 
  std::size_t bitOffset = 0;
 
  std::size_t parentDataItemByteOffset = 0;
 
  std::string parentDataItemTextId;
 
  std::string gsdmlDataType;
 
  IoSignalValueType valueType = IoSignalValueType::Unsupported;
 
  bool doubleCompatible = false;
 
  std::string moduleId;
 
  std::string moduleName;
 
  std::string submoduleId;
 
  std::string submoduleName;
 
  std::uint32_t moduleIdentNumber = 0;
 
  std::uint32_t submoduleIdentNumber = 0;
 
  std::size_t byteOffset = 0;
 
  std::size_t byteLength = 0;
 
  std::vector<int> possibleSlots;
 
  std::vector<int> possibleSubslots;
 
  [[nodiscard]] bool IsBitSignal() const noexcept;
 
  [[nodiscard]] bool IsSensor() const noexcept;
 
  [[nodiscard]] bool IsActuator() const noexcept;
 
  [[nodiscard]] bool IsDoubleCompatible() const noexcept;
 
  bool operator==(const IoSignal&) const = default;
};
 
class IoSignalCatalog
{
 public:
  [[nodiscard]] static IoSignalCatalog FromGsdml(const gsdml::GSDMLDevice& device);
 
  [[nodiscard]] const std::vector<IoSignal>& Sensors() const noexcept;
 
  [[nodiscard]] const std::vector<IoSignal>& Actuators() const noexcept;
 
  [[nodiscard]] std::size_t Size() const noexcept;
 
 private:
  std::vector<IoSignal> sensors;
  std::vector<IoSignal> actuators;
};
 
[[nodiscard]] IoSignalValueType ClassifyDataType(std::string_view dataType) noexcept;
 
[[nodiscard]] bool IsReservedSignal(std::string_view textId, std::string_view name) noexcept;
 
[[nodiscard]] bool IsReservedSignal(std::string_view textId, std::string_view bitId, std::string_view name) noexcept;
 
} // namespace profinet::io