iParameter alarm item (USI 0x8201). More...

#include <alarms.h>

Collaboration diagram for profinet::IParameterItem:

Public Member Functions
std::string	UsiName () const
	Human-readable name for this item's USI.

Public Attributes
Usi	userStructureId = Usi::IParameter
	User Structure Identifier for this item.

std::uint16_t	blockType = 0
	Nested block type.

std::uint16_t	blockLength = 0
	Nested block length.

std::uint16_t	blockVersion = 0
	Nested block version.

std::uint32_t	iParReqHeader = 0
	iParameter request header.

std::uint32_t	maxSegmentSize = 0
	Maximum segment size for the transfer.

std::uint32_t	transferIndex = 0
	Transfer index.

std::uint32_t	totalIparSize = 0
	Total iParameter data size in bytes.

Detailed Description

iParameter alarm item (USI 0x8201).

Defined for API parity with alarms.py; ParseAlarmItem() never constructs one (see UploadRetrievalItem's note above) – kept in case callers want to build or hand-decode one from RawData themselves.

Definition at line 205 of file alarms.h.

Member Function Documentation

◆ UsiName()

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

inline

Human-readable name for this item's USI.

Returns: The USI name (see GetUsiName()).

Definition at line 233 of file alarms.h.

References profinet::GetUsiName(), and userStructureId.

Here is the call graph for this function:

Member Data Documentation

◆ blockLength

std::uint16_t profinet::IParameterItem::blockLength = 0

Nested block length.

Definition at line 214 of file alarms.h.

◆ blockType

std::uint16_t profinet::IParameterItem::blockType = 0

Nested block type.

Definition at line 211 of file alarms.h.

◆ blockVersion

std::uint16_t profinet::IParameterItem::blockVersion = 0

Nested block version.

Definition at line 217 of file alarms.h.

◆ iParReqHeader

std::uint32_t profinet::IParameterItem::iParReqHeader = 0

iParameter request header.

Definition at line 220 of file alarms.h.

◆ maxSegmentSize

std::uint32_t profinet::IParameterItem::maxSegmentSize = 0

Maximum segment size for the transfer.

Definition at line 223 of file alarms.h.

◆ totalIparSize

std::uint32_t profinet::IParameterItem::totalIparSize = 0

Total iParameter data size in bytes.

Definition at line 229 of file alarms.h.

◆ transferIndex

std::uint32_t profinet::IParameterItem::transferIndex = 0

Transfer index.

Definition at line 226 of file alarms.h.

◆ userStructureId

Usi profinet::IParameterItem::userStructureId = Usi::IParameter

User Structure Identifier for this item.

Definition at line 208 of file alarms.h.

Referenced by UsiName().

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

include/profinet/alarms.h

Public Member Functions

Public Attributes