PROFINET IO Controller Stack 1.0.0
Modern C++ implementation of a PROFINET IO Controller stack
Loading...
Searching...
No Matches
profinet::PNInM1 Struct Reference

I&M1: user-assigned tag function and location strings. More...

#include <protocol.h>

+ Collaboration diagram for profinet::PNInM1:

Public Member Functions

bool operator== (const PNInM1 &) const =default
 Compares two PNInM1 for equality.
 

Static Public Member Functions

static PNInM1 Parse (const Bytes &data)
 Parse an I&M1 record from raw bytes.
 

Public Attributes

std::array< std::uint8_t, blockHeaderLenghtblockHeader {}
 Nested 6-byte block header.
 
std::string imTagFunction
 User-assigned function description (32 chars).
 
std::string imTagLocation
 User-assigned installation location (22 chars).
 

Static Public Attributes

static constexpr std::uint16_t IDX = 0xAFF1
 Record data index for I&M1.
 
static constexpr std::size_t kSize = 60
 Size in bytes of this record.
 

Detailed Description

I&M1: user-assigned tag function and location strings.

Definition at line 1177 of file protocol.h.

Member Function Documentation

◆ operator==()

bool profinet::PNInM1::operator== ( const PNInM1 ) const
default

Compares two PNInM1 for equality.

Two PNInM1 are equal when all scalar configuration fields are equal.

◆ Parse()

static PNInM1 profinet::PNInM1::Parse ( const Bytes data)
inlinestatic

Parse an I&M1 record from raw bytes.

Parameters
dataBytes starting at the BlockHeader field.
Returns
The parsed record.

Definition at line 1199 of file protocol.h.

References blockHeader, profinet::blockHeaderLenght, profinet::DecodeBytes(), profinet::wire::Reader::Fixed(), imTagFunction, imTagLocation, kSize, and profinet::wire::Reader::ReadBytes().

Referenced by profinet::rpc::RPCCon::ReadIm1().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ blockHeader

std::array<std::uint8_t, blockHeaderLenght> profinet::PNInM1::blockHeader {}

Nested 6-byte block header.

Definition at line 1185 of file protocol.h.

Referenced by Parse().

◆ IDX

constexpr std::uint16_t profinet::PNInM1::IDX = 0xAFF1
staticconstexpr

Record data index for I&M1.

Definition at line 1181 of file protocol.h.

Referenced by profinet::rpc::RPCCon::ReadIm1().

◆ imTagFunction

std::string profinet::PNInM1::imTagFunction

User-assigned function description (32 chars).

Definition at line 1188 of file protocol.h.

Referenced by Parse().

◆ imTagLocation

std::string profinet::PNInM1::imTagLocation

User-assigned installation location (22 chars).

Definition at line 1191 of file protocol.h.

Referenced by Parse().

◆ kSize

constexpr std::size_t profinet::PNInM1::kSize = 60
staticconstexpr

Size in bytes of this record.

Definition at line 1194 of file protocol.h.

Referenced by Parse().


The documentation for this struct was generated from the following file: