IOSignal.h File Reference

Defines the GSDML-derived logical process-data signal catalogue. More...

#include <cstddef>
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
#include "profinet/gsdml.h"

Include dependency graph for IOSignal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	profinet::io::GSDMLBitDataItem
	One bit-defined logical signal within a GSDML DataItem. More...
struct	profinet::io::IoSignal
	Describes one logical process-data signal available from a GSDML device. More...
class	profinet::io::IoSignalCatalog
	Builds and owns the logical sensor and actuator signals described by a GSDML device. More...

Namespaces
namespace	profinet
namespace	profinet::io

Enumerations
enum class	profinet::io::IoSignalDirection { profinet::io::Sensor , profinet::io::Actuator }
	Logical direction of a process-data signal from the controller's perspective. More...
enum class	profinet::io::IoSignalValueType {   profinet::io::Boolean , profinet::io::SignedInteger , profinet::io::UnsignedInteger , profinet::io::FloatingPoint ,   profinet::io::Unsupported }
	Logical value category used when exposing a signal to higher layers. More...

Functions
IoSignalValueType	profinet::io::ClassifyDataType (std::string_view dataType) noexcept
	Classify a GSDML DataType into a logical connector value category.
bool	profinet::io::IsReservedSignal (std::string_view textId, std::string_view name) noexcept
	Determine whether a DataItem should be hidden from the normal signal catalogue.
bool	profinet::io::IsReservedSignal (std::string_view textId, std::string_view bitId, std::string_view name) noexcept
	Determine whether a DataItem should be hidden from the normal signal catalogue.

Detailed Description

Defines the GSDML-derived logical process-data signal catalogue.

The signal catalogue is an intermediate representation between the parsed GSDML device description and the later configured cyclic-I/O mapping.

It deliberately contains no runtime process-data values, DataStatus, TransferStatus, socket handling, IOCR frame offsets, or cyclic-controller dependencies. The byte offset stored by this class is local to the submodule's process-data area and is calculated from the GSDML DataItem order.

Definition in file IOSignal.h.