profinet::PNAlarmAckPDU Struct Reference

AlarmAck-PDU: acknowledges receipt of an AlarmNotification-PDU. More...

#include <protocol.h>

Collaboration diagram for profinet::PNAlarmAckPDU:

Public Member Functions
Bytes	ToBytes () const
	Serialize this PDU back to raw bytes.

Public Attributes
std::array< std::uint8_t, blockHeaderLenght >	blockHeader {}
	Nested 6-byte block header.
AlarmType	alarmType = AlarmType::Unknown
	Alarm type being acknowledged.
std::uint32_t	api = 0
	API number.
std::uint16_t	slotNumber = 0
	Slot number being acknowledged.
std::uint16_t	subslotNumber = 0
	Subslot number being acknowledged.
std::uint16_t	alarmSpecifier = 0
	Alarm specifier flags echoed from the notification.
std::uint32_t	statusPNIO = 0
	PNIO status code (0 = acknowledged OK).

Static Public Attributes
static constexpr std::size_t	kSize = 22
	Size in bytes of this PDU.

Detailed Description

AlarmAck-PDU: acknowledges receipt of an AlarmNotification-PDU.

Definition at line 1860 of file protocol.h.

Member Function Documentation

ToBytes()

Bytes profinet::PNAlarmAckPDU::ToBytes ( ) const

inline

Serialize this PDU back to raw bytes.

Returns

The encoded bytes.

Definition at line 1888 of file protocol.h.

References alarmSpecifier, alarmType, api, blockHeader, profinet::wire::PutFixed(), profinet::wire::PutU16(), profinet::wire::PutU32(), slotNumber, statusPNIO, and subslotNumber.

Referenced by profinet::AlarmListener::SendAck().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

alarmSpecifier

std::uint16_t profinet::PNAlarmAckPDU::alarmSpecifier = 0

Alarm specifier flags echoed from the notification.

Definition at line 1878 of file protocol.h.

Referenced by profinet::AlarmListener::SendAck(), and ToBytes().

alarmType

AlarmType profinet::PNAlarmAckPDU::alarmType = AlarmType::Unknown

Alarm type being acknowledged.

Definition at line 1866 of file protocol.h.

Referenced by profinet::AlarmListener::SendAck(), and ToBytes().

api

std::uint32_t profinet::PNAlarmAckPDU::api = 0

API number.

Definition at line 1869 of file protocol.h.

Referenced by profinet::AlarmListener::SendAck(), and ToBytes().

blockHeader

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

Nested 6-byte block header.

Definition at line 1863 of file protocol.h.

Referenced by profinet::AlarmListener::SendAck(), and ToBytes().

kSize

constexpr std::size_t profinet::PNAlarmAckPDU::kSize = 22

staticconstexpr

Size in bytes of this PDU.

Definition at line 1884 of file protocol.h.

Referenced by profinet::AlarmListener::SendAck().

slotNumber

std::uint16_t profinet::PNAlarmAckPDU::slotNumber = 0

Slot number being acknowledged.

Definition at line 1872 of file protocol.h.

Referenced by profinet::AlarmListener::SendAck(), and ToBytes().

statusPNIO

std::uint32_t profinet::PNAlarmAckPDU::statusPNIO = 0

PNIO status code (0 = acknowledged OK).

Definition at line 1881 of file protocol.h.

Referenced by profinet::AlarmListener::SendAck(), and ToBytes().

subslotNumber

std::uint16_t profinet::PNAlarmAckPDU::subslotNumber = 0

Subslot number being acknowledged.

Definition at line 1875 of file protocol.h.

Referenced by profinet::AlarmListener::SendAck(), and ToBytes().

---

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

• include/profinet/protocol.h