profinet::RSAlarmItem Struct Reference

Reporting System alarm item (USI 0x8300-0x8302). More...

#include <alarms.h>

Collaboration diagram for profinet::RSAlarmItem:

Public Member Functions
std::string	UsiName () const
	Human-readable name for this item's USI.
std::uint16_t	RsSpecifier () const
	RS specifier extracted from RsAlarmInfo.
std::uint16_t	RsSequenceNumber () const
	RS sequence number (alias for RsSpecifier()).

Public Attributes
Usi	userStructureId = Usi::Unknown
	User Structure Identifier for this item.
std::uint16_t	rsAlarmInfo = 0
	RS alarm info bitfield.

Detailed Description

Reporting System alarm item (USI 0x8300-0x8302).

Definition at line 273 of file alarms.h.

Member Function Documentation

RsSequenceNumber()

std::uint16_t profinet::RSAlarmItem::RsSequenceNumber ( ) const

inline

RS sequence number (alias for RsSpecifier()).

Returns

The same value as RsSpecifier().

Definition at line 297 of file alarms.h.

References RsSpecifier().

Here is the call graph for this function:

RsSpecifier()

std::uint16_t profinet::RSAlarmItem::RsSpecifier ( ) const

inline

RS specifier extracted from RsAlarmInfo.

Returns

The low 11 bits of RsAlarmInfo.

Definition at line 290 of file alarms.h.

References profinet::Low11BitsOfRsAlarmInfo, and rsAlarmInfo.

Referenced by RsSequenceNumber().

Here is the caller graph for this function:

UsiName()

std::string profinet::RSAlarmItem::UsiName ( ) const

inline

Human-readable name for this item's USI.

Returns

The USI name (see GetUsiName()).

Definition at line 283 of file alarms.h.

References profinet::GetUsiName(), and userStructureId.

Here is the call graph for this function:

Member Data Documentation

rsAlarmInfo

std::uint16_t profinet::RSAlarmItem::rsAlarmInfo = 0

RS alarm info bitfield.

Definition at line 279 of file alarms.h.

Referenced by RsSpecifier().

userStructureId

Usi profinet::RSAlarmItem::userStructureId = Usi::Unknown

User Structure Identifier for this item.

Definition at line 276 of file alarms.h.

Referenced by UsiName().

---

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

• include/profinet/alarms.h