gsdml.h

Go to the documentation of this file.

 
 
#pragma once
 
#include <cstdint>
#include <map>
#include <optional>
#include <string>
#include <tuple>
#include <vector>
 
#include "profinet/rpc.h"
 
namespace profinet::gsdml
{
 
struct GSDMLBitDataItem
{
  std::uint8_t bitOffset = 0;
  std::string textId;
  std::string name;
};
 
struct GSDMLDataItem
{
  std::string dataType;
  std::string textId;
 
  std::string name;
 
  int length = 0;
 
  int byteOffset = 0;
 
  bool useAsBits = false;
 
  std::vector<GSDMLBitDataItem> bitDataItems;
};
 
struct GSDMLSubmoduleReference
{
  std::string submoduleId;
 
  std::vector<int> allowedSubslots;
 
  std::vector<int> fixedSubslots;
 
  std::vector<int> usedSubslots;
};
 
struct GSDMLSubmodule
{
  std::string id;
  std::uint32_t submoduleIdentNumber = 0;
  std::string name;
  int inputLength = 0;
  int outputLength = 0;
  std::vector<GSDMLDataItem> inputItems;
  std::vector<GSDMLDataItem> outputItems;
 
  std::vector<int> allowedSubslots;
  std::vector<int> fixedSubslots;
  std::vector<int> usedSubslots;
};
 
struct GSDMLModule
{
  std::string id;
  std::uint32_t moduleIdentNumber = 0;
  std::string name;
 
  std::map<std::string, GSDMLSubmodule> submodules;
 
  std::vector<GSDMLSubmoduleReference> submoduleReferences;
 
  std::vector<int> physicalSubslots;
};
 
struct GSDMLSystemSubmodule
{
  std::uint32_t submoduleIdentNumber = 0;
 
  std::uint16_t subslot = 0;
 
  std::string moduleName;
};
 
struct GSDMLModuleReference
{
  std::string moduleId;
 
  std::vector<int> allowedSlots;
 
  std::vector<int> fixedSlots;
 
  std::vector<int> usedSlots;
};
 
struct GSDMLDevice
{
  std::string vendorName;
  std::string deviceName;
  std::uint16_t vendorId = 0;
  std::uint16_t deviceId = 0;
 
  std::string dapModuleId;
  std::string dapModuleName;
  std::string dapModuleInfo;
  std::uint32_t dapSubmoduleIdentNumber = 0;
  std::uint32_t dapModuleIdentNumber = 0;
  std::vector<int> dapSlots;
 
  std::vector<GSDMLSubmodule> dapSubmodules;
 
  std::vector<GSDMLSystemSubmodule> systemSubmodules;
 
  std::map<std::string, GSDMLModule> modules;
 
  std::map<std::string, GSDMLSubmodule> submodules;
 
  std::vector<GSDMLModuleReference> moduleReferences;
 
  rpc::ApplicationRelations applicationRelations;
 
  /*
    std::map<std::string, std::vector<int>> allowedSlots;
    std::vector<std::pair<int, std::string>> fixedModules;
  */
  [[nodiscard]] const GSDMLModule* FindModule(const std::string& moduleId) const;
 
  [[nodiscard]] const GSDMLSubmodule* FindSubmodule(const std::string& submoduleId) const;
 
  [[nodiscard]] std::vector<rpc::IOSlot> BuildIoSlots(const std::vector<std::tuple<int, std::string, int, std::string>>& plugged = {}) const;
};
 
GSDMLDevice ParseGsdml(const std::string& path);
 
GSDMLDevice ParseGsdmlString(const std::string& xml);
 
} // namespace profinet::gsdml